1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-06-18 01:14:50 +02:00

Javadoc changes for Java 11 compatibility

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

View file

@ -29,7 +29,7 @@ import android.util.Log;
* </p>
* It is possible to not only print the raw sent and received stanzas but also the interpreted
* packets by Smack. By default interpreted packets won't be printed. To enable this feature
* just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
* just change the <code>printInterpreted</code> static variable to <code>true</code>.
*
*/
public class AndroidDebugger extends AbstractDebugger {

View file

@ -286,7 +286,7 @@ public abstract class ConnectionConfiguration {
}
/**
* Returns the keystore type, or <tt>null</tt> if it's not set.
* Returns the keystore type, or <code>null</code> if it's not set.
*
* @return the keystore type.
*/
@ -902,7 +902,7 @@ public abstract class ConnectionConfiguration {
* Sets if an initial available presence will be sent to the server. By default
* an available presence will be sent to the server indicating that this presence
* is not online and available to receive messages. If you want to log in without
* being 'noticed' then pass a <tt>false</tt> value.
* being 'noticed' then pass a <code>false</code> value.
*
* @param sendPresence true if an initial available presence will be sent while logging in.
* @return a reference to this builder.

View file

@ -84,7 +84,7 @@ public final class SmackConfiguration {
* <li> Interpreted Packets -- shows XML packets from the server as parsed by Smack.
* </ul>
* Debugging can be enabled by setting this field to true, or by setting the Java system
* property <tt>smack.debugEnabled</tt> to true. The system property can be set on the
* property <code>smack.debugEnabled</code> to true. The system property can be set on the
* command line such as "java SomeApp -Dsmack.debugEnabled=true".
*/
public static boolean DEBUG = false;

View file

@ -63,7 +63,7 @@ public final class StanzaCollector implements AutoCloseable {
private Exception connectionException;
/**
* Creates a new stanza collector. If the stanza filter is <tt>null</tt>, then
* Creates a new stanza collector. If the stanza filter is <code>null</code>, then
* all packets will match this collector.
*
* @param connection the connection the collector is tied to.
@ -110,11 +110,11 @@ public final class StanzaCollector implements AutoCloseable {
/**
* Polls to see if a stanza is currently available and returns it, or
* immediately returns <tt>null</tt> if no packets are currently in the
* immediately returns <code>null</code> if no packets are currently in the
* result queue.
*
* @param <P> type of the result stanza.
* @return the next stanza result, or <tt>null</tt> if there are no more
* @return the next stanza result, or <code>null</code> if there are no more
* results.
*/
@SuppressWarnings("unchecked")
@ -124,7 +124,7 @@ public final class StanzaCollector implements AutoCloseable {
/**
* Polls to see if a stanza is currently available and returns it, or
* immediately returns <tt>null</tt> if no packets are currently in the
* immediately returns <code>null</code> if no packets are currently in the
* result queue.
* <p>
* Throws an XMPPErrorException in case the polled stanzas did contain an XMPPError.
@ -183,8 +183,8 @@ public final class StanzaCollector implements AutoCloseable {
/**
* Returns the next available stanza. The method call will block (not return) until a stanza is available or the
* <tt>timeout</tt> has elapsed or if the connection was terminated because of an error. If the timeout elapses without a
* result or if there was an connection error, <tt>null</tt> will be returned.
* <code>timeout</code> has elapsed or if the connection was terminated because of an error. If the timeout elapses without a
* result or if there was an connection error, <code>null</code> will be returned.
*
* @param <P> type of the result stanza.
* @param timeout the timeout in milliseconds.
@ -230,7 +230,7 @@ public final class StanzaCollector implements AutoCloseable {
/**
* Returns the next available stanza. The method call will block until a stanza is
* available or the <tt>timeout</tt> has elapsed. This method does also cancel the
* available or the <code>timeout</code> has elapsed. This method does also cancel the
* collector in every case.
* <p>
* Three things can happen when waiting for an response:

View file

@ -123,7 +123,7 @@ public interface XMPPConnection {
/**
* Returns the full XMPP address of the user that is logged in to the connection or
* <tt>null</tt> if not logged in yet. An XMPP address is in the form
* <code>null</code> if not logged in yet. An XMPP address is in the form
* username@server/resource.
*
* @return the full XMPP address of the user logged in.
@ -132,9 +132,9 @@ public interface XMPPConnection {
/**
* Returns the stream ID for this connection, which is the value set by the server
* when opening an XMPP stream. This value will be <tt>null</tt> if not connected to the server.
* when opening an XMPP stream. This value will be <code>null</code> if not connected to the server.
*
* @return the ID of this connection returned from the XMPP server or <tt>null</tt> if
* @return the ID of this connection returned from the XMPP server or <code>null</code> if
* not connected to the server.
* @see <a href="http://xmpp.org/rfcs/rfc6120.html#streams-attr-id">RFC 6120 § 4.7.3. id</a>
*/
@ -471,7 +471,7 @@ public interface XMPPConnection {
/**
* Get the connection counter of this XMPPConnection instance. Those can be used as ID to
* identify the connection, but beware that the ID may not be unique if you create more then
* <tt>2*Integer.MAX_VALUE</tt> instances as the counter could wrap.
* <code>2*Integer.MAX_VALUE</code> instances as the counter could wrap.
*
* @return the connection counter of this XMPPConnection
*/

View file

@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.ExceptionUtil;
* <p>
* It is possible to not only print the raw sent and received stanzas but also the interpreted
* packets by Smack. By default interpreted packets won't be printed. To enable this feature
* just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
* just change the <code>printInterpreted</code> static variable to <code>true</code>.
* </p>
*
* @author Gaston Dombiak

View file

@ -28,7 +28,7 @@ import org.jivesoftware.smack.XMPPConnection;
* <p>
* It is possible to not only print the raw sent and received stanzas but also the interpreted
* packets by Smack. By default interpreted packets won't be printed. To enable this feature
* just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
* just change the <code>printInterpreted</code> static variable to <code>true</code>.
* </p>
*
* @author Gaston Dombiak

View file

@ -25,9 +25,9 @@ import org.jivesoftware.smack.packet.Stanza;
* Filters for packets of a particular type. The type is given as a Class object, so
* example types would:
* <ul>
* <li><tt>Message.class</tt>
* <li><tt>IQ.class</tt>
* <li><tt>Presence.class</tt>
* <li><code>Message.class</code>
* <li><code>IQ.class</code>
* <li><code>Presence.class</code>
* </ul>
*
* @author Matt Tucker
@ -43,7 +43,7 @@ public class PacketTypeFilter implements StanzaFilter {
/**
* Creates a new stanza type filter that will filter for packets that are the
* same type as <tt>packetType</tt>.
* same type as <code>packetType</code>.
*
* @param packetType the Class type.
*/

View file

@ -57,7 +57,7 @@ public interface StanzaFilter {
* Tests whether or not the specified stanza should pass the filter.
*
* @param stanza the stanza to test.
* @return true if and only if <tt>stanza</tt> passes the filter.
* @return true if and only if <code>stanza</code> passes the filter.
*/
boolean accept(Stanza stanza);
}

View file

@ -26,9 +26,9 @@ import org.jivesoftware.smack.packet.Stanza;
* Filters for Stanzas of a particular type. The type is given as a Class object, so
* example types would:
* <ul>
* <li><tt>Message.class</tt>
* <li><tt>IQ.class</tt>
* <li><tt>Presence.class</tt>
* <li><code>Message.class</code>
* <li><code>IQ.class</code>
* <li><code>Presence.class</code>
* </ul>
*
* @author Matt Tucker
@ -43,7 +43,7 @@ public final class StanzaTypeFilter implements StanzaFilter {
/**
* Creates a new stanza type filter that will filter for packets that are the
* same type as <tt>packetType</tt>.
* same type as <code>packetType</code>.
*
* @param packetType the Class type.
*/

View file

@ -93,12 +93,12 @@ public class AbstractError {
/**
* Returns the first stanza extension that matches the specified element name and
* namespace, or <tt>null</tt> if it doesn't exist.
* namespace, or <code>null</code> if it doesn't exist.
*
* @param elementName the XML element name of the stanza extension.
* @param namespace the XML element namespace of the stanza extension.
* @param <PE> type of the ExtensionElement.
* @return the extension, or <tt>null</tt> if it doesn't exist.
* @return the extension, or <code>null</code> if it doesn't exist.
*/
public <PE extends ExtensionElement> PE getExtension(String elementName, String namespace) {
return PacketUtil.extensionElementFrom(extensions, elementName, namespace);

View file

@ -438,9 +438,9 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
/**
* Returns the thread id of the message, which is a unique identifier for a sequence
* of "chat" messages. If no thread id is set, <tt>null</tt> will be returned.
* of "chat" messages. If no thread id is set, <code>null</code> will be returned.
*
* @return the thread id of the message, or <tt>null</tt> if it doesn't exist.
* @return the thread id of the message, or <code>null</code> if it doesn't exist.
*/
public String getThread() {
return thread;

View file

@ -63,11 +63,11 @@ public interface Packet extends TopLevelStreamElement {
void setPacketID(String packetID);
/**
* Returns who the stanza is being sent "to", or <tt>null</tt> if
* Returns who the stanza is being sent "to", or <code>null</code> if
* the value is not set. The XMPP protocol often makes the "to"
* attribute optional, so it does not always need to be set.<p>
*
* @return who the stanza is being sent to, or <tt>null</tt> if the
* @return who the stanza is being sent to, or <code>null</code> if the
* value has not been set.
*/
String getTo();
@ -81,11 +81,11 @@ public interface Packet extends TopLevelStreamElement {
void setTo(String to);
/**
* Returns who the stanza is being sent "from" or <tt>null</tt> if
* Returns who the stanza is being sent "from" or <code>null</code> if
* the value is not set. The XMPP protocol often makes the "from"
* attribute optional, so it does not always need to be set.<p>
*
* @return who the stanza is being sent from, or <tt>null</tt> if the
* @return who the stanza is being sent from, or <code>null</code> if the
* value has not been set.
*/
String getFrom();
@ -100,10 +100,10 @@ public interface Packet extends TopLevelStreamElement {
void setFrom(String from);
/**
* Returns the error associated with this packet, or <tt>null</tt> if there are
* Returns the error associated with this packet, or <code>null</code> if there are
* no errors.
*
* @return the error sub-packet or <tt>null</tt> if there isn't an error.
* @return the error sub-packet or <code>null</code> if there isn't an error.
*/
StanzaError getError();
/**
@ -160,7 +160,7 @@ public interface Packet extends TopLevelStreamElement {
/**
* Returns the first stanza extension that matches the specified element name and
* namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
* namespace, or <code>null</code> if it doesn't exist. If the provided elementName is null,
* only the namespace is matched. Stanza extensions are
* are arbitrary XML sub-documents in standard XMPP packets. By default, a
* DefaultPacketExtension instance will be returned for each extension. However,
@ -172,7 +172,7 @@ public interface Packet extends TopLevelStreamElement {
* @param elementName the XML element name of the stanza extension. (May be null)
* @param namespace the XML element namespace of the stanza extension.
* @param <PE> type of the ExtensionElement.
* @return the extension, or <tt>null</tt> if it doesn't exist.
* @return the extension, or <code>null</code> if it doesn't exist.
*/
<PE extends ExtensionElement> PE getExtension(String elementName, String namespace);
/**

View file

@ -138,7 +138,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
* Returns true if the {@link Type presence type} is available (online) and
* false if the user is unavailable (offline), or if this is a presence packet
* involved in a subscription operation. This is a convenience method
* equivalent to <tt>getType() == Presence.Type.available</tt>. Note that even
* equivalent to <code>getType() == Presence.Type.available</code>. Note that even
* when the user is available, their presence mode may be {@link Mode#away away},
* {@link Mode#xa extended away} or {@link Mode#dnd do not disturb}. Use
* {@link #isAway()} to determine if the user is away.
@ -155,7 +155,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
* {@link Mode#dnd do not disturb}. False will be returned when the type or mode
* is any other value, including when the presence type is unavailable (offline).
* This is a convenience method equivalent to
* <tt>type == Type.available &amp;&amp; (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd)</tt>.
* <code>type == Type.available &amp;&amp; (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd)</code>.
*
* @return true if the presence type is available and the presence mode is away, xa, or dnd.
*/
@ -182,7 +182,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
}
/**
* Returns the status message of the presence update, or <tt>null</tt> if there
* Returns the status message of the presence update, or <code>null</code> if there
* is not a status. The status is free-form text describing a user's presence
* (i.e., "gone to lunch").
*

View file

@ -164,11 +164,11 @@ public abstract class Stanza implements TopLevelStreamElement {
}
/**
* Returns who the stanza is being sent "to", or <tt>null</tt> if
* Returns who the stanza is being sent "to", or <code>null</code> if
* the value is not set. The XMPP protocol often makes the "to"
* attribute optional, so it does not always need to be set.<p>
*
* @return who the stanza is being sent to, or <tt>null</tt> if the
* @return who the stanza is being sent to, or <code>null</code> if the
* value has not been set.
*/
public Jid getTo() {
@ -206,11 +206,11 @@ public abstract class Stanza implements TopLevelStreamElement {
}
/**
* Returns who the stanza is being sent "from" or <tt>null</tt> if
* Returns who the stanza is being sent "from" or <code>null</code> if
* the value is not set. The XMPP protocol often makes the "from"
* attribute optional, so it does not always need to be set.<p>
*
* @return who the stanza is being sent from, or <tt>null</tt> if the
* @return who the stanza is being sent from, or <code>null</code> if the
* value has not been set.
*/
public Jid getFrom() {
@ -250,10 +250,10 @@ public abstract class Stanza implements TopLevelStreamElement {
}
/**
* Returns the error associated with this packet, or <tt>null</tt> if there are
* Returns the error associated with this packet, or <code>null</code> if there are
* no errors.
*
* @return the error sub-packet or <tt>null</tt> if there isn't an error.
* @return the error sub-packet or <code>null</code> if there isn't an error.
*/
public StanzaError getError() {
return error;
@ -346,14 +346,14 @@ public abstract class Stanza implements TopLevelStreamElement {
/**
* Returns the first extension that matches the specified element name and
* namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
* namespace, or <code>null</code> if it doesn't exist. If the provided elementName is null,
* only the namespace is matched. Extensions are
* are arbitrary XML elements in standard XMPP stanzas.
*
* @param elementName the XML element name of the extension. (May be null)
* @param namespace the XML element namespace of the extension.
* @param <PE> type of the ExtensionElement.
* @return the extension, or <tt>null</tt> if it doesn't exist.
* @return the extension, or <code>null</code> if it doesn't exist.
*/
@SuppressWarnings("unchecked")
public <PE extends ExtensionElement> PE getExtension(String elementName, String namespace) {

View file

@ -60,8 +60,8 @@ import org.jivesoftware.smack.xml.XmlPullParserException;
* &lt;/message&gt;
*
* I would have a classes
* <tt>ItemsProvider</tt> extends {@link EmbeddedExtensionProvider}
* <tt>ItemProvider</tt> extends {@link EmbeddedExtensionProvider}
* <code>ItemsProvider</code> extends {@link EmbeddedExtensionProvider}
* <code>ItemProvider</code> extends {@link EmbeddedExtensionProvider}
* and
* AtomProvider extends {@link ExtensionElementProvider}
*

View file

@ -94,7 +94,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
protected SSLSession sslSession;
/**
* Builds and sends the <tt>auth</tt> stanza to the server. Note that this method of
* Builds and sends the <code>auth</code> stanza to the server. Note that this method of
* authentication is not recommended, since it is very inflexible. Use
* {@link #authenticate(String, DomainBareJid, CallbackHandler, EntityBareJid, SSLSession)} whenever possible.
*
@ -161,7 +161,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
}
/**
* Builds and sends the <tt>auth</tt> stanza to the server. The callback handler will handle
* Builds and sends the <code>auth</code> stanza to the server. The callback handler will handle
* any additional information, such as the authentication ID or realm, if it is needed.
*
* @param host the hostname where the user account resides.

View file

@ -32,7 +32,7 @@ public interface ChatMarkersListener {
*
* @param chatMarkersState the current state of the message.
* @param message the new incoming message with a markable XML tag.
* @param chat associated to the message. This element can be <tt>NULL</tt>.
* @param chat associated to the message. This element can be <code>NULL</code>.
*/
void newChatMarkerMessage(ChatMarkersState chatMarkersState, Message message, Chat chat);
}

View file

@ -42,7 +42,7 @@ public final class EligibleForChatMarkerFilter extends StanzaExtensionFilter {
* From XEP-0333, Protocol Format: The Chat Marker MUST have an 'id' which is the 'id' of the
* message being marked.<br>
* In order to make Chat Markers works together with XEP-0085 as it said in
* 8.5 Interaction with Chat States, only messages with <tt>active</tt> chat
* 8.5 Interaction with Chat States, only messages with <code>active</code> chat
* state are accepted.
*
* @param message to be analyzed.

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() {

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

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.

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.

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.
*/

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.

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;

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.

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

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;

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;

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) {

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>