vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-12 22:11:07 +01:00
Code Issues Releases Wiki Activity

Javadoc changes for Java 11 compatibility

Browse source
This commit is contained in:
Florian Schmaus 2019-07-19 18:10:36 +02:00
parent 8fa90113c9
commit 91ec6cc955
58 changed files with 177 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

14
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java
View file

@ -23,7 +23,7 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider;
/**
* This class represents an item that has been, or will be published to a
* PubSub node. An <tt>Item</tt> has several properties that are dependent
* PubSub node. An <code>Item</code> has several properties that are dependent
* on the configuration of the node to which it has been or will be published.
*
* <h3>An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}</h3>
@ -74,10 +74,10 @@ public class Item extends NodeExtension {
private final String itemId;
/**
* Create an empty <tt>Item</tt> with no id. This is a valid item for nodes which are configured
* Create an empty <code>Item</code> with no id. This is a valid item for nodes which are configured
* so that {@link ConfigureForm#isDeliverPayloads()} is false. In most cases an id will be generated by the server.
* For nodes configured with {@link ConfigureForm#isDeliverPayloads()} and {@link ConfigureForm#isPersistItems()}
* set to false, no <tt>Item</tt> is sent to the node, you have to use the {@link LeafNode#publish()}
* set to false, no <code>Item</code> is sent to the node, you have to use the {@link LeafNode#publish()}
* method in this case.
*/
public Item() {
@ -85,7 +85,7 @@ public class Item extends NodeExtension {
}
/**
* Create an <tt>Item</tt> with an id but no payload. This is a valid item for nodes which are configured
* Create an <code>Item</code> with an id but no payload. This is a valid item for nodes which are configured
* so that {@link ConfigureForm#isDeliverPayloads()} is false.
*
* @param itemId The id if the item. It must be unique within the node unless overwriting and existing item.
@ -96,7 +96,7 @@ public class Item extends NodeExtension {
}
/**
* Create an <tt>Item</tt> with an id but no payload. This is a valid item for nodes which are configured
* Create an <code>Item</code> with an id but no payload. This is a valid item for nodes which are configured
* so that {@link ConfigureForm#isDeliverPayloads()} is false.
*
* @param itemId The id if the item. It must be unique within the node unless overwriting and existing item.
@ -107,7 +107,7 @@ public class Item extends NodeExtension {
}
/**
* Create an <tt>Item</tt> with an id and a node id.
* Create an <code>Item</code> with an id and a node id.
* <p>
* <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
* one as part of {@link Message}. If used to create an Item to publish
@ -122,7 +122,7 @@ public class Item extends NodeExtension {
}
/**
* Create an <tt>Item</tt> with an id and a node id.
* Create an <code>Item</code> with an id and a node id.
* <p>
* <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
* one as part of {@link Message}. If used to create an Item to publish

2
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java
View file

@ -28,7 +28,7 @@ public class ItemDeleteEvent extends SubscriptionEvent {
private List<String> itemIds = Collections.emptyList();
/**
* Constructs an <tt>ItemDeleteEvent</tt> that indicates the the supplied
* Constructs an <code>ItemDeleteEvent</code> that indicates the the supplied
* items (by id) have been deleted, and that the event matches the listed
* subscriptions. The subscriptions would have been created by calling
* {@link LeafNode#subscribe(String)}.

6
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java
View file

@ -30,7 +30,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
private Date originalDate;
/**
* Constructs an <tt>ItemPublishEvent</tt> with the provided list
* Constructs an <code>ItemPublishEvent</code> with the provided list
* of {@link Item} that were published.
*
* @param nodeId The id of the node the event came from
@ -42,7 +42,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
}
/**
* Constructs an <tt>ItemPublishEvent</tt> with the provided list
* Constructs an <code>ItemPublishEvent</code> with the provided list
* of {@link Item} that were published. The list of subscription ids
* represents the subscriptions that matched the event, in the case
* of the user having multiple subscriptions.
@ -57,7 +57,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
}
/**
* Constructs an <tt>ItemPublishEvent</tt> with the provided list
* Constructs an <code>ItemPublishEvent</code> with the provided list
* of {@link Item} that were published in the past. The published
* date signifies that this is delayed event. The list of subscription ids
* represents the subscriptions that matched the event, in the case

4
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java
View file

@ -33,7 +33,7 @@ public class NodeExtension implements ExtensionElement {
private final String node;
/**
* Constructs a <tt>NodeExtension</tt> with an element name specified
* Constructs a <code>NodeExtension</code> with an element name specified
* by {@link PubSubElementType} and the specified node id.
*
* @param elem Defines the element name and namespace
@ -45,7 +45,7 @@ public class NodeExtension implements ExtensionElement {
}
/**
* Constructs a <tt>NodeExtension</tt> with an element name specified
* Constructs a <code>NodeExtension</code> with an element name specified
* by {@link PubSubElementType}.
*
* @param elem Defines the element name and namespace

12
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java
View file

@ -24,7 +24,7 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider;
/**
* This class represents an item that has been, or will be published to a
* pubsub node. An <tt>Item</tt> has several properties that are dependent
* pubsub node. An <code>Item</code> has several properties that are dependent
* on the configuration of the node to which it has been or will be published.
*
* <h3>An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}</h3>
@ -53,7 +53,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
private final E payload;
/**
* Create an <tt>Item</tt> with no id and a payload The id will be set by the server.
* Create an <code>Item</code> with no id and a payload The id will be set by the server.
*
* @param payloadExt A {@link ExtensionElement} which represents the payload data.
*/
@ -66,7 +66,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
}
/**
* Create an <tt>Item</tt> with an id and payload.
* Create an <code>Item</code> with an id and payload.
*
* @param itemId The id of this item. It can be null if we want the server to set the id.
* @param payloadExt A {@link ExtensionElement} which represents the payload data.
@ -80,7 +80,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
}
/**
* Create an <tt>Item</tt> with an id, node id and payload.
* Create an <code>Item</code> with an id, node id and payload.
*
* <p>
* <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
@ -98,7 +98,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
}
/**
* Create an <tt>Item</tt> with an id, node id and payload.
* Create an <code>Item</code> with an id, node id and payload.
*
* <p>
* <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
@ -120,7 +120,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
}
/**
* Get the payload associated with this <tt>Item</tt>. Customising the payload
* Get the payload associated with this <code>Item</code>. Customising the payload
* parsing from the server can be accomplished as described in {@link ItemProvider}.
*
* @return The payload as a {@link ExtensionElement}.

2
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java
View file

@ -29,7 +29,7 @@ public class RetractItem implements ExtensionElement {
private final String id;
/**
* Construct a <tt>RetractItem</tt> with the specified id.
* Construct a <code>RetractItem</code> with the specified id.
*
* @param itemId The id if the item deleted
*/

4
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java
View file

@ -38,7 +38,7 @@ public class SimplePayload implements ExtensionElement {
private final String payload;
/**
* Construct a <tt>SimplePayload</tt> object with the specified element name,
* Construct a <code>SimplePayload</code> object with the specified element name,
* namespace and content. The content must be well formed XML.
*
* @param xmlPayload The payload data
@ -60,7 +60,7 @@ public class SimplePayload implements ExtensionElement {
}
/**
* Construct a <tt>SimplePayload</tt> object with the specified element name,
* Construct a <code>SimplePayload</code> object with the specified element name,
* namespace and content. The content must be well formed XML.
*
* @param elementName The root element name (of the payload)