From 91ec6cc95548528732dc64907e51b1c46559e3d1 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Fri, 19 Jul 2019 18:10:36 +0200 Subject: [PATCH] Javadoc changes for Java 11 compatibility --- .../debugger/android/AndroidDebugger.java | 2 +- .../smack/ConnectionConfiguration.java | 4 +-- .../smack/SmackConfiguration.java | 2 +- .../jivesoftware/smack/StanzaCollector.java | 14 ++++---- .../jivesoftware/smack/XMPPConnection.java | 8 ++--- .../smack/debugger/ConsoleDebugger.java | 2 +- .../smack/debugger/JulDebugger.java | 2 +- .../smack/filter/PacketTypeFilter.java | 8 ++--- .../smack/filter/StanzaFilter.java | 2 +- .../smack/filter/StanzaTypeFilter.java | 8 ++--- .../smack/packet/AbstractError.java | 4 +-- .../jivesoftware/smack/packet/Message.java | 4 +-- .../org/jivesoftware/smack/packet/Packet.java | 16 ++++----- .../jivesoftware/smack/packet/Presence.java | 6 ++-- .../org/jivesoftware/smack/packet/Stanza.java | 16 ++++----- .../provider/EmbeddedExtensionProvider.java | 4 +-- .../smack/sasl/SASLMechanism.java | 4 +-- .../chat_markers/ChatMarkersListener.java | 2 +- .../filter/EligibleForChatMarkerFilter.java | 2 +- .../smackx/address/MultipleRecipientInfo.java | 8 ++--- .../address/MultipleRecipientManager.java | 22 ++++++------ .../smackx/commands/AdHocCommand.java | 4 +-- .../smackx/commands/AdHocCommandManager.java | 12 +++---- .../smackx/commands/LocalCommand.java | 2 +- .../smackx/commands/RemoteCommand.java | 2 +- .../smackx/delay/packet/DelayInformation.java | 6 ++-- .../smackx/disco/ServiceDiscoveryManager.java | 2 +- .../smackx/iqregister/AccountManager.java | 8 ++--- .../iqregister/packet/Registration.java | 4 +-- .../jiveproperties/JivePropertiesManager.java | 2 +- .../packet/JivePropertiesExtension.java | 4 +-- .../smackx/muc/MultiUserChat.java | 34 +++++++++---------- .../muc/packet/GroupChatInvitation.java | 12 +++---- .../smackx/offline/OfflineMessageManager.java | 12 +++---- .../smackx/privacy/packet/Privacy.java | 8 ++--- .../privacy/provider/PrivacyProvider.java | 4 +-- .../org/jivesoftware/smackx/pubsub/Item.java | 14 ++++---- .../smackx/pubsub/ItemDeleteEvent.java | 2 +- .../smackx/pubsub/ItemPublishEvent.java | 6 ++-- .../smackx/pubsub/NodeExtension.java | 4 +-- .../smackx/pubsub/PayloadItem.java | 12 +++---- .../smackx/pubsub/RetractItem.java | 2 +- .../smackx/pubsub/SimplePayload.java | 4 +-- .../jivesoftware/smackx/time/packet/Time.java | 2 +- .../org/jivesoftware/smackx/xdata/Form.java | 2 +- .../org/jivesoftware/smack/chat/Chat.java | 2 +- .../org/jivesoftware/smack/roster/Roster.java | 14 ++++---- .../smack/roster/RosterGroup.java | 4 +-- .../smackx/workgroup/agent/AgentRoster.java | 4 +-- .../smackx/workgroup/agent/AgentSession.java | 4 +-- .../workgroup/agent/WorkgroupQueue.java | 2 +- .../packet/OfferRequestProvider.java | 2 +- .../smackx/workgroup/user/Workgroup.java | 4 +-- .../smackx/xevent/MessageEventManager.java | 2 +- .../smackx/xroster/RemoteRosterEntry.java | 2 +- .../ox/element/OpenPgpContentElement.java | 4 +-- .../ox/store/abstr/AbstractOpenPgpStore.java | 3 +- .../jivesoftware/smack/xml/XmlPullParser.java | 3 +- 58 files changed, 177 insertions(+), 177 deletions(-) diff --git a/smack-android/src/main/java/org/jivesoftware/smackx/debugger/android/AndroidDebugger.java b/smack-android/src/main/java/org/jivesoftware/smackx/debugger/android/AndroidDebugger.java index 45b45c5f8..c1a355def 100644 --- a/smack-android/src/main/java/org/jivesoftware/smackx/debugger/android/AndroidDebugger.java +++ b/smack-android/src/main/java/org/jivesoftware/smackx/debugger/android/AndroidDebugger.java @@ -29,7 +29,7 @@ import android.util.Log; *

* 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 printInterpreted static variable to true. + * just change the printInterpreted static variable to true. * */ public class AndroidDebugger extends AbstractDebugger { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java index 8c1c23135..32986efe2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java @@ -286,7 +286,7 @@ public abstract class ConnectionConfiguration { } /** - * Returns the keystore type, or null if it's not set. + * Returns the keystore type, or null 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 false value. + * being 'noticed' then pass a false value. * * @param sendPresence true if an initial available presence will be sent while logging in. * @return a reference to this builder. diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java index f7957cccb..252239371 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java @@ -84,7 +84,7 @@ public final class SmackConfiguration { *
  • Interpreted Packets -- shows XML packets from the server as parsed by Smack. * * Debugging can be enabled by setting this field to true, or by setting the Java system - * property smack.debugEnabled to true. The system property can be set on the + * property smack.debugEnabled to true. The system property can be set on the * command line such as "java SomeApp -Dsmack.debugEnabled=true". */ public static boolean DEBUG = false; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java b/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java index 93c15244e..27f121b40 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java @@ -63,7 +63,7 @@ public final class StanzaCollector implements AutoCloseable { private Exception connectionException; /** - * Creates a new stanza collector. If the stanza filter is null, then + * Creates a new stanza collector. If the stanza filter is null, 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 null if no packets are currently in the + * immediately returns null if no packets are currently in the * result queue. * * @param

    type of the result stanza. - * @return the next stanza result, or null if there are no more + * @return the next stanza result, or null 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 null if no packets are currently in the + * immediately returns null if no packets are currently in the * result queue. *

    * 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 - * timeout 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, null will be returned. + * timeout 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, null will be returned. * * @param

    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 timeout has elapsed. This method does also cancel the + * available or the timeout has elapsed. This method does also cancel the * collector in every case. *

    * Three things can happen when waiting for an response: diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java index cd7c6cf7e..4bad89b20 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java @@ -123,7 +123,7 @@ public interface XMPPConnection { /** * Returns the full XMPP address of the user that is logged in to the connection or - * null if not logged in yet. An XMPP address is in the form + * null 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 null if not connected to the server. + * when opening an XMPP stream. This value will be null if not connected to the server. * - * @return the ID of this connection returned from the XMPP server or null if + * @return the ID of this connection returned from the XMPP server or null if * not connected to the server. * @see RFC 6120 ยง 4.7.3. id */ @@ -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 - * 2*Integer.MAX_VALUE instances as the counter could wrap. + * 2*Integer.MAX_VALUE instances as the counter could wrap. * * @return the connection counter of this XMPPConnection */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/ConsoleDebugger.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/ConsoleDebugger.java index def9b310e..b026f7bb3 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/ConsoleDebugger.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/ConsoleDebugger.java @@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.ExceptionUtil; *

    * 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 printInterpreted static variable to true. + * just change the printInterpreted static variable to true. *

    * * @author Gaston Dombiak diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/JulDebugger.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/JulDebugger.java index 32b275f83..db0772271 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/JulDebugger.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/JulDebugger.java @@ -28,7 +28,7 @@ import org.jivesoftware.smack.XMPPConnection; *

    * 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 printInterpreted static variable to true. + * just change the printInterpreted static variable to true. *

    * * @author Gaston Dombiak diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java index f5498ae29..37d37a49c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java @@ -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: * * * @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 packetType. + * same type as packetType. * * @param packetType the Class type. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java index 914f3c3ab..db0d1da72 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java @@ -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 stanza passes the filter. + * @return true if and only if stanza passes the filter. */ boolean accept(Stanza stanza); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java index a2bfb9f82..2c9e9ca7c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java @@ -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: * * * @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 packetType. + * same type as packetType. * * @param packetType the Class type. */ diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java index e75e7a0e9..d6a0d56a2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java @@ -93,12 +93,12 @@ public class AbstractError { /** * Returns the first stanza extension that matches the specified element name and - * namespace, or null if it doesn't exist. + * namespace, or null 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 type of the ExtensionElement. - * @return the extension, or null if it doesn't exist. + * @return the extension, or null if it doesn't exist. */ public PE getExtension(String elementName, String namespace) { return PacketUtil.extensionElementFrom(extensions, elementName, namespace); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java index dece4f384..4807da0bf 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java @@ -438,9 +438,9 @@ public final class Message extends Stanza implements TypedCloneable { /** * Returns the thread id of the message, which is a unique identifier for a sequence - * of "chat" messages. If no thread id is set, null will be returned. + * of "chat" messages. If no thread id is set, null will be returned. * - * @return the thread id of the message, or null if it doesn't exist. + * @return the thread id of the message, or null if it doesn't exist. */ public String getThread() { return thread; diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java index d4451ae68..9999e9afb 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java @@ -63,11 +63,11 @@ public interface Packet extends TopLevelStreamElement { void setPacketID(String packetID); /** - * Returns who the stanza is being sent "to", or null if + * Returns who the stanza is being sent "to", or null if * the value is not set. The XMPP protocol often makes the "to" * attribute optional, so it does not always need to be set.

    * - * @return who the stanza is being sent to, or null if the + * @return who the stanza is being sent to, or null 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 null if + * Returns who the stanza is being sent "from" or null if * the value is not set. The XMPP protocol often makes the "from" * attribute optional, so it does not always need to be set.

    * - * @return who the stanza is being sent from, or null if the + * @return who the stanza is being sent from, or null 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 null if there are + * Returns the error associated with this packet, or null if there are * no errors. * - * @return the error sub-packet or null if there isn't an error. + * @return the error sub-packet or null 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 null if it doesn't exist. If the provided elementName is null, + * namespace, or null 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 type of the ExtensionElement. - * @return the extension, or null if it doesn't exist. + * @return the extension, or null if it doesn't exist. */ PE getExtension(String elementName, String namespace); /** diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java index 114cef1b1..64a6a90d2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java @@ -138,7 +138,7 @@ public final class Presence extends Stanza implements TypedCloneable { * 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 getType() == Presence.Type.available. Note that even + * equivalent to getType() == Presence.Type.available. 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 { * {@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 - * type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd). + * type == Type.available && (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd). * * @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 { } /** - * Returns the status message of the presence update, or null if there + * Returns the status message of the presence update, or null if there * is not a status. The status is free-form text describing a user's presence * (i.e., "gone to lunch"). * diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java index f40f5ba22..0a0c9b7c8 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java @@ -164,11 +164,11 @@ public abstract class Stanza implements TopLevelStreamElement { } /** - * Returns who the stanza is being sent "to", or null if + * Returns who the stanza is being sent "to", or null if * the value is not set. The XMPP protocol often makes the "to" * attribute optional, so it does not always need to be set.

    * - * @return who the stanza is being sent to, or null if the + * @return who the stanza is being sent to, or null 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 null if + * Returns who the stanza is being sent "from" or null if * the value is not set. The XMPP protocol often makes the "from" * attribute optional, so it does not always need to be set.

    * - * @return who the stanza is being sent from, or null if the + * @return who the stanza is being sent from, or null 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 null if there are + * Returns the error associated with this packet, or null if there are * no errors. * - * @return the error sub-packet or null if there isn't an error. + * @return the error sub-packet or null 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 null if it doesn't exist. If the provided elementName is null, + * namespace, or null 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 type of the ExtensionElement. - * @return the extension, or null if it doesn't exist. + * @return the extension, or null if it doesn't exist. */ @SuppressWarnings("unchecked") public PE getExtension(String elementName, String namespace) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java index f572d876d..40ab16fb5 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java @@ -60,8 +60,8 @@ import org.jivesoftware.smack.xml.XmlPullParserException; * </message> * * I would have a classes - * ItemsProvider extends {@link EmbeddedExtensionProvider} - * ItemProvider extends {@link EmbeddedExtensionProvider} + * ItemsProvider extends {@link EmbeddedExtensionProvider} + * ItemProvider extends {@link EmbeddedExtensionProvider} * and * AtomProvider extends {@link ExtensionElementProvider} * diff --git a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java index d130061d3..d65c86227 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java @@ -94,7 +94,7 @@ public abstract class SASLMechanism implements Comparable { protected SSLSession sslSession; /** - * Builds and sends the auth stanza to the server. Note that this method of + * Builds and sends the auth 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 { } /** - * Builds and sends the auth stanza to the server. The callback handler will handle + * Builds and sends the auth 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. diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersListener.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersListener.java index 537b59187..3170ef69f 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersListener.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersListener.java @@ -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 NULL. + * @param chat associated to the message. This element can be NULL. */ void newChatMarkerMessage(ChatMarkersState chatMarkersState, Message message, Chat chat); } diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/filter/EligibleForChatMarkerFilter.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/filter/EligibleForChatMarkerFilter.java index bc97a5007..edf3f60ef 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/filter/EligibleForChatMarkerFilter.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/filter/EligibleForChatMarkerFilter.java @@ -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.
    * In order to make Chat Markers works together with XEP-0085 as it said in - * 8.5 Interaction with Chat States, only messages with active chat + * 8.5 Interaction with Chat States, only messages with active chat * state are accepted. * * @param message to be analyzed. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java index ec8e8da1c..e222f6c14 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java @@ -58,12 +58,12 @@ public class MultipleRecipientInfo { } /** - * Returns the JID of a MUC room to which responses should be sent or null if + * Returns the JID of a MUC room to which responses should be sent or null 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 null if + * @return the JID of a MUC room to which responses should be sent or null 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 null if + * Returns the address to which all replies are requested to be sent or null 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 null if + * @return the address to which all replies are requested to be sent or null if * no specific address was provided. */ public MultipleAddresses.Address getReplyAddress() { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java index be9c5c70e..30d83b53d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java @@ -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 null if no TO + * @param to the collection of JIDs to include in the TO list or null if no TO * list exists. - * @param cc the collection of JIDs to include in the CC list or null if no CC + * @param cc the collection of JIDs to include in the CC list or null if no CC * list exists. - * @param bcc the collection of JIDs to include in the BCC list or null if no BCC + * @param bcc the collection of JIDs to include in the BCC list or null 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 null if no TO list exists. - * @param cc the collection of JIDs to include in the CC list or null if no CC list exists. - * @param bcc the collection of JIDs to include in the BCC list or null if no BCC list + * @param to the collection of JIDs to include in the TO list or null if no TO list exists. + * @param cc the collection of JIDs to include in the CC list or null if no CC list exists. + * @param bcc the collection of JIDs to include in the BCC list or null if no BCC list * exists. - * @param replyTo address to which all replies are requested to be sent or null + * @param replyTo address to which all replies are requested to be sent or null * indicating that they can reply to any address. - * @param replyRoom JID of a MUC room to which responses should be sent or null + * @param replyRoom JID of a MUC room to which responses should be sent or null * 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 - * null if none was found. Only packets sent to multiple recipients will + * null 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 null + * @return the MultipleRecipientInfo contained in the specified stanza or null * 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 null if none was found. + * @return the address of the multiple recipients service or null if none was found. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException * @throws NotConnectedException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java index fffd03cd5..a323f8543 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java @@ -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 * getForm method retrieves a form with all the users. *

    - * Each command has a node that should be unique within a given JID. + * Each command has a node that should be unique within a given JID. *

    *

    * 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 error or null if the + * Returns the specific condition of the error or null if the * error doesn't have any. * * @param error the error the get the specific condition from. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java index dd05857ae..120da7970 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java @@ -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 node is an unique identifier of that command for - * the connection related to this command manager. The name is the - * human readable name of the command. The class is the class of + * connection. The node is an unique identifier of that command for + * the connection related to this command manager. The name is the + * human readable name of the command. The class 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 node is an unique identifier of that - * command for the connection related to this command manager. The name - * is the human readable name of the command. The factory generates + * connection. The node is an unique identifier of that + * command for the connection related to this command manager. The name + * is the human readable name of the command. The factory generates * new instances of the command. * * @param node the unique identifier of the command. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java index 4a3c49fce..1dd01d3ab 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java @@ -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 true. + * Commands that don't have multiple stages can always return true. * * @return true if the command is in the last stage. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java index 98f61c331..6c5b8423a 100755 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java @@ -121,7 +121,7 @@ public class RemoteCommand extends AdHocCommand { /** * Executes the action with the form. * The action could be any of the available actions. The form must - * be the answer of the previous stage. It can be null if it is the first stage. + * be the answer of the previous stage. It can be null if it is the first stage. * * @param action the action to execute. * @param form the form with the information. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java index 71db396b6..57a59ebbb 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java @@ -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 null if this information is not available. + * delivery of the stanza or null 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 null if + * Returns a natural-language description of the reason for the delay or null if * this information is not available. * - * @return a natural-language description of the reason for the delay or null. + * @return a natural-language description of the reason for the delay or null. */ public String getReason() { return reason; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java index 38b965577..407a1811f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java @@ -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 null if none.

    + * (ie items) related to a given node or null if none.

    * * 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. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java index c149e0b14..af955915b 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java @@ -194,11 +194,11 @@ public final class AccountManager extends Manager { } /** - * Returns the value of a given account attribute or null if the account + * Returns the value of a given account attribute or null 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 null if an account + * @return the value of the account attribute or null 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 null if there + * Returns the instructions for creating a new account, or null 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 null if there are none. + * @return the account creation instructions, or null if there are none. * @throws XMPPErrorException * @throws NoResponseException * @throws NotConnectedException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java index 039658016..e8b9795e4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java @@ -68,11 +68,11 @@ public class Registration extends IQ { } /** - * Returns the registration instructions, or null if no instructions + * Returns the registration instructions, or null 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 null if there are none. + * @return the registration instructions, or null if there are none. */ public String getInstructions() { return instructions; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java index 424e71762..8074f052d 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java @@ -70,7 +70,7 @@ public class JivePropertiesManager { * * @param packet * @param name - * @return the property or null if none found. + * @return the property or null if none found. */ public static Object getProperty(Stanza packet, String name) { Object res = null; diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java index fb6b11df8..5a9061c4f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java @@ -60,13 +60,13 @@ public class JivePropertiesExtension implements ExtensionElement { } /** - * Returns the stanza property with the specified name or null if the + * Returns the stanza property with the specified name or null 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 null if the property doesn't exist. + * @return the property, or null if the property doesn't exist. */ public synchronized Object getProperty(String name) { if (properties == null) { diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java index f593a2e90..15f0b20ff 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java @@ -781,12 +781,12 @@ public class MultiUserChat { } /** - * Returns the room's configuration form that the room's owner can use or null if + * Returns the room's configuration form that the room's owner can use or null 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 - * null if no configuration is possible. + * null 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 null if no registration is possible. Some rooms may restrict the + * of the room or null if no registration is possible. Some rooms may restrict the * privilege to register members and allow only room admins to add new members.

    * * 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 null if no registration is possible. + * instrucions or null 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 null if the user hasn't joined the room + * Returns the last known room's subject or null 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.

    * @@ -1052,7 +1052,7 @@ public class MultiUserChat { * * To change the room's subject use {@link #changeSubject(String)}. * - * @return the room's subject or null if the user hasn't joined the room or the + * @return the room's subject or null 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 null if none. + * @return the reserved room nickname or null 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 null if not + * Returns the nickname that was used to join the room, or null 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 null if the user + * Returns the presence info for a particular user, or null if the user * is not in the room.

    * * @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 null if the user is unavailable + * @return the occupant's current presence, or null 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 null if the + * Returns the Occupant information for a particular occupant, or null 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.

    * * @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 null if the user is unavailable (i.e. not in the room). + * @return the Occupant or null 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 null if there isn't + * Polls for and returns the next message, or null 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 - * null otherwise. + * null 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 timeout has elapased. - * If the timeout elapses without a result, null will be returned. + * (not return) until a stanza is available or the timeout has elapased. + * If the timeout elapses without a result, null will be returned. * * @param timeout the maximum amount of time to wait for the next message. - * @return the next message, or null if the timeout elapses without a + * @return the next message, or null if the timeout elapses without a * message becoming available. * @throws MucNotJoinedException * @throws InterruptedException diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java index 6d870ba17..d00f71586 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java @@ -41,7 +41,7 @@ import org.jivesoftware.smack.xml.XmlPullParserException; * * * To listen for group chat invitations, use a StanzaExtensionFilter for the - * x element name and jabber:x:conference namespace, as in the + * x element name and jabber:x:conference namespace, as in the * following code example: * *

    @@ -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 room@service,
    -     * where service is the name of group chat server, such as
    -     * chat.example.com.
    +     * GroupChat room addresses are in the form room@service,
    +     * where service is the name of group chat server, such as
    +     * chat.example.com.
          *
          * @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 room@service, where service is
    -     * the name of group chat server, such as chat.example.com.
    +     * are in the form room@service, where service is
    +     * the name of group chat server, such as chat.example.com.
          *
          * @return the address of the group chat room.
          */
    diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java
    index 8b579bb11..f1bbb7d7e 100644
    --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java
    +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java
    @@ -110,11 +110,11 @@ public class OfflineMessageManager {
         }
     
         /**
    -     * Returns a List of OfflineMessageHeader that keep information about the
    +     * Returns a List of OfflineMessageHeader 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 OfflineMessageHeader that keep information about the offline
    +     * @return a List of OfflineMessageHeader 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 Messages whose stamp matches the specified
    +     * Returns a List of the offline Messages 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 Messages that were received as part of
    +     * @return a List with the offline Messages 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 Messages of the user. The returned offline
    +     * Returns a List of Messages with all the offline Messages 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 Messages of the user.
    +     * @return a List with all the offline Messages 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.
    diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java
    index d25baec53..97e9b6673 100644
    --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java
    +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java
    @@ -107,9 +107,9 @@ public class Privacy extends IQ {
         }
     
         /**
    -     * Returns the active privacy list or null if none was found.
    +     * Returns the active privacy list or null if none was found.
          *
    -     * @return list with {@link PrivacyItem} or null if none was found.
    +     * @return list with {@link PrivacyItem} or null if none was found.
          */
         public List getActivePrivacyList() {
             // Check if we have the default list
    @@ -123,9 +123,9 @@ public class Privacy extends IQ {
         }
     
         /**
    -     * Returns the default privacy list or null if none was found.
    +     * Returns the default privacy list or null if none was found.
          *
    -     * @return list with {@link PrivacyItem} or null if none was found.
    +     * @return list with {@link PrivacyItem} or null if none was found.
          */
         public List getDefaultPrivacyList() {
             // Check if we have the default list
    diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java
    index 792fdd299..a9609106a 100644
    --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java
    +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java
    @@ -31,8 +31,8 @@ import org.jivesoftware.smackx.privacy.packet.PrivacyItem;
     
     /**
      * The PrivacyProvider parses {@link Privacy} packets. {@link Privacy}
    - * Parses the query sub-document and creates an instance of {@link Privacy}.
    - * For each item in the list element, it creates an instance
    + * Parses the query sub-document and creates an instance of {@link Privacy}.
    + * For each item in the list element, it creates an instance
      * of {@link PrivacyItem}.
      *
      * @author Francisco Vives
    diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java
    index ec1f5ca02..04f277339 100644
    --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java
    +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java
    @@ -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 Item has several properties that are dependent
    + * PubSub node.  An Item has several properties that are dependent
      * on the configuration of the node to which it has been or will be published.
      *
      * 

    An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}

    @@ -74,10 +74,10 @@ public class Item extends NodeExtension { private final String itemId; /** - * Create an empty Item with no id. This is a valid item for nodes which are configured + * Create an empty Item 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 Item is sent to the node, you have to use the {@link LeafNode#publish()} + * set to false, no Item 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 Item with an id but no payload. This is a valid item for nodes which are configured + * Create an Item 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 Item with an id but no payload. This is a valid item for nodes which are configured + * Create an Item 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 Item with an id and a node id. + * Create an Item with an id and a node id. *

    * Note: 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 Item with an id and a node id. + * Create an Item with an id and a node id. *

    * Note: 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 diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java index ada69c2bd..bb521c95a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java @@ -28,7 +28,7 @@ public class ItemDeleteEvent extends SubscriptionEvent { private List itemIds = Collections.emptyList(); /** - * Constructs an ItemDeleteEvent that indicates the the supplied + * Constructs an ItemDeleteEvent 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)}. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java index a61e36324..da845a337 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java @@ -30,7 +30,7 @@ public class ItemPublishEvent extends SubscriptionEvent { private Date originalDate; /** - * Constructs an ItemPublishEvent with the provided list + * Constructs an ItemPublishEvent 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 extends SubscriptionEvent { } /** - * Constructs an ItemPublishEvent with the provided list + * Constructs an ItemPublishEvent 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 extends SubscriptionEvent { } /** - * Constructs an ItemPublishEvent with the provided list + * Constructs an ItemPublishEvent 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 diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java index 5cda91fa4..cc8fac480 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java @@ -33,7 +33,7 @@ public class NodeExtension implements ExtensionElement { private final String node; /** - * Constructs a NodeExtension with an element name specified + * Constructs a NodeExtension 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 NodeExtension with an element name specified + * Constructs a NodeExtension with an element name specified * by {@link PubSubElementType}. * * @param elem Defines the element name and namespace diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java index 59fe54acc..ca843a805 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java @@ -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 Item has several properties that are dependent + * pubsub node. An Item has several properties that are dependent * on the configuration of the node to which it has been or will be published. * *

    An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}

    @@ -53,7 +53,7 @@ public class PayloadItem extends Item { private final E payload; /** - * Create an Item with no id and a payload The id will be set by the server. + * Create an Item 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 extends Item { } /** - * Create an Item with an id and payload. + * Create an Item 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 extends Item { } /** - * Create an Item with an id, node id and payload. + * Create an Item with an id, node id and payload. * *

    * Note: This is not valid for publishing an item to a node, only receiving from @@ -98,7 +98,7 @@ public class PayloadItem extends Item { } /** - * Create an Item with an id, node id and payload. + * Create an Item with an id, node id and payload. * *

    * Note: This is not valid for publishing an item to a node, only receiving from @@ -120,7 +120,7 @@ public class PayloadItem extends Item { } /** - * Get the payload associated with this Item. Customising the payload + * Get the payload associated with this Item. Customising the payload * parsing from the server can be accomplished as described in {@link ItemProvider}. * * @return The payload as a {@link ExtensionElement}. diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java index 3bb4acfd4..6e8b39d26 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java @@ -29,7 +29,7 @@ public class RetractItem implements ExtensionElement { private final String id; /** - * Construct a RetractItem with the specified id. + * Construct a RetractItem with the specified id. * * @param itemId The id if the item deleted */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java index 4d1089ed5..20f535d0f 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java @@ -38,7 +38,7 @@ public class SimplePayload implements ExtensionElement { private final String payload; /** - * Construct a SimplePayload object with the specified element name, + * Construct a SimplePayload 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 SimplePayload object with the specified element name, + * Construct a SimplePayload 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) diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java index a2b98960a..98189c312 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java @@ -61,7 +61,7 @@ public class Time extends IQ { } /** - * Returns the local time or null if the time hasn't been set. + * Returns the local time or null if the time hasn't been set. * * @return the local time. */ diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java index 14be9d63c..9e5bb999a 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java @@ -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 null if there was not + * @return the data form parsed from the stanza or null if there was not * a form in the packet. */ public static Form getFormFrom(Stanza packet) { diff --git a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java index 8982b948e..41bbddb6c 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java @@ -65,7 +65,7 @@ public class Chat { /** * Returns the thread id associated with this chat, which corresponds to the - * thread field of XMPP messages. This method may return null + * thread field of XMPP messages. This method may return null * if there is no thread ID is associated with this Chat. * * @return the thread ID of this chat. diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java index 1a861c780..262105ae6 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java @@ -637,7 +637,7 @@ public final class Roster extends Manager { * * @param user the user. (e.g. johndoe@jabber.org) * @param name the nickname of the user. - * @param groups the list of group names the entry will belong to, or null if the + * @param groups the list of group names the entry will belong to, or null if the * the roster entry won't belong to a group. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException if an XMPP exception occurs. @@ -662,7 +662,7 @@ public final class Roster extends Manager { * * @param jid the XMPP address of the contact (e.g. johndoe@jabber.org) * @param name the nickname of the user. - * @param groups the list of group names the entry will belong to, or null if the the roster entry won't + * @param groups the list of group names the entry will belong to, or null if the the roster entry won't * belong to a group. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException if an XMPP exception occurs. @@ -695,7 +695,7 @@ public final class Roster extends Manager { * * @param jid the XMPP address of the contact (e.g. johndoe@jabber.org) * @param name the nickname of the user. - * @param groups the list of group names the entry will belong to, or null if the + * @param groups the list of group names the entry will belong to, or null if the * the roster entry won't belong to a group. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException if an XMPP exception occurs. @@ -716,7 +716,7 @@ public final class Roster extends Manager { * * @param user the user. (e.g. johndoe@jabber.org) * @param name the nickname of the user. - * @param groups the list of group names the entry will belong to, or null if the + * @param groups the list of group names the entry will belong to, or null if the * the roster entry won't belong to a group. * @throws NoResponseException if there was no response from the server. * @throws XMPPErrorException if an XMPP exception occurs. @@ -913,11 +913,11 @@ public final class Roster extends Manager { /** * Returns the roster entry associated with the given XMPP address or - * null if the user is not an entry in the roster. + * null if the user is not an entry in the roster. * * @param jid the XMPP address of the user (eg "jsmith@example.com"). The address could be * in any valid format (e.g. "domain/resource", "user@domain" or "user@domain/resource"). - * @return the roster entry or null if it does not exist. + * @return the roster entry or null if it does not exist. */ public RosterEntry getEntry(BareJid jid) { if (jid == null) { @@ -939,7 +939,7 @@ public final class Roster extends Manager { } /** - * Returns the roster group with the specified name, or null if the + * Returns the roster group with the specified name, or null if the * group doesn't exist. * * @param name the name of the group. diff --git a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java index c23343487..f245289fe 100644 --- a/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java +++ b/smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java @@ -114,10 +114,10 @@ public class RosterGroup extends Manager { /** * Returns the roster entry associated with the given XMPP address or - * null if the user is not an entry in the group. + * null if the user is not an entry in the group. * * @param user the XMPP address of the user (eg "jsmith@example.com"). - * @return the roster entry or null if it does not exist in the group. + * @return the roster entry or null if it does not exist in the group. */ public RosterEntry getEntry(Jid user) { if (user == null) { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRoster.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRoster.java index b6082bf40..4b98e1a7c 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRoster.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRoster.java @@ -201,12 +201,12 @@ public class AgentRoster { } /** - * Returns the presence info for a particular agent, or null if the agent + * Returns the presence info for a particular agent, or null if the agent * is unavailable (offline) or if no presence information is available.

    * * @param user a fully qualified xmpp JID. The address could be in any valid format (e.g. * "domain/resource", "user@domain" or "user@domain/resource"). - * @return the agent's current presence, or null if the agent is unavailable + * @return the agent's current presence, or null if the agent is unavailable * or if no presence information is available.. */ public Presence getPresence(Jid user) { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java index be441bc4f..9bf7926f5 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java @@ -119,7 +119,7 @@ public class AgentSession { /** * Constructs a new agent session instance. Note, the {@link #setOnline(boolean)} - * method must be called with an argument of true to mark the agent + * method must be called with an argument of true to mark the agent * as available to accept chat requests. * * @param connection a connection instance which must have already gone through @@ -307,7 +307,7 @@ public class AgentSession { * Allows the retrieval of meta data for a specified key. * * @param key the meta data key - * @return the meta data value associated with the key or null if the meta-data + * @return the meta data value associated with the key or null if the meta-data * doesn't exist.. */ public List getMetaData(String key) { diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/WorkgroupQueue.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/WorkgroupQueue.java index 0a352025b..4cc0b6c4c 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/WorkgroupQueue.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/WorkgroupQueue.java @@ -122,7 +122,7 @@ public class WorkgroupQueue { /** * Returns the date of the oldest request waiting in the queue. If there - * are no requests waiting to be routed, this method will return null. + * are no requests waiting to be routed, this method will return null. * * @return the date of the oldest request in the queue. */ diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OfferRequestProvider.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OfferRequestProvider.java index 7167dedae..c975db452 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OfferRequestProvider.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OfferRequestProvider.java @@ -159,7 +159,7 @@ public class OfferRequestProvider extends IQProvider { /** * Returns the session ID associated with the request and ensuing chat. If the offer - * does not contain a session ID, null will be returned. + * does not contain a session ID, null will be returned. * * @return the session id associated with the request. */ diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java index f360fd972..e4143370d 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java @@ -334,7 +334,7 @@ public class Workgroup { * * @param answerForm the completed form associated with the join request. * @param userID String that represents the ID of the user when using anonymous sessions - * or null if a userID should not be used. + * or null if a userID should not be used. * @throws XMPPErrorException if an error occurred joining the queue. An error may indicate * that a connection failure occurred or that the server explicitly rejected the * request to join the queue. @@ -383,7 +383,7 @@ public class Workgroup { * * @param metadata metadata to create a dataform from. * @param userID String that represents the ID of the user when using anonymous sessions - * or null if a userID should not be used. + * or null if a userID should not be used. * @throws XMPPException if an error occurred joining the queue. An error may indicate * that a connection failure occurred or that the server explicitly rejected the * request to join the queue. diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java index 121f0cf54..2dfc66a7a 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java @@ -103,7 +103,7 @@ public final class MessageEventManager extends Manager { /** * Adds event notification requests to a message. For each event type that - * the user wishes event notifications from the message recipient for, true + * the user wishes event notifications from the message recipient for, true * should be passed in to this method. * * @param message the message to add the requested notifications. diff --git a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/RemoteRosterEntry.java b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/RemoteRosterEntry.java index 2f8f1aff4..94d702847 100644 --- a/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/RemoteRosterEntry.java +++ b/smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/RemoteRosterEntry.java @@ -45,7 +45,7 @@ public class RemoteRosterEntry { * * @param user the user. * @param name the user's name. - * @param groups the list of group names the entry will belong to, or null if the + * @param groups the list of group names the entry will belong to, or null if the * the roster entry won't belong to a group. */ public RemoteRosterEntry(Jid user, String name, String[] groups) { diff --git a/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/element/OpenPgpContentElement.java b/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/element/OpenPgpContentElement.java index 47c2295b6..8ac666259 100644 --- a/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/element/OpenPgpContentElement.java +++ b/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/element/OpenPgpContentElement.java @@ -122,14 +122,14 @@ public abstract class OpenPgpContentElement implements ExtensionElement { /** * Returns the first extension that matches the specified element name and - * namespace, or null if it doesn't exist. If the provided elementName is null, + * namespace, or null 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 type of the ExtensionElement. - * @return the extension, or null if it doesn't exist. + * @return the extension, or null if it doesn't exist. */ @SuppressWarnings("unchecked") public PE getExtension(String elementName, String namespace) { diff --git a/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/store/abstr/AbstractOpenPgpStore.java b/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/store/abstr/AbstractOpenPgpStore.java index 61f91cb7c..83c46ebdf 100644 --- a/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/store/abstr/AbstractOpenPgpStore.java +++ b/smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/store/abstr/AbstractOpenPgpStore.java @@ -23,7 +23,6 @@ import java.security.NoSuchProviderException; import java.util.Date; import java.util.HashMap; import java.util.Map; -import java.util.Observable; import org.jivesoftware.smack.util.Objects; @@ -46,7 +45,7 @@ import org.pgpainless.key.collection.PGPKeyRing; import org.pgpainless.key.protection.SecretKeyRingProtector; import org.pgpainless.key.protection.UnprotectedKeysProtector; -public abstract class AbstractOpenPgpStore extends Observable implements OpenPgpStore { +public abstract class AbstractOpenPgpStore implements OpenPgpStore { protected final OpenPgpKeyStore keyStore; protected final OpenPgpMetadataStore metadataStore; diff --git a/smack-xmlparser/src/main/java/org/jivesoftware/smack/xml/XmlPullParser.java b/smack-xmlparser/src/main/java/org/jivesoftware/smack/xml/XmlPullParser.java index cfc208751..ebb8f07e9 100644 --- a/smack-xmlparser/src/main/java/org/jivesoftware/smack/xml/XmlPullParser.java +++ b/smack-xmlparser/src/main/java/org/jivesoftware/smack/xml/XmlPullParser.java @@ -41,7 +41,8 @@ import javax.xml.namespace.QName; *

    * The following table shows the mapping of Smack's XmlPullParser events to StAX and XPP3 events: *

    - * + *
    + * * * *
    XmlPullParser event mapping
    Smack's {@link XmlPullParser.Event}StAX EventXPP3 Event
    {@link XmlPullParser.Event#START_DOCUMENT}START_DOCUMENT (7)START_DOCUMENT (0)
    {@link XmlPullParser.Event#END_DOCUMENT}END_DOCUMENT (8)END_DOCUMENT (1)