Enable javadoc checkstyle

and fix violations.
filetransferTypos
Florian Schmaus 8 years ago
parent 57260b2a44
commit 64d134052d
  1. 15
      config/checkstyle.xml
  2. 2
      smack-android/src/main/java/org/jivesoftware/smack/util/stringencoder/android/AndroidBase64Encoder.java
  3. 4
      smack-android/src/main/java/org/jivesoftware/smack/util/stringencoder/android/AndroidBase64UrlSafeEncoder.java
  4. 3
      smack-core/src/main/java/org/jivesoftware/smack/AbstractConnectionClosedListener.java
  5. 4
      smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java
  6. 2
      smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
  7. 3
      smack-core/src/main/java/org/jivesoftware/smack/MessageListener.java
  8. 1
      smack-core/src/main/java/org/jivesoftware/smack/PacketListener.java
  9. 3
      smack-core/src/main/java/org/jivesoftware/smack/PresenceListener.java
  10. 14
      smack-core/src/main/java/org/jivesoftware/smack/ReconnectionManager.java
  11. 2
      smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
  12. 6
      smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java
  13. 4
      smack-core/src/main/java/org/jivesoftware/smack/debugger/ReflectionDebuggerFactory.java
  14. 3
      smack-core/src/main/java/org/jivesoftware/smack/filter/AbstractListFilter.java
  15. 3
      smack-core/src/main/java/org/jivesoftware/smack/filter/IQResultReplyFilter.java
  16. 2
      smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithBodiesFilter.java
  17. 2
      smack-core/src/main/java/org/jivesoftware/smack/filter/MessageWithSubjectFilter.java
  18. 4
      smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java
  19. 2
      smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java
  20. 4
      smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java
  21. 2
      smack-core/src/main/java/org/jivesoftware/smack/packet/StreamError.java
  22. 14
      smack-core/src/main/java/org/jivesoftware/smack/packet/StreamOpen.java
  23. 4
      smack-core/src/main/java/org/jivesoftware/smack/parsing/UnparsablePacket.java
  24. 3
      smack-core/src/main/java/org/jivesoftware/smack/provider/StreamFeatureProviderInfo.java
  25. 2
      smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks4ProxySocketFactory.java
  26. 2
      smack-core/src/main/java/org/jivesoftware/smack/proxy/Socks5ProxySocketFactory.java
  27. 2
      smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLAnonymous.java
  28. 5
      smack-core/src/main/java/org/jivesoftware/smack/sasl/packet/SaslStreamElements.java
  29. 2
      smack-core/src/main/java/org/jivesoftware/smack/util/FileUtils.java
  30. 6
      smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java
  31. 4
      smack-core/src/main/java/org/jivesoftware/smack/util/PacketUtil.java
  32. 4
      smack-core/src/main/java/org/jivesoftware/smack/util/StringUtils.java
  33. 8
      smack-core/src/main/java/org/jivesoftware/smack/util/XmlStringBuilder.java
  34. 4
      smack-core/src/main/java/org/jivesoftware/smack/util/dns/SRVRecord.java
  35. 6
      smack-core/src/main/java/org/jivesoftware/smack/util/stringencoder/StringEncoder.java
  36. 2
      smack-core/src/test/java/org/jivesoftware/smack/ThreadedDummyConnection.java
  37. 3
      smack-core/src/test/java/org/jivesoftware/smack/filters/FilterToStringTest.java
  38. 2
      smack-core/src/test/java/org/jivesoftware/smack/filters/FromMatchesFilterTest.java
  39. 3
      smack-core/src/test/java/org/jivesoftware/smack/packet/MessageTest.java
  40. 3
      smack-core/src/test/java/org/jivesoftware/smack/packet/PresenceTest.java
  41. 3
      smack-core/src/test/java/org/jivesoftware/smack/util/PacketParserUtilsTest.java
  42. 2
      smack-debug-slf4j/src/main/java/org/jivesoftware/smackx/debugger/slf4j/SLF4JDebuggerFactory.java
  43. 4
      smack-debug-slf4j/src/main/java/org/jivesoftware/smackx/debugger/slf4j/SLF4JSmackDebugger.java
  44. 2
      smack-experimental/src/main/java/org/jivesoftware/smackx/carbons/packet/Carbon.java
  45. 3
      smack-experimental/src/main/java/org/jivesoftware/smackx/csi/ClientStateIndicationManager.java
  46. 2
      smack-experimental/src/main/java/org/jivesoftware/smackx/csi/packet/ClientStateIndication.java
  47. 2
      smack-experimental/src/main/java/org/jivesoftware/smackx/hoxt/packet/AbstractHttpOverXmpp.java
  48. 2
      smack-experimental/src/main/java/org/jivesoftware/smackx/json/packet/JsonPacketExtension.java
  49. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java
  50. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java
  51. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java
  52. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java
  53. 10
      smack-extensions/src/main/java/org/jivesoftware/smackx/amp/packet/AMPExtension.java
  54. 5
      smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java
  55. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java
  56. 1
      smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java
  57. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/packet/DataPacketExtension.java
  58. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/packet/Bytestream.java
  59. 12
      smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java
  60. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java
  61. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/caps/packet/CapsExtension.java
  62. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java
  63. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/delay/DelayInformationManager.java
  64. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
  65. 3
      smack-extensions/src/main/java/org/jivesoftware/smackx/disco/AbstractNodeInformationProvider.java
  66. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
  67. 8
      smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java
  68. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransfer.java
  69. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java
  70. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java
  71. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java
  72. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/packet/Version.java
  73. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCAffiliation.java
  74. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MUCRole.java
  75. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
  76. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/nick/packet/Nick.java
  77. 7
      smack-extensions/src/main/java/org/jivesoftware/smackx/pep/provider/PEPProvider.java
  78. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
  79. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java
  80. 12
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/AccessModel.java
  81. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ChildrenAssociationPolicy.java
  82. 10
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java
  83. 48
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureNodeFields.java
  84. 12
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/EventElementType.java
  85. 8
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/FormNodeType.java
  86. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemReply.java
  87. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java
  88. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java
  89. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java
  90. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeType.java
  91. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java
  92. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PublishModel.java
  93. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java
  94. 11
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeOptionFields.java
  95. 6
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Subscription.java
  96. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscriptionsExtension.java
  97. 4
      smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
  98. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/search/ReportedData.java
  99. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java
  100. 2
      smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/Header.java
  101. Some files were not shown because too many files have changed in this diff Show More

@ -75,5 +75,20 @@
<property name="message" value="Usage of println"/>
<property name="ignoreComments" value="true"/>
</module>
<module name="JavadocMethod">
<!-- TODO stricten those checks -->
<property name="scope" value="public"/>
<property name="allowUndeclaredRTE" value="true"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowMissingJavadoc" value="true"/>
<property name="suppressLoadErrors" value="true"/>
</module>
<module name="JavadocStyle">
<property name="scope" value="public"/>
<property name="checkEmptyJavadoc" value="true"/>
<property name="checkHtml" value="false"/>
</module>
</module>
</module>

@ -19,7 +19,7 @@ package org.jivesoftware.smack.util.stringencoder.android;
import android.util.Base64;
/**
* A Base 64 encoding implementation based on android.util.Base64
* A Base 64 encoding implementation based on android.util.Base64.
* @author Florian Schmaus
*/
public class AndroidBase64Encoder implements org.jivesoftware.smack.util.stringencoder.Base64.Encoder {

@ -23,10 +23,6 @@ import org.jivesoftware.smack.util.stringencoder.StringEncoder;
import android.util.Base64;
/**
*
*/
public class AndroidBase64UrlSafeEncoder implements StringEncoder {
private static AndroidBase64UrlSafeEncoder instance = new AndroidBase64UrlSafeEncoder();

@ -16,9 +16,6 @@
*/
package org.jivesoftware.smack;
/**
*
*/
public abstract class AbstractConnectionClosedListener extends AbstractConnectionListener {
@Override

@ -47,7 +47,6 @@ import org.jivesoftware.smack.SmackException.AlreadyConnectedException;
import org.jivesoftware.smack.SmackException.AlreadyLoggedInException;
import org.jivesoftware.smack.SmackException.NoResponseException;
import org.jivesoftware.smack.SmackException.NotConnectedException;
import org.jivesoftware.smack.SmackException.ConnectionException;
import org.jivesoftware.smack.SmackException.ResourceBindingNotOfferedException;
import org.jivesoftware.smack.SmackException.SecurityRequiredException;
import org.jivesoftware.smack.XMPPException.StreamErrorException;
@ -342,7 +341,6 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* @throws XMPPException if an error occurs on the XMPP protocol level.
* @throws SmackException if an error occurs somewhere else besides XMPP protocol level.
* @throws IOException
* @throws ConnectionException with detailed information about the failed connection.
* @return a reference to this object, to chain <code>connect()</code> with <code>login()</code>.
* @throws InterruptedException
*/
@ -1554,7 +1552,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
/**
* Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a
* stanza
* stanza.
*
* @param callback the callback to install
*/

@ -497,7 +497,7 @@ public abstract class ConnectionConfiguration {
/**
* Sets the PKCS11 library file location, needed when the
* Keystore type is PKCS11
* Keystore type is PKCS11.
*
* @param pkcs11Library the path to the PKCS11 library file.
* @return a reference to this builder.

@ -19,9 +19,6 @@ package org.jivesoftware.smack;
import org.jivesoftware.smack.packet.Message;
/**
*
*/
public interface MessageListener {
void processMessage(Message message);
}

@ -18,6 +18,7 @@
package org.jivesoftware.smack;
/**
* This interface is deprecated.
* @deprecated use {@link StanzaListener} instead
*/
@Deprecated

@ -19,9 +19,6 @@ package org.jivesoftware.smack;
import org.jivesoftware.smack.packet.Presence;
/**
*
*/
public interface PresenceListener {
void processPresence(Presence presence);
}

@ -121,7 +121,7 @@ public class ReconnectionManager {
}
/**
* Set the default Reconnection Policy to use
* Set the default Reconnection Policy to use.
*
* @param reconnectionPolicy
*/
@ -131,7 +131,7 @@ public class ReconnectionManager {
/**
* Set the fixed delay in seconds between the reconnection attempts Also set the connection
* policy to {@link ReconnectionPolicy#FIXED_DELAY}
* policy to {@link ReconnectionPolicy#FIXED_DELAY}.
*
* @param fixedDelay Delay expressed in seconds
*/
@ -141,7 +141,7 @@ public class ReconnectionManager {
}
/**
* Set the Reconnection Policy to use
* Set the Reconnection Policy to use.
*
* @param reconnectionPolicy
*/
@ -150,7 +150,7 @@ public class ReconnectionManager {
}
/**
* Flag that indicates if a reconnection should be attempted when abruptly disconnected
* Flag that indicates if a reconnection should be attempted when abruptly disconnected.
*/
private boolean automaticReconnectEnabled = false;
@ -357,17 +357,17 @@ public class ReconnectionManager {
/**
* Reconnection Policy, where {@link ReconnectionPolicy#RANDOM_INCREASING_DELAY} is the default policy used by smack and {@link ReconnectionPolicy#FIXED_DELAY} implies
* a fixed amount of time between reconnection attempts
* a fixed amount of time between reconnection attempts.
*/
public enum ReconnectionPolicy {
/**
* Default policy classically used by smack, having an increasing delay related to the
* overall number of attempts
* overall number of attempts.
*/
RANDOM_INCREASING_DELAY,
/**
* Policy using fixed amount of time between reconnection attempts
* Policy using fixed amount of time between reconnection attempts.
*/
FIXED_DELAY,
;

@ -65,7 +65,7 @@ public class SASLAuthentication {
private static final Set<String> BLACKLISTED_MECHANISMS = new HashSet<String>();
/**
* Registers a new SASL mechanism
* Registers a new SASL mechanism.
*
* @param mechanism a SASLMechanism subclass.
*/

@ -175,6 +175,8 @@ public final class SmackConfiguration {
}
/**
* Get the debugger factory.
*
* @return a debugger factory or <code>null</code>
*/
public static SmackDebuggerFactory getDebuggerFactory() {
@ -230,7 +232,7 @@ public final class SmackConfiguration {
}
/**
* Set the default parsing exception callback for all newly created connections
* Set the default parsing exception callback for all newly created connections.
*
* @param callback
* @see ParsingExceptionCallback
@ -240,7 +242,7 @@ public final class SmackConfiguration {
}
/**
* Returns the default parsing exception callback
* Returns the default parsing exception callback.
*
* @return the default parsing exception callback
* @see ParsingExceptionCallback

@ -44,7 +44,7 @@ public class ReflectionDebuggerFactory implements SmackDebuggerFactory {
};
/**
* Sets custom debugger class to be created by this factory
* Sets custom debugger class to be created by this factory.
* @param debuggerClass class to be used by this factory
*/
public static void setDebuggerClass(Class<? extends SmackDebugger> debuggerClass) {
@ -56,7 +56,7 @@ public class ReflectionDebuggerFactory implements SmackDebuggerFactory {
}
/**
* Returns debugger class used by this factory
* Returns debugger class used by this factory.
* @return debugger class that will be used for instantiation by this factory
*/
@SuppressWarnings("unchecked")

@ -24,9 +24,6 @@ import java.util.List;
import org.jivesoftware.smack.util.Objects;
/**
*
*/
public abstract class AbstractListFilter implements StanzaFilter {
/**

@ -20,9 +20,6 @@ import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smack.packet.IQ;
import org.jivesoftware.smack.packet.Stanza;
/**
*
*/
public class IQResultReplyFilter extends IQReplyFilter {

@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter;
import org.jivesoftware.smack.packet.Message;
/**
* Filters message stanzas which have at least one body
* Filters message stanzas which have at least one body.
*/
public class MessageWithBodiesFilter extends FlexibleStanzaTypeFilter<Message> {

@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter;
import org.jivesoftware.smack.packet.Message;
/**
* Filters message stanzas which have at least one body
* Filters message stanzas which have at least one body.
*/
public class MessageWithSubjectFilter extends FlexibleStanzaTypeFilter<Message> {

@ -39,7 +39,7 @@ public interface Packet extends TopLevelStreamElement {
public String getStanzaId();
/**
*
* Get the stanza id.
* @return the stanza id.
* @deprecated use {@link #getStanzaId()} instead.
*/
@ -55,7 +55,7 @@ public interface Packet extends TopLevelStreamElement {
public void setStanzaId(String id);
/**
*
* Set the stanza ID.
* @param packetID
* @deprecated use {@link #setStanzaId(String)} instead.
*/

@ -304,7 +304,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
error,
/**
* A presence probe as defined in section 4.3 of RFC 6121
* A presence probe as defined in section 4.3 of RFC 6121.
*/
probe,
;

@ -105,7 +105,7 @@ public abstract class Stanza implements TopLevelStreamElement {
}
/**
*
* Get the Stanza ID.
* @return the stanza id.
* @deprecated use {@link #getStanzaId()} instead.
*/
@ -128,7 +128,7 @@ public abstract class Stanza implements TopLevelStreamElement {
}
/**
*
* Set the stanza ID.
* @param packetID
* @deprecated use {@link #setStanzaId(String)} instead.
*/

@ -149,7 +149,7 @@ public class StreamError extends AbstractError implements PlainStreamElement {
}
/**
* The defined stream error conditions, see RFC 6120 § 4.9.3
* The defined stream error conditions, see RFC 6120 § 4.9.3.
*
*/
public enum Condition {

@ -21,7 +21,7 @@ import org.jivesoftware.smack.util.StringUtils;
import org.jivesoftware.smack.util.XmlStringBuilder;
/**
*
* The stream open <b>tag</b>.
*/
public class StreamOpen extends FullStreamElement {
@ -31,32 +31,32 @@ public class StreamOpen extends FullStreamElement {
public static final String SERVER_NAMESPACE = "jabber:server";
/**
* RFC 6120 § 4.7.5
* RFC 6120 § 4.7.5.
*/
public static final String VERSION = "1.0";
/**
* RFC 6120 § 4.7.1
* RFC 6120 § 4.7.1.
*/
private final String from;
/**
* RFC 6120 § 4.7.2
* RFC 6120 § 4.7.2.
*/
private final String to;
/**
* RFC 6120 § 4.7.3
* RFC 6120 § 4.7.3.
*/
private final String id;
/**
* RFC 6120 § 4.7.4
* RFC 6120 § 4.7.4.
*/
private final String lang;
/**
* RFC 6120 § 4.8.2
* RFC 6120 § 4.8.2.
*/
private final String contentNamespace;

@ -34,7 +34,7 @@ public class UnparsablePacket {
}
/**
*
* Get the exception that caused the parser to fail.
* @return the exception that caused the parser to fail
*/
public Exception getParsingException() {
@ -42,7 +42,7 @@ public class UnparsablePacket {
}
/**
* Retrieve the raw stanza data
* Retrieve the raw stanza data.
*
* @return the raw stanza data
*/

@ -18,9 +18,6 @@ package org.jivesoftware.smack.provider;
import org.jivesoftware.smack.packet.ExtensionElement;
/**
*
*/
public final class StreamFeatureProviderInfo extends AbstractProviderInfo {
/**

@ -26,7 +26,7 @@ import java.net.UnknownHostException;
import javax.net.SocketFactory;
/**
* Socket factory for socks4 proxy
* Socket factory for socks4 proxy.
*
* @author Atul Aggarwal
*/

@ -25,7 +25,7 @@ import java.net.UnknownHostException;
import javax.net.SocketFactory;
/**
* Socket factory for Socks5 proxy
* Socket factory for Socks5 proxy.
*
* @author Atul Aggarwal
*/

@ -21,7 +21,7 @@ import org.jivesoftware.smack.SmackException;
import javax.security.auth.callback.CallbackHandler;
/**
* Implementation of the SASL ANONYMOUS mechanism
* Implementation of the SASL ANONYMOUS mechanism.
*
* @author Jay Kline
*/

@ -122,7 +122,7 @@ public class SaslStreamElements {
final private String data;
/**
* Construct a new SASL success stream element with optional additional data for the SASL layer
* Construct a new SASL success stream element with optional additional data for the SASL layer.
* (RFC6120 6.3.10)
*
* @param data additional data for the SASL layer or <code>null</code>
@ -151,7 +151,7 @@ public class SaslStreamElements {
}
/**
* A SASL failure stream element, also called "SASL Error"
* A SASL failure stream element, also called "SASL Error".
* @see <a href="http://xmpp.org/rfcs/rfc6120.html#sasl-errors">RFC 6120 6.5 SASL Errors</a>
*/
public static class SASLFailure extends AbstractError implements PlainStreamElement {
@ -188,6 +188,7 @@ public class SaslStreamElements {
}
/**
* Get the SASL error as String.
* @return the SASL error as String
*/
public String getSASLErrorString() {

@ -96,7 +96,7 @@ public final class FileUtils {
}
/**
* Reads the contents of a File
* Reads the contents of a File.
*
* @param file
* @return the content of file or null in case of an error

@ -28,7 +28,6 @@ import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.compress.packet.Compress;
import org.jivesoftware.smack.packet.DefaultExtensionElement;
import org.jivesoftware.smack.packet.EmptyResultIQ;
@ -593,9 +592,7 @@ public class PacketParserUtils {
*
* @param parser the XML parser, positioned at the start of an IQ packet.
* @return an IQ object.
* @throws XmlPullParserException
* @throws IOException
* @throws SmackException
* @throws Exception
*/
public static IQ parseIQ(XmlPullParser parser) throws Exception {
ParserUtils.assertAtStartTag(parser);
@ -887,6 +884,7 @@ public class PacketParserUtils {
}
/**
* Parse an extension element.
* @deprecated use {@link #parseExtensionElement(String, String, XmlPullParser)} instead.
*/
@Deprecated

@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
public class PacketUtil {
/**
* Get a extension element from a collection
* Get a extension element from a collection.
*
* @param collection
* @param element
@ -39,7 +39,7 @@ public class PacketUtil {
}
/**
* Get a extension element from a collection
* Get a extension element from a collection.
*
* @param collection
* @param element

@ -187,7 +187,7 @@ public class StringUtils {
}
/**
* Returns true if CharSequence is not null and is not empty, false otherwise
* Returns true if CharSequence is not null and is not empty, false otherwise.
* Examples:
* isNotEmpty(null) - false
* isNotEmpty("") - false
@ -212,7 +212,7 @@ public class StringUtils {
}
/**
* Returns true if the given CharSequence is empty
* Returns true if the given CharSequence is empty.
*
* @param cs
* @return true if the given CharSequence is empty

@ -50,6 +50,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
* Add a new element to this builder.
*
* @param name
* @param content
@ -64,6 +65,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
* Add a new element to this builder.
*
* @param name
* @param content
@ -158,7 +160,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
* Add a right angle bracket '>'
* Add a right angle bracket '>'.
*
* @return a reference to this object.
*/
@ -168,7 +170,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
*
* Add a right angle bracket '>'.
* @return a reference to this object
* @deprecated use {@link #rightAngleBracket()} instead
*/
@ -229,7 +231,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
}
/**
* Add the given attribute if value => 0
* Add the given attribute if {@code value => 0}.
*
* @param name
* @param value

@ -17,6 +17,8 @@
package org.jivesoftware.smack.util.dns;
/**
* A DNS SRV RR.
*
* @see <a href="http://tools.ietf.org/html/rfc2782">RFC 2782: A DNS RR for specifying the location of services (DNS
* SRV)</a>
* @author Florian Schmaus
@ -28,7 +30,7 @@ public class SRVRecord extends HostAddress implements Comparable<SRVRecord> {
private int priority;
/**
* Create a new SRVRecord
* SRV Record constructor.
*
* @param fqdn Fully qualified domain name
* @param port The connection port

@ -17,11 +17,13 @@
package org.jivesoftware.smack.util.stringencoder;
/**
* An interface for String encoder.
*
* @author Florian Schmaus
*/
public interface StringEncoder {
/**
* Encodes an string to another representation
* Encodes an string to another representation.
*
* @param string
* @return the encoded String
@ -29,7 +31,7 @@ public interface StringEncoder {
String encode(String string);
/**
* Decodes an string back to it's initial representation
* Decodes an string back to it's initial representation.
*
* @param string
* @return the decoded String

@ -30,7 +30,7 @@ import org.jivesoftware.smack.packet.Stanza;
import org.jivesoftware.smack.packet.IQ.Type;
/**
*
* A threaded dummy connection.
* @author Robin Collier
*
*/

@ -24,9 +24,6 @@ import org.jivesoftware.smack.filter.StanzaIdFilter;
import org.jivesoftware.smack.filter.ThreadFilter;
import org.junit.Test;
/**
*
*/
public class FilterToStringTest {
@Test

@ -27,7 +27,7 @@ import org.jxmpp.jid.Jid;
import org.jxmpp.jid.JidTestUtil;
/**
*
* From matches filter test.
* @author Robin Collier
*
*/

@ -30,9 +30,6 @@ import java.util.Collection;
import java.util.List;
import java.util.ArrayList;
/**
*
*/
public class MessageTest {
@Test

@ -27,9 +27,6 @@ import org.xml.sax.SAXException;
import java.io.IOException;
/**
*
*/
public class PresenceTest {
@Test
public void setPresenceTypeTest() throws IOException, SAXException {

@ -47,9 +47,6 @@ import org.xmlpull.v1.XmlPullParserException;
import com.jamesmurty.utils.XMLBuilder;
/**
*
*/
public class PacketParserUtilsTest {
private static Properties outputProperties = new Properties();

@ -25,7 +25,7 @@ import java.io.Reader;
import java.io.Writer;
/**
* Implementation of SmackDebuggerFactory which always creates instance of SLF4JSmackDebugger
* Implementation of SmackDebuggerFactory which always creates instance of SLF4JSmackDebugger.
*/
public class SLF4JDebuggerFactory implements SmackDebuggerFactory {
@Override

@ -55,14 +55,14 @@ public class SLF4JSmackDebugger implements SmackDebugger {
private ObservableReader reader;
/**
* Makes Smack use this Debugger
* Makes Smack use this Debugger.
*/
public static void enable() {
SmackConfiguration.setDebuggerFactory(new SLF4JDebuggerFactory());
}
/**
* Create new SLF4J Smack Debugger instance
* Create new SLF4J Smack Debugger instance.
* @param connection Smack connection to debug
* @param writer connection data writer to observe
* @param reader connection data reader to observe

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.carbons.packet;
import org.jivesoftware.smack.packet.SimpleIQ;
/**
* Carbon IQs
* Carbon IQs.
*/
public class Carbon {
public static final String NAMESPACE = "urn:xmpp:carbons:2";

@ -21,7 +21,8 @@ import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smackx.csi.packet.ClientStateIndication;
/**
*
* Manager for Client State Indication.
*
* @see <a href="http://xmpp.org/extensions/xep-0352.html">XEP-0352: Client State Indication</a>
*
*/

@ -20,7 +20,7 @@ import org.jivesoftware.smack.packet.FullStreamElement;
import org.jivesoftware.smack.packet.ExtensionElement;
/**
*
* Client State Indication.
* @see <a href="http://xmpp.org/extensions/xep-0352.html">XEP-0352: Client State Indication</a>
*
*/

@ -246,7 +246,7 @@ public abstract class AbstractHttpOverXmpp extends IQ {
private final String text;
/**
* Creates this element.builder.toString();
* Creates this element.builder.toString().
*
* @param text value of text
*/

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.json.packet;
import org.jivesoftware.smack.packet.Stanza;
/**
* XMPP JSON Containers as defined in XEP-0335
* XMPP JSON Containers as defined in XEP-0335.
*
* @see <a href="http://xmpp.org/extensions/xep-0335.html">XEP-0335: JSON Containers</a>
*/

@ -27,7 +27,7 @@ public class AMPDeliverCondition implements AMPExtension.Condition {
public static final String NAME = "deliver";
/**
* Check if server supports deliver condition
* Check if server supports deliver condition.
* @param connection Smack connection instance
* @return true if deliver condition is supported.
* @throws XMPPErrorException

@ -31,7 +31,7 @@ public class AMPExpireAtCondition implements AMPExtension.Condition {
public static final String NAME = "expire-at";
/**
* Check if server supports expire-at condition
* Check if server supports expire-at condition.
* @param connection Smack connection instance
* @return true if expire-at condition is supported.
* @throws XMPPErrorException

@ -79,7 +79,7 @@ public class AMPManager {
}
/**
* Check if server supports specified action
* Check if server supports specified action.
* @param connection active xmpp connection
* @param action action to check
* @return true if this action is supported.
@ -94,7 +94,7 @@ public class AMPManager {
}
/**
* Check if server supports specified condition
* Check if server supports specified condition.
* @param connection active xmpp connection
* @param conditionName name of condition to check
* @return true if this condition is supported.

@ -27,7 +27,7 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
public static final String NAME = "match-resource";
/**
* Check if server supports match-resource condition
* Check if server supports match-resource condition.
* @param connection Smack connection instance
* @return true if match-resource condition is supported.
* @throws XMPPErrorException
@ -63,7 +63,7 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
}
/**
* match-resource amp condition value as defined by XEP-0079
* match-resource amp condition value as defined by XEP-0079.
* See http://xmpp.org/extensions/xep-0079.html#conditions-def-match
*/
public static enum Value {

@ -59,6 +59,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* Get the JID that triggered this AMP callback.
* @return jid that triggered this amp callback.
*/
public String getFrom() {
@ -66,6 +67,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* Get the receiver of this AMP receipt.
* @return receiver of this amp receipt.
*/
public String getTo() {
@ -73,7 +75,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* Status of this amp notification
* Status of this amp notification.
* @return Status for this amp
*/
public Status getStatus() {
@ -217,7 +219,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* Interface for defining XEP-0079 Conditions and their values
* Interface for defining XEP-0079 Conditions and their values.
* @see AMPDeliverCondition
* @see AMPExpireAtCondition
* @see AMPMatchResourceCondition
@ -230,7 +232,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* amp action attribute
* amp action attribute.
* See http://xmpp.org/extensions/xep-0079.html#actions-def
**/
public static enum Action {
@ -267,7 +269,7 @@ public class AMPExtension implements ExtensionElement {
}
/**
* amp notification status as defined by XEP-0079
* amp notification status as defined by XEP-0079.
*/
public static enum Status {
alert,

@ -23,11 +23,9 @@ import java.util.List;
import java.util.Map;
import java.util.WeakHashMap;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.SmackException.NoResponseException;
import org.jivesoftware.smack.SmackException.NotConnectedException;
import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smack.XMPPException;
import org.jivesoftware.smack.XMPPException.XMPPErrorException;
import org.jivesoftware.smackx.iqprivate.PrivateDataManager;
@ -56,12 +54,9 @@ public class BookmarkManager {
* @param connection the connection for which the manager is desired.
* @return Returns the <i>BookmarkManager</i> for a connection, if it doesn't
* exist it is created.
* @throws XMPPException
* @throws SmackException thrown has not been authenticated.
* @throws IllegalArgumentException when the connection is null.
*/
public synchronized static BookmarkManager getBookmarkManager(XMPPConnection connection)
throws XMPPException, SmackException
{
BookmarkManager manager = bookmarkManagerMap.get(connection);
if (manager == null) {

@ -128,7 +128,7 @@ public class InBandBytestreamManager implements BytestreamManager {
}
/**
* Maximum block size that is allowed for In-Band Bytestreams
* Maximum block size that is allowed for In-Band Bytestreams.
*/
public static final int MAXIMUM_BLOCK_SIZE = 65535;

@ -818,6 +818,7 @@ public class InBandBytestreamSession implements BytestreamSession {
}
/**
* Process IQ stanza.
* @param data
* @throws NotConnectedException
* @throws InterruptedException

@ -23,7 +23,7 @@ import org.jivesoftware.smack.util.stringencoder.Base64;
/**
* Represents a chunk of data of an In-Band Bytestream within an IQ stanza or a
* message stanza
* message stanza.
*
* @author Henning Staib
*/
@ -35,7 +35,7 @@ public class DataPacketExtension implements ExtensionElement {
public final static String ELEMENT = "data";
/**
* The XMPP namespace of the In-Band Bytestream
* The XMPP namespace of the In-Band Bytestream.
*/
public static final String NAMESPACE = "http://jabber.org/protocol/ibb";

@ -35,7 +35,7 @@ public class Bytestream extends IQ {
public static final String ELEMENT = QUERY_ELEMENT;
/**
* The XMPP namespace of the SOCKS5 Bytestream
* The XMPP namespace of the SOCKS5 Bytestream.
*/
public static final String NAMESPACE = "http://jabber.org/protocol/bytestreams";
@ -50,7 +50,7 @@ public class Bytestream extends IQ {
private Activate toActivate;
/**
* The default constructor
* The default constructor.
*/
public Bytestream() {
super(ELEMENT, NAMESPACE);

@ -127,7 +127,7 @@ public class EntityCapsManager extends Manager {
}