diff --git a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java
index c799b2c4e..f92a6dd9f 100644
--- a/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java
+++ b/smack-bosh/src/main/java/org/jivesoftware/smack/bosh/XMPPBOSHConnection.java
@@ -292,6 +292,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection {
* Send a HTTP request to the connection manager with the provided body element.
*
* @param body the body which will be sent.
+ * @throws BOSHException
*/
protected void send(ComposableBody body) throws BOSHException {
if (!connected) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java
index 8b6428de3..19f07e7b9 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/AbstractXMPPConnection.java
@@ -966,6 +966,11 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
private SmackConfiguration.UnknownIqRequestReplyMode unknownIqRequestReplyMode = SmackConfiguration.getUnknownIqRequestReplyMode();
+ /**
+ * Set how Smack behaves when an unknown IQ request has been received.
+ *
+ * @param unknownIqRequestReplyMode reply mode.
+ */
public void setUnknownIqRequestReplyMode(UnknownIqRequestReplyMode unknownIqRequestReplyMode) {
this.unknownIqRequestReplyMode = Objects.requireNonNull(unknownIqRequestReplyMode, "Mode must not be null");
}
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 6b8bc55fb..90ec82a8f 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java
@@ -889,6 +889,7 @@ public abstract class ConnectionConfiguration {
* argument. It also calls {@link #allowEmptyOrNullUsernames()} and {@link #setSecurityMode(ConnectionConfiguration.SecurityMode)} to
* {@link SecurityMode#required}.
*
+ * @param sslContext custom SSLContext to be used.
* @return a reference to this builder.
*/
public B performSaslExternalAuthentication(SSLContext sslContext) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
index 8e8418b23..5c8a648fc 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/SASLAuthentication.java
@@ -260,6 +260,7 @@ public final class SASLAuthentication {
/**
* Notification message saying that SASL authentication was successful. The next step
* would be to bind the resource.
+ * @param success result of the authentication.
* @throws SmackException
* @throws InterruptedException
*/
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 163c2cc53..4c81c5593 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java
@@ -248,6 +248,16 @@ public final class SmackConfiguration {
compressionHandlers.add(xmppInputOutputStream);
}
+ /**
+ * Get compression handlers.
+ *
+ * @deprecated use {@link #getCompressionHandlers()} instead.
+ */
+ @Deprecated
+ public static List type of the result stanza.
* @return the next stanza(/packet) result, or null if there are no more
* results.
*/
@@ -124,7 +125,8 @@ public class StanzaCollector {
*
* Throws an XMPPErrorException in case the polled stanzas did contain an XMPPError.
* type of the result stanza.
* @return the next available packet.
* @throws XMPPErrorException in case an error response.
*/
@@ -139,7 +141,8 @@ public class StanzaCollector {
/**
* Returns the next available packet. The method call will block (not return) until a stanza(/packet) is
* available.
- *
+ *
+ * @param type of the result stanza.
* @return the next available packet.
* @throws InterruptedException
*/
@@ -156,7 +159,8 @@ public class StanzaCollector {
/**
* Returns the next available packet. The method call will block until the connection's default
* timeout has elapsed.
- *
+ *
+ * @param type of the result stanza.
* @return the next available packet.
* @throws InterruptedException
*/
@@ -171,6 +175,7 @@ public class StanzaCollector {
* until a stanza(/packet) is available or the timeout has elapsed. If the
* timeout elapses without a result, null will be returned.
*
+ * @param type of the result stanza.
* @param timeout the timeout in milliseconds.
* @return the next available packet.
* @throws InterruptedException
@@ -195,7 +200,8 @@ public class StanzaCollector {
* Returns the next available stanza. The method in equivalent to
* {@link #nextResultOrThrow(long)} where the timeout argument is the default reply timeout of
* the connection associated with this collector.
- *
+ *
+ * @param type of the result stanza.
* @return the next available stanza.
* @throws XMPPErrorException in case an error response was received.
* @throws NoResponseException if there was no response from the server.
@@ -236,6 +242,7 @@ public class StanzaCollector {
* type of the result stanza.
* @return the next available stanza.
* @throws NoResponseException if there was no response from the server.
* @throws XMPPErrorException in case an error response was received.
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java b/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java
index dd99e8d9e..ac0c79a54 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/SynchronizationPoint.java
@@ -68,6 +68,7 @@ public class SynchronizationPointnull
if synchronization point was successful, or the failure Exception.
*/
public E sendAndWaitForResponse(TopLevelStreamElement request) throws NoResponseException,
@@ -101,6 +102,7 @@ public class SynchronizationPointnull
if the server doesn't support that feature.
- *
+ *
+ * @param null
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java b/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
index 7a250ff4d..b85546729 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/XMPPException.java
@@ -90,7 +90,8 @@ public abstract class XMPPException extends Exception {
/**
* Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.
- *
+ *
+ * @param stanza stanza that contained the exception.
* @param error the root cause of the exception.
*/
public XMPPErrorException(Stanza stanza, XMPPError error) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
index 98a1debc8..606bc7789 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebugger.java
@@ -58,6 +58,7 @@ public abstract class SmackDebugger {
* needs to wrap the new reader and writer to keep being notified of the connection
* traffic.
*
+ * @param reader connection reader.
* @return a new special Reader that wraps the new connection Reader.
*/
public abstract Reader newConnectionReader(Reader reader);
@@ -68,6 +69,7 @@ public abstract class SmackDebugger {
* needs to wrap the new reader and writer to keep being notified of the connection
* traffic.
*
+ * @param writer connection writer.
* @return a new special Writer that wraps the new connection Writer.
*/
public abstract Writer newConnectionWriter(Writer writer);
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebuggerFactory.java b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebuggerFactory.java
index e4cfc0580..5f618674c 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebuggerFactory.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/debugger/SmackDebuggerFactory.java
@@ -23,6 +23,8 @@ public interface SmackDebuggerFactory {
* Initialize the new SmackDebugger instance.
*
* @param connection the XMPP connection this debugger is going to get attached to.
+ *
+ * @return SmackDebugger.
* @throws IllegalArgumentException if the SmackDebugger can't be loaded.
*/
SmackDebugger create(XMPPConnection connection) throws IllegalArgumentException;
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java
index 1b16b09ae..5bdc98549 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/FromMatchesFilter.java
@@ -52,6 +52,7 @@ public final class FromMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter for the "from" address.
*/
public static FromMatchesFilter create(Jid address) {
return new FromMatchesFilter(address, address != null ? address.hasNoResource() : false) ;
@@ -63,6 +64,7 @@ public final class FromMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter matching the "from" address.
*/
public static FromMatchesFilter createBare(Jid address) {
return new FromMatchesFilter(address, true);
@@ -74,6 +76,7 @@ public final class FromMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter matching the "from" address.
*/
public static FromMatchesFilter createFull(Jid address) {
return new FromMatchesFilter(address, false);
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java
index 130e0cb10..981813b82 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/IQReplyFilter.java
@@ -81,6 +81,7 @@ public class IQReplyFilter implements StanzaFilter {
* and following discussion in February and March.
*
* @param iqPacket An IQ request. Filter for replies to this packet.
+ * @param conn connection.
*/
public IQReplyFilter(IQ iqPacket, XMPPConnection conn) {
if (!iqPacket.isRequestIQ()) {
diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/ToMatchesFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/ToMatchesFilter.java
index a923bfe86..6ac4fe450 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/ToMatchesFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/ToMatchesFilter.java
@@ -35,6 +35,7 @@ public final class ToMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter matching the "to" address.
*/
public static ToMatchesFilter create(Jid address) {
return new ToMatchesFilter(address, address != null ? address.hasNoResource() : false) ;
@@ -46,6 +47,7 @@ public final class ToMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter matching the "to" address.
*/
public static ToMatchesFilter createBare(Jid address) {
return new ToMatchesFilter(address, true);
@@ -57,6 +59,7 @@ public final class ToMatchesFilter extends AbstractFromToMatchesFilter {
*
* @param address The address to filter for. If null
is given, the stanza must not
* have a from address.
+ * @return filter matching the "to" address.
*/
public static ToMatchesFilter createFull(Jid address) {
return new ToMatchesFilter(address, false);
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 fbb68eb52..ccabb1599 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
@@ -96,6 +96,7 @@ public class AbstractError {
*
* @param elementName the XML element name of the stanza(/packet) extension.
* @param namespace the XML element namespace of the stanza(/packet) extension.
+ * @param
* Objects of the following type(s) are allowed in the list: {@link String },
* {@link Section }, {@link Fieldref } and {@link Reportedref }
+ *
+ * @return list of DataFormLayoutElements.
*/
public List
* Objects of the following type(s) are allowed in the list: {@link String },
* {@link Section }, {@link Fieldref } and {@link Reportedref }
+ *
+ * @return list of DataFormLayoutElements.
*/
public List