Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-09-10 18:59:41 +02: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

8
smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java
View file

@ -58,12 +58,12 @@ public class MultipleRecipientInfo {
}
/**
* Returns the JID of a MUC room to which responses should be sent or <tt>null</tt> if
* Returns the JID of a MUC room to which responses should be sent or <code>null</code> if
* no specific address was provided. When no specific address was provided then the reply
* can be sent to any or all recipients. Otherwise, the user should join the specified room
* and send the reply to the room.
*
* @return the JID of a MUC room to which responses should be sent or <tt>null</tt> if
* @return the JID of a MUC room to which responses should be sent or <code>null</code> if
* no specific address was provided.
*/
// TODO should return EntityBareJid
@ -84,11 +84,11 @@ public class MultipleRecipientInfo {
}
/**
* Returns the address to which all replies are requested to be sent or <tt>null</tt> if
* Returns the address to which all replies are requested to be sent or <code>null</code> if
* no specific address was provided. When no specific address was provided then the reply
* can be sent to any or all recipients.
*
* @return the address to which all replies are requested to be sent or <tt>null</tt> if
* @return the address to which all replies are requested to be sent or <code>null</code> if
* no specific address was provided.
*/
public MultipleAddresses.Address getReplyAddress() {

22
smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java
View file

@ -56,11 +56,11 @@ public class MultipleRecipientManager {
*
* @param connection the connection to use to send the packet.
* @param packet the stanza to send to the list of recipients.
* @param to the collection of JIDs to include in the TO list or <tt>null</tt> if no TO
* @param to the collection of JIDs to include in the TO list or <code>null</code> if no TO
* list exists.
* @param cc the collection of JIDs to include in the CC list or <tt>null</tt> if no CC
* @param cc the collection of JIDs to include in the CC list or <code>null</code> if no CC
* list exists.
* @param bcc the collection of JIDs to include in the BCC list or <tt>null</tt> if no BCC
* @param bcc the collection of JIDs to include in the BCC list or <code>null</code> if no BCC
* list exists.
* @throws FeatureNotSupportedException if special XEP-33 features where requested, but the
* server does not support them.
@ -84,13 +84,13 @@ public class MultipleRecipientManager {
*
* @param connection the connection to use to send the packet.
* @param packet the stanza to send to the list of recipients.
* @param to the collection of JIDs to include in the TO list or <tt>null</tt> if no TO list exists.
* @param cc the collection of JIDs to include in the CC list or <tt>null</tt> if no CC list exists.
* @param bcc the collection of JIDs to include in the BCC list or <tt>null</tt> if no BCC list
* @param to the collection of JIDs to include in the TO list or <code>null</code> if no TO list exists.
* @param cc the collection of JIDs to include in the CC list or <code>null</code> if no CC list exists.
* @param bcc the collection of JIDs to include in the BCC list or <code>null</code> if no BCC list
* exists.
* @param replyTo address to which all replies are requested to be sent or <tt>null</tt>
* @param replyTo address to which all replies are requested to be sent or <code>null</code>
* indicating that they can reply to any address.
* @param replyRoom JID of a MUC room to which responses should be sent or <tt>null</tt>
* @param replyRoom JID of a MUC room to which responses should be sent or <code>null</code>
* indicating that they can reply to any address.
* @param noReply true means that receivers should not reply to the message.
* @throws XMPPErrorException if server does not support XEP-33: Extended Stanza Addressing and
@ -195,11 +195,11 @@ public class MultipleRecipientManager {
/**
* Returns the {@link MultipleRecipientInfo} contained in the specified stanza or
* <tt>null</tt> if none was found. Only packets sent to multiple recipients will
* <code>null</code> if none was found. Only packets sent to multiple recipients will
* contain such information.
*
* @param packet the stanza to check.
* @return the MultipleRecipientInfo contained in the specified stanza or <tt>null</tt>
* @return the MultipleRecipientInfo contained in the specified stanza or <code>null</code>
* if none was found.
*/
public static MultipleRecipientInfo getMultipleRecipientInfo(Stanza packet) {
@ -278,7 +278,7 @@ public class MultipleRecipientManager {
*
* @param connection the connection to use for disco. The connected server is going to be
* queried.
* @return the address of the multiple recipients service or <tt>null</tt> if none was found.
* @return the address of the multiple recipients service or <code>null</code> if none was found.
* @throws NoResponseException if there was no response from the server.
* @throws XMPPErrorException
* @throws NotConnectedException

4
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java
View file

@ -37,7 +37,7 @@ import org.jxmpp.jid.Jid;
* list and the result is stored as a form in the command instance, i.e. the
* <code>getForm</code> method retrieves a form with all the users.
* <p>
* Each command has a <tt>node</tt> that should be unique within a given JID.
* Each command has a <code>node</code> that should be unique within a given JID.
* </p>
* <p>
* Commands may have zero or more stages. Each stage is usually used for
@ -87,7 +87,7 @@ public abstract class AdHocCommand {
}
/**
* Returns the specific condition of the <code>error</code> or <tt>null</tt> if the
* Returns the specific condition of the <code>error</code> or <code>null</code> if the
* error doesn't have any.
*
* @param error the error the get the specific condition from.

12
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java
View file

@ -184,9 +184,9 @@ public final class AdHocCommandManager extends Manager {
/**
* Registers a new command with this command manager, which is related to a
* connection. The <tt>node</tt> is an unique identifier of that command for
* the connection related to this command manager. The <tt>name</tt> is the
* human readable name of the command. The <tt>class</tt> is the class of
* connection. The <code>node</code> is an unique identifier of that command for
* the connection related to this command manager. The <code>name</code> is the
* human readable name of the command. The <code>class</code> is the class of
* the command, which must extend {@link LocalCommand} and have a default
* constructor.
*
@ -205,9 +205,9 @@ public final class AdHocCommandManager extends Manager {
/**
* Registers a new command with this command manager, which is related to a
* connection. The <tt>node</tt> is an unique identifier of that
* command for the connection related to this command manager. The <tt>name</tt>
* is the human readable name of the command. The <tt>factory</tt> generates
* connection. The <code>node</code> is an unique identifier of that
* command for the connection related to this command manager. The <code>name</code>
* is the human readable name of the command. The <code>factory</code> generates
* new instances of the command.
*
* @param node the unique identifier of the command.

2
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java
View file

@ -114,7 +114,7 @@ public abstract class LocalCommand extends AdHocCommand {
/**
* Returns true if the current stage is the last one. If it is then the
* execution of some action will complete the execution of the command.
* Commands that don't have multiple stages can always return <tt>true</tt>.
* Commands that don't have multiple stages can always return <code>true</code>.
*
* @return true if the command is in the last stage.
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java
View file

@ -121,7 +121,7 @@ public class RemoteCommand extends AdHocCommand {
/**
* Executes the <code>action</code> with the <code>form</code>.
* The action could be any of the available actions. The form must
* be the answer of the previous stage. It can be <tt>null</tt> if it is the first stage.
* be the answer of the previous stage. It can be <code>null</code> if it is the first stage.
*
* @param action the action to execute.
* @param form the form with the information.

6
smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
View file

@ -62,7 +62,7 @@ public class DelayInformation implements ExtensionElement {
/**
* Returns the JID of the entity that originally sent the stanza or that delayed the
* delivery of the stanza or <tt>null</tt> if this information is not available.
* delivery of the stanza or <code>null</code> if this information is not available.
*
* @return the JID of the entity that originally sent the stanza or that delayed the
* delivery of the packet.
@ -82,10 +82,10 @@ public class DelayInformation implements ExtensionElement {
}
/**
* Returns a natural-language description of the reason for the delay or <tt>null</tt> if
* Returns a natural-language description of the reason for the delay or <code>null</code> if
* this information is not available.
*
* @return a natural-language description of the reason for the delay or <tt>null</tt>.
* @return a natural-language description of the reason for the delay or <code>null</code>.
*/
public String getReason() {
return reason;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
View file

@ -312,7 +312,7 @@ public final class ServiceDiscoveryManager extends Manager {
/**
* Returns the NodeInformationProvider responsible for providing information
* (ie items) related to a given node or <tt>null</null> if none.<p>
* (ie items) related to a given node or <code>null</null> if none.<p>
*
* In MUC, a node could be 'http://jabber.org/protocol/muc#rooms' which means that the
* NodeInformationProvider will provide information about the rooms where the user has joined.

8
smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java
View file

@ -194,11 +194,11 @@ public final class AccountManager extends Manager {
}
/**
* Returns the value of a given account attribute or <tt>null</tt> if the account
* Returns the value of a given account attribute or <code>null</code> if the account
* attribute wasn't found.
*
* @param name the name of the account attribute to return its value.
* @return the value of the account attribute or <tt>null</tt> if an account
* @return the value of the account attribute or <code>null</code> if an account
* attribute wasn't found for the requested name.
* @throws XMPPErrorException
* @throws NoResponseException
@ -213,11 +213,11 @@ public final class AccountManager extends Manager {
}
/**
* Returns the instructions for creating a new account, or <tt>null</tt> if there
* Returns the instructions for creating a new account, or <code>null</code> if there
* are no instructions. If present, instructions should be displayed to the end-user
* that will complete the registration process.
*
* @return the account creation instructions, or <tt>null</tt> if there are none.
* @return the account creation instructions, or <code>null</code> if there are none.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException

4
smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java
View file

@ -68,11 +68,11 @@ public class Registration extends IQ {
}
/**
* Returns the registration instructions, or <tt>null</tt> if no instructions
* Returns the registration instructions, or <code>null</code> if no instructions
* have been set. If present, instructions should be displayed to the end-user
* that will complete the registration process.
*
* @return the registration instructions, or <tt>null</tt> if there are none.
* @return the registration instructions, or <code>null</code> if there are none.
*/
public String getInstructions() {
return instructions;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java
View file

@ -70,7 +70,7 @@ public class JivePropertiesManager {
*
* @param packet
* @param name
* @return the property or <tt>null</tt> if none found.
* @return the property or <code>null</code> if none found.
*/
public static Object getProperty(Stanza packet, String name) {
Object res = null;

4
smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java
View file

@ -60,13 +60,13 @@ public class JivePropertiesExtension implements ExtensionElement {
}
/**
* Returns the stanza property with the specified name or <tt>null</tt> if the
* Returns the stanza property with the specified name or <code>null</code> if the
* property doesn't exist. Property values that were originally primitives will
* be returned as their object equivalent. For example, an int property will be
* returned as an Integer, a double as a Double, etc.
*
* @param name the name of the property.
* @return the property, or <tt>null</tt> if the property doesn't exist.
* @return the property, or <code>null</code> if the property doesn't exist.
*/
public synchronized Object getProperty(String name) {
if (properties == null) {

34
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java
View file

@ -781,12 +781,12 @@ public class MultiUserChat {
}
/**
* Returns the room's configuration form that the room's owner can use or <tt>null</tt> if
* Returns the room's configuration form that the room's owner can use or <code>null</code> if
* no configuration is possible. The configuration form allows to set the room's language,
* enable logging, specify room's type, etc..
*
* @return the Form that contains the fields to complete together with the instrucions or
* <tt>null</tt> if no configuration is possible.
* <code>null</code> if no configuration is possible.
* @throws XMPPErrorException if an error occurs asking the configuration form for the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
@ -822,7 +822,7 @@ public class MultiUserChat {
/**
* Returns the room's registration form that an unaffiliated user, can use to become a member
* of the room or <tt>null</tt> if no registration is possible. Some rooms may restrict the
* of the room or <code>null</code> if no registration is possible. Some rooms may restrict the
* privilege to register members and allow only room admins to add new members.<p>
*
* If the user requesting registration requirements is not allowed to register with the room
@ -830,7 +830,7 @@ public class MultiUserChat {
* error to the user (error code 405).
*
* @return the registration Form that contains the fields to complete together with the
* instrucions or <tt>null</tt> if no registration is possible.
* instrucions or <code>null</code> if no registration is possible.
* @throws XMPPErrorException if an error occurs asking the registration form for the room or a
* 405 error if the user is not allowed to register with the room.
* @throws NoResponseException if there was no response from the server.
@ -1043,7 +1043,7 @@ public class MultiUserChat {
}
/**
* Returns the last known room's subject or <tt>null</tt> if the user hasn't joined the room
* Returns the last known room's subject or <code>null</code> if the user hasn't joined the room
* or the room does not have a subject yet. In case the room has a subject, as soon as the
* user joins the room a message with the current room's subject will be received.<p>
*
@ -1052,7 +1052,7 @@ public class MultiUserChat {
*
* To change the room's subject use {@link #changeSubject(String)}.
*
* @return the room's subject or <tt>null</tt> if the user hasn't joined the room or the
* @return the room's subject or <code>null</code> if the user hasn't joined the room or the
* room does not have a subject yet.
*/
public String getSubject() {
@ -1065,7 +1065,7 @@ public class MultiUserChat {
* cases it may be desirable for the user to discover the reserved nickname before attempting
* to enter the room.
*
* @return the reserved room nickname or <tt>null</tt> if none.
* @return the reserved room nickname or <code>null</code> if none.
* @throws SmackException if there was no response from the server.
* @throws InterruptedException
*/
@ -1088,7 +1088,7 @@ public class MultiUserChat {
}
/**
* Returns the nickname that was used to join the room, or <tt>null</tt> if not
* Returns the nickname that was used to join the room, or <code>null</code> if not
* currently joined.
*
* @return the nickname currently being used.
@ -1690,12 +1690,12 @@ public class MultiUserChat {
}
/**
* Returns the presence info for a particular user, or <tt>null</tt> if the user
* Returns the presence info for a particular user, or <code>null</code> if the user
* is not in the room.<p>
*
* @param user the room occupant to search for his presence. The format of user must
* be: roomName@service/nickname (e.g. darkcave@macbeth.shakespeare.lit/thirdwitch).
* @return the occupant's current presence, or <tt>null</tt> if the user is unavailable
* @return the occupant's current presence, or <code>null</code> if the user is unavailable
* or if no presence information is available.
*/
public Presence getOccupantPresence(EntityFullJid user) {
@ -1703,13 +1703,13 @@ public class MultiUserChat {
}
/**
* Returns the Occupant information for a particular occupant, or <tt>null</tt> if the
* Returns the Occupant information for a particular occupant, or <code>null</code> if the
* user is not in the room. The Occupant object may include information such as full
* JID of the user as well as the role and affiliation of the user in the room.<p>
*
* @param user the room occupant to search for his presence. The format of user must
* be: roomName@service/nickname (e.g. darkcave@macbeth.shakespeare.lit/thirdwitch).
* @return the Occupant or <tt>null</tt> if the user is unavailable (i.e. not in the room).
* @return the Occupant or <code>null</code> if the user is unavailable (i.e. not in the room).
*/
public Occupant getOccupant(EntityFullJid user) {
Presence presence = getOccupantPresence(user);
@ -1933,7 +1933,7 @@ public class MultiUserChat {
}
/**
* Polls for and returns the next message, or <tt>null</tt> if there isn't
* Polls for and returns the next message, or <code>null</code> if there isn't
* a message immediately available. This method provides significantly different
* functionalty than the {@link #nextMessage()} method since it's non-blocking.
* In other words, the method call will always return immediately, whereas the
@ -1941,7 +1941,7 @@ public class MultiUserChat {
* a specific timeout).
*
* @return the next message if one is immediately available and
* <tt>null</tt> otherwise.
* <code>null</code> otherwise.
* @throws MucNotJoinedException
*/
public Message pollMessage() throws MucNotJoinedException {
@ -1968,11 +1968,11 @@ public class MultiUserChat {
/**
* Returns the next available message in the chat. The method call will block
* (not return) until a stanza is available or the <tt>timeout</tt> has elapased.
* If the timeout elapses without a result, <tt>null</tt> will be returned.
* (not return) until a stanza is available or the <code>timeout</code> has elapased.
* If the timeout elapses without a result, <code>null</code> will be returned.
*
* @param timeout the maximum amount of time to wait for the next message.
* @return the next message, or <tt>null</tt> if the timeout elapses without a
* @return the next message, or <code>null</code> if the timeout elapses without a
* message becoming available.
* @throws MucNotJoinedException
* @throws InterruptedException

12
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
View file

@ -41,7 +41,7 @@ import org.jivesoftware.smack.xml.XmlPullParserException;
* </pre>
*
* To listen for group chat invitations, use a StanzaExtensionFilter for the
* <tt>x</tt> element name and <tt>jabber:x:conference</tt> namespace, as in the
* <code>x</code> element name and <code>jabber:x:conference</code> namespace, as in the
* following code example:
*
* <pre>
@ -72,9 +72,9 @@ public class GroupChatInvitation implements ExtensionElement {
/**
* Creates a new group chat invitation to the specified room address.
* GroupChat room addresses are in the form <tt>room@service</tt>,
* where <tt>service</tt> is the name of group chat server, such as
* <tt>chat.example.com</tt>.
* GroupChat room addresses are in the form <code>room@service</code>,
* where <code>service</code> is the name of group chat server, such as
* <code>chat.example.com</code>.
*
* @param roomAddress the address of the group chat room.
*/
@ -84,8 +84,8 @@ public class GroupChatInvitation implements ExtensionElement {
/**
* Returns the address of the group chat room. GroupChat room addresses
* are in the form <tt>room@service</tt>, where <tt>service</tt> is
* the name of group chat server, such as <tt>chat.example.com</tt>.
* are in the form <code>room@service</code>, where <code>service</code> is
* the name of group chat server, such as <code>chat.example.com</code>.
*
* @return the address of the group chat room.
*/

12
smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java
View file

@ -110,11 +110,11 @@ public class OfflineMessageManager {
}
/**
* Returns a List of <tt>OfflineMessageHeader</tt> that keep information about the
* Returns a List of <code>OfflineMessageHeader</code> that keep information about the
* offline message. The OfflineMessageHeader includes a stamp that could be used to retrieve
* the complete message or delete the specific message.
*
* @return a List of <tt>OfflineMessageHeader</tt> that keep information about the offline
* @return a List of <code>OfflineMessageHeader</code> that keep information about the offline
* message.
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
@ -133,13 +133,13 @@ public class OfflineMessageManager {
}
/**
* Returns a List of the offline <tt>Messages</tt> whose stamp matches the specified
* Returns a List of the offline <code>Messages</code> whose stamp matches the specified
* request. The request will include the list of stamps that uniquely identifies
* the offline messages to retrieve. The returned offline messages will not be deleted
* from the server. Use {@link #deleteMessages(java.util.List)} to delete the messages.
*
* @param nodes the list of stamps that uniquely identifies offline message.
* @return a List with the offline <tt>Messages</tt> that were received as part of
* @return a List with the offline <code>Messages</code> that were received as part of
* this request.
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
@ -184,11 +184,11 @@ public class OfflineMessageManager {
}
/**
* Returns a List of Messages with all the offline <tt>Messages</tt> of the user. The returned offline
* Returns a List of Messages with all the offline <code>Messages</code> of the user. The returned offline
* messages will not be deleted from the server. Use {@link #deleteMessages(java.util.List)}
* to delete the messages.
*
* @return a List with all the offline <tt>Messages</tt> of the user.
* @return a List with all the offline <code>Messages</code> of the user.
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.

8
smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java
View file

@ -107,9 +107,9 @@ public class Privacy extends IQ {
}
/**
* Returns the active privacy list or <tt>null</tt> if none was found.
* Returns the active privacy list or <code>null</code> if none was found.
*
* @return list with {@link PrivacyItem} or <tt>null</tt> if none was found.
* @return list with {@link PrivacyItem} or <code>null</code> if none was found.
*/
public List<PrivacyItem> getActivePrivacyList() {
// Check if we have the default list
@ -123,9 +123,9 @@ public class Privacy extends IQ {
}
/**
* Returns the default privacy list or <tt>null</tt> if none was found.
* Returns the default privacy list or <code>null</code> if none was found.
*
* @return list with {@link PrivacyItem} or <tt>null</tt> if none was found.
* @return list with {@link PrivacyItem} or <code>null</code> if none was found.
*/
public List<PrivacyItem> getDefaultPrivacyList() {
// Check if we have the default list

4
smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java
View file

@ -31,8 +31,8 @@ import org.jivesoftware.smackx.privacy.packet.PrivacyItem;
/**
* The PrivacyProvider parses {@link Privacy} packets. {@link Privacy}
* Parses the <tt>query</tt> sub-document and creates an instance of {@link Privacy}.
* For each <tt>item</tt> in the <tt>list</tt> element, it creates an instance
* Parses the <code>query</code> sub-document and creates an instance of {@link Privacy}.
* For each <code>item</code> in the <code>list</code> element, it creates an instance
* of {@link PrivacyItem}.
*
* @author Francisco Vives

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)

2
smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java
View file

@ -61,7 +61,7 @@ public class Time extends IQ {
}
/**
* Returns the local time or <tt>null</tt> if the time hasn't been set.
* Returns the local time or <code>null</code> if the time hasn't been set.
*
* @return the local time.
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java
View file

@ -52,7 +52,7 @@ public class Form {
* extension that matches the elementName and namespace "x","jabber:x:data".
*
* @param packet the stanza used for gathering data.
* @return the data form parsed from the stanza or <tt>null</tt> if there was not
* @return the data form parsed from the stanza or <code>null</code> if there was not
* a form in the packet.
*/
public static Form getFormFrom(Stanza packet) {