mirror of
https://github.com/vanitasvitae/Smack.git
synced 2025-09-09 17:19:39 +02:00
Enable javadoc checkstyle
and fix violations.
This commit is contained in:
Florian Schmaus
parent
57260b2a44
commit
64d134052d
198 changed files with 529 additions and 501 deletions
|
|
@ -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 {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
|
@ -217,7 +217,7 @@ public class EntityCapsManager extends Manager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set the persistent cache implementation
|
||||
* Set the persistent cache implementation.
|
||||
*
|
||||
* @param cache
|
||||
*/
|
||||
|
|
@ -226,7 +226,7 @@ public class EntityCapsManager extends Manager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the maximum cache sizes
|
||||
* Sets the maximum cache sizes.
|
||||
*
|
||||
* @param maxJidToNodeVerSize
|
||||
* @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
|
||||
* @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.
|
||||
* @throws XMPPErrorException
|
||||
|
|
@ -524,7 +524,7 @@ public class EntityCapsManager extends Manager {
|
|||
|
||||
/**
|
||||
* 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
|
||||
* 5.4 Processing Method</a>
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
|
|||
|
||||
public interface EntityCapsPersistentCache {
|
||||
/**
|
||||
* Add an DiscoverInfo to the persistent Cache
|
||||
* Add an DiscoverInfo to the persistent Cache.
|
||||
*
|
||||
* @param nodeVer
|
||||
* @param info
|
||||
|
|
@ -28,12 +28,12 @@ public interface EntityCapsPersistentCache {
|
|||
void addDiscoverInfoByNodePersistent(String nodeVer, DiscoverInfo info);
|
||||
|
||||
/**
|
||||
* Lookup DiscoverInfo by a Node string
|
||||
* Lookup DiscoverInfo by a Node string.
|
||||
*/
|
||||
DiscoverInfo lookup(String nodeVer);
|
||||
|
||||
/**
|
||||
* Empty the Cache
|
||||
* Empty the Cache.
|
||||
*/
|
||||
void emptyCache();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -56,6 +56,8 @@ public class CapsExtension implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}.
|
||||
*
|
||||
* <pre>
|
||||
* <c xmlns='http://jabber.org/protocol/caps'
|
||||
* hash='sha-1'
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
|
@ -137,7 +137,7 @@ public class AdHocCommandData extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the identifier of the command
|
||||
* Returns the identifier of the command.
|
||||
*
|
||||
* @return the node.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
|
|||
import org.jivesoftware.smackx.delay.packet.DelayInformation;
|
||||
|
||||
/**
|
||||
* Delayed Delivery (XEP-203)
|
||||
* Delayed Delivery (XEP-203).
|
||||
*
|
||||
* @author Florian Schmaus
|
||||
* @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
|
||||
* @return the Delayed Delivery timestamp or <code>null</code>
|
||||
|
|
|
|||
|
|
@ -108,7 +108,8 @@ public class DelayInformation implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Return delay information from the given stanza.
|
||||
*
|
||||
* @param packet
|
||||
* @return the DelayInformation or null
|
||||
* @deprecated use {@link #from(Stanza)} instead
|
||||
|
|
@ -119,7 +120,8 @@ public class DelayInformation implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Return delay information from the given stanza.
|
||||
*
|
||||
* @param packet
|
||||
* @return the DelayInformation or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -23,9 +23,6 @@ import org.jivesoftware.smackx.disco.packet.DiscoverItems;
|
|||
import java.util.List;
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
public abstract class AbstractNodeInformationProvider implements NodeInformationProvider {
|
||||
|
||||
public List<DiscoverItems.Item> getNodeItems() {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -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>
|
||||
* @return the data form
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
|
|||
}
|
||||
|
||||
/**
|
||||
* Copy constructor
|
||||
* Copy constructor.
|
||||
*
|
||||
* @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
|
||||
*/
|
||||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -391,7 +391,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
|
|||
/**
|
||||
* Check equality for Identity for category, type, lang and name
|
||||
* 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) {
|
||||
|
|
|
|||
|
|
@ -288,7 +288,7 @@ public abstract class FileTransfer {
|
|||
complete("Complete"),
|
||||
|
||||
/**
|
||||
* The file transfer was cancelled
|
||||
* The file transfer was cancelled.
|
||||
*/
|
||||
cancelled("Cancelled");
|
||||
|
||||
|
|
@ -313,7 +313,7 @@ public abstract class FileTransfer {
|
|||
|
||||
public enum Error {
|
||||
/**
|
||||
* No error
|
||||
* 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."),
|
||||
|
||||
/**
|
||||
* 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.");
|
||||
|
||||
|
|
|
|||
|
|
@ -438,7 +438,7 @@ public class OutgoingFileTransfer extends FileTransfer {
|
|||
public interface NegotiationProgress {
|
||||
|
||||
/**
|
||||
* Called when the status changes
|
||||
* Called when the status changes.
|
||||
*
|
||||
* @param oldStatus the previous status of the file transfer.
|
||||
* @param newStatus the new status of the file transfer.
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ public class Forwarded implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Get the forwarded extension.
|
||||
* @param packet
|
||||
* @return the Forwarded extension or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* @return true if Last Activity is supported, otherwise false
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ public class Version extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Request version IQ
|
||||
* Request version IQ.
|
||||
*
|
||||
* @param to the jid where to request version from
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
|
|||
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>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ package org.jivesoftware.smackx.muc;
|
|||
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>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ public class GroupChatInvitation implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Deprecated.
|
||||
* @param packet
|
||||
* @return the GroupChatInvitation or null
|
||||
* @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
|
||||
* @return the GroupChatInvitation or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ public class Nick implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* The value of this nickname
|
||||
* The value of this 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
|
||||
* the name to set
|
||||
|
|
|
|||
|
|
@ -17,15 +17,12 @@
|
|||
|
||||
package org.jivesoftware.smackx.pep.provider;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
import org.jivesoftware.smack.SmackException;
|
||||
import org.jivesoftware.smack.packet.ExtensionElement;
|
||||
import org.jivesoftware.smack.provider.ExtensionElementProvider;
|
||||
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.
|
||||
* @return a PacketExtension.
|
||||
* @throws IOException
|
||||
* @throws XmlPullParserException
|
||||
* @throws SmackException
|
||||
* @throws Exception
|
||||
*/
|
||||
@Override
|
||||
public ExtensionElement parse(XmlPullParser parser, int initialDepth)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
* @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
|
||||
*/
|
||||
|
|
@ -297,7 +297,7 @@ public class PingManager extends Manager {
|
|||
}
|
||||
|
||||
/**
|
||||
* Unregister a PingFailedListener
|
||||
* Unregister a PingFailedListener.
|
||||
*
|
||||
* @param listener the listener to remove
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -18,24 +18,24 @@ package org.jivesoftware.smackx.pubsub;
|
|||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public enum AccessModel
|
||||
{
|
||||
/** Anyone may subscribe and retrieve items */
|
||||
/** Anyone may subscribe and retrieve items. */
|
||||
open,
|
||||
|
||||
/** Subscription request must be approved and only subscribers may retrieve items */
|
||||
/** Subscription request must be approved and only subscribers may retrieve items. */
|
||||
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,
|
||||
|
||||
/** 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,
|
||||
|
||||
/** Only those on a whitelist may subscribe and retrieve items */
|
||||
/** Only those on a whitelist may subscribe and retrieve items. */
|
||||
whitelist;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,13 +18,13 @@ package org.jivesoftware.smackx.pubsub;
|
|||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public enum ChildrenAssociationPolicy
|
||||
{
|
||||
/** Anyone may associate leaf nodes with the collection */
|
||||
/** Anyone may associate leaf nodes with the collection. */
|
||||
all,
|
||||
|
||||
/** Only collection node owners may associate leaf nodes with the collection. */
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -352,7 +352,7 @@ public class ConfigureForm extends Form
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets the node type
|
||||
* Gets 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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import org.jivesoftware.smackx.xdata.Form;
|
|||
public enum ConfigureNodeFields
|
||||
{
|
||||
/**
|
||||
* Determines who may subscribe and retrieve items
|
||||
* Determines who may subscribe and retrieve items.
|
||||
*
|
||||
* <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
|
||||
* payloads in order to generate an appropriate message
|
||||
* body element
|
||||
* body element.
|
||||
*
|
||||
* <p><b>Value: {@link URL}</b></p>
|
||||
*/
|
||||
body_xslt,
|
||||
|
||||
/**
|
||||
* The collection with which a node is affiliated
|
||||
* The collection with which a node is affiliated.
|
||||
*
|
||||
* <p><b>Value: String</b></p>
|
||||
*/
|
||||
|
|
@ -63,21 +63,21 @@ public enum ConfigureNodeFields
|
|||
dataform_xslt,
|
||||
|
||||
/**
|
||||
* Whether to deliver payloads with event notifications
|
||||
* Whether to deliver payloads with event notifications.
|
||||
*
|
||||
* <p><b>Value: boolean</b></p>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
itemreply,
|
||||
|
||||
/**
|
||||
* Who may associate leaf nodes with a collection
|
||||
* Who may associate leaf nodes with a collection.
|
||||
*
|
||||
* <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
|
||||
* collection
|
||||
* collection.
|
||||
*
|
||||
* <p><b>Value: List of JIDs as Strings</b></p>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
|
|
@ -100,56 +100,56 @@ public enum ConfigureNodeFields
|
|||
|
||||
/**
|
||||
* The maximum number of child nodes that can be associated with a
|
||||
* collection
|
||||
* collection.
|
||||
*
|
||||
* <p><b>Value: int</b></p>
|
||||
*/
|
||||
children_max,
|
||||
|
||||
/**
|
||||
* The maximum number of items to persist
|
||||
* The maximum number of items to persist.
|
||||
*
|
||||
* <p><b>Value: int</b></p>
|
||||
*/
|
||||
max_items,
|
||||
|
||||
/**
|
||||
* The maximum payload size in bytes
|
||||
* The maximum payload size in bytes.
|
||||
*
|
||||
* <p><b>Value: int</b></p>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* <p><b>Value: boolean</b></p>
|
||||
|
|
@ -157,49 +157,49 @@ public enum ConfigureNodeFields
|
|||
persist_items,
|
||||
|
||||
/**
|
||||
* Whether to deliver notifications to available users only
|
||||
* Whether to deliver notifications to available users only.
|
||||
*
|
||||
* <p><b>Value: boolean</b></p>
|
||||
*/
|
||||
presence_based_delivery,
|
||||
|
||||
/**
|
||||
* Defines who can publish to the node
|
||||
* Defines who can publish to the node.
|
||||
*
|
||||
* <p><b>Value: {@link PublishModel}</b></p>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
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>
|
||||
*/
|
||||
roster_groups_allowed,
|
||||
|
||||
/**
|
||||
* Whether to allow subscriptions
|
||||
* Whether to allow subscriptions.
|
||||
*
|
||||
* <p><b>Value: boolean</b></p>
|
||||
*/
|
||||
subscribe,
|
||||
|
||||
/**
|
||||
* A friendly name for the node
|
||||
* A friendly name for the node.
|
||||
*
|
||||
* <p><b>Value: String</b></p>
|
||||
*/
|
||||
|
|
@ -208,7 +208,7 @@ public enum ConfigureNodeFields
|
|||
/**
|
||||
* The type of node data, ussually specified by the namespace
|
||||
* of the payload(if any);MAY be a list-single rather than a
|
||||
* text single
|
||||
* text single.
|
||||
*
|
||||
* <p><b>Value: String</b></p>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -24,21 +24,21 @@ package org.jivesoftware.smackx.pubsub;
|
|||
*/
|
||||
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,
|
||||
|
||||
/** A node has had its configuration changed */
|
||||
/** A node has had its configuration changed. */
|
||||
configuration,
|
||||
|
||||
/** A node has been deleted */
|
||||
/** A node has been deleted. */
|
||||
delete,
|
||||
|
||||
/** Items have been published to a node */
|
||||
/** Items have been published to a node. */
|
||||
items,
|
||||
|
||||
/** All items have been purged from a node */
|
||||
/** All items have been purged from a node. */
|
||||
purge,
|
||||
|
||||
/** A node has been subscribed to */
|
||||
/** A node has been subscribed to. */
|
||||
subscription
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,16 +27,16 @@ import org.jivesoftware.smackx.pubsub.packet.PubSubNamespace;
|
|||
*/
|
||||
public enum FormNodeType
|
||||
{
|
||||
/** Form for configuring an existing node */
|
||||
/** Form for configuring an existing node. */
|
||||
CONFIGURE_OWNER,
|
||||
|
||||
/** Form for configuring a node during creation */
|
||||
/** Form for configuring a node during creation. */
|
||||
CONFIGURE,
|
||||
|
||||
/** Form for configuring subscription options */
|
||||
/** Form for configuring subscription options. */
|
||||
OPTIONS,
|
||||
|
||||
/** Form which represents the default node configuration options */
|
||||
/** Form which represents the default node configuration options. */
|
||||
DEFAULT;
|
||||
|
||||
public PubSubElementType getNodeElement()
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ package org.jivesoftware.smackx.pubsub;
|
|||
*/
|
||||
public enum ItemReply
|
||||
{
|
||||
/** The node owner */
|
||||
/** The node owner. */
|
||||
owner,
|
||||
|
||||
/** The item publisher */
|
||||
/** The item publisher. */
|
||||
publisher;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -40,10 +40,10 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
|
|||
|
||||
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"),
|
||||
|
||||
/** 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");
|
||||
|
||||
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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ abstract public class Node
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the NodeId
|
||||
* Get the NodeId.
|
||||
*
|
||||
* @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
|
||||
* @throws XMPPErrorException
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ public class NodeExtension implements ExtensionElement
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets the node id
|
||||
* Gets the node id.
|
||||
*
|
||||
* @return The node id
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
package org.jivesoftware.smackx.pubsub;
|
||||
|
||||
/**
|
||||
* Defines the available types of nodes
|
||||
* Defines the available types of nodes.
|
||||
*
|
||||
* @author Robin Collier
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -268,7 +268,7 @@ final public class PubSubManager
|
|||
}
|
||||
|
||||
/**
|
||||
* Delete the specified node
|
||||
* Delete the specified node.
|
||||
*
|
||||
* @param nodeId
|
||||
* @throws XMPPErrorException
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ package org.jivesoftware.smackx.pubsub;
|
|||
*/
|
||||
public enum PublishModel
|
||||
{
|
||||
/** Only publishers may publish */
|
||||
/** Only publishers may publish. */
|
||||
publishers,
|
||||
|
||||
/** Only subscribers may publish */
|
||||
/** Only subscribers may publish. */
|
||||
subscribers,
|
||||
|
||||
/** Anyone may publish */
|
||||
/** Anyone may publish. */
|
||||
open;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import java.util.Calendar;
|
|||
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>
|
||||
*/
|
||||
|
|
@ -42,14 +42,14 @@ public enum SubscribeOptionFields
|
|||
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>
|
||||
*/
|
||||
digest_frequency,
|
||||
|
||||
/**
|
||||
*
|
||||
* Expire.
|
||||
* <p><b>Value: {@link Calendar}</b></p>
|
||||
*/
|
||||
expire,
|
||||
|
|
@ -70,14 +70,15 @@ public enum SubscribeOptionFields
|
|||
show_values,
|
||||
|
||||
/**
|
||||
*
|
||||
* Subscription type.
|
||||
*
|
||||
* <p><b>Value: </b></p>
|
||||
*/
|
||||
subscription_type,
|
||||
|
||||
/**
|
||||
*
|
||||
* Subscription depth.
|
||||
*
|
||||
* <p><b>Value: </b></p>
|
||||
*/
|
||||
subscription_depth;
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
@ -104,7 +104,7 @@ public class Subscription extends NodeExtension
|
|||
}
|
||||
|
||||
/**
|
||||
* Gets the subscription id
|
||||
* Gets 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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ public class SubscriptionsExtension extends NodeExtension
|
|||
protected List<Subscription> items = Collections.emptyList();
|
||||
|
||||
/**
|
||||
* Subscriptions to the root node
|
||||
* Subscriptions to the root node.
|
||||
*
|
||||
* @param subList The list of subscriptions
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ public class DeliveryReceiptManager extends Manager {
|
|||
public enum AutoReceiptMode {
|
||||
|
||||
/**
|
||||
* Never send deliver receipts
|
||||
* Never send deliver receipts.
|
||||
*/
|
||||
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
|
||||
* @return true if supported
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
public void addColumn(Column column){
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ public class UserSearchManager {
|
|||
|
||||
/**
|
||||
* 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 searchService the name of the search service to use.
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
|
|||
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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import org.jivesoftware.smack.packet.ExtensionElement;
|
|||
import org.jivesoftware.smack.util.XmlStringBuilder;
|
||||
|
||||
/**
|
||||
* Extension representing a list of headers as specified in <a href="http://xmpp.org/extensions/xep-0131">Stanza Headers and Internet Metadata (SHIM)</a>
|
||||
* Extension representing a list of headers as specified in <a href="http://xmpp.org/extensions/xep-0131">Stanza Headers and Internet Metadata (SHIM)</a>.
|
||||
*
|
||||
* @see Header
|
||||
*
|
||||
|
|
|
|||
|
|
@ -243,7 +243,7 @@ public class StreamInitiation extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Sets the MD5 sum of the file's contents
|
||||
* Sets the MD5 sum of the file's contents.
|
||||
*
|
||||
* @param hash The MD5 sum of the file's contents.
|
||||
*/
|
||||
|
|
@ -252,7 +252,7 @@ public class StreamInitiation extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the MD5 sum of the file's contents
|
||||
* Returns the MD5 sum of the file's contents.
|
||||
*
|
||||
* @return Returns the MD5 sum of the file's contents
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -247,7 +247,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get home address field
|
||||
* Get home address field.
|
||||
*
|
||||
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
|
||||
* LOCALITY, REGION, PCODE, CTRY
|
||||
|
|
@ -257,7 +257,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set home address field
|
||||
* Set home address field.
|
||||
*
|
||||
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
|
||||
* LOCALITY, REGION, PCODE, CTRY
|
||||
|
|
@ -267,7 +267,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get work address field
|
||||
* Get work address field.
|
||||
*
|
||||
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
|
||||
* LOCALITY, REGION, PCODE, CTRY
|
||||
|
|
@ -277,7 +277,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set work address field
|
||||
* Set work address field.
|
||||
*
|
||||
* @param addrField one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET,
|
||||
* LOCALITY, REGION, PCODE, CTRY
|
||||
|
|
@ -288,7 +288,7 @@ public class VCard extends IQ {
|
|||
|
||||
|
||||
/**
|
||||
* Set home phone number
|
||||
* Set home phone number.
|
||||
*
|
||||
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
|
||||
* @param phoneNum phone number
|
||||
|
|
@ -298,7 +298,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get home phone number
|
||||
* Get home phone number.
|
||||
*
|
||||
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
|
||||
*/
|
||||
|
|
@ -307,7 +307,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set work phone number
|
||||
* Set work phone number.
|
||||
*
|
||||
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
|
||||
* @param phoneNum phone number
|
||||
|
|
@ -317,7 +317,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get work phone number
|
||||
* Get work phone number.
|
||||
*
|
||||
* @param phoneType one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
|
||||
*/
|
||||
|
|
@ -343,7 +343,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Removes the avatar from the vCard
|
||||
* Removes the avatar from the vCard.
|
||||
*
|
||||
* This is done by setting the PHOTO value to the empty string as defined in XEP-0153
|
||||
*/
|
||||
|
|
@ -436,7 +436,7 @@ public class VCard extends IQ {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the MIME Type of the avatar or null if none is set
|
||||
* Returns the MIME Type of the avatar or null if none is set.
|
||||
*
|
||||
* @return the MIME Type of the avatar or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ public class FormField implements NamedElement {
|
|||
public static final String ELEMENT = "field";
|
||||
|
||||
/**
|
||||
* The constant String "FORM_TYPE"
|
||||
* The constant String "FORM_TYPE".
|
||||
*/
|
||||
public static final String FORM_TYPE = "FORM_TYPE";
|
||||
|
||||
|
|
@ -58,17 +58,17 @@ public class FormField implements NamedElement {
|
|||
bool,
|
||||
|
||||
/**
|
||||
* Fixed for putting in text to show sections, or just advertise your web site in the middle of the form
|
||||
* Fixed for putting in text to show sections, or just advertise your web site in the middle of the form.
|
||||
*/
|
||||
fixed,
|
||||
|
||||
/**
|
||||
* Is not given to the user at all, but returned with the questionnaire
|
||||
* Is not given to the user at all, but returned with the questionnaire.
|
||||
*/
|
||||
hidden,
|
||||
|
||||
/**
|
||||
* multiple entries for JIDs
|
||||
* multiple entries for JIDs.
|
||||
*/
|
||||
jid_multi,
|
||||
|
||||
|
|
@ -244,6 +244,8 @@ public class FormField implements NamedElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get validate element.
|
||||
*
|
||||
* @return the validateElement
|
||||
*/
|
||||
public ValidateElement getValidateElement() {
|
||||
|
|
@ -283,6 +285,7 @@ public class FormField implements NamedElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* Set validate element.
|
||||
* @param validateElement the validateElement to set
|
||||
*/
|
||||
public void setValidateElement(ValidateElement validateElement) {
|
||||
|
|
|
|||
|
|
@ -301,7 +301,7 @@ public class DataForm implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Get data form from stanza.
|
||||
* @param packet
|
||||
* @return the DataForm or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -40,6 +40,7 @@ public class DataLayout implements ExtensionElement {
|
|||
private final String label;
|
||||
|
||||
/**
|
||||
* Data layout constructor.
|
||||
* @param label
|
||||
*/
|
||||
public DataLayout(String label) {
|
||||
|
|
@ -116,6 +117,7 @@ public class DataLayout implements ExtensionElement {
|
|||
private final String var;
|
||||
|
||||
/**
|
||||
* Field ref constructor.
|
||||
* @param var reference to a field
|
||||
*/
|
||||
public Fieldref(String var) {
|
||||
|
|
@ -152,6 +154,7 @@ public class DataLayout implements ExtensionElement {
|
|||
private final String label;
|
||||
|
||||
/**
|
||||
* Section constructor.
|
||||
* @param label
|
||||
*/
|
||||
public Section(String label) {
|
||||
|
|
@ -226,6 +229,7 @@ public class DataLayout implements ExtensionElement {
|
|||
private final String text;
|
||||
|
||||
/**
|
||||
* Text constructor.
|
||||
* @param text reference to a field
|
||||
*/
|
||||
public Text(String text) {
|
||||
|
|
|
|||
|
|
@ -32,6 +32,7 @@ public class ValidationConsistencyException extends IllegalArgumentException {
|
|||
private static final long serialVersionUID = 1L;
|
||||
|
||||
/**
|
||||
* Validation consistency exception constructor.
|
||||
* @param message
|
||||
*/
|
||||
public ValidationConsistencyException(String message) {
|
||||
|
|
|
|||
|
|
@ -98,6 +98,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
protected abstract void appendXML(XmlStringBuilder buf);
|
||||
|
||||
/**
|
||||
* Set list range.
|
||||
* @param listRange the listRange to set
|
||||
*/
|
||||
public void setListRange(ListRange listRange) {
|
||||
|
|
@ -105,6 +106,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get list range.
|
||||
* @return the listRange
|
||||
*/
|
||||
public ListRange getListRange() {
|
||||
|
|
@ -112,7 +114,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
}
|
||||
|
||||
/**
|
||||
* Check if this element is consistent according to the business rules in XEP=0122
|
||||
* Check if this element is consistent according to the business rules in XEP=0122.
|
||||
*
|
||||
* @param formField
|
||||
*/
|
||||
|
|
@ -129,6 +131,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
public static final String METHOD = "basic";
|
||||
|
||||
/**
|
||||
* Basic validate element constructor.
|
||||
* @param dataType
|
||||
* @see #getDatatype()
|
||||
*/
|
||||
|
|
@ -170,6 +173,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
public static final String METHOD = "open";
|
||||
|
||||
/**
|
||||
* Open validate element constructor.
|
||||
* @param dataType
|
||||
* @see #getDatatype()
|
||||
*/
|
||||
|
|
@ -210,6 +214,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
private final String max;
|
||||
|
||||
/**
|
||||
* Range validate element constructor.
|
||||
* @param dataType
|
||||
* @param min the minimum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use.
|
||||
* @param max the maximum allowable value. This attribute is OPTIONAL. The value depends on the datatype in use.
|
||||
|
|
@ -273,6 +278,7 @@ public abstract class ValidateElement implements ExtensionElement {
|
|||
private final String regex;
|
||||
|
||||
/**
|
||||
* Regex validate element.
|
||||
* @param dataType
|
||||
* @param regex
|
||||
* @see #getDatatype()
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ public class InBandBytestreamManagerTest extends InitExtensions {
|
|||
/**
|
||||
* Test that
|
||||
* {@link InBandBytestreamManager#getByteStreamManager(XMPPConnection)} returns
|
||||
* one bytestream manager for every connection
|
||||
* one bytestream manager for every connection.
|
||||
*/
|
||||
@Test
|
||||
public void shouldHaveOneManagerForEveryConnection() {
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ public class Socks5ByteStreamManagerTest {
|
|||
|
||||
/**
|
||||
* Test that {@link Socks5BytestreamManager#getBytestreamManager(XMPPConnection)} returns one
|
||||
* bytestream manager for every connection
|
||||
* bytestream manager for every connection.
|
||||
*/
|
||||
@Test
|
||||
public void shouldHaveOneManagerForEveryConnection() {
|
||||
|
|
|
|||
|
|
@ -248,7 +248,7 @@ public class Socks5ClientTest {
|
|||
}
|
||||
|
||||
/**
|
||||
* The SOCKS5 client should successfully connect to the SOCKS5 server
|
||||
* The SOCKS5 client should successfully connect to the SOCKS5 server.
|
||||
*
|
||||
* @throws Exception should not happen
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ import org.junit.Test;
|
|||
public class Socks5ProxyTest {
|
||||
|
||||
/**
|
||||
* The SOCKS5 proxy should be a singleton used by all XMPP connections
|
||||
* The SOCKS5 proxy should be a singleton used by all XMPP connections.
|
||||
*/
|
||||
@Test
|
||||
public void shouldBeASingleton() {
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ public class Socks5TestProxy {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the local SOCKS5 proxy server
|
||||
* Returns the local SOCKS5 proxy server.
|
||||
*
|
||||
* @param port of the test proxy
|
||||
* @return the local SOCKS5 proxy server
|
||||
|
|
@ -83,7 +83,7 @@ public class Socks5TestProxy {
|
|||
}
|
||||
|
||||
/**
|
||||
* Stops the test proxy
|
||||
* Stops the test proxy.
|
||||
*/
|
||||
public static synchronized void stopProxy() {
|
||||
if (socks5Server != null) {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ public class EntityCapsManagerTest extends InitExtensions {
|
|||
|
||||
/**
|
||||
* <a href="http://xmpp.org/extensions/xep-0115.html#ver-gen-complex">XEP-
|
||||
* 0115 Complex Generation Example</a>
|
||||
* 0115 Complex Generation Example</a>.
|
||||
* @throws XmppStringprepException
|
||||
*/
|
||||
@Test
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ import org.junit.Test;
|
|||
import org.jxmpp.stringprep.XmppStringprepException;
|
||||
|
||||
/**
|
||||
*
|
||||
* Configure form test.
|
||||
* @author Robin Collier
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import org.junit.Test;
|
|||
import org.xmlpull.v1.XmlPullParser;
|
||||
|
||||
/**
|
||||
*
|
||||
* Item validation test.
|
||||
* @author Robin Collier
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ import org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement.RegexValid
|
|||
import org.junit.Test;
|
||||
|
||||
/**
|
||||
*
|
||||
* Data validation helper test.
|
||||
* @author Anno van Vliet
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import org.xmlpull.v1.XmlPullParser;
|
|||
import org.xmlpull.v1.XmlPullParserException;
|
||||
|
||||
/**
|
||||
*
|
||||
* Data validation test.
|
||||
* @author Anno van Vliet
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue