vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-10 01:29:38 +02:00
Code Issues Releases Wiki Activity

Enable werror for javadoc and fix javadoc issues

Browse source
This commit is contained in:
Florian Schmaus 2019-08-30 12:08:30 +02:00
parent 4249c1a845
commit 1a3067c89b
323 changed files with 2929 additions and 2704 deletions
Download patch file Download diff file Expand all files Collapse all files

2
smack-extensions/src/integration-test/java/org/jivesoftware/smackx/GroupChatInvitationTest.java
View file

@ -34,7 +34,7 @@ public class GroupChatInvitationTest extends SmackTestCase {
/**
* Constructor for GroupChatInvitationTest.
* @param arg0
* @param arg0 TODO javadoc me please
*/
public GroupChatInvitationTest(String arg0) {
super(arg0);

2
smack-extensions/src/integration-test/java/org/jivesoftware/smackx/RosterExchangeManagerTest.java
View file

@ -35,7 +35,7 @@ public class RosterExchangeManagerTest extends SmackTestCase {
/**
* Constructor for RosterExchangeManagerTest.
* @param name
* @param name TODO javadoc me please
*/
public RosterExchangeManagerTest(String name) {
super(name);

2
smack-extensions/src/integration-test/java/org/jivesoftware/smackx/XHTMLManagerTest.java
View file

@ -36,7 +36,7 @@ public class XHTMLManagerTest extends SmackTestCase {
/**
* Constructor for XHTMLManagerTest.
* @param name
* @param name TODO javadoc me please
*/
public XHTMLManagerTest(String name) {
super(name);

2
smack-extensions/src/integration-test/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ByteStreamTest.java
View file

@ -48,7 +48,7 @@ public class Socks5ByteStreamTest extends SmackTestCase {
/**
* Constructor
*
* @param arg0
* @param arg0 TODO javadoc me please
*/
public Socks5ByteStreamTest(String arg0) {
super(arg0);

2
smack-extensions/src/integration-test/java/org/jivesoftware/smackx/muc/MultiUserChatCreationTest.java
View file

@ -36,7 +36,7 @@ public class MultiUserChatCreationTest extends SmackTestCase {
/**
* Constructor for MultiUserChatCreationTest.
* @param arg0
* @param arg0 TODO javadoc me please
*/
public MultiUserChatCreationTest(String arg0) {
super(arg0);

2
smack-extensions/src/main/java/org/jivesoftware/smack/chat2/ChatManager.java
View file

@ -264,7 +264,7 @@ public final class ChatManager extends Manager {
/**
* Also notify about messages containing XHTML-IM.
*
* @param xhtmlIm
* @param xhtmlIm TODO javadoc me please
*/
public void setXhmtlImEnabled(boolean xhtmlIm) {
this.xhtmlIm = xhtmlIm;

24
smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientManager.java
View file

@ -67,8 +67,8 @@ public class MultipleRecipientManager {
* @throws XMPPErrorException if server does not support XEP-33: Extended Stanza Addressing and
* some XEP-33 specific features were requested.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static void send(XMPPConnection connection, Stanza packet, Collection<? extends Jid> to,
Collection<? extends Jid> cc, Collection<? extends Jid> bcc) throws NoResponseException, XMPPErrorException,
@ -98,8 +98,8 @@ public class MultipleRecipientManager {
* @throws NoResponseException if there was no response from the server.
* @throws FeatureNotSupportedException if special XEP-33 features where requested, but the
* server does not support them.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static void send(XMPPConnection connection, Stanza packet, Collection<? extends Jid> to, Collection<? extends Jid> cc, Collection<? extends Jid> bcc,
Jid replyTo, Jid replyRoom, boolean noReply) throws NoResponseException, XMPPErrorException, FeatureNotSupportedException, NotConnectedException, InterruptedException {
@ -139,11 +139,11 @@ public class MultipleRecipientManager {
* @param connection the connection to use to send the reply.
* @param original the previously received stanza that was sent to multiple recipients.
* @param reply the new message to send as a reply.
* @throws XMPPErrorException
* @throws InterruptedException
* @throws NotConnectedException
* @throws FeatureNotSupportedException
* @throws NoResponseException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws FeatureNotSupportedException if a requested feature is not supported by the remote entity.
* @throws NoResponseException if there was no response from the remote entity.
*/
public static void reply(XMPPConnection connection, Message original, Message reply)
throws XMPPErrorException, InterruptedException, NotConnectedException, NoResponseException, FeatureNotSupportedException {
@ -280,9 +280,9 @@ public class MultipleRecipientManager {
* queried.
* @return the address of the multiple recipients service or <code>null</code> if none was found.
* @throws NoResponseException if there was no response from the server.
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private static DomainBareJid getMultipleRecipientServiceAddress(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPDeliverCondition.java
View file

@ -31,10 +31,10 @@ public class AMPDeliverCondition implements AMPExtension.Condition {
* Check if server supports deliver condition.
* @param connection Smack connection instance
* @return true if deliver condition is supported.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return AMPManager.isConditionSupported(connection, NAME);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPExpireAtCondition.java
View file

@ -36,10 +36,10 @@ public class AMPExpireAtCondition implements AMPExtension.Condition {
* Check if server supports expire-at condition.
* @param connection Smack connection instance
* @return true if expire-at condition is supported.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return AMPManager.isConditionSupported(connection, NAME);

16
smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPManager.java
View file

@ -85,10 +85,10 @@ public class AMPManager {
* @param connection active xmpp connection
* @param action action to check
* @return true if this action is supported.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static boolean isActionSupported(XMPPConnection connection, AMPExtension.Action action) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
String featureName = AMPExtension.NAMESPACE + "?action=" + action.toString();
@ -100,10 +100,10 @@ public class AMPManager {
* @param connection active xmpp connection
* @param conditionName name of condition to check
* @return true if this condition is supported.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see AMPDeliverCondition
* @see AMPExpireAtCondition
* @see AMPMatchResourceCondition

8
smack-extensions/src/main/java/org/jivesoftware/smackx/amp/AMPMatchResourceCondition.java
View file

@ -31,10 +31,10 @@ public class AMPMatchResourceCondition implements AMPExtension.Condition {
* Check if server supports match-resource condition.
* @param connection Smack connection instance
* @return true if match-resource condition is supported.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return AMPManager.isConditionSupported(connection, NAME);

4
smack-extensions/src/main/java/org/jivesoftware/smackx/amp/provider/AMPExtensionProvider.java
View file

@ -38,8 +38,8 @@ public class AMPExtensionProvider extends ExtensionElementProvider<AMPExtension>
*
* @param parser the XML parser, positioned at the starting element of the extension.
* @return a PacketExtension.
* @throws IOException
* @throws XmlPullParserException
* @throws IOException if an I/O error occured.
* @throws XmlPullParserException if an error in the XML parser occured.
*/
@Override
public AMPExtension parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment)

46
smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/BlockingCommandManager.java
View file

@ -72,7 +72,7 @@ public final class BlockingCommandManager extends Manager {
/**
* Get the singleton instance of BlockingCommandManager.
*
* @param connection
* @param connection TODO javadoc me please
* @return the instance of BlockingCommandManager
*/
public static synchronized BlockingCommandManager getInstanceFor(XMPPConnection connection) {
@ -161,10 +161,10 @@ public final class BlockingCommandManager extends Manager {
* Returns true if Blocking Command is supported by the server.
*
* @return true if Blocking Command is supported by the server.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isSupportedByServer()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -175,10 +175,10 @@ public final class BlockingCommandManager extends Manager {
* Returns the block list.
*
* @return the blocking list
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Jid> getBlockList()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -195,11 +195,11 @@ public final class BlockingCommandManager extends Manager {
/**
* Block contacts.
*
* @param jids
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @param jids TODO javadoc me please
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void blockContacts(List<Jid> jids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -210,11 +210,11 @@ public final class BlockingCommandManager extends Manager {
/**
* Unblock contacts.
*
* @param jids
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @param jids TODO javadoc me please
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void unblockContacts(List<Jid> jids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -225,10 +225,10 @@ public final class BlockingCommandManager extends Manager {
/**
* Unblock all.
*
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void unblockAll()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

2
smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockContactsIQ.java
View file

@ -49,7 +49,7 @@ public class BlockContactsIQ extends IQ {
/**
* Block list IQ constructor.
*
* @param jids
* @param jids TODO javadoc me please
*/
public BlockContactsIQ(List<Jid> jids) {
super(ELEMENT, NAMESPACE);

2
smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockListIQ.java
View file

@ -50,7 +50,7 @@ public class BlockListIQ extends IQ {
/**
* Block list IQ constructor.
*
* @param jids
* @param jids TODO javadoc me please
*/
public BlockListIQ(List<Jid> jids) {
super(ELEMENT, NAMESPACE);

2
smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/BlockedErrorExtension.java
View file

@ -65,7 +65,7 @@ public class BlockedErrorExtension implements ExtensionElement {
* message was blocked because the JID blocked the sender, and that was
* reflected back as an error message.
*
* @param message
* @param message TODO javadoc me please
* @return true if the message contains a BlockedErrorExtension, false if
* not
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/blocking/element/UnblockContactsIQ.java
View file

@ -50,7 +50,7 @@ public class UnblockContactsIQ extends IQ {
/**
* Unblock contacts IQ constructor.
*
* @param jids
* @param jids TODO javadoc me please
*/
public UnblockContactsIQ(List<Jid> jids) {
super(ELEMENT, NAMESPACE);

6
smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBData.java
View file

@ -42,9 +42,9 @@ public class BoBData {
/**
* BoB data constructor.
*
* @param type
* @param content
* @param maxAge
* @param type TODO javadoc me please
* @param content TODO javadoc me please
* @param maxAge TODO javadoc me please
*/
public BoBData(String type, byte[] content, int maxAge) {
this.type = type;

8
smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBHash.java
View file

@ -35,8 +35,8 @@ public class BoBHash {
/**
* BoB hash constructor.
*
* @param hash
* @param hashType
* @param hash TODO javadoc me please
* @param hashType TODO javadoc me please
*/
public BoBHash(String hash, String hashType) {
this.hash = StringUtils.requireNotNullNorEmpty(hash, "hash must not be null nor empty");
@ -97,7 +97,7 @@ public class BoBHash {
/**
* Get BoB hash from src attribute string.
*
* @param src
* @param src TODO javadoc me please
* @return the BoB hash
*/
public static BoBHash fromSrc(String src) {
@ -109,7 +109,7 @@ public class BoBHash {
/**
* Get BoB hash from cid attribute string.
*
* @param cid
* @param cid TODO javadoc me please
* @return the BoB hash
*/
public static BoBHash fromCid(String cid) {

24
smack-extensions/src/main/java/org/jivesoftware/smackx/bob/BoBManager.java
View file

@ -68,7 +68,7 @@ public final class BoBManager extends Manager {
/**
* Get the singleton instance of BoBManager.
*
* @param connection
* @param connection TODO javadoc me please
* @return the instance of BoBManager
*/
public static synchronized BoBManager getInstanceFor(XMPPConnection connection) {
@ -115,10 +115,10 @@ public final class BoBManager extends Manager {
* Returns true if Bits of Binary is supported by the server.
*
* @return true if Bits of Binary is supported by the server.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isSupportedByServer()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -128,14 +128,14 @@ public final class BoBManager extends Manager {
/**
* Request BoB data.
*
* @param to
* @param bobHash
* @param to TODO javadoc me please
* @param bobHash TODO javadoc me please
* @return the BoB data
* @throws NotLoggedInException
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotLoggedInException if the XMPP connection is not authenticated.
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public BoBData requestBoB(Jid to, BoBHash bobHash) throws NotLoggedInException, NoResponseException,
XMPPErrorException, NotConnectedException, InterruptedException {

6
smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBExtension.java
View file

@ -39,9 +39,9 @@ public class BoBExtension extends XHTMLExtension {
/**
* Bits of Binary extension constructor.
*
* @param bobHash
* @param alt
* @param paragraph
* @param bobHash TODO javadoc me please
* @param alt TODO javadoc me please
* @param paragraph TODO javadoc me please
*/
public BoBExtension(BoBHash bobHash, String alt, String paragraph) {
this.bobHash = bobHash;

6
smack-extensions/src/main/java/org/jivesoftware/smackx/bob/element/BoBIQ.java
View file

@ -47,8 +47,8 @@ public class BoBIQ extends IQ {
/**
* Bits of Binary IQ constructor.
*
* @param bobHash
* @param bobData
* @param bobHash TODO javadoc me please
* @param bobData TODO javadoc me please
*/
public BoBIQ(BoBHash bobHash, BoBData bobData) {
super(ELEMENT, NAMESPACE);
@ -59,7 +59,7 @@ public class BoBIQ extends IQ {
/**
* Bits of Binary IQ constructor.
*
* @param bobHash
* @param bobHash TODO javadoc me please
*/
public BoBIQ(BoBHash bobHash) {
this(bobHash, null);

36
smack-extensions/src/main/java/org/jivesoftware/smackx/bookmarks/BookmarkManager.java
View file

@ -87,10 +87,10 @@ public final class BookmarkManager {
* Returns all currently bookmarked conferences.
*
* @return returns all currently bookmarked conferences
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see BookmarkedConference
*/
public List<BookmarkedConference> getBookmarkedConferences() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -109,8 +109,8 @@ public final class BookmarkManager {
* @throws XMPPErrorException thrown when there is an issue retrieving the current bookmarks from
* the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void addBookmarkedConference(String name, EntityBareJid jid, boolean isAutoJoin,
Resourcepart nickname, String password) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -141,8 +141,8 @@ public final class BookmarkManager {
* @throws XMPPErrorException thrown when there is a problem with the connection attempting to
* retrieve the bookmarks or persist the bookmarks.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws IllegalArgumentException thrown when the conference being removed is a shared
* conference
*/
@ -168,8 +168,8 @@ public final class BookmarkManager {
* @return returns an unmodifiable collection of all bookmarked urls.
* @throws XMPPErrorException thrown when there is a problem retriving bookmarks from the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<BookmarkedURL> getBookmarkedURLs() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
retrieveBookmarks();
@ -185,8 +185,8 @@ public final class BookmarkManager {
* @throws XMPPErrorException thrown when there is an error retriving or saving bookmarks from or to
* the server
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void addBookmarkedURL(String URL, String name, boolean isRSS) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
retrieveBookmarks();
@ -213,8 +213,8 @@ public final class BookmarkManager {
* @throws XMPPErrorException thrown if there is an error retriving or saving bookmarks from or to
* the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void removeBookmarkedURL(String bookmarkURL) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
retrieveBookmarks();
@ -236,10 +236,10 @@ public final class BookmarkManager {
* Check if the service supports bookmarks using private data.
*
* @return true if the service supports private data, false otherwise.
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @see PrivateDataManager#isSupported()
* @since 4.2
*/

10
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/BytestreamRequest.java
View file

@ -57,17 +57,17 @@ public interface BytestreamRequest {
* @throws XMPPErrorException if an error occurred while accepting the bytestream request
* @throws InterruptedException if the thread was interrupted while waiting in a blocking
* operation
* @throws NotConnectedException
* @throws CouldNotConnectToAnyProvidedSocks5Host
* @throws NoSocks5StreamHostsProvided
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws CouldNotConnectToAnyProvidedSocks5Host if no connection to any provided stream host could be established
* @throws NoSocks5StreamHostsProvided if no stream host was provided.
*/
BytestreamSession accept() throws InterruptedException, XMPPErrorException, CouldNotConnectToAnyProvidedSocks5Host,
NotConnectedException, NoSocks5StreamHostsProvided;
/**
* Rejects the bytestream request by sending a reject error to the initiator.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
void reject() throws NotConnectedException, InterruptedException;

18
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamManager.java
View file

@ -401,7 +401,7 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* @throws XMPPException if the user doesn't support or accept in-band bytestreams, or if the
* user prefers smaller block sizes
* @throws SmackException if there was no response from the server.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
@Override
public InBandBytestreamSession establishSession(Jid targetJID) throws XMPPException, SmackException, InterruptedException {
@ -419,8 +419,8 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* @throws XMPPErrorException if the user doesn't support or accept in-band bytestreams, or if the
* user prefers smaller block sizes
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
@Override
public InBandBytestreamSession establishSession(Jid targetJID, String sessionID)
@ -445,8 +445,8 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* not accepted.
*
* @param request IQ stanza that should be answered with a not-acceptable error
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void replyRejectPacket(IQ request) throws NotConnectedException, InterruptedException {
IQ error = IQ.createErrorResponse(request, StanzaError.Condition.not_acceptable);
@ -458,8 +458,8 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* request is rejected because its block size is greater than the maximum allowed block size.
*
* @param request IQ stanza that should be answered with a resource-constraint error
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void replyResourceConstraintPacket(IQ request) throws NotConnectedException, InterruptedException {
IQ error = IQ.createErrorResponse(request, StanzaError.Condition.resource_constraint);
@ -471,8 +471,8 @@ public final class InBandBytestreamManager extends Manager implements Bytestream
* session could not be found.
*
* @param request IQ stanza that should be answered with a item-not-found error
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void replyItemNotFoundPacket(IQ request) throws NotConnectedException, InterruptedException {
IQ error = IQ.createErrorResponse(request, StanzaError.Condition.item_not_found);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamRequest.java
View file

@ -72,8 +72,8 @@ public class InBandBytestreamRequest implements BytestreamRequest {
* send/receive data.
*
* @return the session to send/receive data
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
@Override
public InBandBytestreamSession accept() throws NotConnectedException, InterruptedException {
@ -94,8 +94,8 @@ public class InBandBytestreamRequest implements BytestreamRequest {
/**
* Rejects the In-Band Bytestream request by sending a reject error to the
* initiator.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
@Override
public void reject() throws NotConnectedException, InterruptedException {

16
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/ibb/InBandBytestreamSession.java
View file

@ -168,8 +168,8 @@ public class InBandBytestreamSession implements BytestreamSession {
* This method is invoked if a request to close the In-Band Bytestream has been received.
*
* @param closeRequest the close request from the remote peer
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void closeByPeer(Close closeRequest) throws NotConnectedException, InterruptedException {
@ -636,8 +636,8 @@ public class InBandBytestreamSession implements BytestreamSession {
*
* @param data the data packet
* @throws IOException if an I/O error occurred while sending or if the stream is closed
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected abstract void writeToXML(DataPacketExtension data) throws IOException, NotConnectedException, InterruptedException;
@ -846,10 +846,10 @@ public class InBandBytestreamSession implements BytestreamSession {
/**
* Process IQ stanza.
* @param data
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotLoggedInException
* @param data TODO javadoc me please
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException if the XMPP connection is not authenticated.
*/
public void processIQPacket(Data data) throws NotConnectedException, InterruptedException, NotLoggedInException {
inputStream.dataPacketListener.processStanza(data);

28
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamManager.java
View file

@ -392,7 +392,7 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
/**
* Set whether or not the bytestream manager will annouce the local stream host(s), i.e. the local SOCKS5 proxy.
*
* @param announceLocalStreamHost
* @param announceLocalStreamHost TODO javadoc me please
* @see #isAnnouncingLocalStreamHostEnabled()
* @since 4.4.0
*/
@ -435,11 +435,11 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
* @return the Socket to send/receive data to/from the user
* @throws IOException if the bytestream could not be established
* @throws InterruptedException if the current thread was interrupted while waiting
* @throws XMPPException
* @throws NotConnectedException
* @throws NoResponseException
* @throws SmackMessageException
* @throws FeatureNotSupportedException
* @throws XMPPException if an XMPP protocol error was received.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the remote entity.
* @throws SmackMessageException if there was an error.
* @throws FeatureNotSupportedException if a requested feature is not supported by the remote entity.
*/
@Override
public Socks5BytestreamSession establishSession(Jid targetJID, String sessionID)
@ -540,10 +540,10 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
* @param targetJID the target JID
* @return <code>true</code> if the given target JID supports feature SOCKS5 Bytestream
* otherwise <code>false</code>
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private boolean supportsSocks5(Jid targetJID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(targetJID, Bytestream.NAMESPACE);
@ -556,8 +556,8 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
* @return list of JIDs of SOCKS5 proxies
* @throws XMPPErrorException if there was an error querying the XMPP server for SOCKS5 proxies
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Jid> determineProxies() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
XMPPConnection connection = connection();
@ -714,8 +714,8 @@ public final class Socks5BytestreamManager extends Manager implements Bytestream
* </p>
*
* @param packet Stanza that should be answered with a not-acceptable error
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void replyRejectPacket(IQ packet) throws NotConnectedException, InterruptedException {
StanzaError.Builder xmppError = StanzaError.getBuilder(StanzaError.Condition.not_acceptable);

18
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5BytestreamRequest.java
View file

@ -224,10 +224,10 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
*
* @return the socket to send/receive data
* @throws InterruptedException if the current thread was interrupted while waiting
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws CouldNotConnectToAnyProvidedSocks5Host
* @throws NoSocks5StreamHostsProvided
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws CouldNotConnectToAnyProvidedSocks5Host if no connection to any provided stream host could be established
* @throws NoSocks5StreamHostsProvided if no stream host was provided.
*/
@Override
public Socks5BytestreamSession accept() throws InterruptedException, XMPPErrorException,
@ -299,8 +299,8 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
/**
* Rejects the SOCKS5 Bytestream request by sending a reject error to the initiator.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
@Override
public void reject() throws NotConnectedException, InterruptedException {
@ -312,10 +312,10 @@ public class Socks5BytestreamRequest implements BytestreamRequest {
* XMPP exception.
*
* @param streamHosts the stream hosts.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws CouldNotConnectToAnyProvidedSocks5Host as expected result.
* @throws NoSocks5StreamHostsProvided
* @throws NoSocks5StreamHostsProvided if no stream host was provided.
*/
private void cancelRequest(Map<StreamHost, Exception> streamHostsExceptions)
throws NotConnectedException, InterruptedException, CouldNotConnectToAnyProvidedSocks5Host, NoSocks5StreamHostsProvided {

12
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Client.java
View file

@ -78,10 +78,10 @@ public class Socks5Client {
* @throws IOException if initializing the socket failed due to a network error
* @throws TimeoutException if connecting to SOCKS5 proxy timed out
* @throws InterruptedException if the current thread was interrupted while waiting
* @throws XMPPException
* @throws SmackMessageException
* @throws NotConnectedException
* @throws NoResponseException
* @throws XMPPException if an XMPP protocol error was received.
* @throws SmackMessageException if there was an error.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the remote entity.
*/
public Socket getSocket(int timeout) throws IOException, InterruptedException,
TimeoutException, XMPPException, SmackMessageException, NotConnectedException, NoResponseException {
@ -130,8 +130,8 @@ public class Socks5Client {
* supported by the Socks5Client.
*
* @param socket connected to a SOCKS5 proxy
* @throws IOException
* @throws SmackMessageException
* @throws IOException if an I/O error occured.
* @throws SmackMessageException if there was an error.
*/
protected void establish(Socket socket) throws IOException, SmackMessageException {

8
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5ClientForInitiator.java
View file

@ -107,10 +107,10 @@ public class Socks5ClientForInitiator extends Socks5Client {
/**
* Activates the SOCKS5 Bytestream by sending an XMPP SOCKS5 Bytestream activation stanza to the
* SOCKS5 proxy.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private void activate() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Bytestream activate = createStreamHostActivation();

2
smack-extensions/src/main/java/org/jivesoftware/smackx/bytestreams/socks5/Socks5Proxy.java
View file

@ -230,6 +230,8 @@ public class Socks5Proxy {
/**
* Starts the local SOCKS5 proxy server. If it is already running, this method does nothing.
*
* @return the server socket.
*/
public synchronized ServerSocket start() {
if (isRunning()) {

50
smack-extensions/src/main/java/org/jivesoftware/smackx/caps/EntityCapsManager.java
View file

@ -166,7 +166,7 @@ public final class EntityCapsManager extends Manager {
/**
* Set the default entity node that will be used for new EntityCapsManagers.
*
* @param entityNode
* @param entityNode TODO javadoc me please
*/
public static void setDefaultEntityNode(String entityNode) {
DEFAULT_ENTITY_NODE = entityNode;
@ -175,10 +175,10 @@ public final class EntityCapsManager extends Manager {
/**
* Add DiscoverInfo to the database.
*
* @param nodeVer
* @param nodeVer TODO javadoc me please
* The node and verification String (e.g.
* "http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w=").
* @param info
* @param info TODO javadoc me please
* DiscoverInfo for the specified node.
*/
static void addDiscoverInfoByNode(String nodeVer, DiscoverInfo info) {
@ -192,7 +192,7 @@ public final class EntityCapsManager extends Manager {
* Get the Node version (node#ver) of a JID. Returns a String or null if
* EntiyCapsManager does not have any information.
*
* @param jid
* @param jid TODO javadoc me please
* the user (Full JID)
* @return the node version (node#ver) or null
*/
@ -214,7 +214,7 @@ public final class EntityCapsManager extends Manager {
* the user has a node#ver associated with it and the node#ver has a
* discover info associated with it.
*
* @param user
* @param user TODO javadoc me please
* user name (Full JID)
* @return the discovered info
*/
@ -229,7 +229,7 @@ public final class EntityCapsManager extends Manager {
/**
* Retrieve DiscoverInfo for a specific node.
*
* @param nodeVer
* @param nodeVer TODO javadoc me please
* The node name (e.g.
* "http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w=").
* @return The corresponding DiscoverInfo or null if none is known.
@ -256,7 +256,7 @@ public final class EntityCapsManager extends Manager {
/**
* Set the persistent cache implementation.
*
* @param cache
* @param cache TODO javadoc me please
*/
public static void setPersistentCache(EntityCapsPersistentCache cache) {
persistentCache = cache;
@ -265,8 +265,8 @@ public final class EntityCapsManager extends Manager {
/**
* Sets the maximum cache sizes.
*
* @param maxJidToNodeVerSize
* @param maxCapsCacheSize
* @param maxJidToNodeVerSize TODO javadoc me please
* @param maxCapsCacheSize TODO javadoc me please
*/
public static void setMaxsCacheSizes(int maxJidToNodeVerSize, int maxCapsCacheSize) {
JID_TO_NODEVER_CACHE.setMaxCacheSize(maxJidToNodeVerSize);
@ -447,7 +447,7 @@ public final class EntityCapsManager extends Manager {
/**
* Remove a record telling what entity caps node a user has.
*
* @param user
* @param user TODO javadoc me please
* the user (Full JID)
*/
public static void removeUserCapsNode(Jid user) {
@ -484,12 +484,12 @@ public final class EntityCapsManager extends Manager {
/**
* Returns true if Entity Caps are supported by a given JID.
*
* @param jid
* @param jid TODO javadoc me please
* @return true if the entity supports Entity Capabilities.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean areEntityCapsSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return sdm.supportsFeature(jid, NAMESPACE);
@ -499,10 +499,10 @@ public final class EntityCapsManager extends Manager {
* Returns true if Entity Caps are supported by the local service/server.
*
* @return true if the user's server supports Entity Capabilities.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean areEntityCapsSupportedByServer() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return areEntityCapsSupported(connection().getXMPPServiceDomain());
@ -577,9 +577,9 @@ public final class EntityCapsManager extends Manager {
* @see <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0115
* 5.4 Processing Method</a>
*
* @param ver
* @param hash
* @param info
* @param ver TODO javadoc me please
* @param hash TODO javadoc me please
* @param info TODO javadoc me please
* @return true if it's valid and should be cache, false if not
*/
public static boolean verifyDiscoverInfoVersion(String ver, String hash, DiscoverInfo info) {
@ -605,7 +605,7 @@ public final class EntityCapsManager extends Manager {
/**
*
* @param info
* @param info TODO javadoc me please
* @return true if the stanza extensions is ill-formed
*/
protected static boolean verifyPacketExtensions(DiscoverInfo info) {
@ -637,8 +637,8 @@ public final class EntityCapsManager extends Manager {
* @see <a href="http://xmpp.org/extensions/xep-0115.html#ver">XEP-115
* Verification String</a>
*
* @param discoverInfo
* @param hash
* @param discoverInfo TODO javadoc me please
* @param hash TODO javadoc me please
* the used hash function, if null, default hash will be used
* @return The generated verification String or null if the hash is not
* supported

6
smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/EntityCapsPersistentCache.java vendored
View file

@ -22,14 +22,14 @@ public interface EntityCapsPersistentCache {
/**
* Add an DiscoverInfo to the persistent Cache.
*
* @param nodeVer
* @param info
* @param nodeVer TODO javadoc me please
* @param info TODO javadoc me please
*/
void addDiscoverInfoByNodePersistent(String nodeVer, DiscoverInfo info);
/**
* Lookup DiscoverInfo by a Node string.
* @param nodeVer
* @param nodeVer TODO javadoc me please
*
* @return DiscoverInfo.
*/

12
smack-extensions/src/main/java/org/jivesoftware/smackx/caps/cache/SimpleDirectoryPersistentCache.java vendored
View file

@ -53,7 +53,7 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache
* file systems, both case sensitive and case insensitive. It does however
* produce longer filenames.
*
* @param cacheDir
* @param cacheDir TODO javadoc me please
*/
public SimpleDirectoryPersistentCache(File cacheDir) {
this(cacheDir, Base32.getStringEncoder());
@ -125,9 +125,9 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache
/**
* Writes the DiscoverInfo stanza to an file
*
* @param file
* @param info
* @throws IOException
* @param file TODO javadoc me please
* @param info TODO javadoc me please
* @throws IOException if an I/O error occured.
*/
private static void writeInfoToFile(File file, DiscoverInfo info) throws IOException {
try (DataOutputStream dos = new DataOutputStream(new FileOutputStream(file))) {
@ -138,9 +138,9 @@ public class SimpleDirectoryPersistentCache implements EntityCapsPersistentCache
/**
* Tries to restore an DiscoverInfo stanza from a file.
*
* @param file
* @param file TODO javadoc me please
* @return the restored DiscoverInfo
* @throws Exception
* @throws Exception if an exception occurs.
*/
private static DiscoverInfo restoreInfoFromFile(File file) throws Exception {
String fileContent;

4
smack-extensions/src/main/java/org/jivesoftware/smackx/chatstates/ChatStateManager.java
View file

@ -208,8 +208,8 @@ public final class ChatStateManager extends Manager {
*
* @param newState the new state of the chat
* @param chat the chat.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void setCurrentState(ChatState newState, Chat chat) throws NotConnectedException, InterruptedException {
if (chat == null || newState == null) {

32
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommand.java
View file

@ -214,10 +214,10 @@ public abstract class AdHocCommand {
* command. It is invoked on every command. If there is a problem executing
* the command it throws an XMPPException.
*
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there is an error executing the command.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract void execute() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
@ -229,10 +229,10 @@ public abstract class AdHocCommand {
* XMPPException.
*
* @param response the form answer of the previous stage.
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there is a problem executing the command.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract void next(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
@ -245,10 +245,10 @@ public abstract class AdHocCommand {
*
* @param response the form answer of the previous stage.
*
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there is a problem executing the command.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract void complete(Form response) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
@ -258,10 +258,10 @@ public abstract class AdHocCommand {
* the previous one. If there is a problem executing the command it throws
* an XMPPException.
*
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there is a problem executing the command.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract void prev() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
@ -270,10 +270,10 @@ public abstract class AdHocCommand {
* the execution. If there is a problem executing the command it throws an
* XMPPException.
*
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there is a problem executing the command.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract void cancel() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException;
@ -369,7 +369,7 @@ public abstract class AdHocCommand {
* The {@link Action#cancel cancel} action is always allowed. To define the
* available actions use the <code>addActionAvailable</code> method.
*
* @param action
* @param action TODO javadoc me please
* The action to check if it is available.
* @return True if the action is available for the current stage.
*/

24
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/AdHocCommandManager.java
View file

@ -250,7 +250,7 @@ public final class AdHocCommandManager extends Manager {
* @return the discovered items.
* @throws XMPPException if the operation failed for some reason.
* @throws SmackException if there was no response from the server.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverItems discoverCommands(Jid jid) throws XMPPException, SmackException, InterruptedException {
return serviceDiscoveryManager.discoverItems(jid, NAMESPACE);
@ -291,11 +291,11 @@ public final class AdHocCommandManager extends Manager {
* <li>The action to execute is one of the available actions</li>
* </ul>
*
* @param requestData
* @param requestData TODO javadoc me please
* the stanza to process.
* @throws NotConnectedException
* @throws NoResponseException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the remote entity.
* @throws InterruptedException if the calling thread was interrupted.
*/
private IQ processAdHocCommand(AdHocCommandData requestData) throws NoResponseException, NotConnectedException, InterruptedException {
// Creates the response with the corresponding data
@ -555,7 +555,7 @@ public final class AdHocCommandManager extends Manager {
*
* @param response the response to send.
* @param condition the condition of the error.
* @throws NotConnectedException
* @throws NotConnectedException if the XMPP connection is not connected.
*/
private static IQ respondError(AdHocCommandData response,
StanzaError.Condition condition) {
@ -568,7 +568,7 @@ public final class AdHocCommandManager extends Manager {
* @param response the response to send.
* @param condition the condition of the error.
* @param specificCondition the adhoc command error condition.
* @throws NotConnectedException
* @throws NotConnectedException if the XMPP connection is not connected.
*/
private static IQ respondError(AdHocCommandData response, StanzaError.Condition condition,
AdHocCommand.SpecificErrorCondition specificCondition) {
@ -581,7 +581,7 @@ public final class AdHocCommandManager extends Manager {
*
* @param response the response to send.
* @param error the error to send.
* @throws NotConnectedException
* @throws NotConnectedException if the XMPP connection is not connected.
*/
private static IQ respondError(AdHocCommandData response, StanzaError.Builder error) {
response.setType(IQ.Type.error);
@ -596,10 +596,10 @@ public final class AdHocCommandManager extends Manager {
* @param sessionID the session id of this execution.
* @return the command instance to execute.
* @throws XMPPErrorException if there is problem creating the new instance.
* @throws SecurityException
* @throws NoSuchMethodException
* @throws InvocationTargetException
* @throws IllegalArgumentException
* @throws SecurityException if there was a security violation.
* @throws NoSuchMethodException if no such method is declared
* @throws InvocationTargetException if a reflection-based method or constructor invocation threw.
* @throws IllegalArgumentException if an illegal argument was given.
* @throws IllegalAccessException
* @throws InstantiationException
*/

8
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommandFactory.java
View file

@ -36,10 +36,10 @@ public interface LocalCommandFactory {
* @return a LocalCommand instance.
* @throws InstantiationException if creating an instance failed.
* @throws IllegalAccessException if creating an instance is not allowed.
* @throws SecurityException
* @throws NoSuchMethodException
* @throws InvocationTargetException
* @throws IllegalArgumentException
* @throws SecurityException if there was a security violation.
* @throws NoSuchMethodException if no such method is declared
* @throws InvocationTargetException if a reflection-based method or constructor invocation threw.
* @throws IllegalArgumentException if an illegal argument was given.
*/
LocalCommand getInstance() throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException;

8
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/RemoteCommand.java
View file

@ -97,8 +97,8 @@ public class RemoteCommand extends AdHocCommand {
* @param form the form answer of the previous stage.
* @throws XMPPErrorException if an error occurs.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void execute(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
executeAction(Action.execute, form);
@ -127,8 +127,8 @@ public class RemoteCommand extends AdHocCommand {
* @param form the form with the information.
* @throws XMPPErrorException if there is a problem executing the command.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private void executeAction(Action action, Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// TODO: Check that all the required fields of the form were filled, if

2
smack-extensions/src/main/java/org/jivesoftware/smackx/commands/packet/AdHocCommandData.java
View file

@ -230,7 +230,7 @@ public class AdHocCommandData extends IQ {
* href="http://xmpp.org/extensions/xep-0050.html#impl-session">XEP-0050 § 3.3 Session Lifetime</a>.
* </p>
*
* @param sessionID
* @param sessionID TODO javadoc me please
*/
public void setSessionID(String sessionID) {
this.sessionID = sessionID;

10
smack-extensions/src/main/java/org/jivesoftware/smackx/delay/DelayInformationManager.java
View file

@ -41,7 +41,7 @@ public class DelayInformationManager {
* <p>
* Prefer {@link #getDelayInformation(Stanza)} over this method for backwards compatibility.
* </p>
* @param packet
* @param packet TODO javadoc me please
* @return the Delayed Delivery information or <code>null</code>
*/
public static DelayInformation getXep203DelayInformation(Stanza packet) {
@ -53,7 +53,7 @@ public class DelayInformationManager {
* <p>
* Prefer {@link #getDelayInformation(Stanza)} over this method for backwards compatibility.
* </p>
* @param packet
* @param packet TODO javadoc me please
* @return the Delayed Delivery information or <code>null</code>
*/
public static DelayInformation getLegacyDelayInformation(Stanza packet) {
@ -64,7 +64,7 @@ public class DelayInformationManager {
* Get Delayed Delivery information. This method first looks for a PacketExtension with the
* XEP-203 namespace and falls back to the XEP-91 namespace.
*
* @param packet
* @param packet TODO javadoc me please
* @return the Delayed Delivery information or <code>null</code>
*/
public static DelayInformation getDelayInformation(Stanza packet) {
@ -78,7 +78,7 @@ public class DelayInformationManager {
/**
* Get the Delayed Delivery timestamp or <code>null</code>.
*
* @param packet
* @param packet TODO javadoc me please
* @return the Delayed Delivery timestamp or <code>null</code>
*/
public static Date getDelayTimestamp(Stanza packet) {
@ -92,7 +92,7 @@ public class DelayInformationManager {
/**
* Check if the given stanza is a delayed stanza as of XEP-203.
*
* @param packet
* @param packet TODO javadoc me please
* @return true if the stanza got delayed.
*/
public static boolean isDelayedStanza(Stanza packet) {

4
smack-extensions/src/main/java/org/jivesoftware/smackx/delay/packet/DelayInformation.java
View file

@ -115,7 +115,7 @@ public class DelayInformation implements ExtensionElement {
/**
* Return delay information from the given stanza.
*
* @param packet
* @param packet TODO javadoc me please
* @return the DelayInformation or null
* @deprecated use {@link #from(Stanza)} instead
*/
@ -127,7 +127,7 @@ public class DelayInformation implements ExtensionElement {
/**
* Return delay information from the given stanza.
*
* @param packet
* @param packet TODO javadoc me please
* @return the DelayInformation or null
*/
public static DelayInformation from(Stanza packet) {

98
smack-extensions/src/main/java/org/jivesoftware/smackx/disco/ServiceDiscoveryManager.java
View file

@ -104,7 +104,7 @@ public final class ServiceDiscoveryManager extends Manager {
* Set the default identity all new connections will have. If unchanged the default identity is an
* identity where category is set to 'client', type is set to 'pc' and name is set to 'Smack'.
*
* @param identity
* @param identity TODO javadoc me please
*/
public static void setDefaultIdentity(DiscoverInfo.Identity identity) {
defaultIdentity = identity;
@ -206,7 +206,7 @@ public final class ServiceDiscoveryManager extends Manager {
/**
* Sets the default identity the client will report.
*
* @param identity
* @param identity TODO javadoc me please
*/
public synchronized void setIdentity(Identity identity) {
this.identity = Objects.requireNonNull(identity, "Identity can not be null");
@ -239,7 +239,7 @@ public final class ServiceDiscoveryManager extends Manager {
/**
* Add an further identity to the client.
*
* @param identity
* @param identity TODO javadoc me please
*/
public synchronized void addIdentity(DiscoverInfo.Identity identity) {
identities.add(identity);
@ -252,7 +252,7 @@ public final class ServiceDiscoveryManager extends Manager {
* Remove an identity from the client. Note that the client needs at least one identity, the default identity, which
* can not be removed.
*
* @param identity
* @param identity TODO javadoc me please
* @return true, if successful. Otherwise the default identity was given.
*/
public synchronized boolean removeIdentity(DiscoverInfo.Identity identity) {
@ -425,7 +425,7 @@ public final class ServiceDiscoveryManager extends Manager {
* configure the extended info before logging to the server so that the
* information is already available if it is required upon login.
*
* @param info
* @param info TODO javadoc me please
* the data form that contains the extend service discovery
* information.
*/
@ -481,10 +481,10 @@ public final class ServiceDiscoveryManager extends Manager {
*
* @param entityID the address of the XMPP entity or null.
* @return the discovered information.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverInfo discoverInfo(Jid entityID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
if (entityID == null)
@ -518,8 +518,8 @@ public final class ServiceDiscoveryManager extends Manager {
* @return the discovered information.
* @throws XMPPErrorException if the operation failed for some reason.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverInfo discoverInfo(Jid entityID, String node) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Discover the entity's info
@ -540,8 +540,8 @@ public final class ServiceDiscoveryManager extends Manager {
* @return the discovered information.
* @throws XMPPErrorException if the operation failed for some reason.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverItems discoverItems(Jid entityID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return discoverItems(entityID, null);
@ -557,8 +557,8 @@ public final class ServiceDiscoveryManager extends Manager {
* @return the discovered items.
* @throws XMPPErrorException if the operation failed for some reason.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverItems discoverItems(Jid entityID, String node) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Discover the entity's items
@ -574,12 +574,12 @@ public final class ServiceDiscoveryManager extends Manager {
/**
* Returns true if the server supports the given feature.
*
* @param feature
* @param feature TODO javadoc me please
* @return true if the server supports the given feature.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.1
*/
public boolean serverSupportsFeature(CharSequence feature) throws NoResponseException, XMPPErrorException,
@ -604,10 +604,10 @@ public final class ServiceDiscoveryManager extends Manager {
*
* @param features the features to check
* @return <code>true</code> if all features are supported by the connection account, <code>false</code> otherwise
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.2
*/
public boolean accountSupportsFeatures(CharSequence... features)
@ -621,10 +621,10 @@ public final class ServiceDiscoveryManager extends Manager {
*
* @param features a collection of features
* @return <code>true</code> if all features are supported by the connection account, <code>false</code> otherwise
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.2
*/
public boolean accountSupportsFeatures(Collection<? extends CharSequence> features)
@ -637,12 +637,12 @@ public final class ServiceDiscoveryManager extends Manager {
* Queries the remote entity for it's features and returns true if the given feature is found.
*
* @param jid the JID of the remote entity
* @param feature
* @param feature TODO javadoc me please
* @return true if the entity supports the feature, false otherwise
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean supportsFeature(Jid jid, CharSequence feature) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return supportsFeatures(jid, feature);
@ -676,10 +676,10 @@ public final class ServiceDiscoveryManager extends Manager {
* @param stopOnFirst if true, stop searching after the first service was found
* @param useCache if true, query a cache first to avoid network I/O
* @return a possible empty list of services providing the given feature
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<DiscoverInfo> findServicesDiscoverInfo(String feature, boolean stopOnFirst, boolean useCache)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -694,10 +694,10 @@ public final class ServiceDiscoveryManager extends Manager {
* @param useCache if true, query a cache first to avoid network I/O
* @param encounteredExceptions an optional map which will be filled with the exceptions encountered
* @return a possible empty list of services providing the given feature
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.2
*/
public List<DiscoverInfo> findServicesDiscoverInfo(String feature, boolean stopOnFirst, boolean useCache, Map<? super Jid, Exception> encounteredExceptions)
@ -715,10 +715,10 @@ public final class ServiceDiscoveryManager extends Manager {
* @param useCache if true, query a cache first to avoid network I/O
* @param encounteredExceptions an optional map which will be filled with the exceptions encountered
* @return a possible empty list of services providing the given feature
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.3.0
*/
public List<DiscoverInfo> findServicesDiscoverInfo(DomainBareJid serviceName, String feature, boolean stopOnFirst,
@ -798,10 +798,10 @@ public final class ServiceDiscoveryManager extends Manager {
* @param stopOnFirst if true, stop searching after the first service was found
* @param useCache if true, query a cache first to avoid network I/O
* @return a possible empty list of services providing the given feature
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<DomainBareJid> findServices(String feature, boolean stopOnFirst, boolean useCache) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
List<DiscoverInfo> services = findServicesDiscoverInfo(feature, stopOnFirst, useCache);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java
View file

@ -61,7 +61,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
/**
* Copy constructor.
*
* @param d
* @param d TODO javadoc me please
*/
public DiscoverInfo(DiscoverInfo d) {
super(d);
@ -93,7 +93,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
/**
* Adds a collection of features to the packet. Does noting if featuresToAdd is null.
*
* @param featuresToAdd
* @param featuresToAdd TODO javadoc me please
*/
public void addFeatures(Collection<String> featuresToAdd) {
if (featuresToAdd == null) return;
@ -133,7 +133,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
/**
* Adds identities to the DiscoverInfo stanza.
*
* @param identitiesToAdd
* @param identitiesToAdd TODO javadoc me please
*/
public void addIdentities(Collection<Identity> identitiesToAdd) {
if (identitiesToAdd == null) return;
@ -422,7 +422,7 @@ public class DiscoverInfo extends IQ implements TypedCloneable<DiscoverInfo> {
* If all three are identical the other Identity is considered equal. Name is not used for
* comparison, as defined by XEP-0115
*
* @param other
* @param other TODO javadoc me please
* @return a negative integer, zero, or a positive integer as this object is less than,
* equal to, or greater than the specified object.
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverItems.java
View file

@ -59,7 +59,7 @@ public class DiscoverItems extends IQ {
/**
* Adds a collection of items to the discovered information. Does nothing if itemsToAdd is null
*
* @param itemsToAdd
* @param itemsToAdd TODO javadoc me please
*/
public void addItems(Collection<Item> itemsToAdd) {
if (itemsToAdd == null) return;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferListener.java
View file

@ -26,7 +26,7 @@ public interface FileTransferListener {
/**
* A request to send a file has been received from another user.
*
* @param request
* @param request TODO javadoc me please
* The request from the other user.
*/
void fileTransferRequest(FileTransferRequest request);

16
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferManager.java
View file

@ -65,7 +65,7 @@ public final class FileTransferManager extends Manager {
/**
* Creates a file transfer manager to initiate and receive file transfers.
*
* @param connection
* @param connection TODO javadoc me please
* The XMPPConnection that the file transfers will use.
*/
private FileTransferManager(XMPPConnection connection) {
@ -90,7 +90,7 @@ public final class FileTransferManager extends Manager {
* Add a file transfer listener to listen to incoming file transfer
* requests.
*
* @param li
* @param li TODO javadoc me please
* The listener
* @see #removeFileTransferListener(FileTransferListener)
* @see FileTransferListener
@ -102,7 +102,7 @@ public final class FileTransferManager extends Manager {
/**
* Removes a file transfer listener.
*
* @param li
* @param li TODO javadoc me please
* The file transfer listener to be removed
* @see FileTransferListener
*/
@ -113,7 +113,7 @@ public final class FileTransferManager extends Manager {
/**
* Creates an OutgoingFileTransfer to send a file to another user.
*
* @param userID
* @param userID TODO javadoc me please
* The fully qualified jabber ID (i.e. full JID) with resource of the user to
* send the file to.
* @return The send file object on which the negotiated transfer can be run.
@ -137,7 +137,7 @@ public final class FileTransferManager extends Manager {
* invoked. It will create an IncomingFileTransfer which allows the
* transmission of the file to proceed.
*
* @param request
* @param request TODO javadoc me please
* The remote request that is being accepted.
* @return The IncomingFileTransfer which manages the download of the file
* from the transfer initiator.
@ -160,9 +160,9 @@ public final class FileTransferManager extends Manager {
* <p>
* Specified in XEP-95 4.2 and 3.2 Example 8
* </p>
* @param request
* @throws NotConnectedException
* @throws InterruptedException
* @param request TODO javadoc me please
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
protected void rejectIncomingFileTransfer(FileTransferRequest request) throws NotConnectedException, InterruptedException {
StreamInitiation initiation = request.getStreamInitiation();

14
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferNegotiator.java
View file

@ -182,9 +182,9 @@ public final class FileTransferNegotiator extends Manager {
* @return The file transfer object that handles the transfer
* @throws NoStreamMethodsOfferedException If there are either no stream methods contained in the packet, or
* there is not an appropriate stream method.
* @throws NotConnectedException
* @throws NoAcceptableTransferMechanisms
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoAcceptableTransferMechanisms if no acceptable transfer mechanisms are available
* @throws InterruptedException if the calling thread was interrupted.
*/
public StreamNegotiator selectStreamNegotiator(
FileTransferRequest request) throws NotConnectedException, NoStreamMethodsOfferedException, NoAcceptableTransferMechanisms, InterruptedException {
@ -296,10 +296,10 @@ public final class FileTransferNegotiator extends Manager {
* user to respond. If they do not respond in time, this
* @return Returns the stream negotiator selected by the peer.
* @throws XMPPErrorException Thrown if there is an error negotiating the file transfer.
* @throws NotConnectedException
* @throws NoResponseException
* @throws NoAcceptableTransferMechanisms
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NoAcceptableTransferMechanisms if no acceptable transfer mechanisms are available
* @throws InterruptedException if the calling thread was interrupted.
*/
public StreamNegotiator negotiateOutgoingTransfer(final Jid userID,
final String streamID, final String fileName, final long size,

8
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/FileTransferRequest.java
View file

@ -37,10 +37,10 @@ public class FileTransferRequest {
* A receive request is constructed from the Stream Initiation request
* received from the initiator.
*
* @param manager
* @param manager TODO javadoc me please
* The manager handling this file transfer
*
* @param si
* @param si TODO javadoc me please
* The Stream initiation received from the initiator.
*/
public FileTransferRequest(FileTransferManager manager, StreamInitiation si) {
@ -131,8 +131,8 @@ public class FileTransferRequest {
/**
* Rejects the file transfer request.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void reject() throws NotConnectedException, InterruptedException {
manager.rejectIncomingFileTransfer(this);

6
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/IncomingFileTransfer.java
View file

@ -74,10 +74,10 @@ public class IncomingFileTransfer extends FileTransfer {
* the negotiated stream.
*
* @return The negotiated InputStream from which to read the data.
* @throws SmackException
* @throws SmackException if Smack detected an exceptional situation.
* @throws XMPPErrorException If there is an error in the negotiation process an exception
* is thrown.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
public InputStream receiveFile() throws SmackException, XMPPErrorException, InterruptedException {
if (inputStream != null) {
@ -110,7 +110,7 @@ public class IncomingFileTransfer extends FileTransfer {
*
* @param file The location to save the file.
* @throws SmackException when the file transfer fails
* @throws IOException
* @throws IOException if an I/O error occured.
* @throws IllegalArgumentException This exception is thrown when the the provided file is
* either null, or cannot be written to.
*/

22
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/OutgoingFileTransfer.java
View file

@ -63,7 +63,7 @@ public class OutgoingFileTransfer extends FileTransfer {
* Sets the time in milliseconds after which the file transfer negotiation
* process will timeout if the other user has not responded.
*
* @param responseTimeout
* @param responseTimeout TODO javadoc me please
* The timeout time in milliseconds.
*/
public static void setResponseTimeout(int responseTimeout) {
@ -108,21 +108,21 @@ public class OutgoingFileTransfer extends FileTransfer {
* This method handles the negotiation of the file transfer and the stream,
* it only returns the created stream after the negotiation has been completed.
*
* @param fileName
* @param fileName TODO javadoc me please
* The name of the file that will be transmitted. It is
* preferable for this name to have an extension as it will be
* used to determine the type of file it is.
* @param fileSize
* @param fileSize TODO javadoc me please
* The size in bytes of the file that will be transmitted.
* @param description
* @param description TODO javadoc me please
* A description of the file that will be transmitted.
* @return The OutputStream that is connected to the peer to transmit the
* file.
* @throws XMPPException
* @throws XMPPException if an XMPP protocol error was received.
* Thrown if an error occurs during the file transfer
* negotiation process.
* @throws SmackException if there was no response from the server.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
public synchronized OutputStream sendFile(String fileName, long fileSize,
String description) throws XMPPException, SmackException, InterruptedException {
@ -146,15 +146,15 @@ public class OutgoingFileTransfer extends FileTransfer {
* returns immediately and its progress will be updated through the
* {@link NegotiationProgress} callback.
*
* @param fileName
* @param fileName TODO javadoc me please
* The name of the file that will be transmitted. It is
* preferable for this name to have an extension as it will be
* used to determine the type of file it is.
* @param fileSize
* @param fileSize TODO javadoc me please
* The size in bytes of the file that will be transmitted.
* @param description
* @param description TODO javadoc me please
* A description of the file that will be transmitted.
* @param progress
* @param progress TODO javadoc me please
* A callback to monitor the progress of the file transfer
* negotiation process and to retrieve the OutputStream when it
* is complete.
@ -212,7 +212,7 @@ public class OutgoingFileTransfer extends FileTransfer {
*
* @param file the file to transfer to the remote entity.
* @param description a description for the file to transfer.
* @throws SmackException
* @throws SmackException if Smack detected an exceptional situation.
* If there is an error during the negotiation process or the
* sending of the file.
*/

8
smack-extensions/src/main/java/org/jivesoftware/smackx/filetransfer/StreamNegotiator.java
View file

@ -152,7 +152,7 @@ public abstract class StreamNegotiator extends Manager {
* @throws XMPPErrorException If an error occurs during this process an XMPPException is
* thrown.
* @throws InterruptedException If thread is interrupted.
* @throws SmackException
* @throws SmackException if Smack detected an exceptional situation.
*/
public abstract InputStream createIncomingStream(StreamInitiation initiation)
throws XMPPErrorException, InterruptedException, SmackException;
@ -168,9 +168,9 @@ public abstract class StreamNegotiator extends Manager {
* @param target The fully-qualified JID of the target or receiver of the file
* transfer.
* @return The negotiated stream ready for data.
* @throws SmackException
* @throws XMPPException
* @throws InterruptedException
* @throws SmackException if Smack detected an exceptional situation.
* @throws XMPPException if an XMPP protocol error was received.
* @throws InterruptedException if the calling thread was interrupted.
*/
public abstract OutputStream createOutgoingStream(String streamID,
Jid initiator, Jid target) throws SmackException, XMPPException, InterruptedException;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/forward/packet/Forwarded.java
View file

@ -111,7 +111,7 @@ public class Forwarded implements ExtensionElement {
/**
* Get the forwarded extension.
* @param packet
* @param packet TODO javadoc me please
* @return the Forwarded extension or null
*/
public static Forwarded from(Stanza packet) {

22
smack-extensions/src/main/java/org/jivesoftware/smackx/geoloc/GeoLocationManager.java
View file

@ -100,12 +100,12 @@ public final class GeoLocationManager extends Manager {
/**
* Send geolocation through the PubSub node.
*
* @param geoLocation
* @throws InterruptedException
* @throws NotConnectedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotALeafNodeException
* @param geoLocation TODO javadoc me please
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotALeafNodeException if a PubSub leaf node operation was attempted on a non-leaf node.
*/
public void sendGeolocation(GeoLocation geoLocation)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotALeafNodeException {
@ -115,11 +115,11 @@ public final class GeoLocationManager extends Manager {
/**
* Send empty geolocation through the PubSub node.
*
* @throws InterruptedException
* @throws NotConnectedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotALeafNodeException
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotALeafNodeException if a PubSub leaf node operation was attempted on a non-leaf node.
*/
public void stopPublishingGeolocation()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotALeafNodeException {

21
smack-extensions/src/main/java/org/jivesoftware/smackx/iqlast/LastActivityManager.java
View file

@ -76,7 +76,6 @@ import org.jxmpp.jid.Jid;
*
* To get the uptime of a host, you simple send the LastActivity stanza to it,
* as in the following code example:
* <p>
*
* <pre>
* LastActivity activity = LastActivity.getLastActivity(con, &quot;jabber.org&quot;);
@ -98,7 +97,7 @@ public final class LastActivityManager extends Manager {
/**
* Enable or disable Last Activity for new XMPPConnections.
*
* @param enabledPerDefault
* @param enabledPerDefault TODO javadoc me please
*/
public static void setEnabledPerDefault(boolean enabledPerDefault) {
LastActivityManager.enabledPerDefault = enabledPerDefault;
@ -127,7 +126,7 @@ public final class LastActivityManager extends Manager {
/**
* Creates a last activity manager to response last activity requests.
*
* @param connection
* @param connection TODO javadoc me please
* The XMPPConnection that the last activity requests will use.
*/
private LastActivityManager(XMPPConnection connection) {
@ -226,14 +225,14 @@ public final class LastActivityManager extends Manager {
* Moreover, when the jid is a server or component (e.g., a JID of the form
* 'host') the last activity is the uptime.
*
* @param jid
* @param jid TODO javadoc me please
* the JID of the user.
* @return the LastActivity stanza of the jid.
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* thrown if a server error has occured.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public LastActivity getLastActivity(Jid jid) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException {
@ -246,10 +245,10 @@ public final class LastActivityManager extends Manager {
*
* @param jid a JID to be tested for Last Activity support
* @return true if Last Activity is supported, otherwise false
* @throws NotConnectedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isLastActivitySupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, LastActivity.NAMESPACE);

24
smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/PrivateDataManager.java
View file

@ -154,10 +154,10 @@ public final class PrivateDataManager extends Manager {
* @param elementName the element name.
* @param namespace the namespace.
* @return the private data.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public PrivateData getPrivateData(final String elementName, final String namespace) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Create an IQ packet to get the private data.
@ -174,10 +174,10 @@ public final class PrivateDataManager extends Manager {
* element name and namespace, then the new private data will overwrite the old value.
*
* @param privateData the private data.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void setPrivateData(final PrivateData privateData) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Create an IQ packet to set the private data.
@ -207,10 +207,10 @@ public final class PrivateDataManager extends Manager {
* Check if the service supports private data.
*
* @return true if the service supports private data, false otherwise.
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @since 4.2
*/
public boolean isSupported() throws NoResponseException, NotConnectedException,

4
smack-extensions/src/main/java/org/jivesoftware/smackx/iqprivate/provider/PrivateDataProvider.java
View file

@ -41,8 +41,8 @@ public interface PrivateDataProvider {
*
* @param parser an XML parser.
* @return a new PrivateData instance.
* @throws XmlPullParserException
* @throws IOException
* @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException if an I/O error occured.
*/
PrivateData parsePrivateData(XmlPullParser parser) throws XmlPullParserException, IOException;
}

64
smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/AccountManager.java
View file

@ -70,7 +70,7 @@ public final class AccountManager extends Manager {
/**
* The default value used by new account managers for <code>allowSensitiveOperationOverInsecureConnection</code>.
*
* @param allow
* @param allow TODO javadoc me please
* @see #sensitiveOperationOverInsecureConnection(boolean)
* @since 4.1
*/
@ -87,7 +87,7 @@ public final class AccountManager extends Manager {
* unencrypted) connections.
* </p>
*
* @param allow
* @param allow TODO javadoc me please
* @since 4.1
*/
public void sensitiveOperationOverInsecureConnection(boolean allow) {
@ -131,10 +131,10 @@ public final class AccountManager extends Manager {
* behavior is to only create new accounts before having logged in to a server.
*
* @return true if the server support creating new accounts.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean supportsAccountCreation() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// TODO: Replace this body with isSupported() and possible deprecate this method.
@ -176,10 +176,10 @@ public final class AccountManager extends Manager {
* the user's email address.
*
* @return the required account attributes.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Set<String> getAccountAttributes() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
if (info == null) {
@ -200,10 +200,10 @@ public final class AccountManager extends Manager {
* @param name the name of the account attribute to return its value.
* @return the value of the account attribute or <code>null</code> if an account
* attribute wasn't found for the requested name.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public String getAccountAttribute(String name) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
if (info == null) {
@ -218,10 +218,10 @@ public final class AccountManager extends Manager {
* that will complete the registration process.
*
* @return the account creation instructions, or <code>null</code> if there are none.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public String getAccountInstructions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
if (info == null) {
@ -240,10 +240,10 @@ public final class AccountManager extends Manager {
*
* @param username the username.
* @param password the password.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void createAccount(Localpart username, String password) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Create a map for all the required attributes, but give them blank values.
@ -264,8 +264,8 @@ public final class AccountManager extends Manager {
* @param attributes the account attributes.
* @throws XMPPErrorException if an error occurs creating the account.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see #getAccountAttributes()
*/
public void createAccount(Localpart username, String password, Map<String, String> attributes)
@ -298,8 +298,8 @@ public final class AccountManager extends Manager {
* @throws IllegalStateException if not currently logged-in to the server.
* @throws XMPPErrorException if an error occurs when changing the password.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void changePassword(String newPassword) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
if (!connection().isSecureConnection() && !allowSensitiveOperationOverInsecureConnection) {
@ -322,8 +322,8 @@ public final class AccountManager extends Manager {
* @throws IllegalStateException if not currently logged-in to the server.
* @throws XMPPErrorException if an error occurs when deleting the account.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteAccount() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Map<String, String> attributes = new HashMap<>();
@ -356,10 +356,10 @@ public final class AccountManager extends Manager {
/**
* Gets the account registration info from the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
* @throws XMPPException if an error occurs.
* @throws SmackException if there was no response from the server.

10
smack-extensions/src/main/java/org/jivesoftware/smackx/iqversion/VersionManager.java
View file

@ -135,12 +135,12 @@ public final class VersionManager extends Manager {
/**
* Request version information from a given JID.
*
* @param jid
* @param jid TODO javadoc me please
* @return the version information or {@code null} if not supported by JID
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Version getVersion(Jid jid) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException {

5
smack-extensions/src/main/java/org/jivesoftware/smackx/jingle/element/JingleError.java
View file

@ -62,7 +62,10 @@ public final class JingleError implements ExtensionElement {
}
/**
* Returns a Action instance associated with the String value.
* Returns a error instance associated with the String value.
*
* @param value the input String.
* @return the jingle error instance associated with the input String.
*/
public static JingleError fromString(String value) {
value = value.toLowerCase(Locale.US);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/JivePropertiesManager.java
View file

@ -68,8 +68,8 @@ public class JivePropertiesManager {
* Convenience method to get a property from a packet. Will return null if the stanza contains
* not property with the given name.
*
* @param packet
* @param name
* @param packet TODO javadoc me please
* @param name TODO javadoc me please
* @return the property or <code>null</code> if none found.
*/
public static Object getProperty(Stanza packet, String name) {
@ -85,7 +85,7 @@ public class JivePropertiesManager {
* Return a collection of the names of all properties of the given packet. If the packet
* contains no properties extension, then an empty collection will be returned.
*
* @param packet
* @param packet TODO javadoc me please
* @return a collection of the names of all properties.
*/
public static Collection<String> getPropertiesNames(Stanza packet) {
@ -100,7 +100,7 @@ public class JivePropertiesManager {
* Return a map of all properties of the given packet. If the stanza contains no properties
* extension, an empty map will be returned.
*
* @param packet
* @param packet TODO javadoc me please
* @return a map of all properties of the given packet.
*/
public static Map<String, Object> getProperties(Stanza packet) {

4
smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/provider/JivePropertiesExtensionProvider.java
View file

@ -48,8 +48,8 @@ public class JivePropertiesExtensionProvider extends ExtensionElementProvider<Ji
*
* @param parser the XML parser, positioned at the start of a properties sub-packet.
* @return a map of the properties.
* @throws IOException
* @throws XmlPullParserException
* @throws IOException if an I/O error occured.
* @throws XmlPullParserException if an error in the XML parser occured.
*/
@Override
public JivePropertiesExtension parse(XmlPullParser parser,

28
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucConfigFormManager.java
View file

@ -83,10 +83,10 @@ public class MucConfigFormManager {
* </p>
*
* @param multiUserChat the MUC for this configuration form.
* @throws InterruptedException
* @throws NotConnectedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
*/
MucConfigFormManager(MultiUserChat multiUserChat) throws NoResponseException,
XMPPErrorException, NotConnectedException, InterruptedException {
@ -156,7 +156,7 @@ public class MucConfigFormManager {
* Make the room for members only.
*
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager makeMembersOnly() throws MucConfigurationNotSupportedException {
return setMembersOnly(true);
@ -167,7 +167,7 @@ public class MucConfigFormManager {
*
* @param isMembersOnly if the room should be members only.
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager setMembersOnly(boolean isMembersOnly) throws MucConfigurationNotSupportedException {
if (!supportsMembersOnly()) {
@ -192,7 +192,7 @@ public class MucConfigFormManager {
*
* @param password the password to set.
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager setAndEnablePassword(String password)
throws MucConfigurationNotSupportedException {
@ -203,7 +203,7 @@ public class MucConfigFormManager {
* Make the room password protected.
*
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager makePasswordProtected() throws MucConfigurationNotSupportedException {
return setIsPasswordProtected(true);
@ -212,9 +212,9 @@ public class MucConfigFormManager {
/**
* Set if this room is password protected. Rooms are by default not password protected.
*
* @param isPasswordProtected
* @param isPasswordProtected TODO javadoc me please
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager setIsPasswordProtected(boolean isPasswordProtected)
throws MucConfigurationNotSupportedException {
@ -232,7 +232,7 @@ public class MucConfigFormManager {
*
* @param secret the secret/password.
* @return a reference to this object.
* @throws MucConfigurationNotSupportedException
* @throws MucConfigurationNotSupportedException if the requested MUC configuration is not supported by the MUC service.
*/
public MucConfigFormManager setRoomSecret(String secret)
throws MucConfigurationNotSupportedException {
@ -247,9 +247,9 @@ public class MucConfigFormManager {
* Submit the configuration as {@link Form} to the room.
*
* @throws NoResponseException if there was no response from the room.
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void submitConfigurationForm() throws NoResponseException, XMPPErrorException, NotConnectedException,
InterruptedException {

2
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MucEnterConfiguration.java
View file

@ -101,7 +101,7 @@ public final class MucEnterConfiguration {
* 'available', otherwise an {@link IllegalArgumentException} will be thrown.
* <p>
*
* @param presence
* @param presence TODO javadoc me please
* @return a reference to this builder.
*/
public Builder withPresence(Presence presence) {

336
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java
View file

@ -318,11 +318,11 @@ public class MultiUserChat {
*
* @param conf the configuration used to enter the room.
* @return the returned presence by the service after the client send the initial presence in order to enter the room.
* @throws NotConnectedException
* @throws NoResponseException
* @throws XMPPErrorException
* @throws InterruptedException
* @throws NotAMucServiceException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
* @see <a href="http://xmpp.org/extensions/xep-0045.html#enter">XEP-45 7.2 Entering a Room</a>
*/
private Presence enter(MucEnterConfiguration conf) throws NotConnectedException, NoResponseException,
@ -444,11 +444,11 @@ public class MultiUserChat {
* @throws XMPPErrorException if the room couldn't be created for some reason (e.g. 405 error if
* the user is not allowed to create the room)
* @throws NoResponseException if there was no response from the server.
* @throws InterruptedException
* @throws NotConnectedException
* @throws MucAlreadyJoinedException
* @throws MissingMucCreationAcknowledgeException
* @throws NotAMucServiceException
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws MucAlreadyJoinedException if already joined the Multi-User Chat.7y
* @throws MissingMucCreationAcknowledgeException if there MUC creation was not acknowledged by the service.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public synchronized MucCreateConfigFormHandle create(Resourcepart nickname) throws NoResponseException,
XMPPErrorException, InterruptedException, MucAlreadyJoinedException,
@ -477,12 +477,12 @@ public class MultiUserChat {
*
* @param nickname the nickname to use in the MUC room.
* @return A {@link MucCreateConfigFormHandle} if the room was created while joining, or {@code null} if the room was just joined.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws InterruptedException
* @throws NotConnectedException
* @throws MucAlreadyJoinedException
* @throws NotAMucServiceException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws MucAlreadyJoinedException if already joined the Multi-User Chat.7y
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public synchronized MucCreateConfigFormHandle createOrJoin(Resourcepart nickname) throws NoResponseException, XMPPErrorException,
InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException {
@ -501,10 +501,10 @@ public class MultiUserChat {
* @throws XMPPErrorException if the room couldn't be created for some reason (e.g. 405 error if
* the user is not allowed to create the room)
* @throws NoResponseException if there was no response from the server.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
* @throws MucAlreadyJoinedException if the MUC is already joined
* @throws NotConnectedException
* @throws NotAMucServiceException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public synchronized MucCreateConfigFormHandle createOrJoin(MucEnterConfiguration mucEnterConfiguration)
throws NoResponseException, XMPPErrorException, InterruptedException, MucAlreadyJoinedException, NotConnectedException, NotAMucServiceException {
@ -539,10 +539,10 @@ public class MultiUserChat {
* Create an instant room. The default configuration will be accepted and the room will become unlocked, i.e.
* other users are able to join.
*
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://www.xmpp.org/extensions/xep-0045.html#createroom-instant">XEP-45 § 10.1.2 Creating an
* Instant Room</a>
*/
@ -555,10 +555,10 @@ public class MultiUserChat {
* Alias for {@link MultiUserChat#getConfigFormManager()}.
*
* @return a MUC configuration form manager for this room.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see MultiUserChat#getConfigFormManager()
*/
public MucConfigFormManager getConfigFormManager() throws NoResponseException,
@ -573,11 +573,11 @@ public class MultiUserChat {
* @param nickname the required nickname to use.
* @param password the optional password required to join
* @return A {@link MucCreateConfigFormHandle} if the room was created while joining, or {@code null} if the room was just joined.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotAMucServiceException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public MucCreateConfigFormHandle createOrJoinIfNecessary(Resourcepart nickname, String password) throws NoResponseException,
XMPPErrorException, NotConnectedException, InterruptedException, NotAMucServiceException {
@ -602,7 +602,7 @@ public class MultiUserChat {
* joining the room, the room will decide the amount of history to send.
*
* @param nickname the nickname to use.
* @throws NoResponseException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if an error occurs joining the room. In particular, a
* 401 error can occur if no password was provided and one is required; or a
* 403 error can occur if the user is banned; or a
@ -610,9 +610,9 @@ public class MultiUserChat {
* 407 error can occur if user is not on the member list; or a
* 409 error can occur if someone is already in the group chat with the same nickname.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotAMucServiceException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public void join(Resourcepart nickname) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotAMucServiceException {
@ -638,10 +638,10 @@ public class MultiUserChat {
* 404 error can occur if the room does not exist or is locked; or a
* 407 error can occur if user is not on the member list; or a
* 409 error can occur if someone is already in the group chat with the same nickname.
* @throws InterruptedException
* @throws NotConnectedException
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the server.
* @throws NotAMucServiceException
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public void join(Resourcepart nickname, String password) throws XMPPErrorException, InterruptedException, NoResponseException, NotConnectedException, NotAMucServiceException {
MucEnterConfiguration.Builder builder = getEnterConfigurationBuilder(nickname).withPassword(
@ -671,9 +671,9 @@ public class MultiUserChat {
* 407 error can occur if user is not on the member list; or a
* 409 error can occur if someone is already in the group chat with the same nickname.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotAMucServiceException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
*/
public synchronized void join(MucEnterConfiguration mucEnterConfiguration)
throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException, NotAMucServiceException {
@ -704,11 +704,11 @@ public class MultiUserChat {
* Leave the chat room.
*
* @return the leave presence as reflected by the MUC.
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws MucNotJoinedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
* @deprecated use {@link #leave()} instead.
*/
@Deprecated
@ -721,11 +721,11 @@ public class MultiUserChat {
* Leave the chat room.
*
* @return the leave presence as reflected by the MUC.
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws MucNotJoinedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
*/
public synchronized Presence leave()
throws NotConnectedException, InterruptedException, NoResponseException, XMPPErrorException, MucNotJoinedException {
@ -768,10 +768,10 @@ public class MultiUserChat {
* </p>
*
* @return a MUC configuration form manager for this room.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0045.html#roomconfig">XEP-45 § 10.2 Subsequent Room Configuration</a>
* @since 4.2
*/
@ -789,8 +789,8 @@ public class MultiUserChat {
* <code>null</code> if no configuration is possible.
* @throws XMPPErrorException if an error occurs asking the configuration form for the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Form getConfigurationForm() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCOwner iq = new MUCOwner();
@ -808,8 +808,8 @@ public class MultiUserChat {
* @param form the form with the new settings.
* @throws XMPPErrorException if an error occurs setting the new rooms' configuration.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void sendConfigurationForm(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCOwner iq = new MUCOwner();
@ -834,8 +834,8 @@ public class MultiUserChat {
* @throws XMPPErrorException if an error occurs asking the registration form for the room or a
* 405 error if the user is not allowed to register with the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Form getRegistrationForm() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Registration reg = new Registration();
@ -860,8 +860,8 @@ public class MultiUserChat {
* 409 error can occur if the desired room nickname is already reserved for that room;
* or a 503 error can occur if the room does not support registration.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void sendRegistrationForm(Form form) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Registration reg = new Registration();
@ -884,8 +884,8 @@ public class MultiUserChat {
* XMPP error code 403. The error code can be used to present more
* appropiate error messages to end-users.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void destroy(String reason, EntityBareJid alternateJID) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCOwner iq = new MUCOwner();
@ -923,8 +923,8 @@ public class MultiUserChat {
*
* @param user the user to invite to the room.(e.g. hecate@shakespeare.lit)
* @param reason the reason why the user is being invited.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void invite(EntityBareJid user, String reason) throws NotConnectedException, InterruptedException {
invite(new Message(), user, reason);
@ -940,8 +940,8 @@ public class MultiUserChat {
* @param message the message to use for sending the invitation.
* @param user the user to invite to the room.(e.g. hecate@shakespeare.lit)
* @param reason the reason why the user is being invited.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void invite(Message message, EntityBareJid user, String reason) throws NotConnectedException, InterruptedException {
// TODO listen for 404 error code when inviter supplies a non-existent JID
@ -1067,7 +1067,7 @@ public class MultiUserChat {
*
* @return the reserved room nickname or <code>null</code> if none.
* @throws SmackException if there was no response from the server.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
public String getReservedNickname() throws SmackException, InterruptedException {
try {
@ -1111,9 +1111,9 @@ public class MultiUserChat {
* @param nickname the new nickname within the room.
* @throws XMPPErrorException if the new nickname is already in use by another occupant.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws MucNotJoinedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
*/
public synchronized void changeNickname(Resourcepart nickname) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, MucNotJoinedException {
Objects.requireNonNull(nickname, "Nickname must not be null or blank.");
@ -1150,9 +1150,9 @@ public class MultiUserChat {
*
* @param status a text message describing the presence update.
* @param mode the mode type for the presence update.
* @throws NotConnectedException
* @throws InterruptedException
* @throws MucNotJoinedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
*/
public void changeAvailabilityStatus(String status, Presence.Mode mode) throws NotConnectedException, InterruptedException, MucNotJoinedException {
final EntityFullJid myRoomJid = this.myRoomJid;
@ -1194,8 +1194,8 @@ public class MultiUserChat {
* not have kicking privileges (i.e. Forbidden error); or a
* 400 error can occur if the provided nickname is not present in the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void kickParticipant(Resourcepart nickname, String reason) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nickname, MUCRole.none, reason);
@ -1204,8 +1204,8 @@ public class MultiUserChat {
/**
* Sends a voice request to the MUC. The room moderators usually need to approve this request.
*
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0045.html#requestvoice">XEP-45 § 7.13 Requesting
* Voice</a>
* @since 4.1
@ -1236,8 +1236,8 @@ public class MultiUserChat {
* a moderator in this room (i.e. Forbidden error); or a
* 400 error can occur if the provided nickname is not present in the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantVoice(Collection<Resourcepart> nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nicknames, MUCRole.participant);
@ -1254,8 +1254,8 @@ public class MultiUserChat {
* a moderator in this room (i.e. Forbidden error); or a
* 400 error can occur if the provided nickname is not present in the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantVoice(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nickname, MUCRole.participant, null);
@ -1272,8 +1272,8 @@ public class MultiUserChat {
* was tried to revoke his voice (i.e. Not Allowed error); or a
* 400 error can occur if the provided nickname is not present in the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeVoice(Collection<Resourcepart> nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nicknames, MUCRole.visitor);
@ -1290,8 +1290,8 @@ public class MultiUserChat {
* was tried to revoke his voice (i.e. Not Allowed error); or a
* 400 error can occur if the provided nickname is not present in the room.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeVoice(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nickname, MUCRole.visitor, null);
@ -1309,8 +1309,8 @@ public class MultiUserChat {
* 405 error can occur if a moderator or a user with an affiliation of "owner" or "admin"
* was tried to be banned (i.e. Not Allowed error).
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void banUsers(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.outcast);
@ -1329,8 +1329,8 @@ public class MultiUserChat {
* 405 error can occur if a moderator or a user with an affiliation of "owner" or "admin"
* was tried to be banned (i.e. Not Allowed error).
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void banUser(Jid jid, String reason) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.outcast, reason);
@ -1344,8 +1344,8 @@ public class MultiUserChat {
* @param jids the XMPP user IDs of the users to grant membership.
* @throws XMPPErrorException if an error occurs granting membership to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantMembership(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.member);
@ -1359,8 +1359,8 @@ public class MultiUserChat {
* @param jid the XMPP user ID of the user to grant membership (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs granting membership to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantMembership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.member, null);
@ -1375,8 +1375,8 @@ public class MultiUserChat {
* @param jids the bare XMPP user IDs of the users to revoke membership.
* @throws XMPPErrorException if an error occurs revoking membership to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeMembership(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.none);
@ -1391,8 +1391,8 @@ public class MultiUserChat {
* @param jid the bare XMPP user ID of the user to revoke membership (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs revoking membership to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeMembership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.none, null);
@ -1406,8 +1406,8 @@ public class MultiUserChat {
* @param nicknames the nicknames of the occupants to grant moderator privileges.
* @throws XMPPErrorException if an error occurs granting moderator privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantModerator(Collection<Resourcepart> nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nicknames, MUCRole.moderator);
@ -1421,8 +1421,8 @@ public class MultiUserChat {
* @param nickname the nickname of the occupant to grant moderator privileges.
* @throws XMPPErrorException if an error occurs granting moderator privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantModerator(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nickname, MUCRole.moderator, null);
@ -1437,8 +1437,8 @@ public class MultiUserChat {
* @param nicknames the nicknames of the occupants to revoke moderator privileges.
* @throws XMPPErrorException if an error occurs revoking moderator privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeModerator(Collection<Resourcepart> nicknames) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nicknames, MUCRole.participant);
@ -1453,8 +1453,8 @@ public class MultiUserChat {
* @param nickname the nickname of the occupant to revoke moderator privileges.
* @throws XMPPErrorException if an error occurs revoking moderator privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeModerator(Resourcepart nickname) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeRole(nickname, MUCRole.participant, null);
@ -1469,8 +1469,8 @@ public class MultiUserChat {
* @param jids the collection of bare XMPP user IDs of the users to grant ownership.
* @throws XMPPErrorException if an error occurs granting ownership privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantOwnership(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.owner);
@ -1485,8 +1485,8 @@ public class MultiUserChat {
* @param jid the bare XMPP user ID of the user to grant ownership (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs granting ownership privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantOwnership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.owner, null);
@ -1500,8 +1500,8 @@ public class MultiUserChat {
* @param jids the bare XMPP user IDs of the users to revoke ownership.
* @throws XMPPErrorException if an error occurs revoking ownership privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeOwnership(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.admin);
@ -1515,8 +1515,8 @@ public class MultiUserChat {
* @param jid the bare XMPP user ID of the user to revoke ownership (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs revoking ownership privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeOwnership(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.admin, null);
@ -1530,8 +1530,8 @@ public class MultiUserChat {
* @param jids the bare XMPP user IDs of the users to grant administrator privileges.
* @throws XMPPErrorException if an error occurs granting administrator privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantAdmin(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.admin);
@ -1546,8 +1546,8 @@ public class MultiUserChat {
* (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs granting administrator privileges to a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void grantAdmin(Jid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.admin);
@ -1561,8 +1561,8 @@ public class MultiUserChat {
* @param jids the bare XMPP user IDs of the user to revoke administrator privileges.
* @throws XMPPErrorException if an error occurs revoking administrator privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeAdmin(Collection<? extends Jid> jids) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jids, MUCAffiliation.admin);
@ -1577,8 +1577,8 @@ public class MultiUserChat {
* (e.g. "user@host.org").
* @throws XMPPErrorException if an error occurs revoking administrator privileges from a user.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void revokeAdmin(EntityJid jid) throws XMPPErrorException, NoResponseException, NotConnectedException, InterruptedException {
changeAffiliationByAdmin(jid, MUCAffiliation.member);
@ -1587,12 +1587,12 @@ public class MultiUserChat {
/**
* Tries to change the affiliation with an 'muc#admin' namespace
*
* @param jid
* @param affiliation
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @param jid TODO javadoc me please
* @param affiliation TODO javadoc me please
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private void changeAffiliationByAdmin(Jid jid, MUCAffiliation affiliation)
throws NoResponseException, XMPPErrorException,
@ -1603,13 +1603,13 @@ public class MultiUserChat {
/**
* Tries to change the affiliation with an 'muc#admin' namespace
*
* @param jid
* @param affiliation
* @param jid TODO javadoc me please
* @param affiliation TODO javadoc me please
* @param reason the reason for the affiliation change (optional)
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private void changeAffiliationByAdmin(Jid jid, MUCAffiliation affiliation, String reason) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCAdmin iq = new MUCAdmin();
@ -1750,8 +1750,8 @@ public class MultiUserChat {
* @return a list of <code>Affiliate</code> with the room owners.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliate> getOwners() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getAffiliatesByAdmin(MUCAffiliation.owner);
@ -1763,8 +1763,8 @@ public class MultiUserChat {
* @return a list of <code>Affiliate</code> with the room administrators.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliate> getAdmins() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getAffiliatesByAdmin(MUCAffiliation.admin);
@ -1776,8 +1776,8 @@ public class MultiUserChat {
* @return a list of <code>Affiliate</code> with the room members.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliate> getMembers() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getAffiliatesByAdmin(MUCAffiliation.member);
@ -1789,8 +1789,8 @@ public class MultiUserChat {
* @return a list of <code>Affiliate</code> with the room outcasts.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliate> getOutcasts() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getAffiliatesByAdmin(MUCAffiliation.outcast);
@ -1804,8 +1804,8 @@ public class MultiUserChat {
* @return a collection of <code>Affiliate</code> that have the specified room affiliation.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private List<Affiliate> getAffiliatesByAdmin(MUCAffiliation affiliation) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCAdmin iq = new MUCAdmin();
@ -1831,8 +1831,8 @@ public class MultiUserChat {
* @return a list of <code>Occupant</code> with the room moderators.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Occupant> getModerators() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getOccupants(MUCRole.moderator);
@ -1844,8 +1844,8 @@ public class MultiUserChat {
* @return a list of <code>Occupant</code> with the room participants.
* @throws XMPPErrorException if you don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Occupant> getParticipants() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getOccupants(MUCRole.participant);
@ -1859,8 +1859,8 @@ public class MultiUserChat {
* @throws XMPPErrorException if an error occured while performing the request to the server or you
* don't have enough privileges to get this information.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private List<Occupant> getOccupants(MUCRole role) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCAdmin iq = new MUCAdmin();
@ -1883,8 +1883,8 @@ public class MultiUserChat {
* Sends a message to the chat room.
*
* @param text the text of the message to send.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void sendMessage(String text) throws NotConnectedException, InterruptedException {
Message message = createMessage();
@ -1923,8 +1923,8 @@ public class MultiUserChat {
* Sends a Message to the chat room.
*
* @param message the message.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void sendMessage(Message message) throws NotConnectedException, InterruptedException {
message.setTo(room);
@ -1942,7 +1942,7 @@ public class MultiUserChat {
*
* @return the next message if one is immediately available and
* <code>null</code> otherwise.
* @throws MucNotJoinedException
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
*/
public Message pollMessage() throws MucNotJoinedException {
if (messageCollector == null) {
@ -1956,8 +1956,8 @@ public class MultiUserChat {
* (not return) until a message is available.
*
* @return the next message.
* @throws MucNotJoinedException
* @throws InterruptedException
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Message nextMessage() throws MucNotJoinedException, InterruptedException {
if (messageCollector == null) {
@ -1974,8 +1974,8 @@ public class MultiUserChat {
* @param timeout the maximum amount of time to wait for the next message.
* @return the next message, or <code>null</code> if the timeout elapses without a
* message becoming available.
* @throws MucNotJoinedException
* @throws InterruptedException
* @throws MucNotJoinedException if not joined to the Multi-User Chat.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Message nextMessage(long timeout) throws MucNotJoinedException, InterruptedException {
if (messageCollector == null) {
@ -2020,8 +2020,8 @@ public class MultiUserChat {
* @throws XMPPErrorException if someone without appropriate privileges attempts to change the
* room subject will throw an error with code 403 (i.e. Forbidden)
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void changeSubject(final String subject) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Message message = createMessage();
@ -2367,10 +2367,10 @@ public class MultiUserChat {
/**
* Fires events according to the received presence code.
*
* @param statusCodes
* @param isUserModification
* @param mucUser
* @param from
* @param statusCodes TODO javadoc me please
* @param isUserModification TODO javadoc me please
* @param mucUser TODO javadoc me please
* @param from TODO javadoc me please
*/
private void checkPresenceCode(
Set<Status> statusCodes,

64
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChatManager.java
View file

@ -120,7 +120,7 @@ public final class MultiUserChatManager extends Manager {
/**
* Get a instance of a multi user chat manager for the given connection.
*
* @param connection
* @param connection TODO javadoc me please
* @return a multi user chat manager.
*/
public static synchronized MultiUserChatManager getInstanceFor(XMPPConnection connection) {
@ -281,10 +281,10 @@ public final class MultiUserChatManager extends Manager {
*
* @param user the user to check. A fully qualified xmpp ID, e.g. jdoe@example.com.
* @return a boolean indicating whether the specified user supports the MUC protocol.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isServiceEnabled(Jid user) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return serviceDiscoveryManager.supportsFeature(user, MUCInitialPresence.NAMESPACE);
@ -309,10 +309,10 @@ public final class MultiUserChatManager extends Manager {
*
* @param user the user to check. A fully qualified xmpp ID, e.g. jdoe@example.com.
* @return a List of the rooms where the requested user has joined.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<EntityBareJid> getJoinedRooms(EntityFullJid user) throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException {
@ -338,10 +338,10 @@ public final class MultiUserChatManager extends Manager {
*
* @param room the name of the room in the form "roomName@service" of which we want to discover its information.
* @return the discovered information of a given room without actually having to join the room.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public RoomInfo getRoomInfo(EntityBareJid room) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
DiscoverInfo info = serviceDiscoveryManager.discoverInfo(room);
@ -352,10 +352,10 @@ public final class MultiUserChatManager extends Manager {
* Returns a collection with the XMPP addresses of the Multi-User Chat services.
*
* @return a collection with the XMPP addresses of the Multi-User Chat services.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<DomainBareJid> getMucServiceDomains() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return serviceDiscoveryManager.findServices(MUCInitialPresence.NAMESPACE, false, false);
@ -365,10 +365,10 @@ public final class MultiUserChatManager extends Manager {
* Returns a collection with the XMPP addresses of the Multi-User Chat services.
*
* @return a collection with the XMPP addresses of the Multi-User Chat services.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link #getMucServiceDomains()} instead.
*/
// TODO: Remove in Smack 4.5
@ -382,10 +382,10 @@ public final class MultiUserChatManager extends Manager {
*
* @param domainBareJid the domain bare JID to check.
* @return <code>true</code> if the provided JID provides a MUC service, <code>false</code> otherwise.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0045.html#disco-service-features">XEP-45 § 6.2 Discovering the Features Supported by a MUC Service</a>
* @since 4.2
*/
@ -402,11 +402,11 @@ public final class MultiUserChatManager extends Manager {
*
* @param serviceName the service that is hosting the rooms to discover.
* @return a map from the room's address to its HostedRoom information.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotAMucServiceException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAMucServiceException if the entity is not a MUC serivce.
* @since 4.3.1
*/
public Map<EntityBareJid, HostedRoom> getRoomsHostedBy(DomainBareJid serviceName) throws NoResponseException, XMPPErrorException,
@ -434,8 +434,8 @@ public final class MultiUserChatManager extends Manager {
* @param room the room that sent the original invitation.
* @param inviter the inviter of the declined invitation.
* @param reason the reason why the invitee is declining the invitation.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void decline(EntityBareJid room, EntityBareJid inviter, String reason) throws NotConnectedException, InterruptedException {
Message message = new Message(room);

4
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/GroupChatInvitation.java
View file

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

73
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCInitialPresence.java
View file

@ -140,7 +140,7 @@ public class MUCInitialPresence implements ExtensionElement {
/**
* Retrieve the MUCInitialPresence PacketExtension from packet, if any.
*
* @param packet
* @param packet TODO javadoc me please
* @return the MUCInitialPresence PacketExtension or {@code null}
* @deprecated use {@link #from(Stanza)} instead
*/
@ -152,7 +152,7 @@ public class MUCInitialPresence implements ExtensionElement {
/**
* Retrieve the MUCInitialPresence PacketExtension from packet, if any.
*
* @param packet
* @param packet TODO javadoc me please
* @return the MUCInitialPresence PacketExtension or {@code null}
*/
public static MUCInitialPresence from(Stanza packet) {
@ -169,22 +169,10 @@ public class MUCInitialPresence implements ExtensionElement {
public static final String ELEMENT = "history";
// TODO make those fields final once the deprecated setter methods have been removed.
private int maxChars;
private int maxStanzas;
private int seconds;
private Date since;
/**
* Deprecated constructor.
* @deprecated use {@link #History(int, int, int, Date)} instead.
*/
@Deprecated
public History() {
this.maxChars = -1;
this.maxStanzas = -1;
this.seconds = -1;
}
private final int maxChars;
private final int maxStanzas;
private final int seconds;
private final Date since;
public History(int maxChars, int maxStanzas, int seconds, Date since) {
if (maxChars < 0 && maxStanzas < 0 && seconds < 0 && since == null) {
@ -236,55 +224,6 @@ public class MUCInitialPresence implements ExtensionElement {
return since;
}
/**
* Sets the total number of characters to receive in the history.
*
* @param maxChars the total number of characters to receive in the history.
* @deprecated use {@link #History(int, int, int, Date)} instead.
*/
@Deprecated
public void setMaxChars(int maxChars) {
this.maxChars = maxChars;
}
/**
* Sets the total number of messages to receive in the history.
*
* @param maxStanzas the total number of messages to receive in the history.
* @deprecated use {@link #History(int, int, int, Date)} instead.
*/
@Deprecated
public void setMaxStanzas(int maxStanzas) {
this.maxStanzas = maxStanzas;
}
/**
* Sets the number of seconds to use to filter the messages received during that time.
* In other words, only the messages received in the last "X" seconds will be included in
* the history.
*
* @param seconds the number of seconds to use to filter the messages received during
* that time.
* @deprecated use {@link #History(int, int, int, Date)} instead.
*/
@Deprecated
public void setSeconds(int seconds) {
this.seconds = seconds;
}
/**
* Sets the since date to use to filter the messages received during that time.
* In other words, only the messages received since the datetime specified will be
* included in the history.
*
* @param since the since date to use to filter the messages received during that time.
* @deprecated use {@link #History(int, int, int, Date)} instead.
*/
@Deprecated
public void setSince(Date since) {
this.since = since;
}
@Override
public XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace) {
XmlStringBuilder xml = new XmlStringBuilder(this);

10
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCItem.java
View file

@ -71,11 +71,11 @@ public class MUCItem implements NamedElement {
*
* @param affiliation the actor's affiliation to the room
* @param role the privilege level of an occupant within a room.
* @param actor
* @param reason
* @param jid
* @param nick
* @param actorNick
* @param actor TODO javadoc me please
* @param reason TODO javadoc me please
* @param jid TODO javadoc me please
* @param nick TODO javadoc me please
* @param actorNick TODO javadoc me please
*/
public MUCItem(MUCAffiliation affiliation, MUCRole role, Jid actor,
String reason, Jid jid, Resourcepart nick, Resourcepart actorNick) {

4
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/packet/MUCUser.java
View file

@ -220,7 +220,7 @@ public class MUCUser implements ExtensionElement {
/**
* Retrieve the MUCUser PacketExtension from packet, if any.
*
* @param packet
* @param packet TODO javadoc me please
* @return the MUCUser PacketExtension or {@code null}
* @deprecated use {@link #from(Stanza)} instead
*/
@ -232,7 +232,7 @@ public class MUCUser implements ExtensionElement {
/**
* Retrieve the MUCUser PacketExtension from packet, if any.
*
* @param packet
* @param packet TODO javadoc me please
* @return the MUCUser PacketExtension or {@code null}
*/
public static MUCUser from(Stanza packet) {

4
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/provider/MUCUserProvider.java
View file

@ -43,8 +43,8 @@ public class MUCUserProvider extends ExtensionElementProvider<MUCUser> {
*
* @param parser the XML parser, positioned at the starting element of the extension.
* @return a PacketExtension.
* @throws IOException
* @throws XmlPullParserException
* @throws IOException if an I/O error occured.
* @throws XmlPullParserException if an error in the XML parser occured.
*/
@Override
public MUCUser parse(XmlPullParser parser, int initialDepth, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException {

28
smack-extensions/src/main/java/org/jivesoftware/smackx/offline/OfflineMessageManager.java
View file

@ -81,8 +81,8 @@ public class OfflineMessageManager {
* @return a boolean indicating if the server supports Flexible Offline Message Retrieval.
* @throws XMPPErrorException If the user is not allowed to make this request.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean supportsFlexibleRetrieval() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection).serverSupportsFeature(namespace);
@ -95,8 +95,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public int getMessageCount() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
DiscoverInfo info = ServiceDiscoveryManager.getInstanceFor(connection).discoverInfo(null,
@ -119,8 +119,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<OfflineMessageHeader> getHeaders() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
List<OfflineMessageHeader> answer = new ArrayList<>();
@ -144,8 +144,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Message> getMessages(final List<String> nodes) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
List<Message> messages = new ArrayList<>(nodes.size());
@ -192,8 +192,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Message> getMessages() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
OfflineMessageRequest request = new OfflineMessageRequest();
@ -226,8 +226,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteMessages(List<String> nodes) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
OfflineMessageRequest request = new OfflineMessageRequest();
@ -246,8 +246,8 @@ public class OfflineMessageManager {
* @throws XMPPErrorException If the user is not allowed to make this request or the server does
* not support offline message retrieval.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteMessages() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
OfflineMessageRequest request = new OfflineMessageRequest();

4
smack-extensions/src/main/java/org/jivesoftware/smackx/offline/packet/OfflineMessageInfo.java
View file

@ -99,8 +99,8 @@ public class OfflineMessageInfo implements ExtensionElement {
*
* @param parser the XML parser, positioned at the starting element of the extension.
* @return a PacketExtension.
* @throws IOException
* @throws XmlPullParserException
* @throws IOException if an I/O error occured.
* @throws XmlPullParserException if an error in the XML parser occured.
*/
@Override
public OfflineMessageInfo parse(XmlPullParser parser,

10
smack-extensions/src/main/java/org/jivesoftware/smackx/pep/PepManager.java
View file

@ -153,11 +153,11 @@ public final class PepManager extends Manager {
* @param nodeId the ID of the node to publish on.
* @param item the item to publish.
* @return the leaf node the item was published on.
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotALeafNodeException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotALeafNodeException if a PubSub leaf node operation was attempted on a non-leaf node.
*/
public LeafNode publish(String nodeId, Item item) throws NotConnectedException, InterruptedException,
NoResponseException, XMPPErrorException, NotALeafNodeException {

26
smack-extensions/src/main/java/org/jivesoftware/smackx/ping/PingManager.java
View file

@ -79,7 +79,7 @@ public final class PingManager extends Manager {
* Retrieves a {@link PingManager} for the specified {@link XMPPConnection}, creating one if it doesn't already
* exist.
*
* @param connection
* @param connection TODO javadoc me please
* The connection the manager is attached to.
* @return The new or existing manager.
*/
@ -223,8 +223,8 @@ public final class PingManager extends Manager {
* @param pingTimeout The time to wait for a reply in milliseconds
* @return true if a reply was received from the entity, false otherwise.
* @throws NoResponseException if there was no response from the jid.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean ping(Jid jid, long pingTimeout) throws NotConnectedException, NoResponseException, InterruptedException {
final XMPPConnection connection = connection();
@ -249,9 +249,9 @@ public final class PingManager extends Manager {
*
* @param jid The id of the entity the ping is being sent to
* @return true if a reply was received from the entity, false otherwise.
* @throws NotConnectedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException if there was no response from the jid.
* @throws InterruptedException
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean ping(Jid jid) throws NotConnectedException, NoResponseException, InterruptedException {
return ping(jid, connection().getReplyTimeout());
@ -264,8 +264,8 @@ public final class PingManager extends Manager {
* @return true if it supports ping, false otherwise.
* @throws XMPPErrorException An XMPP related error occurred during the request
* @throws NoResponseException if there was no response from the jid.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isPingSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, Ping.NAMESPACE);
@ -279,8 +279,8 @@ public final class PingManager extends Manager {
* {@link #isPingSupported(Jid)} is false.
*
* @return true if a reply was received from the server, false otherwise.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean pingMyServer() throws NotConnectedException, InterruptedException {
return pingMyServer(true);
@ -295,8 +295,8 @@ public final class PingManager extends Manager {
*
* @param notifyListeners Notify the PingFailedListener in case of error if true
* @return true if the user's server could be pinged.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean pingMyServer(boolean notifyListeners) throws NotConnectedException, InterruptedException {
return pingMyServer(notifyListeners, connection().getReplyTimeout());
@ -312,8 +312,8 @@ public final class PingManager extends Manager {
* @param notifyListeners Notify the PingFailedListener in case of error if true
* @param pingTimeout The time to wait for a reply in milliseconds
* @return true if the user's server could be pinged.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean pingMyServer(boolean notifyListeners, long pingTimeout) throws NotConnectedException, InterruptedException {
boolean res;

154
smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/PrivacyListManager.java
View file

@ -224,10 +224,10 @@ public final class PrivacyListManager extends Manager {
* @param requestPrivacy is the {@link Privacy} stanza configured properly whose XML
* will be sent to the server.
* @return a new {@link Privacy} with the data received from the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private Privacy getRequest(Privacy requestPrivacy) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request is a get iq type
@ -243,10 +243,10 @@ public final class PrivacyListManager extends Manager {
* @param requestPrivacy is the {@link Privacy} stanza configured properly whose xml will be
* sent to the server.
* @return a new {@link Privacy} with the data received from the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private Stanza setRequest(Privacy requestPrivacy) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request is a get iq type
@ -259,10 +259,10 @@ public final class PrivacyListManager extends Manager {
* Answer a privacy containing the list structure without {@link PrivacyItem}.
*
* @return a Privacy with the list names.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private Privacy getPrivacyWithListNames() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an empty privacy message
@ -276,10 +276,10 @@ public final class PrivacyListManager extends Manager {
* Answer the active privacy list. Returns <code>null</code> if there is no active list.
*
* @return the privacy list of the active list.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public PrivacyList getActiveList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Privacy privacyAnswer = this.getPrivacyWithListNames();
@ -295,10 +295,10 @@ public final class PrivacyListManager extends Manager {
* Get the name of the active list.
*
* @return the name of the active list or null if there is none set.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.1
*/
public String getActiveListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -312,10 +312,10 @@ public final class PrivacyListManager extends Manager {
* Answer the default privacy list. Returns <code>null</code> if there is no default list.
*
* @return the privacy list of the default list.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public PrivacyList getDefaultList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Privacy privacyAnswer = this.getPrivacyWithListNames();
@ -331,10 +331,10 @@ public final class PrivacyListManager extends Manager {
* Get the name of the default list.
*
* @return the name of the default list or null if there is none set.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.1
*/
public String getDefaultListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -352,10 +352,10 @@ public final class PrivacyListManager extends Manager {
* </p>
*
* @return the name of the effective privacy list or null if there is none set.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.1
*/
public String getEffectiveListName() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -371,10 +371,10 @@ public final class PrivacyListManager extends Manager {
*
* @param listName the name of the list to get the allowed and blocked permissions.
* @return a list of privacy items under the list listName.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
private List<PrivacyItem> getPrivacyListItems(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
assert StringUtils.isNotEmpty(listName);
@ -393,10 +393,10 @@ public final class PrivacyListManager extends Manager {
*
* @param listName the name of the list to get the allowed and blocked permissions.
* @return a privacy list under the list listName.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public PrivacyList getPrivacyList(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
listName = StringUtils.requireNotNullNorEmpty(listName, "List name must not be null");
@ -407,10 +407,10 @@ public final class PrivacyListManager extends Manager {
* Answer every privacy list with the allowed and blocked permissions.
*
* @return an array of privacy lists.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<PrivacyList> getPrivacyLists() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Privacy privacyAnswer = getPrivacyWithListNames();
@ -429,10 +429,10 @@ public final class PrivacyListManager extends Manager {
* Set or change the active list to listName.
*
* @param listName the list name to set as the active one.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void setActiveListName(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an privacy message with an empty list
@ -445,10 +445,10 @@ public final class PrivacyListManager extends Manager {
/**
* Client declines the use of active lists.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void declineActiveList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an privacy message with an empty list
@ -463,10 +463,10 @@ public final class PrivacyListManager extends Manager {
* Set or change the default list to listName.
*
* @param listName the list name to set as the default one.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void setDefaultListName(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an privacy message with an empty list
@ -479,10 +479,10 @@ public final class PrivacyListManager extends Manager {
/**
* Client declines the use of default lists.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void declineDefaultList() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an privacy message with an empty list
@ -498,10 +498,10 @@ public final class PrivacyListManager extends Manager {
*
* @param listName the list that has changed its content.
* @param privacyItems a List with every privacy item in the list.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void createPrivacyList(String listName, List<PrivacyItem> privacyItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
updatePrivacyList(listName, privacyItems);
@ -514,10 +514,10 @@ public final class PrivacyListManager extends Manager {
*
* @param listName the list that has changed its content.
* @param privacyItems a List with every privacy item in the list.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void updatePrivacyList(String listName, List<PrivacyItem> privacyItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Build the privacy package to add or update the new list
@ -532,10 +532,10 @@ public final class PrivacyListManager extends Manager {
* Remove a privacy list.
*
* @param listName the list that has changed its content.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deletePrivacyList(String listName) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// The request of the list is an privacy message with an empty list
@ -560,7 +560,7 @@ public final class PrivacyListManager extends Manager {
/**
* Removes the privacy list listener.
*
* @param listener
* @param listener TODO javadoc me please
* @return true, if the listener was removed.
*/
public boolean removeListener(PrivacyListListener listener) {
@ -571,10 +571,10 @@ public final class PrivacyListManager extends Manager {
* Check if the user's server supports privacy lists.
*
* @return true, if the server supports privacy lists, false otherwise.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isSupported() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(NAMESPACE);

4
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Affiliation.java
View file

@ -95,8 +95,8 @@ public class Affiliation implements ExtensionElement {
/**
* Construct a affiliation modification request.
*
* @param jid
* @param affiliation
* @param jid TODO javadoc me please
* @param affiliation TODO javadoc me please
*/
public Affiliation(BareJid jid, Type affiliation) {
this(jid, affiliation, AffiliationNamespace.owner);

10
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ConfigureForm.java
View file

@ -39,7 +39,7 @@ public class ConfigureForm extends Form {
* Create a decorator from an existing {@link DataForm} that has been
* retrieved from parsing a node configuration request.
*
* @param configDataForm
* @param configDataForm TODO javadoc me please
*/
public ConfigureForm(DataForm configDataForm) {
super(configDataForm);
@ -50,7 +50,7 @@ public class ConfigureForm extends Form {
* Typically, this can be used to create a decorator for an answer form
* by using the result of {@link #createAnswerForm()} as the input parameter.
*
* @param nodeConfigForm
* @param nodeConfigForm TODO javadoc me please
*/
public ConfigureForm(Form nodeConfigForm) {
super(nodeConfigForm.getDataFormToSend());
@ -61,7 +61,7 @@ public class ConfigureForm extends Form {
* when creating and configuring a node at the same time via {@link PubSubManager#createNode(String, Form)}, since
* configuration of an existing node is typically accomplished by calling {@link LeafNode#getNodeConfiguration()} and
* using the resulting form to create a answer form. See {@link #ConfigureForm(Form)}.
* @param formType
* @param formType TODO javadoc me please
*/
public ConfigureForm(DataForm.Type formType) {
super(formType);
@ -84,7 +84,7 @@ public class ConfigureForm extends Form {
/**
* Sets the value of access model.
*
* @param accessModel
* @param accessModel TODO javadoc me please
*/
public void setAccessModel(AccessModel accessModel) {
addField(ConfigureNodeFields.access_model, FormField.Type.list_single);
@ -124,7 +124,7 @@ public class ConfigureForm extends Form {
/**
* Set the list of child node ids that are associated with a collection node.
*
* @param children
* @param children TODO javadoc me please
*/
public void setChildren(List<String> children) {
addField(ConfigureNodeFields.children, FormField.Type.text_multi);

2
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Item.java
View file

@ -99,6 +99,7 @@ public class Item extends NodeExtension {
* Create an <code>Item</code> with an id but no payload. This is a valid item for nodes which are configured
* so that {@link ConfigureForm#isDeliverPayloads()} is false.
*
* @param itemNamespace the namespace of the item.
* @param itemId The id if the item. It must be unique within the node unless overwriting and existing item.
* Passing null is the equivalent of calling {@link #Item()}.
*/
@ -129,6 +130,7 @@ public class Item extends NodeExtension {
* (via {@link LeafNode#publish(Item)}, the server <i>may</i> return an
* error for an invalid packet.
*
* @param itemNamespace the namespace of the item.
* @param itemId The id of the item.
* @param nodeId The id of the node which the item was published to.
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java
View file

@ -106,7 +106,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
*
* @param nodeId The node to which the items are being sent or deleted
* @param items The list of {@link Item} or {@link RetractItem}
* @param notify
* @param notify TODO javadoc me please
*/
public ItemsExtension(String nodeId, List<? extends ExtensionElement> items, boolean notify) {
super(ItemsElementType.retract.getNodeElement(), nodeId);

112
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/LeafNode.java
View file

@ -47,10 +47,10 @@ public class LeafNode extends Node {
* {@link DiscoverItems} format.
*
* @return The item details in {@link DiscoverItems} format
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverItems discoverItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
DiscoverItems items = new DiscoverItems();
@ -64,10 +64,10 @@ public class LeafNode extends Node {
*
* @param <T> type of the items.
* @return List of {@link Item} in the node
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getItems((List<ExtensionElement>) null, null);
@ -83,10 +83,10 @@ public class LeafNode extends Node {
* @param <T> type of the items.
*
* @return List of {@link Item} in the node
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems(String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), subscriptionId));
@ -104,10 +104,10 @@ public class LeafNode extends Node {
* @param <T> type of the items.
*
* @return The list of {@link Item} with payload
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems(Collection<String> ids) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
List<Item> itemList = new ArrayList<>(ids.size());
@ -126,10 +126,10 @@ public class LeafNode extends Node {
* @param <T> type of the items.
*
* @return List of {@link Item}
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems(int maxItems) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), maxItems));
@ -147,10 +147,10 @@ public class LeafNode extends Node {
* @return List of {@link Item}
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems(int maxItems, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = createPubsubPacket(Type.get, new GetItemsRequest(getId(), subscriptionId, maxItems));
@ -171,10 +171,10 @@ public class LeafNode extends Node {
* @param <T> type of the items.
*
* @return List of {@link Item}
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public <T extends Item> List<T> getItems(List<ExtensionElement> additionalExtensions,
List<ExtensionElement> returnedExtensions) throws NoResponseException,
@ -208,10 +208,10 @@ public class LeafNode extends Node {
* This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false
* and {@link ConfigureForm#isDeliverPayloads()}=false.
*
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @deprecated use {@link #publish()} instead.
*/
@Deprecated
@ -230,10 +230,10 @@ public class LeafNode extends Node {
* @param item - The item being sent
* @param <T> type of the items.
*
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @deprecated use {@link #publish(Item)} instead.
*/
@SuppressWarnings("unchecked")
@ -251,10 +251,10 @@ public class LeafNode extends Node {
* @param items - The collection of items being sent
* @param <T> type of the items.
*
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @deprecated use {@link #publish(Collection)} instead.
*/
@Deprecated
@ -269,10 +269,10 @@ public class LeafNode extends Node {
* This is only acceptable for nodes with {@link ConfigureForm#isPersistItems()}=false
* and {@link ConfigureForm#isDeliverPayloads()}=false.
*
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public void publish() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -296,10 +296,10 @@ public class LeafNode extends Node {
* @param item - The item being sent
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
@SuppressWarnings("unchecked")
@ -318,10 +318,10 @@ public class LeafNode extends Node {
* @param items - The collection of {@link Item} objects being sent
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public <T extends Item> void publish(Collection<T> items) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -335,10 +335,10 @@ public class LeafNode extends Node {
*
* <p>Note: Some implementations may keep the last item
* sent.
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteAllItems() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = createPubsubPacket(Type.set, new NodeExtension(PubSubElementType.PURGE_OWNER, getId()));
@ -350,10 +350,10 @@ public class LeafNode extends Node {
* Delete the item with the specified id from the node.
*
* @param itemId The id of the item
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteItem(String itemId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Collection<String> items = new ArrayList<>(1);
@ -365,10 +365,10 @@ public class LeafNode extends Node {
* Delete the items with the specified id's from the node.
*
* @param itemIds The list of id's of items to delete
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void deleteItem(Collection<String> itemIds) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
List<Item> items = new ArrayList<>(itemIds.size());

180
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/Node.java
View file

@ -83,10 +83,10 @@ public abstract class Node {
* via the {@link #sendConfigurationForm(Form)}.
*
* @return the configuration form
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ConfigureForm getNodeConfiguration() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub pubSub = createPubsubPacket(Type.get, new NodeExtension(
@ -98,11 +98,11 @@ public abstract class Node {
/**
* Update the configuration with the contents of the new {@link Form}.
*
* @param submitForm
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @param submitForm TODO javadoc me please
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void sendConfigurationForm(Form submitForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub packet = createPubsubPacket(Type.set, new FormNode(FormNodeType.CONFIGURE_OWNER,
@ -114,10 +114,10 @@ public abstract class Node {
* Discover node information in standard {@link DiscoverInfo} format.
*
* @return The discovery information about the node.
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverInfo discoverInfo() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
DiscoverInfo info = new DiscoverInfo();
@ -130,10 +130,10 @@ public abstract class Node {
* Get the subscriptions currently associated with this node.
*
* @return List of {@link Subscription}
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public List<Subscription> getSubscriptions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -147,14 +147,14 @@ public abstract class Node {
* {@code returnedExtensions} will be filled with the stanza extensions found in the answer.
* </p>
*
* @param additionalExtensions
* @param additionalExtensions TODO javadoc me please
* @param returnedExtensions a collection that will be filled with the returned packet
* extensions
* @return List of {@link Subscription}
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Subscription> getSubscriptions(List<ExtensionElement> additionalExtensions, Collection<ExtensionElement> returnedExtensions)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -165,10 +165,10 @@ public abstract class Node {
* Get the subscriptions currently associated with this node as owner.
*
* @return List of {@link Subscription}
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see #getSubscriptionsAsOwner(List, Collection)
* @since 4.1
*/
@ -189,13 +189,13 @@ public abstract class Node {
* {@code returnedExtensions} will be filled with the stanza extensions found in the answer.
* </p>
*
* @param additionalExtensions
* @param additionalExtensions TODO javadoc me please
* @param returnedExtensions a collection that will be filled with the returned stanza extensions
* @return List of {@link Subscription}
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://www.xmpp.org/extensions/xep-0060.html#owner-subscriptions-retrieve">XEP-60 § 8.8.1 -
* Retrieve Subscriptions List</a>
* @since 4.1
@ -234,10 +234,10 @@ public abstract class Node {
*
* @param changedSubs subscriptions that have changed
* @return <code>null</code> or a PubSub stanza with additional information on success.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="https://xmpp.org/extensions/xep-0060.html#owner-subscriptions-modify">XEP-60 § 8.8.2 Modify Subscriptions</a>
* @since 4.3
*/
@ -253,10 +253,10 @@ public abstract class Node {
* Get the affiliations of this node.
*
* @return List of {@link Affiliation}
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliation> getAffiliations() throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException {
@ -274,10 +274,10 @@ public abstract class Node {
* @param returnedExtensions a collection that will be filled with the returned packet
* extensions
* @return List of {@link Affiliation}
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Affiliation> getAffiliations(List<ExtensionElement> additionalExtensions, Collection<ExtensionElement> returnedExtensions)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -289,10 +289,10 @@ public abstract class Node {
* Retrieve the affiliation list for this node as owner.
*
* @return list of entities whose affiliation is not 'none'.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see #getAffiliations(List, Collection)
* @since 4.2
*/
@ -312,10 +312,10 @@ public abstract class Node {
* @param returnedExtensions an optional collection that will be filled with the returned
* extension elements.
* @return list of entities whose affiliation is not 'none'.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://www.xmpp.org/extensions/xep-0060.html#owner-affiliations-retrieve">XEP-60 § 8.9.1 Retrieve Affiliations List</a>
* @since 4.2
*/
@ -351,12 +351,12 @@ public abstract class Node {
* Note that this is an <b>optional</b> PubSub feature ('pubsub#modify-affiliations').
* </p>
*
* @param affiliations
* @param affiliations TODO javadoc me please
* @return <code>null</code> or a PubSub stanza with additional information on success.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://www.xmpp.org/extensions/xep-0060.html#owner-affiliations-modify">XEP-60 § 8.9.2 Modify Affiliation</a>
* @since 4.2
*/
@ -385,10 +385,10 @@ public abstract class Node {
* the caller can configure it but is not required to do so.
* @param jid The jid to subscribe as.
* @return The subscription
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Subscription subscribe(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub pubSub = createPubsubPacket(Type.set, new SubscribeExtension(jid, getId()));
@ -410,10 +410,10 @@ public abstract class Node {
*
* @param jidString The jid to subscribe as.
* @return The subscription
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws IllegalArgumentException if the provided string is not a valid JID.
* @deprecated use {@link #subscribe(Jid)} instead.
*/
@ -443,13 +443,13 @@ public abstract class Node {
* the caller can configure it but is not required to do so.
*
* @param jid The jid to subscribe as.
* @param subForm
* @param subForm TODO javadoc me please
*
* @return The subscription
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Subscription subscribe(Jid jid, SubscribeForm subForm) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = createPubsubPacket(Type.set, new SubscribeExtension(jid, getId()));
@ -472,13 +472,13 @@ public abstract class Node {
* the caller can configure it but is not required to do so.
*
* @param jidString The jid to subscribe as.
* @param subForm
* @param subForm TODO javadoc me please
*
* @return The subscription
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws IllegalArgumentException if the provided string is not a valid JID.
* @deprecated use {@link #subscribe(Jid, SubscribeForm)} instead.
*/
@ -500,10 +500,10 @@ public abstract class Node {
* use {@link #unsubscribe(String, String)}.
*
* @param jid The JID used to subscribe to the node
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public void unsubscribe(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -515,10 +515,10 @@ public abstract class Node {
*
* @param jid The JID used to subscribe to the node
* @param subscriptionId The id of the subscription being removed
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void unsubscribe(String jid, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
sendPubsubPacket(createPubsubPacket(Type.set, new UnsubscribeExtension(jid, getId(), subscriptionId)));
@ -528,13 +528,13 @@ public abstract class Node {
* Returns a SubscribeForm for subscriptions, from which you can create an answer form to be submitted
* via the {@link #sendConfigurationForm(Form)}.
*
* @param jid
* @param jid TODO javadoc me please
*
* @return A subscription options form
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public SubscribeForm getSubscriptionOptions(String jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return getSubscriptionOptions(jid, null);
@ -548,10 +548,10 @@ public abstract class Node {
* @param subscriptionId The subscription id
*
* @return The subscription option form
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public SubscribeForm getSubscriptionOptions(String jid, String subscriptionId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

1
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java
View file

@ -107,6 +107,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
* error for an invalid packet.
* </p>
*
* @param itemNamespace the namespace of the item.
* @param itemId The id of this item.
* @param nodeId The id of the node the item was published to.
* @param payloadExt A {@link ExtensionElement} which represents the payload data.

139
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PubSubManager.java
View file

@ -86,7 +86,7 @@ public final class PubSubManager extends Manager {
/**
* Get a PubSub manager for the default PubSub service of the connection.
*
* @param connection
* @param connection TODO javadoc me please
* @return the default PubSub manager.
*/
// CHECKSTYLE:OFF:RegexpSingleline
@ -155,6 +155,8 @@ public final class PubSubManager extends Manager {
/**
* Deprecated.
*
* @param connection the connection.
* @return the PubSub manager for the given connection.
* @deprecated use {@link #getInstanceFor(XMPPConnection)} instead.
*/
@Deprecated
@ -166,6 +168,9 @@ public final class PubSubManager extends Manager {
/**
* Deprecated.
*
* @param connection the connection.
* @param pubSubService the XMPP address of the PubSub service.
* @return the PubSub manager for the given connection.
* @deprecated use {@link #getInstanceFor(XMPPConnection, BareJid)} instead.
*/
@Deprecated
@ -201,10 +206,10 @@ public final class PubSubManager extends Manager {
* Creates an instant node, if supported.
*
* @return The node that was created
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public LeafNode createNode() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub reply = sendPubsubPacket(Type.set, new NodeExtension(PubSubElementType.CREATE), null);
@ -222,10 +227,10 @@ public final class PubSubManager extends Manager {
* @param nodeId The id of the node, which must be unique within the
* pubsub service
* @return The node that was created
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public LeafNode createNode(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return (LeafNode) createNode(nodeId, null);
@ -240,10 +245,10 @@ public final class PubSubManager extends Manager {
* pubsub service
* @param config The configuration for the node
* @return The node that was created
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Node createNode(String nodeId, Form config) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
PubSub request = PubSub.createPubsubPacket(pubSubService, Type.set, new NodeExtension(PubSubElementType.CREATE, nodeId));
@ -275,9 +280,9 @@ public final class PubSubManager extends Manager {
* @return the node
* @throws XMPPErrorException The node does not exist
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotAPubSubNodeException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotAPubSubNodeException if a involved node is not a PubSub node.
*/
public Node getNode(String id) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException, NotAPubSubNodeException {
StringUtils.requireNotNullNorEmpty(id, "The node ID can not be null or the empty string");
@ -309,10 +314,10 @@ public final class PubSubManager extends Manager {
*
* @param id The unique ID of the node.
* @return the leaf node.
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotALeafNodeException in case the node already exists as collection node.
* @since 4.2.1
*/
@ -361,11 +366,11 @@ public final class PubSubManager extends Manager {
* @param id the node ID.
* @return the requested leaf node.
* @throws NotALeafNodeException in case the node exists but is a collection node.
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NotAPubSubNodeException
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotAPubSubNodeException if a involved node is not a PubSub node.
* @since 4.2.1
*/
public LeafNode getLeafNode(String id) throws NotALeafNodeException, NoResponseException, NotConnectedException,
@ -431,11 +436,11 @@ public final class PubSubManager extends Manager {
* @param <I> type of the item.
*
* @return the LeafNode on which the item was published.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotALeafNodeException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws NotALeafNodeException if a PubSub leaf node operation was attempted on a non-leaf node.
* @since 4.2.1
*/
public <I extends Item> LeafNode tryToPublishAndPossibleAutoCreate(String id, I item)
@ -467,10 +472,10 @@ public final class PubSubManager extends Manager {
* @param nodeId - The id of the collection node for which the child
* nodes will be returned.
* @return {@link DiscoverItems} representing the existing nodes
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverItems discoverNodes(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
DiscoverItems items = new DiscoverItems();
@ -486,10 +491,10 @@ public final class PubSubManager extends Manager {
* Gets the subscriptions on the root node.
*
* @return List of exceptions
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<Subscription> getSubscriptions() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
Stanza reply = sendPubsubPacket(Type.get, new NodeExtension(PubSubElementType.SUBSCRIPTIONS), null);
@ -501,10 +506,10 @@ public final class PubSubManager extends Manager {
* Gets the affiliations on the root node.
*
* @return List of affiliations
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*
*/
public List<Affiliation> getAffiliations() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -516,11 +521,11 @@ public final class PubSubManager extends Manager {
/**
* Delete the specified node.
*
* @param nodeId
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @param nodeId TODO javadoc me please
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @return <code>true</code> if this node existed and was deleted and <code>false</code> if this node did not exist.
*/
public boolean deleteNode(String nodeId) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -542,10 +547,10 @@ public final class PubSubManager extends Manager {
* Returns the default settings for Node configuration.
*
* @return configuration form containing the default settings.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ConfigureForm getDefaultConfiguration() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Errors will cause exceptions in getReply, so it only returns
@ -568,10 +573,10 @@ public final class PubSubManager extends Manager {
* as a standard {@link DiscoverInfo} instance.
*
* @return The supported features
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public DiscoverInfo getSupportedFeatures() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
ServiceDiscoveryManager mgr = ServiceDiscoveryManager.getInstanceFor(connection());
@ -582,10 +587,10 @@ public final class PubSubManager extends Manager {
* Check if the PubSub service supports automatic node creation.
*
* @return true if the PubSub service supports automatic node creation.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.1
* @see <a href="https://xmpp.org/extensions/xep-0060.html#publisher-publish-autocreate">XEP-0060 § 7.1.4 Automatic Node Creation</a>
*/
@ -606,10 +611,10 @@ public final class PubSubManager extends Manager {
* </p>
*
* @return <code>true</code> if it is possible to create nodes, <code>false</code> otherwise.
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPErrorException if there was an XMPP error returned.
*/
public boolean canCreateNodesAndPublishItems() throws NoResponseException, NotConnectedException, InterruptedException, XMPPErrorException {
LeafNode leafNode = null;
@ -664,12 +669,12 @@ public final class PubSubManager extends Manager {
* simply an arbitrary XMPP service with the PubSub feature and an identity of category "pubsub"
* and type "service".
*
* @param connection
* @param connection TODO javadoc me please
* @return the default PubSub service or <code>null</code>.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0060.html#entity-features">XEP-60 § 5.1 Discover
* Features</a>
*/

2
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SubscribeForm.java
View file

@ -65,7 +65,7 @@ public class SubscribeForm extends Form {
/**
* Sets whether an entity wants to receive notifications.
*
* @param deliverNotifications
* @param deliverNotifications TODO javadoc me please
*/
public void setDeliverOn(boolean deliverNotifications) {
addField(SubscribeOptionFields.deliver, FormField.Type.bool);

4
smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/util/NodeUtils.java
View file

@ -32,8 +32,8 @@ public class NodeUtils {
/**
* Get a {@link ConfigureForm} from a packet.
*
* @param packet
* @param elem
* @param packet TODO javadoc me please
* @param elem TODO javadoc me please
* @return The configuration form
*/
public static ConfigureForm getFormFromPacket(Stanza packet, PubSubElementType elem) {

6
smack-extensions/src/main/java/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
View file

@ -207,11 +207,11 @@ public final class DeliveryReceiptManager extends Manager {
/**
* Returns true if Delivery Receipts are supported by a given JID.
*
* @param jid
* @param jid TODO javadoc me please
* @return true if supported
* @throws SmackException if there was no response from the server.
* @throws XMPPException
* @throws InterruptedException
* @throws XMPPException if an XMPP protocol error was received.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isSupported(Jid jid) throws SmackException, XMPPException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid,

24
smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearch.java
View file

@ -65,10 +65,10 @@ public class UserSearch extends SimpleIQ {
* @param con the current XMPPConnection.
* @param searchService the search service to use. (ex. search.jivesoftware.com)
* @return the search form received by the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Form getSearchForm(XMPPConnection con, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
UserSearch search = new UserSearch();
@ -86,10 +86,10 @@ public class UserSearch extends SimpleIQ {
* @param searchForm the <code>Form</code> to send for querying.
* @param searchService the search service to use. (ex. search.jivesoftware.com)
* @return ReportedData the data found from the query.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ReportedData sendSearchForm(XMPPConnection con, Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
UserSearch search = new UserSearch();
@ -108,10 +108,10 @@ public class UserSearch extends SimpleIQ {
* @param searchForm the <code>Form</code> to send for querying.
* @param searchService the search service to use. (ex. search.jivesoftware.com)
* @return ReportedData the data found from the query.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ReportedData sendSimpleSearchForm(XMPPConnection con, Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
SimpleUserSearch search = new SimpleUserSearch();

24
smack-extensions/src/main/java/org/jivesoftware/smackx/search/UserSearchManager.java
View file

@ -66,10 +66,10 @@ public class UserSearchManager {
*
* @param searchService the search service to query.
* @return the form to fill out to perform a search.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public Form getSearchForm(DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return userSearch.getSearchForm(con, searchService);
@ -82,10 +82,10 @@ public class UserSearchManager {
* @param searchForm the <code>Form</code> to submit for searching.
* @param searchService the name of the search service to use.
* @return the ReportedData returned by the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public ReportedData getSearchResults(Form searchForm, DomainBareJid searchService) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return userSearch.sendSearchForm(con, searchForm, searchService);
@ -96,10 +96,10 @@ public class UserSearchManager {
* Returns a collection of search services found on the server.
*
* @return a Collection of search services found on the server.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public List<DomainBareJid> getSearchServices() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
ServiceDiscoveryManager discoManager = ServiceDiscoveryManager.getInstanceFor(con);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/sharedgroups/SharedGroupManager.java
View file

@ -42,10 +42,10 @@ public class SharedGroupManager {
*
* @param connection connection to use to get the user's shared groups.
* @return collection with the shared groups' name of the logged user.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public static List<String> getSharedGroups(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// Discover the shared groups of the logged user

2
smack-extensions/src/main/java/org/jivesoftware/smackx/shim/packet/HeadersExtension.java
View file

@ -70,7 +70,7 @@ public class HeadersExtension implements ExtensionElement {
/**
* Return the SHIM headers extension of this stanza or null if there is none.
*
* @param packet
* @param packet TODO javadoc me please
* @return the headers extension or null.
*/
public static HeadersExtension from(Stanza packet) {

40
smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/VCardManager.java
View file

@ -69,13 +69,13 @@ public final class VCardManager extends Manager {
/**
* Returns true if the given entity understands the vCard-XML format and allows the exchange of such.
*
* @param jid
* @param connection
* @param jid TODO javadoc me please
* @param connection TODO javadoc me please
* @return true if the given entity understands the vCard-XML format and exchange.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link #isSupported(Jid)} instead.
*/
@Deprecated
@ -96,8 +96,8 @@ public final class VCardManager extends Manager {
*
* @throws XMPPErrorException thrown if there was an issue setting the VCard in the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public void saveVCard(VCard vcard) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
// XEP-54 § 3.2 "A user may publish or update his or her vCard by sending an IQ of type "set" with no 'to' address…"
@ -113,10 +113,10 @@ public final class VCardManager extends Manager {
* Load the VCard of the current user.
*
* @return VCard.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public VCard loadVCard() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return loadVCard(null);
@ -128,10 +128,10 @@ public final class VCardManager extends Manager {
* @param bareJid bareJid of the user.
*
* @return VCard.
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public VCard loadVCard(EntityBareJid bareJid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
VCard vcardRequest = new VCard();
@ -143,12 +143,12 @@ public final class VCardManager extends Manager {
/**
* Returns true if the given entity understands the vCard-XML format and allows the exchange of such.
*
* @param jid
* @param jid TODO javadoc me please
* @return true if the given entity understands the vCard-XML format and exchange.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
*/
public boolean isSupported(Jid jid) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).supportsFeature(jid, NAMESPACE);

18
smack-extensions/src/main/java/org/jivesoftware/smackx/vcardtemp/packet/VCard.java
View file

@ -547,8 +547,8 @@ public final class VCard extends IQ {
* @param connection the XMPPConnection to use.
* @throws XMPPErrorException thrown if there was an issue setting the VCard in the server.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link VCardManager#saveVCard(VCard)} instead.
*/
@Deprecated
@ -561,10 +561,10 @@ public final class VCard extends IQ {
* and not anonymous.
*
* @param connection connection.
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
* @throws InterruptedException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link VCardManager#loadVCard()} instead.
*/
@Deprecated
@ -578,10 +578,10 @@ public final class VCard extends IQ {
* @param connection connection.
* @param user user whos information we want to load.
*
* @throws XMPPErrorException
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
* @throws InterruptedException
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link VCardManager#loadVCard(EntityBareJid)} instead.
*/
@Deprecated

8
smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/FormField.java
View file

@ -491,6 +491,7 @@ public final class FormField implements FullyQualifiedElement {
* Sets an indicative of the format for the data to answer.
*
* @param type an indicative of the format for the data to answer.
* @return a reference to this builder.
* @see Type
*/
public Builder setType(Type type) {
@ -517,6 +518,7 @@ public final class FormField implements FullyQualifiedElement {
* </p>
*
* @param description provides extra clarification about the question.
* @return a reference to this builder.
*/
public Builder setDescription(String description) {
Description descriptionElement = new Description(description);
@ -529,6 +531,7 @@ public final class FormField implements FullyQualifiedElement {
* fill out the form.
*
* @param label the label of the question.
* @return a reference to this builder.
*/
public Builder setLabel(String label) {
this.label = label;
@ -539,6 +542,7 @@ public final class FormField implements FullyQualifiedElement {
* Sets if the question must be answered in order to complete the questionnaire.
*
* @param required if the question must be answered in order to complete the questionnaire.
* @return a reference to this builder.
*/
public Builder setRequired(boolean required) {
setOnlyElement(Required.INSTANCE, Required.class);
@ -550,6 +554,7 @@ public final class FormField implements FullyQualifiedElement {
* Otherwise, adds an answered value to the question.
*
* @param value a default value or an answered value of the question.
* @return a reference to this builder.
*/
public Builder addValue(CharSequence value) {
return addFormFieldChildElement(new Value(value));
@ -560,6 +565,7 @@ public final class FormField implements FullyQualifiedElement {
* instance was formated.
*
* @param date the date instance to add as XEP-0082 formated string.
* @return a reference to this builder.
*/
public Builder addValue(Date date) {
String dateString = XmppDateTime.formatXEP0082Date(date);
@ -571,6 +577,7 @@ public final class FormField implements FullyQualifiedElement {
* Otherwise, adds an answered values to the question.
*
* @param values default values or an answered values of the question.
* @return a reference to this builder.
*/
public Builder addValues(Collection<? extends CharSequence> values) {
for (CharSequence value : values) {
@ -588,6 +595,7 @@ public final class FormField implements FullyQualifiedElement {
* the question.
*
* @param option a new available option for the question.
* @return a reference to this builder.
*/
public Builder addOption(Option option) {
return addFormFieldChildElement(option);

8
smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/XDataManager.java
View file

@ -88,10 +88,10 @@ public final class XDataManager extends Manager {
*
* @param jid the JID of the entity to check.
* @return true if the entity supports data forms.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0004.html#disco">XEP-0004: Data Forms § 6. Service Discovery</a>
* @since 4.1
*/

8
smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/packet/DataForm.java
View file

@ -151,7 +151,7 @@ public class DataForm implements ExtensionElement {
/**
* Return the form field with the given variable name or null.
*
* @param variableName
* @param variableName TODO javadoc me please
* @return the form field or null.
* @since 4.1
*/
@ -175,7 +175,7 @@ public class DataForm implements ExtensionElement {
/**
* Check if a form field with the given variable name exists.
*
* @param variableName
* @param variableName TODO javadoc me please
* @return true if a form field with the variable name exists, false otherwise.
* @since 4.2
*/
@ -250,7 +250,7 @@ public class DataForm implements ExtensionElement {
/**
* Add the given fields to this form.
*
* @param fieldsToAdd
* @param fieldsToAdd TODO javadoc me please
* @return true if a field was overridden.
* @since 4.3.0
*/
@ -357,7 +357,7 @@ public class DataForm implements ExtensionElement {
/**
* Get data form from stanza.
* @param packet
* @param packet TODO javadoc me please
* @return the DataForm or null
*/
public static DataForm from(Stanza packet) {

8
smack-extensions/src/main/java/org/jivesoftware/smackx/xdatalayout/packet/DataLayout.java
View file

@ -41,7 +41,7 @@ public class DataLayout implements ExtensionElement {
/**
* Data layout constructor.
* @param label
* @param label TODO javadoc me please
*/
public DataLayout(String label) {
this.label = label;
@ -104,8 +104,8 @@ public class DataLayout implements ExtensionElement {
}
/**
* @param buf
* @param pageLayout
* @param buf TODO javadoc me please
* @param pageLayout TODO javadoc me please
*/
private static void walkList(XmlStringBuilder buf, List<DataFormLayoutElement> pageLayout) {
for (DataFormLayoutElement object : pageLayout) {
@ -158,7 +158,7 @@ public class DataLayout implements ExtensionElement {
/**
* Section constructor.
* @param label
* @param label TODO javadoc me please
*/
public Section(String label) {
this.label = label;

2
smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/ValidationConsistencyException.java
View file

@ -33,7 +33,7 @@ public class ValidationConsistencyException extends IllegalArgumentException {
/**
* Validation consistency exception constructor.
* @param message
* @param message TODO javadoc me please
*/
public ValidationConsistencyException(String message) {
super(message);

22
smack-extensions/src/main/java/org/jivesoftware/smackx/xdatavalidation/packet/ValidateElement.java
View file

@ -108,7 +108,7 @@ public abstract class ValidateElement implements FormFieldChildElement {
}
/**
* @param buf
* @param buf TODO javadoc me please
*/
protected abstract void appendXML(XmlStringBuilder buf);
@ -152,7 +152,7 @@ public abstract class ValidateElement implements FormFieldChildElement {
/**
* Basic validate element constructor.
* @param datatype
* @param datatype TODO javadoc me please
* @see #getDatatype()
*/
public BasicValidateElement(String datatype) {
@ -195,7 +195,7 @@ public abstract class ValidateElement implements FormFieldChildElement {
/**
* Open validate element constructor.
* @param datatype
* @param datatype TODO javadoc me please
* @see #getDatatype()
*/
public OpenValidateElement(String datatype) {
@ -237,7 +237,7 @@ public abstract class ValidateElement implements FormFieldChildElement {
/**
* Range validate element constructor.
* @param datatype
* @param datatype TODO javadoc me please
* @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.
* @see #getDatatype()
@ -302,8 +302,8 @@ public abstract class ValidateElement implements FormFieldChildElement {
/**
* Regex validate element.
* @param datatype
* @param regex
* @param datatype TODO javadoc me please
* @param regex TODO javadoc me please
* @see #getDatatype()
*/
public RegexValidateElement(String datatype, String regex) {
@ -351,8 +351,8 @@ public abstract class ValidateElement implements FormFieldChildElement {
* specifies the minimum allowable number of selected/entered values. Both attributes are optional, but at
* least one must bet set, and the value must be within the range of a unsigned 32-bit integer.
*
* @param min
* @param max
* @param min TODO javadoc me please
* @param max TODO javadoc me please
*/
public ListRange(UInt32 min, UInt32 max) {
if (max == null && min == null) {
@ -400,7 +400,7 @@ public abstract class ValidateElement implements FormFieldChildElement {
* The &gt;list-range/&lt; element SHOULD be included only when the &lt;field/&gt; is of type "list-multi" and SHOULD be ignored
* otherwise.
*
* @param formField
* @param formField TODO javadoc me please
*/
protected void checkListRangeConsistency(FormField.Builder formField) {
ListRange listRange = getListRange();
@ -417,8 +417,8 @@ public abstract class ValidateElement implements FormFieldChildElement {
}
/**
* @param formField
* @param method
* @param formField TODO javadoc me please
* @param method TODO javadoc me please
*/
protected void checkNonMultiConsistency(FormField.Builder formField, String method) {
checkListRangeConsistency(formField);

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