Enable javadoc checkstyle

and fix violations.
This commit is contained in:
Florian Schmaus 2015-03-29 12:15:32 +02:00
parent 57260b2a44
commit 64d134052d
198 changed files with 529 additions and 501 deletions

View File

@ -75,5 +75,20 @@
<property name="message" value="Usage of println"/> <property name="message" value="Usage of println"/>
<property name="ignoreComments" value="true"/> <property name="ignoreComments" value="true"/>
</module> </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>
</module> </module>

View File

@ -19,7 +19,7 @@ package org.jivesoftware.smack.util.stringencoder.android;
import android.util.Base64; 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 * @author Florian Schmaus
*/ */
public class AndroidBase64Encoder implements org.jivesoftware.smack.util.stringencoder.Base64.Encoder { public class AndroidBase64Encoder implements org.jivesoftware.smack.util.stringencoder.Base64.Encoder {

View File

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

View File

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

View File

@ -47,7 +47,6 @@ import org.jivesoftware.smack.SmackException.AlreadyConnectedException;
import org.jivesoftware.smack.SmackException.AlreadyLoggedInException; import org.jivesoftware.smack.SmackException.AlreadyLoggedInException;
import org.jivesoftware.smack.SmackException.NoResponseException; import org.jivesoftware.smack.SmackException.NoResponseException;
import org.jivesoftware.smack.SmackException.NotConnectedException; import org.jivesoftware.smack.SmackException.NotConnectedException;
import org.jivesoftware.smack.SmackException.ConnectionException;
import org.jivesoftware.smack.SmackException.ResourceBindingNotOfferedException; import org.jivesoftware.smack.SmackException.ResourceBindingNotOfferedException;
import org.jivesoftware.smack.SmackException.SecurityRequiredException; import org.jivesoftware.smack.SmackException.SecurityRequiredException;
import org.jivesoftware.smack.XMPPException.StreamErrorException; 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 XMPPException if an error occurs on the XMPP protocol level.
* @throws SmackException if an error occurs somewhere else besides XMPP protocol level. * @throws SmackException if an error occurs somewhere else besides XMPP protocol level.
* @throws IOException * @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>. * @return a reference to this object, to chain <code>connect()</code> with <code>login()</code>.
* @throws InterruptedException * @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 * 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 * @param callback the callback to install
*/ */

View File

@ -497,7 +497,7 @@ public abstract class ConnectionConfiguration {
/** /**
* Sets the PKCS11 library file location, needed when the * 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. * @param pkcs11Library the path to the PKCS11 library file.
* @return a reference to this builder. * @return a reference to this builder.

View File

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

View File

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

View File

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

View File

@ -121,7 +121,7 @@ public class ReconnectionManager {
} }
/** /**
* Set the default Reconnection Policy to use * Set the default Reconnection Policy to use.
* *
* @param reconnectionPolicy * @param reconnectionPolicy
*/ */
@ -131,7 +131,7 @@ public class ReconnectionManager {
/** /**
* Set the fixed delay in seconds between the reconnection attempts Also set the connection * 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 * @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 * @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; 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 * 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 { public enum ReconnectionPolicy {
/** /**
* Default policy classically used by smack, having an increasing delay related to the * Default policy classically used by smack, having an increasing delay related to the
* overall number of attempts * overall number of attempts.
*/ */
RANDOM_INCREASING_DELAY, RANDOM_INCREASING_DELAY,
/** /**
* Policy using fixed amount of time between reconnection attempts * Policy using fixed amount of time between reconnection attempts.
*/ */
FIXED_DELAY, FIXED_DELAY,
; ;

View File

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

View File

@ -175,6 +175,8 @@ public final class SmackConfiguration {
} }
/** /**
* Get the debugger factory.
*
* @return a debugger factory or <code>null</code> * @return a debugger factory or <code>null</code>
*/ */
public static SmackDebuggerFactory getDebuggerFactory() { 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 * @param callback
* @see ParsingExceptionCallback * @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 * @return the default parsing exception callback
* @see ParsingExceptionCallback * @see ParsingExceptionCallback

View File

@ -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 * @param debuggerClass class to be used by this factory
*/ */
public static void setDebuggerClass(Class<? extends SmackDebugger> debuggerClass) { 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 * @return debugger class that will be used for instantiation by this factory
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

View File

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

View File

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

View File

@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter;
import org.jivesoftware.smack.packet.Message; 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> { public class MessageWithBodiesFilter extends FlexibleStanzaTypeFilter<Message> {

View File

@ -20,7 +20,7 @@ package org.jivesoftware.smack.filter;
import org.jivesoftware.smack.packet.Message; 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> { public class MessageWithSubjectFilter extends FlexibleStanzaTypeFilter<Message> {

View File

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

View File

@ -304,7 +304,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
error, 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, probe,
; ;

View File

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

View File

@ -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 { public enum Condition {

View File

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

View File

@ -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 * @return the exception that caused the parser to fail
*/ */
public Exception getParsingException() { 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 * @return the raw stanza data
*/ */

View File

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

View File

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

View File

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

View File

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

View File

@ -122,7 +122,7 @@ public class SaslStreamElements {
final private String data; 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) * (RFC6120 6.3.10)
* *
* @param data additional data for the SASL layer or <code>null</code> * @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> * @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 { 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 * @return the SASL error as String
*/ */
public String getSASLErrorString() { public String getSASLErrorString() {

View File

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

View File

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

View File

@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
public class PacketUtil { public class PacketUtil {
/** /**
* Get a extension element from a collection * Get a extension element from a collection.
* *
* @param collection * @param collection
* @param element * @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 collection
* @param element * @param element

View File

@ -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: * Examples:
* isNotEmpty(null) - false * isNotEmpty(null) - false
* isNotEmpty("") - 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 * @param cs
* @return true if the given CharSequence is empty * @return true if the given CharSequence is empty

View File

@ -50,6 +50,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
} }
/** /**
* Add a new element to this builder.
* *
* @param name * @param name
* @param content * @param content
@ -64,6 +65,7 @@ public class XmlStringBuilder implements Appendable, CharSequence {
} }
/** /**
* Add a new element to this builder.
* *
* @param name * @param name
* @param content * @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. * @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 * @return a reference to this object
* @deprecated use {@link #rightAngleBracket()} instead * @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 name
* @param value * @param value

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -25,7 +25,7 @@ import java.io.Reader;
import java.io.Writer; 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 { public class SLF4JDebuggerFactory implements SmackDebuggerFactory {
@Override @Override

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -31,7 +31,7 @@ public class AMPExpireAtCondition implements AMPExtension.Condition {
public static final String NAME = "expire-at"; 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 * @param connection Smack connection instance
* @return true if expire-at condition is supported. * @return true if expire-at condition is supported.
* @throws XMPPErrorException * @throws XMPPErrorException

View File

@ -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 connection active xmpp connection
* @param action action to check * @param action action to check
* @return true if this action is supported. * @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 connection active xmpp connection
* @param conditionName name of condition to check * @param conditionName name of condition to check
* @return true if this condition is supported. * @return true if this condition is supported.

View File

@ -27,7 +27,7 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
public static final String NAME = "match-resource"; 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 * @param connection Smack connection instance
* @return true if match-resource condition is supported. * @return true if match-resource condition is supported.
* @throws XMPPErrorException * @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 * See http://xmpp.org/extensions/xep-0079.html#conditions-def-match
*/ */
public static enum Value { public static enum Value {

View File

@ -59,6 +59,7 @@ public class AMPExtension implements ExtensionElement {
} }
/** /**
* Get the JID that triggered this AMP callback.
* @return jid that triggered this amp callback. * @return jid that triggered this amp callback.
*/ */
public String getFrom() { 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. * @return receiver of this amp receipt.
*/ */
public String getTo() { 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 * @return Status for this amp
*/ */
public Status getStatus() { 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 AMPDeliverCondition
* @see AMPExpireAtCondition * @see AMPExpireAtCondition
* @see AMPMatchResourceCondition * @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 * See http://xmpp.org/extensions/xep-0079.html#actions-def
**/ **/
public static enum Action { 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 { public static enum Status {
alert, alert,

View File

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

View File

@ -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; public static final int MAXIMUM_BLOCK_SIZE = 65535;

View File

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

View File

@ -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 * Represents a chunk of data of an In-Band Bytestream within an IQ stanza or a
* message stanza * message stanza.
* *
* @author Henning Staib * @author Henning Staib
*/ */
@ -35,7 +35,7 @@ public class DataPacketExtension implements ExtensionElement {
public final static String ELEMENT = "data"; 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"; public static final String NAMESPACE = "http://jabber.org/protocol/ibb";

View File

@ -35,7 +35,7 @@ public class Bytestream extends IQ {
public static final String ELEMENT = QUERY_ELEMENT; 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"; public static final String NAMESPACE = "http://jabber.org/protocol/bytestreams";
@ -50,7 +50,7 @@ public class Bytestream extends IQ {
private Activate toActivate; private Activate toActivate;
/** /**
* The default constructor * The default constructor.
*/ */
public Bytestream() { public Bytestream() {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View File

@ -127,7 +127,7 @@ public class EntityCapsManager extends Manager {
} }
/** /**
* Set the default entity node that will be used for new EntityCapsManagers * Set the default entity node that will be used for new EntityCapsManagers.
* *
* @param entityNode * @param entityNode
*/ */
@ -217,7 +217,7 @@ public class EntityCapsManager extends Manager {
} }
/** /**
* Set the persistent cache implementation * Set the persistent cache implementation.
* *
* @param cache * @param cache
*/ */
@ -226,7 +226,7 @@ public class EntityCapsManager extends Manager {
} }
/** /**
* Sets the maximum cache sizes * Sets the maximum cache sizes.
* *
* @param maxJidToNodeVerSize * @param maxJidToNodeVerSize
* @param maxCapsCacheSize * @param maxCapsCacheSize
@ -433,7 +433,7 @@ public class EntityCapsManager extends Manager {
} }
/** /**
* Returns true if Entity Caps are supported by a given JID * Returns true if Entity Caps are supported by a given JID.
* *
* @param jid * @param jid
* @return true if the entity supports Entity Capabilities. * @return true if the entity supports Entity Capabilities.
@ -447,7 +447,7 @@ public class EntityCapsManager extends Manager {
} }
/** /**
* Returns true if Entity Caps are supported by the local service/server * Returns true if Entity Caps are supported by the local service/server.
* *
* @return true if the user's server supports Entity Capabilities. * @return true if the user's server supports Entity Capabilities.
* @throws XMPPErrorException * @throws XMPPErrorException
@ -524,7 +524,7 @@ public class EntityCapsManager extends Manager {
/** /**
* Verify DisoverInfo and Caps Node as defined in XEP-0115 5.4 Processing * Verify DisoverInfo and Caps Node as defined in XEP-0115 5.4 Processing
* Method * Method.
* *
* @see <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0115 * @see <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0115
* 5.4 Processing Method</a> * 5.4 Processing Method</a>

View File

@ -20,7 +20,7 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
public interface EntityCapsPersistentCache { public interface EntityCapsPersistentCache {
/** /**
* Add an DiscoverInfo to the persistent Cache * Add an DiscoverInfo to the persistent Cache.
* *
* @param nodeVer * @param nodeVer
* @param info * @param info
@ -28,12 +28,12 @@ public interface EntityCapsPersistentCache {
void addDiscoverInfoByNodePersistent(String nodeVer, DiscoverInfo info); void addDiscoverInfoByNodePersistent(String nodeVer, DiscoverInfo info);
/** /**
* Lookup DiscoverInfo by a Node string * Lookup DiscoverInfo by a Node string.
*/ */
DiscoverInfo lookup(String nodeVer); DiscoverInfo lookup(String nodeVer);
/** /**
* Empty the Cache * Empty the Cache.
*/ */
void emptyCache(); void emptyCache();
} }

View File

@ -56,6 +56,8 @@ public class CapsExtension implements ExtensionElement {
} }
/** /**
* {@inheritDoc}.
*
* <pre> * <pre>
* <c xmlns='http://jabber.org/protocol/caps' * <c xmlns='http://jabber.org/protocol/caps'
* hash='sha-1' * hash='sha-1'

View File

@ -124,7 +124,7 @@ public class AdHocCommandData extends IQ {
} }
/** /**
* Returns the human name of the command * Returns the human name of the command.
* *
* @return the name of the command. * @return the name of the command.
*/ */
@ -137,7 +137,7 @@ public class AdHocCommandData extends IQ {
} }
/** /**
* Returns the identifier of the command * Returns the identifier of the command.
* *
* @return the node. * @return the node.
*/ */

View File

@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smackx.delay.packet.DelayInformation; import org.jivesoftware.smackx.delay.packet.DelayInformation;
/** /**
* Delayed Delivery (XEP-203) * Delayed Delivery (XEP-203).
* *
* @author Florian Schmaus * @author Florian Schmaus
* @see <a href="http://xmpp.org/extensions/xep-0203.html">Delayed Delivery (XEP-203)</a> * @see <a href="http://xmpp.org/extensions/xep-0203.html">Delayed Delivery (XEP-203)</a>
@ -75,7 +75,7 @@ public class DelayInformationManager {
} }
/** /**
* Get the Delayed Delivery timestamp or <code>null</code> * Get the Delayed Delivery timestamp or <code>null</code>.
* *
* @param packet * @param packet
* @return the Delayed Delivery timestamp or <code>null</code> * @return the Delayed Delivery timestamp or <code>null</code>

View File

@ -108,7 +108,8 @@ public class DelayInformation implements ExtensionElement {
} }
/** /**
* * Return delay information from the given stanza.
*
* @param packet * @param packet
* @return the DelayInformation or null * @return the DelayInformation or null
* @deprecated use {@link #from(Stanza)} instead * @deprecated use {@link #from(Stanza)} instead
@ -119,7 +120,8 @@ public class DelayInformation implements ExtensionElement {
} }
/** /**
* * Return delay information from the given stanza.
*
* @param packet * @param packet
* @return the DelayInformation or null * @return the DelayInformation or null
*/ */

View File

@ -23,9 +23,6 @@ import org.jivesoftware.smackx.disco.packet.DiscoverItems;
import java.util.List; import java.util.List;
/**
*
*/
public abstract class AbstractNodeInformationProvider implements NodeInformationProvider { public abstract class AbstractNodeInformationProvider implements NodeInformationProvider {
public List<DiscoverItems.Item> getNodeItems() { public List<DiscoverItems.Item> getNodeItems() {

View File

@ -260,7 +260,7 @@ public class ServiceDiscoveryManager extends Manager {
} }
/** /**
* Returns all identities of this client as unmodifiable Collection * Returns all identities of this client as unmodifiable Collection.
* *
* @return all identies as set * @return all identies as set
*/ */
@ -432,7 +432,7 @@ public class ServiceDiscoveryManager extends Manager {
} }
/** /**
* Returns the data form that is set as extended information for this Service Discovery instance (XEP-0128) * Returns the data form that is set as extended information for this Service Discovery instance (XEP-0128).
* *
* @see <a href="http://xmpp.org/extensions/xep-0128.html">XEP-128: Service Discovery Extensions</a> * @see <a href="http://xmpp.org/extensions/xep-0128.html">XEP-128: Service Discovery Extensions</a>
* @return the data form * @return the data form

View File

@ -56,7 +56,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
} }
/** /**
* Copy constructor * Copy constructor.
* *
* @param d * @param d
*/ */
@ -128,7 +128,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
} }
/** /**
* Adds identities to the DiscoverInfo stanza * Adds identities to the DiscoverInfo stanza.
* *
* @param identitiesToAdd * @param identitiesToAdd
*/ */
@ -354,7 +354,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
} }
/** /**
* Returns the identities natural language if one is set * Returns the identities natural language if one is set.
* *
* @return the value of xml:lang of this Identity * @return the value of xml:lang of this Identity
*/ */
@ -391,7 +391,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
/** /**
* Check equality for Identity for category, type, lang and name * Check equality for Identity for category, type, lang and name
* in that order as defined by * in that order as defined by
* <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0015 5.4 Processing Method (Step 3.3)</a> * <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0015 5.4 Processing Method (Step 3.3)</a>.
* *
*/ */
public boolean equals(Object obj) { public boolean equals(Object obj) {

View File

@ -288,7 +288,7 @@ public abstract class FileTransfer {
complete("Complete"), complete("Complete"),
/** /**
* The file transfer was cancelled * The file transfer was cancelled.
*/ */
cancelled("Cancelled"); cancelled("Cancelled");
@ -313,7 +313,7 @@ public abstract class FileTransfer {
public enum Error { public enum Error {
/** /**
* No error * No error.
*/ */
none("No error"), none("No error"),
@ -339,7 +339,7 @@ public abstract class FileTransfer {
connection("An error occured over the socket connected to send the file."), connection("An error occured over the socket connected to send the file."),
/** /**
* An error occurred while sending or receiving the file * An error occurred while sending or receiving the file.
*/ */
stream("An error occured while sending or recieving the file."); stream("An error occured while sending or recieving the file.");

View File

@ -438,7 +438,7 @@ public class OutgoingFileTransfer extends FileTransfer {
public interface NegotiationProgress { public interface NegotiationProgress {
/** /**
* Called when the status changes * Called when the status changes.
* *
* @param oldStatus the previous status of the file transfer. * @param oldStatus the previous status of the file transfer.
* @param newStatus the new status of the file transfer. * @param newStatus the new status of the file transfer.

View File

@ -93,7 +93,7 @@ public class Forwarded implements ExtensionElement {
} }
/** /**
* * Get the forwarded extension.
* @param packet * @param packet
* @return the Forwarded extension or null * @return the Forwarded extension or null
*/ */

View File

@ -242,7 +242,7 @@ public class LastActivityManager extends Manager {
} }
/** /**
* Returns true if Last Activity (XEP-0012) is supported by a given JID * Returns true if Last Activity (XEP-0012) is supported by a given JID.
* *
* @param jid a JID to be tested for Last Activity support * @param jid a JID to be tested for Last Activity support
* @return true if Last Activity is supported, otherwise false * @return true if Last Activity is supported, otherwise false

View File

@ -45,7 +45,7 @@ public class Version extends IQ {
} }
/** /**
* Request version IQ * Request version IQ.
* *
* @param to the jid where to request version from * @param to the jid where to request version from
*/ */

View File

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
import java.util.Locale; import java.util.Locale;
/** /**
* XEP-0045: Multi-User-Chat - 5.2 Affiliations * XEP-0045: Multi-User-Chat - 5.2 Affiliations.
* *
* @see <a href="http://xmpp.org/extensions/xep-0045.html#affil">XEP-0045: Multi-User-Chat - 5.2 Affiliations</a> * @see <a href="http://xmpp.org/extensions/xep-0045.html#affil">XEP-0045: Multi-User-Chat - 5.2 Affiliations</a>
*/ */

View File

@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
import java.util.Locale; import java.util.Locale;
/** /**
* XEP-0045: Multi User Chat - 5.1 Roles * XEP-0045: Multi User Chat - 5.1 Roles.
* *
* @see <a href="http://xmpp.org/extensions/xep-0045.html#roles">XEP-0045: Multi-User-Chat - 5.1 Roles</a> * @see <a href="http://xmpp.org/extensions/xep-0045.html#roles">XEP-0045: Multi-User-Chat - 5.1 Roles</a>
*/ */

View File

@ -109,7 +109,7 @@ public class GroupChatInvitation implements ExtensionElement {
} }
/** /**
* * Deprecated.
* @param packet * @param packet
* @return the GroupChatInvitation or null * @return the GroupChatInvitation or null
* @deprecated use {@link #from(Stanza)} instead * @deprecated use {@link #from(Stanza)} instead
@ -120,7 +120,7 @@ public class GroupChatInvitation implements ExtensionElement {
} }
/** /**
* * Get the group chat invitation from the given stanza.
* @param packet * @param packet
* @return the GroupChatInvitation or null * @return the GroupChatInvitation or null
*/ */

View File

@ -42,7 +42,7 @@ public class Nick implements ExtensionElement {
} }
/** /**
* The value of this nickname * The value of this nickname.
* *
* @return the nickname * @return the nickname
*/ */
@ -51,7 +51,7 @@ public class Nick implements ExtensionElement {
} }
/** /**
* Sets the value of this nickname * Sets the value of this nickname.
* *
* @param name * @param name
* the name to set * the name to set

View File

@ -17,15 +17,12 @@
package org.jivesoftware.smackx.pep.provider; package org.jivesoftware.smackx.pep.provider;
import java.io.IOException;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.packet.ExtensionElement; import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.provider.ExtensionElementProvider; import org.jivesoftware.smack.provider.ExtensionElementProvider;
import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
/** /**
* *
@ -55,9 +52,7 @@ public class PEPProvider extends ExtensionElementProvider<ExtensionElement> {
* *
* @param parser the XML parser, positioned at the starting element of the extension. * @param parser the XML parser, positioned at the starting element of the extension.
* @return a PacketExtension. * @return a PacketExtension.
* @throws IOException * @throws Exception
* @throws XmlPullParserException
* @throws SmackException
*/ */
@Override @Override
public ExtensionElement parse(XmlPullParser parser, int initialDepth) public ExtensionElement parse(XmlPullParser parser, int initialDepth)

View File

@ -190,7 +190,7 @@ public class PingManager extends Manager {
} }
/** /**
* Query the specified entity to see if it supports the Ping protocol (XEP-0199) * Query the specified entity to see if it supports the Ping protocol (XEP-0199).
* *
* @param jid The id of the entity the query is being sent to * @param jid The id of the entity the query is being sent to
* @return true if it supports ping, false otherwise. * @return true if it supports ping, false otherwise.
@ -288,7 +288,7 @@ public class PingManager extends Manager {
} }
/** /**
* Register a new PingFailedListener * Register a new PingFailedListener.
* *
* @param listener the listener to invoke * @param listener the listener to invoke
*/ */
@ -297,7 +297,7 @@ public class PingManager extends Manager {
} }
/** /**
* Unregister a PingFailedListener * Unregister a PingFailedListener.
* *
* @param listener the listener to remove * @param listener the listener to remove
*/ */

View File

@ -36,7 +36,7 @@ public class Ping extends SimpleIQ {
} }
/** /**
* Create an XMPP Pong for this Ping * Create an XMPP Pong for this Ping.
* *
* @return the Pong * @return the Pong
*/ */

View File

@ -18,24 +18,24 @@ package org.jivesoftware.smackx.pubsub;
/** /**
* This enumeration represents the access models for the pubsub node * This enumeration represents the access models for the pubsub node
* as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a> * as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>.
* *
* @author Robin Collier * @author Robin Collier
*/ */
public enum AccessModel public enum AccessModel
{ {
/** Anyone may subscribe and retrieve items */ /** Anyone may subscribe and retrieve items. */
open, open,
/** Subscription request must be approved and only subscribers may retrieve items */ /** Subscription request must be approved and only subscribers may retrieve items. */
authorize, authorize,
/** Anyone with a presence subscription of both or from may subscribe and retrieve items */ /** Anyone with a presence subscription of both or from may subscribe and retrieve items. */
presence, presence,
/** Anyone in the specified roster group(s) may subscribe and retrieve items */ /** Anyone in the specified roster group(s) may subscribe and retrieve items. */
roster, roster,
/** Only those on a whitelist may subscribe and retrieve items */ /** Only those on a whitelist may subscribe and retrieve items. */
whitelist; whitelist;
} }

View File

@ -18,13 +18,13 @@ package org.jivesoftware.smackx.pubsub;
/** /**
* This enumeration represents the children association policy for associating leaf nodes * This enumeration represents the children association policy for associating leaf nodes
* with collection nodes as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a> * with collection nodes as defined in the pubsub specification section <a href="http://xmpp.org/extensions/xep-0060.html#registrar-formtypes-config">16.4.3</a>.
* *
* @author Robin Collier * @author Robin Collier
*/ */
public enum ChildrenAssociationPolicy public enum ChildrenAssociationPolicy
{ {
/** Anyone may associate leaf nodes with the collection */ /** Anyone may associate leaf nodes with the collection. */
all, all,
/** Only collection node owners may associate leaf nodes with the collection. */ /** Only collection node owners may associate leaf nodes with the collection. */

View File

@ -282,7 +282,7 @@ public class ConfigureForm extends Form
} }
/** /**
* Determines who should get replies to items * Determines who should get replies to items.
* *
* @return Who should get the reply * @return Who should get the reply
*/ */
@ -297,7 +297,7 @@ public class ConfigureForm extends Form
} }
/** /**
* Sets who should get the replies to items * Sets who should get the replies to items.
* *
* @param reply Defines who should get the reply * @param reply Defines who should get the reply
*/ */
@ -341,7 +341,7 @@ public class ConfigureForm extends Form
} }
/** /**
* Sets the maximum payload size in bytes * Sets the maximum payload size in bytes.
* *
* @param max The maximum payload size * @param max The maximum payload size
*/ */
@ -352,7 +352,7 @@ public class ConfigureForm extends Form
} }
/** /**
* Gets the node type * Gets the node type.
* *
* @return The node type * @return The node type
*/ */
@ -367,7 +367,7 @@ public class ConfigureForm extends Form
} }
/** /**
* Sets the node type * Sets the node type.
* *
* @param type The node type * @param type The node type
*/ */

View File

@ -30,7 +30,7 @@ import org.jivesoftware.smackx.xdata.Form;
public enum ConfigureNodeFields public enum ConfigureNodeFields
{ {
/** /**
* Determines who may subscribe and retrieve items * Determines who may subscribe and retrieve items.
* *
* <p><b>Value: {@link AccessModel}</b></p> * <p><b>Value: {@link AccessModel}</b></p>
*/ */
@ -39,14 +39,14 @@ public enum ConfigureNodeFields
/** /**
* The URL of an XSL transformation which can be applied to * The URL of an XSL transformation which can be applied to
* payloads in order to generate an appropriate message * payloads in order to generate an appropriate message
* body element * body element.
* *
* <p><b>Value: {@link URL}</b></p> * <p><b>Value: {@link URL}</b></p>
*/ */
body_xslt, body_xslt,
/** /**
* The collection with which a node is affiliated * The collection with which a node is affiliated.
* *
* <p><b>Value: String</b></p> * <p><b>Value: String</b></p>
*/ */
@ -63,21 +63,21 @@ public enum ConfigureNodeFields
dataform_xslt, dataform_xslt,
/** /**
* Whether to deliver payloads with event notifications * Whether to deliver payloads with event notifications.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
deliver_payloads, deliver_payloads,
/** /**
* Whether owners or publisher should receive replies to items * Whether owners or publisher should receive replies to items.
* *
* <p><b>Value: {@link ItemReply}</b></p> * <p><b>Value: {@link ItemReply}</b></p>
*/ */
itemreply, itemreply,
/** /**
* Who may associate leaf nodes with a collection * Who may associate leaf nodes with a collection.
* *
* <p><b>Value: {@link ChildrenAssociationPolicy}</b></p> * <p><b>Value: {@link ChildrenAssociationPolicy}</b></p>
*/ */
@ -85,14 +85,14 @@ public enum ConfigureNodeFields
/** /**
* The list of JIDs that may associate leaf nodes with a * The list of JIDs that may associate leaf nodes with a
* collection * collection.
* *
* <p><b>Value: List of JIDs as Strings</b></p> * <p><b>Value: List of JIDs as Strings</b></p>
*/ */
children_association_whitelist, children_association_whitelist,
/** /**
* The child nodes (leaf or collection) associated with a collection * The child nodes (leaf or collection) associated with a collection.
* *
* <p><b>Value: List of Strings</b></p> * <p><b>Value: List of Strings</b></p>
*/ */
@ -100,56 +100,56 @@ public enum ConfigureNodeFields
/** /**
* The maximum number of child nodes that can be associated with a * The maximum number of child nodes that can be associated with a
* collection * collection.
* *
* <p><b>Value: int</b></p> * <p><b>Value: int</b></p>
*/ */
children_max, children_max,
/** /**
* The maximum number of items to persist * The maximum number of items to persist.
* *
* <p><b>Value: int</b></p> * <p><b>Value: int</b></p>
*/ */
max_items, max_items,
/** /**
* The maximum payload size in bytes * The maximum payload size in bytes.
* *
* <p><b>Value: int</b></p> * <p><b>Value: int</b></p>
*/ */
max_payload_size, max_payload_size,
/** /**
* Whether the node is a leaf (default) or collection * Whether the node is a leaf (default) or collection.
* *
* <p><b>Value: {@link NodeType}</b></p> * <p><b>Value: {@link NodeType}</b></p>
*/ */
node_type, node_type,
/** /**
* Whether to notify subscribers when the node configuration changes * Whether to notify subscribers when the node configuration changes.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
notify_config, notify_config,
/** /**
* Whether to notify subscribers when the node is deleted * Whether to notify subscribers when the node is deleted.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
notify_delete, notify_delete,
/** /**
* Whether to notify subscribers when items are removed from the node * Whether to notify subscribers when items are removed from the node.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
notify_retract, notify_retract,
/** /**
* Whether to persist items to storage. This is required to have multiple * Whether to persist items to storage. This is required to have. multiple
* items in the node. * items in the node.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
@ -157,49 +157,49 @@ public enum ConfigureNodeFields
persist_items, persist_items,
/** /**
* Whether to deliver notifications to available users only * Whether to deliver notifications to available users only.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
presence_based_delivery, presence_based_delivery,
/** /**
* Defines who can publish to the node * Defines who can publish to the node.
* *
* <p><b>Value: {@link PublishModel}</b></p> * <p><b>Value: {@link PublishModel}</b></p>
*/ */
publish_model, publish_model,
/** /**
* The specific multi-user chat rooms to specify for replyroom * The specific multi-user chat rooms to specify for replyroom.
* *
* <p><b>Value: List of JIDs as Strings</b></p> * <p><b>Value: List of JIDs as Strings</b></p>
*/ */
replyroom, replyroom,
/** /**
* The specific JID(s) to specify for replyto * The specific JID(s) to specify for replyto.
* *
* <p><b>Value: List of JIDs as Strings</b></p> * <p><b>Value: List of JIDs as Strings</b></p>
*/ */
replyto, replyto,
/** /**
* The roster group(s) allowed to subscribe and retrieve items * The roster group(s) allowed to subscribe and retrieve items.
* *
* <p><b>Value: List of strings</b></p> * <p><b>Value: List of strings</b></p>
*/ */
roster_groups_allowed, roster_groups_allowed,
/** /**
* Whether to allow subscriptions * Whether to allow subscriptions.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
subscribe, subscribe,
/** /**
* A friendly name for the node * A friendly name for the node.
* *
* <p><b>Value: String</b></p> * <p><b>Value: String</b></p>
*/ */
@ -208,7 +208,7 @@ public enum ConfigureNodeFields
/** /**
* The type of node data, ussually specified by the namespace * The type of node data, ussually specified by the namespace
* of the payload(if any);MAY be a list-single rather than a * of the payload(if any);MAY be a list-single rather than a
* text single * text single.
* *
* <p><b>Value: String</b></p> * <p><b>Value: String</b></p>
*/ */

View File

@ -24,21 +24,21 @@ package org.jivesoftware.smackx.pubsub;
*/ */
public enum EventElementType public enum EventElementType
{ {
/** A node has been associated or dissassociated with a collection node */ /** A node has been associated or dissassociated with a collection node. */
collection, collection,
/** A node has had its configuration changed */ /** A node has had its configuration changed. */
configuration, configuration,
/** A node has been deleted */ /** A node has been deleted. */
delete, delete,
/** Items have been published to a node */ /** Items have been published to a node. */
items, items,
/** All items have been purged from a node */ /** All items have been purged from a node. */
purge, purge,
/** A node has been subscribed to */ /** A node has been subscribed to. */
subscription subscription
} }

View File

@ -27,16 +27,16 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace;
*/ */
public enum FormNodeType public enum FormNodeType
{ {
/** Form for configuring an existing node */ /** Form for configuring an existing node. */
CONFIGURE_OWNER, CONFIGURE_OWNER,
/** Form for configuring a node during creation */ /** Form for configuring a node during creation. */
CONFIGURE, CONFIGURE,
/** Form for configuring subscription options */ /** Form for configuring subscription options. */
OPTIONS, OPTIONS,
/** Form which represents the default node configuration options */ /** Form which represents the default node configuration options. */
DEFAULT; DEFAULT;
public PubSubElementType getNodeElement() public PubSubElementType getNodeElement()

View File

@ -24,9 +24,9 @@ package org.jivesoftware.smackx.pubsub;
*/ */
public enum ItemReply public enum ItemReply
{ {
/** The node owner */ /** The node owner. */
owner, owner,
/** The item publisher */ /** The item publisher. */
publisher; publisher;
} }

View File

@ -40,10 +40,10 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
public enum ItemsElementType public enum ItemsElementType
{ {
/** An items element, which has an optional <b>max_items</b> attribute when requesting items */ /** An items element, which has an optional <b>max_items</b> attribute when requesting items. */
items(PubSubElementType.ITEMS, "max_items"), items(PubSubElementType.ITEMS, "max_items"),
/** A retract element, which has an optional <b>notify</b> attribute when publishing deletions */ /** A retract element, which has an optional <b>notify</b> attribute when publishing deletions. */
retract(PubSubElementType.RETRACT, "notify"); retract(PubSubElementType.RETRACT, "notify");
private PubSubElementType elem; private PubSubElementType elem;
@ -115,7 +115,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
} }
/** /**
* Get the type of element * Get the type of element.
* *
* @return The element type * @return The element type
*/ */

View File

@ -80,7 +80,7 @@ abstract public class Node
} }
/** /**
* Get the NodeId * Get the NodeId.
* *
* @return the node id * @return the node id
*/ */
@ -107,7 +107,7 @@ abstract public class Node
} }
/** /**
* Update the configuration with the contents of the new {@link Form} * Update the configuration with the contents of the new {@link Form}.
* *
* @param submitForm * @param submitForm
* @throws XMPPErrorException * @throws XMPPErrorException

View File

@ -56,7 +56,7 @@ public class NodeExtension implements ExtensionElement
} }
/** /**
* Gets the node id * Gets the node id.
* *
* @return The node id * @return The node id
*/ */

View File

@ -17,7 +17,7 @@
package org.jivesoftware.smackx.pubsub; package org.jivesoftware.smackx.pubsub;
/** /**
* Defines the available types of nodes * Defines the available types of nodes.
* *
* @author Robin Collier * @author Robin Collier
*/ */

View File

@ -268,7 +268,7 @@ final public class PubSubManager
} }
/** /**
* Delete the specified node * Delete the specified node.
* *
* @param nodeId * @param nodeId
* @throws XMPPErrorException * @throws XMPPErrorException

View File

@ -24,12 +24,12 @@ package org.jivesoftware.smackx.pubsub;
*/ */
public enum PublishModel public enum PublishModel
{ {
/** Only publishers may publish */ /** Only publishers may publish. */
publishers, publishers,
/** Only subscribers may publish */ /** Only subscribers may publish. */
subscribers, subscribers,
/** Anyone may publish */ /** Anyone may publish. */
open; open;
} }

View File

@ -98,7 +98,7 @@ public class SubscribeForm extends Form
} }
/** /**
* Gets the minimum number of milliseconds between sending notification digests * Gets the minimum number of milliseconds between sending notification digests.
* *
* @return The frequency in milliseconds * @return The frequency in milliseconds
*/ */
@ -108,7 +108,7 @@ public class SubscribeForm extends Form
} }
/** /**
* Sets the minimum number of milliseconds between sending notification digests * Sets the minimum number of milliseconds between sending notification digests.
* *
* @param frequency The frequency in milliseconds * @param frequency The frequency in milliseconds
*/ */

View File

@ -27,7 +27,7 @@ import java.util.Calendar;
public enum SubscribeOptionFields public enum SubscribeOptionFields
{ {
/** /**
* Whether an entity wants to receive or disable notifications * Whether an entity wants to receive or disable notifications.
* *
* <p><b>Value: boolean</b></p> * <p><b>Value: boolean</b></p>
*/ */
@ -42,14 +42,14 @@ public enum SubscribeOptionFields
digest, digest,
/** /**
* The minimum number of seconds between sending any two notifications digests * The minimum number of seconds between sending any two notifications digests.
* *
* <p><b>Value: int</b></p> * <p><b>Value: int</b></p>
*/ */
digest_frequency, digest_frequency,
/** /**
* * Expire.
* <p><b>Value: {@link Calendar}</b></p> * <p><b>Value: {@link Calendar}</b></p>
*/ */
expire, expire,
@ -70,14 +70,15 @@ public enum SubscribeOptionFields
show_values, show_values,
/** /**
* * Subscription type.
* *
* <p><b>Value: </b></p> * <p><b>Value: </b></p>
*/ */
subscription_type, subscription_type,
/** /**
* * Subscription depth.
*
* <p><b>Value: </b></p> * <p><b>Value: </b></p>
*/ */
subscription_depth; subscription_depth;

View File

@ -94,7 +94,7 @@ public class Subscription extends NodeExtension
} }
/** /**
* Gets the JID the subscription is created for * Gets the JID the subscription is created for.
* *
* @return The JID * @return The JID
*/ */
@ -104,7 +104,7 @@ public class Subscription extends NodeExtension
} }
/** /**
* Gets the subscription id * Gets the subscription id.
* *
* @return The subscription id * @return The subscription id
*/ */
@ -124,7 +124,7 @@ public class Subscription extends NodeExtension
} }
/** /**
* This value is only relevant when the {@link #getState()} is {@link State#unconfigured} * This value is only relevant when the {@link #getState()} is {@link State#unconfigured}.
* *
* @return true if configuration is required, false otherwise * @return true if configuration is required, false otherwise
*/ */

View File

@ -29,7 +29,7 @@ public class SubscriptionsExtension extends NodeExtension
protected List<Subscription> items = Collections.emptyList(); protected List<Subscription> items = Collections.emptyList();
/** /**
* Subscriptions to the root node * Subscriptions to the root node.
* *
* @param subList The list of subscriptions * @param subList The list of subscriptions
*/ */

View File

@ -90,7 +90,7 @@ public class DeliveryReceiptManager extends Manager {
public enum AutoReceiptMode { public enum AutoReceiptMode {
/** /**
* Never send deliver receipts * Never send deliver receipts.
*/ */
disabled, disabled,
@ -183,7 +183,7 @@ public class DeliveryReceiptManager extends Manager {
} }
/** /**
* Returns true if Delivery Receipts are supported by a given JID * Returns true if Delivery Receipts are supported by a given JID.
* *
* @param jid * @param jid
* @return true if supported * @return true if supported

View File

@ -99,7 +99,7 @@ public class ReportedData {
} }
/** /**
* Adds a new <code>Column</code> * Adds a new <code>Column</code>.
* @param column the column to add. * @param column the column to add.
*/ */
public void addColumn(Column column){ public void addColumn(Column column){

View File

@ -75,7 +75,7 @@ public class UserSearchManager {
/** /**
* Submits a search form to the server and returns the resulting information * Submits a search form to the server and returns the resulting information
* in the form of <code>ReportedData</code> * in the form of <code>ReportedData</code>.
* *
* @param searchForm the <code>Form</code> to submit for searching. * @param searchForm the <code>Form</code> to submit for searching.
* @param searchService the name of the search service to use. * @param searchService the name of the search service to use.

View File

@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
import org.jivesoftware.smack.util.XmlStringBuilder; import org.jivesoftware.smack.util.XmlStringBuilder;
/** /**
* Represents a <b>Header</b> entry as specified by the <a href="http://xmpp.org/extensions/xep-031.html">Stanza Headers and Internet Metadata (SHIM)</a> * Represents a <b>Header</b> entry as specified by the <a href="http://xmpp.org/extensions/xep-031.html">Stanza Headers and Internet Metadata (SHIM)</a>.
* @author Robin Collier * @author Robin Collier
*/ */

Some files were not shown because too many files have changed in this diff Show More