1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-24 15:22:07 +01:00

Enable werror for javadoc and fix javadoc issues

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

View file

@ -251,15 +251,9 @@ allprojects {
// gradle. // gradle.
options.addStringOption('Xdoclint:all', '-quiet') options.addStringOption('Xdoclint:all', '-quiet')
// TODO: Add
// Treat warnings as errors. // Treat warnings as errors.
// See also https://bugs.openjdk.java.net/browse/JDK-8200363 // See also https://bugs.openjdk.java.net/browse/JDK-8200363
// options.addStringOption('Xwerror', '-quiet') options.addStringOption('Xwerror', '-quiet')
// after all javadoc warnings have been resolved and
// remove Xwerror from the subprojects build.gradle files
// (e.g. smack-android-extensions).
} }
} }
tasks.withType(Javadoc) { tasks.withType(Javadoc) {

133
resources/fix-a-javadoc.sh Executable file
View file

@ -0,0 +1,133 @@
#!/usr/bin/env bash
set -e
# Pretty fancy method to get reliable the absolute path of a shell
# script, *even if it is sourced*. Credits go to GreenFox on
# stackoverflow: http://stackoverflow.com/a/12197518/194894
pushd . > /dev/null
SCRIPTDIR="${BASH_SOURCE[0]}";
while([ -h "${SCRIPTDIR}" ]); do
cd "`dirname "${SCRIPTDIR}"`"
SCRIPTDIR="$(readlink "`basename "${SCRIPTDIR}"`")";
done
cd "`dirname "${SCRIPTDIR}"`" > /dev/null
SCRIPTDIR="`pwd`";
popd > /dev/null
SMACK_DIR=$(readlink "${SCRIPTDIR}"/..)
FIND_ALL_JAVA_SRC="find ${SMACK_DIR} \
-type f \
-name *.java \
-print"
declare -A SMACK_EXCEPTIONS
SMACK_EXCEPTIONS[NotConnectedException]="if the XMPP connection is not connected."
SMACK_EXCEPTIONS[InterruptedException]="if the calling thread was interrupted."
SMACK_EXCEPTIONS[XMPPErrorException]="if there was an XMPP error returned."
SMACK_EXCEPTIONS[NoResponseException]="if there was no response from the remote entity."
SMACK_EXCEPTIONS[NotLoggedInException]="if the XMPP connection is not authenticated."
SMACK_EXCEPTIONS[BOSHException]="if an BOSH related error occured."
SMACK_EXCEPTIONS[IOException]="if an I/O error occured."
SMACK_EXCEPTIONS[SmackException]="if Smack detected an exceptional situation."
SMACK_EXCEPTIONS[XMPPException]="if an XMPP protocol error was received."
SMACK_EXCEPTIONS[SmackSaslException]="if a SASL specific error occured."
SMACK_EXCEPTIONS[SASLErrorException]="if a SASL protocol error was returned."
SMACK_EXCEPTIONS[NotAMucServiceException]="if the entity is not a MUC serivce."
SMACK_EXCEPTIONS[NoSuchAlgorithmException]="if no such algorithm is available."
SMACK_EXCEPTIONS[KeyManagementException]="if there was a key mangement error."
SMACK_EXCEPTIONS[XmppStringprepException]="if the provided string is invalid."
SMACK_EXCEPTIONS[XmlPullParserException]="if an error in the XML parser occured."
SMACK_EXCEPTIONS[SmackParsingException]="if the Smack parser (provider) encountered invalid input."
SMACK_EXCEPTIONS[MucNotJoinedException]="if not joined to the Multi-User Chat."
SMACK_EXCEPTIONS[MucAlreadyJoinedException]="if already joined the Multi-User Chat."7y
SMACK_EXCEPTIONS[NotALeafNodeException]="if a PubSub leaf node operation was attempted on a non-leaf node."
SMACK_EXCEPTIONS[FeatureNotSupportedException]="if a requested feature is not supported by the remote entity."
SMACK_EXCEPTIONS[MucConfigurationNotSupportedException]="if the requested MUC configuration is not supported by the MUC service."
SMACK_EXCEPTIONS[CouldNotConnectToAnyProvidedSocks5Host]="if no connection to any provided stream host could be established"
SMACK_EXCEPTIONS[NoSocks5StreamHostsProvided]="if no stream host was provided."
SMACK_EXCEPTIONS[SmackMessageException]="if there was an error."
SMACK_EXCEPTIONS[SecurityException]="if there was a security violation."
SMACK_EXCEPTIONS[InvocationTargetException]="if a reflection-based method or constructor invocation threw."
SMACK_EXCEPTIONS[IllegalArgumentException]="if an illegal argument was given."
SMACK_EXCEPTIONS[NotAPubSubNodeException]="if a involved node is not a PubSub node."
SMACK_EXCEPTIONS[NoAcceptableTransferMechanisms]="if no acceptable transfer mechanisms are available"
SMACK_EXCEPTIONS[NoSuchMethodException]="if no such method is declared"
SMACK_EXCEPTIONS[Exception]="if an exception occured."
SMACK_EXCEPTIONS[TestNotPossibleException]="if the test is not possible."
SMACK_EXCEPTIONS[TimeoutException]="if there was a timeout."
SMACK_EXCEPTIONS[IllegalStateException]="if an illegal state was encountered"
SMACK_EXCEPTIONS[NoSuchPaddingException]="if the requested padding mechanism is not availble."
SMACK_EXCEPTIONS[BadPaddingException]="if the input data is not padded properly."
SMACK_EXCEPTIONS[InvalidKeyException]="if the key is invalid."
SMACK_EXCEPTIONS[IllegalBlockSizeException]="if the input data length is incorrect."
SMACK_EXCEPTIONS[InvalidAlgorithmParameterException]="if the provided arguments are invalid."
SMACK_EXCEPTIONS[CorruptedOmemoKeyException]="if the OMEMO key is corrupted."
SMACK_EXCEPTIONS[CryptoFailedException]="if the OMEMO cryptography failed."
SMACK_EXCEPTIONS[CannotEstablishOmemoSessionException]="if no OMEMO session could be established."
SMACK_EXCEPTIONS[UntrustedOmemoIdentityException]="if the OMEMO identity is not trusted."
MODE=""
while getopts dm: OPTION "$@"; do
case $OPTION in
d)
set -x
;;
m)
MODE=${OPTARG}
;;
*)
echo "Unknown option ${OPTION}"
exit 1
;;
esac
done
sed_sources() {
sedScript=${1}
${FIND_ALL_JAVA_SRC} |\
xargs sed \
--in-place \
--follow-symlinks \
--regexp-extended \
"${sedScript}"
}
show_affected() {
echo ${!SMACK_EXCEPTIONS{@}}
for exception in ${!SMACK_EXCEPTIONS[@]}; do
${FIND_ALL_JAVA_SRC} |\
xargs grep " \* @throws $exception$" || true
done
for exception in ${!SMACK_EXCEPTIONS[@]}; do
count=$(${FIND_ALL_JAVA_SRC} |\
xargs grep " \* @throws $exception$" | wc -l)
echo "$exception $count"
done
}
fix_affected() {
for exception in "${!SMACK_EXCEPTIONS[@]}"; do
exceptionJavadoc=${SMACK_EXCEPTIONS[${exception}]}
sed_sources "s;@throws ((\w*\.)?${exception})\$;@throws \1 ${exceptionJavadoc};"
done
}
add_todo_to_param_and_return() {
sed_sources "s;@(param|return) (\w*)\$;@\1 \2 TODO javadoc me please;"
}
case $MODE in
show)
show_affected
;;
fix)
fix_affected
;;
*)
echo "Unknown mode ${mode}"
exit 1
esac

View file

@ -7,11 +7,3 @@ dependencies {
compile project(':smack-android') compile project(':smack-android')
compile project(':smack-extensions') compile project(':smack-extensions')
} }
if (JavaVersion.current().isJava8Compatible()) {
tasks.withType(Javadoc) {
// Treat warnings as errors.
// See also https://bugs.openjdk.java.net/browse/JDK-8200363
options.addStringOption('Xwerror', '-quiet')
}
}

View file

@ -296,7 +296,7 @@ public class XMPPBOSHConnection extends AbstractXMPPConnection {
* Send a HTTP request to the connection manager with the provided body element. * Send a HTTP request to the connection manager with the provided body element.
* *
* @param body the body which will be sent. * @param body the body which will be sent.
* @throws BOSHException * @throws BOSHException if an BOSH (Bidirectional-streams Over Synchronous HTTP, XEP-0124) related error occurs
*/ */
protected void send(ComposableBody body) throws BOSHException { protected void send(ComposableBody body) throws BOSHException {
if (!connected) { if (!connected) {

View file

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

View file

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

View file

@ -24,7 +24,7 @@ public class MockPacket extends Packet {
/** /**
* Returns null always. * Returns null always.
* @return null * @return null TODO javadoc me please
*/ */
public String toXML() { public String toXML() {
return null; return null;

View file

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

View file

@ -503,7 +503,7 @@ public abstract class SmackTestCase extends TestCase {
/** /**
* Subscribes all connections with each other: They all become friends * Subscribes all connections with each other: They all become friends
* *
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
*/ */
protected void letsAllBeFriends() throws XMPPException { protected void letsAllBeFriends() throws XMPPException {
ConnectionUtils.letsAllBeFriends(connections); ConnectionUtils.letsAllBeFriends(connections);

View file

@ -488,9 +488,9 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* *
* @throws XMPPException if an error occurs on the XMPP protocol level. * @throws XMPPException if an error occurs on the XMPP protocol level.
* @throws SmackException if an error occurs somewhere else besides XMPP protocol level. * @throws SmackException if an error occurs somewhere else besides XMPP protocol level.
* @throws IOException * @throws IOException if an I/O error occured.
* @return a reference to this object, to chain <code>connect()</code> with <code>login()</code>. * @return a reference to this object, to chain <code>connect()</code> with <code>login()</code>.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public synchronized AbstractXMPPConnection connect() throws SmackException, IOException, XMPPException, InterruptedException { public synchronized AbstractXMPPConnection connect() throws SmackException, IOException, XMPPException, InterruptedException {
// Check if not already connected // Check if not already connected
@ -528,10 +528,10 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* way of XMPP connection establishment. Implementations are required to perform an automatic * way of XMPP connection establishment. Implementations are required to perform an automatic
* login if the previous connection state was logged (authenticated). * login if the previous connection state was logged (authenticated).
* *
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
protected abstract void connectInternal() throws SmackException, IOException, XMPPException, InterruptedException; protected abstract void connectInternal() throws SmackException, IOException, XMPPException, InterruptedException;
@ -563,7 +563,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* @throws XMPPException if an error occurs on the XMPP protocol level. * @throws XMPPException if an error occurs on the XMPP protocol level.
* @throws SmackException if an error occurs somewhere else besides XMPP protocol level. * @throws SmackException if an error occurs somewhere else besides XMPP protocol level.
* @throws IOException if an I/O error occurs during login. * @throws IOException if an I/O error occurs during login.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public synchronized void login() throws XMPPException, SmackException, IOException, InterruptedException { public synchronized void login() throws XMPPException, SmackException, IOException, InterruptedException {
// The previously used username, password and resource take over precedence over the // The previously used username, password and resource take over precedence over the
@ -578,12 +578,12 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* Same as {@link #login(CharSequence, String, Resourcepart)}, but takes the resource from the connection * Same as {@link #login(CharSequence, String, Resourcepart)}, but takes the resource from the connection
* configuration. * configuration.
* *
* @param username * @param username TODO javadoc me please
* @param password * @param password TODO javadoc me please
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @see #login * @see #login
*/ */
public synchronized void login(CharSequence username, String password) throws XMPPException, SmackException, public synchronized void login(CharSequence username, String password) throws XMPPException, SmackException,
@ -595,13 +595,13 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* Login with the given username (authorization identity). You may omit the password if a callback handler is used. * Login with the given username (authorization identity). You may omit the password if a callback handler is used.
* If resource is null, then the server will generate one. * If resource is null, then the server will generate one.
* *
* @param username * @param username TODO javadoc me please
* @param password * @param password TODO javadoc me please
* @param resource * @param resource TODO javadoc me please
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @see #login * @see #login
*/ */
public synchronized void login(CharSequence username, String password, Resourcepart resource) throws XMPPException, public synchronized void login(CharSequence username, String password, Resourcepart resource) throws XMPPException,
@ -847,7 +847,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* presence stanza with whatever data is set. * presence stanza with whatever data is set.
* *
* @param unavailablePresence the optional presence stanza to send during shutdown. * @param unavailablePresence the optional presence stanza to send during shutdown.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
*/ */
public synchronized void disconnect(Presence unavailablePresence) throws NotConnectedException { public synchronized void disconnect(Presence unavailablePresence) throws NotConnectedException {
if (unavailablePresence != null) { if (unavailablePresence != null) {
@ -1277,7 +1277,7 @@ public abstract class AbstractXMPPConnection implements XMPPConnection {
* they are a match with the filter. * they are a match with the filter.
* *
* @param stanza the stanza to process. * @param stanza the stanza to process.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
protected void processStanza(final Stanza stanza) throws InterruptedException { protected void processStanza(final Stanza stanza) throws InterruptedException {
assert stanza != null; assert stanza != null;

View file

@ -40,8 +40,8 @@ public abstract class AbstractXmppNioConnection extends AbstractXmppStateMachine
* Set the interest Ops of a SelectionKey. Since Java's NIO interestOps(int) can block at any time, we use a queue * Set the interest Ops of a SelectionKey. Since Java's NIO interestOps(int) can block at any time, we use a queue
* to perform the actual operation in the reactor where we can perform this operation non-blocking. * to perform the actual operation in the reactor where we can perform this operation non-blocking.
* *
* @param selectionKey * @param selectionKey TODO javadoc me please
* @param interestOps * @param interestOps TODO javadoc me please
*/ */
protected void setInterestOps(SelectionKey selectionKey, int interestOps) { protected void setInterestOps(SelectionKey selectionKey, int interestOps) {
SMACK_REACTOR.setInterestOps(selectionKey, interestOps); SMACK_REACTOR.setInterestOps(selectionKey, interestOps);

View file

@ -544,7 +544,7 @@ public abstract class ConnectionConfiguration {
/** /**
* Check if the given SASL mechansism is enabled in this connection configuration. * Check if the given SASL mechansism is enabled in this connection configuration.
* *
* @param saslMechanism * @param saslMechanism TODO javadoc me please
* @return true if the given SASL mechanism is enabled, false otherwise. * @return true if the given SASL mechanism is enabled, false otherwise.
*/ */
public boolean isEnabledSaslMechanism(String saslMechanism) { public boolean isEnabledSaslMechanism(String saslMechanism) {
@ -642,8 +642,8 @@ public abstract class ConnectionConfiguration {
* Although most services will follow that pattern. * Although most services will follow that pattern.
* </p> * </p>
* *
* @param jid * @param jid TODO javadoc me please
* @param password * @param password TODO javadoc me please
* @return a reference to this builder. * @return a reference to this builder.
* @since 4.4.0 * @since 4.4.0
*/ */
@ -916,7 +916,7 @@ public abstract class ConnectionConfiguration {
/** /**
* Set the enabled SSL/TLS protocols. * Set the enabled SSL/TLS protocols.
* *
* @param enabledSSLProtocols * @param enabledSSLProtocols TODO javadoc me please
* @return a reference to this builder. * @return a reference to this builder.
*/ */
public B setEnabledSSLProtocols(String[] enabledSSLProtocols) { public B setEnabledSSLProtocols(String[] enabledSSLProtocols) {
@ -939,7 +939,7 @@ public abstract class ConnectionConfiguration {
* Set the HostnameVerifier used to verify the hostname of SSLSockets used by XMPP connections * Set the HostnameVerifier used to verify the hostname of SSLSockets used by XMPP connections
* created with this ConnectionConfiguration. * created with this ConnectionConfiguration.
* *
* @param verifier * @param verifier TODO javadoc me please
* @return a reference to this builder. * @return a reference to this builder.
*/ */
public B setHostnameVerifier(HostnameVerifier verifier) { public B setHostnameVerifier(HostnameVerifier verifier) {

View file

@ -61,7 +61,7 @@ public final class ReconnectionManager {
/** /**
* Get a instance of ReconnectionManager for the given connection. * Get a instance of ReconnectionManager for the given connection.
* *
* @param connection * @param connection TODO javadoc me please
* @return a ReconnectionManager for the connection. * @return a ReconnectionManager for the connection.
*/ */
public static synchronized ReconnectionManager getInstanceFor(AbstractXMPPConnection connection) { public static synchronized ReconnectionManager getInstanceFor(AbstractXMPPConnection connection) {
@ -90,7 +90,7 @@ public final class ReconnectionManager {
* Set if the automatic reconnection mechanism will be enabled per default for new XMPP connections. The default is * Set if the automatic reconnection mechanism will be enabled per default for new XMPP connections. The default is
* 'false'. * 'false'.
* *
* @param enabled * @param enabled TODO javadoc me please
*/ */
public static void setEnabledPerDefault(boolean enabled) { public static void setEnabledPerDefault(boolean enabled) {
enabledPerDefault = enabled; enabledPerDefault = enabled;
@ -132,7 +132,7 @@ public final class ReconnectionManager {
/** /**
* Set the default Reconnection Policy to use. * Set the default Reconnection Policy to use.
* *
* @param reconnectionPolicy * @param reconnectionPolicy TODO javadoc me please
*/ */
public static void setDefaultReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) { public static void setDefaultReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) {
defaultReconnectionPolicy = reconnectionPolicy; defaultReconnectionPolicy = reconnectionPolicy;
@ -173,7 +173,7 @@ public final class ReconnectionManager {
/** /**
* Set the Reconnection Policy to use. * Set the Reconnection Policy to use.
* *
* @param reconnectionPolicy * @param reconnectionPolicy TODO javadoc me please
*/ */
public void setReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) { public void setReconnectionPolicy(ReconnectionPolicy reconnectionPolicy) {
this.reconnectionPolicy = reconnectionPolicy; this.reconnectionPolicy = reconnectionPolicy;

View file

@ -183,13 +183,13 @@ public final class SASLAuthentication {
* @param authzid the authorization identifier (typically null). * @param authzid the authorization identifier (typically null).
* @param sslSession the optional SSL/TLS session (if one was established) * @param sslSession the optional SSL/TLS session (if one was established)
* @return the used SASLMechanism. * @return the used SASLMechanism.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws SASLErrorException * @throws SASLErrorException if a SASL protocol error was returned.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws SmackSaslException * @throws SmackSaslException if a SASL specific error occured.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
*/ */
public SASLMechanism authenticate(String username, String password, EntityBareJid authzid, SSLSession sslSession) public SASLMechanism authenticate(String username, String password, EntityBareJid authzid, SSLSession sslSession)
throws XMPPErrorException, SASLErrorException, IOException, throws XMPPErrorException, SASLErrorException, IOException,
@ -239,8 +239,8 @@ public final class SASLAuthentication {
* to <code>false</code>. * to <code>false</code>.
* *
* @param challenge a base64 encoded string representing the challenge. * @param challenge a base64 encoded string representing the challenge.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void challengeReceived(String challenge) throws SmackException, InterruptedException { public void challengeReceived(String challenge) throws SmackException, InterruptedException {
challengeReceived(challenge, false); challengeReceived(challenge, false);
@ -254,9 +254,9 @@ public final class SASLAuthentication {
* *
* @param challenge a base64 encoded string representing the challenge. * @param challenge a base64 encoded string representing the challenge.
* @param finalChallenge true if this is the last challenge send by the server within the success stanza * @param finalChallenge true if this is the last challenge send by the server within the success stanza
* @throws SmackSaslException * @throws SmackSaslException if a SASL specific error occured.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void challengeReceived(String challenge, boolean finalChallenge) throws SmackSaslException, NotConnectedException, InterruptedException { public void challengeReceived(String challenge, boolean finalChallenge) throws SmackSaslException, NotConnectedException, InterruptedException {
try { try {
@ -271,8 +271,8 @@ public final class SASLAuthentication {
* Notification message saying that SASL authentication was successful. The next step * Notification message saying that SASL authentication was successful. The next step
* would be to bind the resource. * would be to bind the resource.
* @param success result of the authentication. * @param success result of the authentication.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void authenticated(Success success) throws SmackException, InterruptedException { public void authenticated(Success success) throws SmackException, InterruptedException {
// RFC6120 6.3.10 "At the end of the authentication exchange, the SASL server (the XMPP // RFC6120 6.3.10 "At the end of the authentication exchange, the SASL server (the XMPP

View file

@ -241,7 +241,7 @@ public final class SmackConfiguration {
/** /**
* Set the default parsing exception callback for all newly created connections. * Set the default parsing exception callback for all newly created connections.
* *
* @param callback * @param callback TODO javadoc me please
* @see ParsingExceptionCallback * @see ParsingExceptionCallback
*/ */
public static void setDefaultParsingExceptionCallback(ParsingExceptionCallback callback) { public static void setDefaultParsingExceptionCallback(ParsingExceptionCallback callback) {
@ -265,13 +265,20 @@ public final class SmackConfiguration {
/** /**
* Get compression handlers. * Get compression handlers.
* *
* @return a list of compression handlers.
* @deprecated use {@link #getCompressionHandlers()} instead. * @deprecated use {@link #getCompressionHandlers()} instead.
*/ */
@Deprecated @Deprecated
// TODO: Remove in Smack 4.4.
public static List<XMPPInputOutputStream> getCompresionHandlers() { public static List<XMPPInputOutputStream> getCompresionHandlers() {
return getCompressionHandlers(); return getCompressionHandlers();
} }
/**
* Get compression handlers.
*
* @return a list of compression handlers.
*/
public static List<XMPPInputOutputStream> getCompressionHandlers() { public static List<XMPPInputOutputStream> getCompressionHandlers() {
List<XMPPInputOutputStream> res = new ArrayList<>(compressionHandlers.size()); List<XMPPInputOutputStream> res = new ArrayList<>(compressionHandlers.size());
for (XMPPInputOutputStream ios : compressionHandlers) { for (XMPPInputOutputStream ios : compressionHandlers) {
@ -310,7 +317,7 @@ public final class SmackConfiguration {
* package is disabled (but can be manually enabled). * package is disabled (but can be manually enabled).
* </p> * </p>
* *
* @param className * @param className TODO javadoc me please
*/ */
public static void addDisabledSmackClass(String className) { public static void addDisabledSmackClass(String className) {
disabledSmackClasses.add(className); disabledSmackClasses.add(className);

View file

@ -292,7 +292,7 @@ public abstract class SmackFuture<V, E extends Exception> implements Future<V>,
* A simple version of InternalSmackFuture which implements isNonFatalException(E) as always returning * A simple version of InternalSmackFuture which implements isNonFatalException(E) as always returning
* <code>false</code> method. * <code>false</code> method.
* *
* @param <V> * @param <V> the return value of the future.
*/ */
public abstract static class SimpleInternalProcessStanzaSmackFuture<V, E extends Exception> public abstract static class SimpleInternalProcessStanzaSmackFuture<V, E extends Exception>
extends InternalProcessStanzaSmackFuture<V, E> { extends InternalProcessStanzaSmackFuture<V, E> {

View file

@ -148,7 +148,7 @@ public final class StanzaCollector implements AutoCloseable {
* *
* @param <P> type of the result stanza. * @param <P> type of the result stanza.
* @return the next available packet. * @return the next available packet.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
// TODO: Consider removing this method as it is hardly ever useful. // TODO: Consider removing this method as it is hardly ever useful.
@ -173,7 +173,7 @@ public final class StanzaCollector implements AutoCloseable {
* *
* @param <P> type of the result stanza. * @param <P> type of the result stanza.
* @return the next available packet. * @return the next available packet.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public <P extends Stanza> P nextResult() throws InterruptedException { public <P extends Stanza> P nextResult() throws InterruptedException {
return nextResult(connection.getReplyTimeout()); return nextResult(connection.getReplyTimeout());
@ -189,7 +189,7 @@ public final class StanzaCollector implements AutoCloseable {
* @param <P> type of the result stanza. * @param <P> type of the result stanza.
* @param timeout the timeout in milliseconds. * @param timeout the timeout in milliseconds.
* @return the next available stanza or <code>null</code> on timeout or connection error. * @return the next available stanza or <code>null</code> on timeout or connection error.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public <P extends Stanza> P nextResult(long timeout) throws InterruptedException { public <P extends Stanza> P nextResult(long timeout) throws InterruptedException {
@ -219,8 +219,8 @@ public final class StanzaCollector implements AutoCloseable {
* @return the next available stanza. * @return the next available stanza.
* @throws XMPPErrorException in case an error response was received. * @throws XMPPErrorException in case an error response was received.
* @throws NoResponseException if there was no response from the server. * @throws NoResponseException if there was no response from the server.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @see #nextResultOrThrow(long) * @see #nextResultOrThrow(long)
*/ */
public <P extends Stanza> P nextResultOrThrow() throws NoResponseException, XMPPErrorException, public <P extends Stanza> P nextResultOrThrow() throws NoResponseException, XMPPErrorException,
@ -387,7 +387,7 @@ public final class StanzaCollector implements AutoCloseable {
* Set the stanza filter used by this collector. If <code>null</code>, then all stanzas will * Set the stanza filter used by this collector. If <code>null</code>, then all stanzas will
* get collected by this collector. * get collected by this collector.
* *
* @param stanzaFilter * @param stanzaFilter TODO javadoc me please
* @return a reference to this configuration. * @return a reference to this configuration.
*/ */
public Configuration setStanzaFilter(StanzaFilter stanzaFilter) { public Configuration setStanzaFilter(StanzaFilter stanzaFilter) {
@ -399,7 +399,7 @@ public final class StanzaCollector implements AutoCloseable {
* Set the maximum size of this collector, i.e. how many stanzas this collector will collect * Set the maximum size of this collector, i.e. how many stanzas this collector will collect
* before dropping old ones. * before dropping old ones.
* *
* @param size * @param size TODO javadoc me please
* @return a reference to this configuration. * @return a reference to this configuration.
*/ */
public Configuration setSize(int size) { public Configuration setSize(int size) {
@ -411,7 +411,7 @@ public final class StanzaCollector implements AutoCloseable {
* Set the collector which timeout for the next result is reset once this collector collects * Set the collector which timeout for the next result is reset once this collector collects
* a packet. * a packet.
* *
* @param collector * @param collector TODO javadoc me please
* @return a reference to this configuration. * @return a reference to this configuration.
*/ */
public Configuration setCollectorToReset(StanzaCollector collector) { public Configuration setCollectorToReset(StanzaCollector collector) {

View file

@ -48,9 +48,9 @@ public interface StanzaListener {
* </p> * </p>
* *
* @param packet the stanza to process. * @param packet the stanza to process.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
*/ */
void processStanza(Stanza packet) throws NotConnectedException, InterruptedException, NotLoggedInException; void processStanza(Stanza packet) throws NotConnectedException, InterruptedException, NotLoggedInException;

View file

@ -140,7 +140,7 @@ public class SynchronizationPoint<E extends Exception> {
/** /**
* Check if this synchronization point is successful or wait the connections reply timeout. * Check if this synchronization point is successful or wait the connections reply timeout.
* @throws NoResponseException if there was no response marking the synchronization point as success or failed. * @throws NoResponseException if there was no response marking the synchronization point as success or failed.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @return <code>null</code> if synchronization point was successful, or the failure Exception. * @return <code>null</code> if synchronization point was successful, or the failure Exception.
*/ */
public Exception checkIfSuccessOrWait() throws NoResponseException, InterruptedException { public Exception checkIfSuccessOrWait() throws NoResponseException, InterruptedException {
@ -281,7 +281,7 @@ public class SynchronizationPoint<E extends Exception> {
* {@link #reportSuccess()}, {@link #reportFailure()} and {@link #reportFailure(Exception)} will either set this * {@link #reportSuccess()}, {@link #reportFailure()} and {@link #reportFailure(Exception)} will either set this
* synchronization point to {@link State#Success} or {@link State#Failure}. If none of them is set after the * synchronization point to {@link State#Success} or {@link State#Failure}. If none of them is set after the
* connections reply timeout, this method will set the state of {@link State#NoResponse}. * connections reply timeout, this method will set the state of {@link State#NoResponse}.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
private void waitForConditionOrTimeout() throws InterruptedException { private void waitForConditionOrTimeout() throws InterruptedException {
waitStart = System.currentTimeMillis(); waitStart = System.currentTimeMillis();
@ -324,7 +324,7 @@ public class SynchronizationPoint<E extends Exception> {
* The exception is thrown, if state is one of 'Initial', 'NoResponse' or 'RequestSent' * The exception is thrown, if state is one of 'Initial', 'NoResponse' or 'RequestSent'
* </p> * </p>
* @return <code>true</code> if synchronization point was successful, <code>false</code> on failure. * @return <code>true</code> if synchronization point was successful, <code>false</code> on failure.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
*/ */
private Exception checkForResponse() throws NoResponseException { private Exception checkForResponse() throws NoResponseException {
switch (state) { switch (state) {

View file

@ -183,7 +183,7 @@ public interface XMPPConnection {
* *
* @param stanza the stanza to send. * @param stanza the stanza to send.
* @throws NotConnectedException if the connection is not connected. * @throws NotConnectedException if the connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* */ * */
void sendStanza(Stanza stanza) throws NotConnectedException, InterruptedException; void sendStanza(Stanza stanza) throws NotConnectedException, InterruptedException;
@ -234,8 +234,8 @@ public interface XMPPConnection {
* </p> * </p>
* *
* @param nonza the Nonza to send. * @param nonza the Nonza to send.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
void sendNonza(Nonza nonza) throws NotConnectedException, InterruptedException; void sendNonza(Nonza nonza) throws NotConnectedException, InterruptedException;
@ -258,11 +258,12 @@ public interface XMPPConnection {
* Send an IQ request and wait for the response. * Send an IQ request and wait for the response.
* *
* @param request the IQ request * @param request the IQ request
* @param <I> the type of the expected result IQ.
* @return an IQ with type 'result' * @return an IQ with type 'result'
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @since 4.3 * @since 4.3
*/ */
<I extends IQ> I sendIqRequestAndWaitForResponse(IQ request) <I extends IQ> I sendIqRequestAndWaitForResponse(IQ request)
@ -276,8 +277,8 @@ public interface XMPPConnection {
* *
* @param request the IQ request to filter responses from * @param request the IQ request to filter responses from
* @return a new stanza collector. * @return a new stanza collector.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
StanzaCollector createStanzaCollectorAndSend(IQ request) throws NotConnectedException, InterruptedException; StanzaCollector createStanzaCollectorAndSend(IQ request) throws NotConnectedException, InterruptedException;
@ -290,8 +291,8 @@ public interface XMPPConnection {
* @param stanzaFilter the stanza filter to use. * @param stanzaFilter the stanza filter to use.
* @param stanza the stanza to send right after the collector got created * @param stanza the stanza to send right after the collector got created
* @return a new stanza collector. * @return a new stanza collector.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
*/ */
StanzaCollector createStanzaCollectorAndSend(StanzaFilter stanzaFilter, Stanza stanza) StanzaCollector createStanzaCollectorAndSend(StanzaFilter stanzaFilter, Stanza stanza)
throws NotConnectedException, InterruptedException; throws NotConnectedException, InterruptedException;
@ -498,7 +499,7 @@ public interface XMPPConnection {
* Set the FromMode for this connection instance. Defines how the 'from' attribute of outgoing * Set the FromMode for this connection instance. Defines how the 'from' attribute of outgoing
* stanzas should be populated by Smack. * stanzas should be populated by Smack.
* *
* @param fromMode * @param fromMode TODO javadoc me please
*/ */
void setFromMode(FromMode fromMode); void setFromMode(FromMode fromMode);
@ -514,8 +515,8 @@ public interface XMPPConnection {
* server, or <code>null</code> if the server doesn't support that feature. * server, or <code>null</code> if the server doesn't support that feature.
* *
* @param <F> {@link ExtensionElement} type of the feature. * @param <F> {@link ExtensionElement} type of the feature.
* @param element * @param element TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return a stanza extensions of the feature or <code>null</code> * @return a stanza extensions of the feature or <code>null</code>
*/ */
<F extends FullyQualifiedElement> F getFeature(String element, String namespace); <F extends FullyQualifiedElement> F getFeature(String element, String namespace);
@ -523,8 +524,8 @@ public interface XMPPConnection {
/** /**
* Return true if the server supports the given stream feature. * Return true if the server supports the given stream feature.
* *
* @param element * @param element TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return true if the server supports the stream feature. * @return true if the server supports the stream feature.
*/ */
boolean hasFeature(String element, String namespace); boolean hasFeature(String element, String namespace);
@ -552,6 +553,7 @@ public interface XMPPConnection {
* *
* @param stanza the stanza to send. * @param stanza the stanza to send.
* @param replyFilter the filter used for the response stanza. * @param replyFilter the filter used for the response stanza.
* @param <S> the type of the stanza to send.
* @return a SmackFuture for the response. * @return a SmackFuture for the response.
*/ */
<S extends Stanza> SmackFuture<S, Exception> sendAsync(S stanza, StanzaFilter replyFilter); <S extends Stanza> SmackFuture<S, Exception> sendAsync(S stanza, StanzaFilter replyFilter);
@ -562,6 +564,7 @@ public interface XMPPConnection {
* @param stanza the stanza to send. * @param stanza the stanza to send.
* @param replyFilter the filter used for the response stanza. * @param replyFilter the filter used for the response stanza.
* @param timeout the reply timeout in milliseconds. * @param timeout the reply timeout in milliseconds.
* @param <S> the type of the stanza to send.
* @return a SmackFuture for the response. * @return a SmackFuture for the response.
*/ */
<S extends Stanza> SmackFuture<S, Exception> sendAsync(S stanza, StanzaFilter replyFilter, long timeout); <S extends Stanza> SmackFuture<S, Exception> sendAsync(S stanza, StanzaFilter replyFilter, long timeout);
@ -588,7 +591,7 @@ public interface XMPPConnection {
/** /**
* Convenience method for {@link #unregisterIQRequestHandler(String, String, org.jivesoftware.smack.packet.IQ.Type)}. * Convenience method for {@link #unregisterIQRequestHandler(String, String, org.jivesoftware.smack.packet.IQ.Type)}.
* *
* @param iqRequestHandler * @param iqRequestHandler TODO javadoc me please
* @return the previously registered IQ request handler or null. * @return the previously registered IQ request handler or null.
*/ */
IQRequestHandler unregisterIQRequestHandler(IQRequestHandler iqRequestHandler); IQRequestHandler unregisterIQRequestHandler(IQRequestHandler iqRequestHandler);

View file

@ -86,17 +86,6 @@ public abstract class XMPPException extends Exception {
*/ */
private final Stanza request; private final Stanza request;
/**
* Creates a new XMPPErrorException with the given builder.
*
* @param xmppErrorBuilder
* @deprecated Use {@link #XMPPErrorException(Stanza, StanzaError)} instead.
*/
@Deprecated
public XMPPErrorException(StanzaError.Builder xmppErrorBuilder) {
this(null, xmppErrorBuilder.build());
}
/** /**
* Creates a new XMPPErrorException with the XMPPError that was the root case of the exception. * Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.
* *

View file

@ -76,7 +76,7 @@ public class Java7ZlibInputOutputStream extends XMPPInputOutputStream {
* byte without blocking, 0 means that the system is known to block for more input. * byte without blocking, 0 means that the system is known to block for more input.
* *
* @return 0 if no data is available, 1 otherwise * @return 0 if no data is available, 1 otherwise
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
@Override @Override
public int available() throws IOException { public int available() throws IOException {

View file

@ -30,7 +30,7 @@ public abstract class XMPPInputOutputStream {
* Only use sync flush if you fully understand the implications. * Only use sync flush if you fully understand the implications.
* *
* @see <a href="https://blog.thijsalkema.de/blog/2014/08/07/https-attacks-and-xmpp-2-crime-and-breach/">Attacks against XMPP when using compression</a> * @see <a href="https://blog.thijsalkema.de/blog/2014/08/07/https-attacks-and-xmpp-2-crime-and-breach/">Attacks against XMPP when using compression</a>
* @param flushMethod * @param flushMethod TODO javadoc me please
*/ */
public static void setFlushMethod(FlushMethod flushMethod) { public static void setFlushMethod(FlushMethod flushMethod) {
XMPPInputOutputStream.flushMethod = flushMethod; XMPPInputOutputStream.flushMethod = flushMethod;

View file

@ -36,7 +36,7 @@ public abstract class AbstractFromToMatchesFilter implements StanzaFilter {
* *
* @param address The address to filter for. If <code>null</code> is given, then * @param address The address to filter for. If <code>null</code> is given, then
* {@link #getAddressToCompare(Stanza)} must also return <code>null</code> to match. * {@link #getAddressToCompare(Stanza)} must also return <code>null</code> to match.
* @param ignoreResourcepart * @param ignoreResourcepart TODO javadoc me please
*/ */
protected AbstractFromToMatchesFilter(Jid address, boolean ignoreResourcepart) { protected AbstractFromToMatchesFilter(Jid address, boolean ignoreResourcepart) {
if (address != null && ignoreResourcepart) { if (address != null && ignoreResourcepart) {

View file

@ -39,7 +39,7 @@ public final class FromMatchesFilter extends AbstractFromToMatchesFilter {
* *
* @param address The address to filter for. If <code>null</code> is given, the stanza must not * @param address The address to filter for. If <code>null</code> is given, the stanza must not
* have a from address. * have a from address.
* @param ignoreResourcepart * @param ignoreResourcepart TODO javadoc me please
*/ */
public FromMatchesFilter(Jid address, boolean ignoreResourcepart) { public FromMatchesFilter(Jid address, boolean ignoreResourcepart) {
super(address, ignoreResourcepart); super(address, ignoreResourcepart);

View file

@ -61,7 +61,7 @@ public class PacketExtensionFilter implements StanzaFilter {
/** /**
* Creates a new stanza extension filter for the given stanza extension. * Creates a new stanza extension filter for the given stanza extension.
* *
* @param packetExtension * @param packetExtension TODO javadoc me please
*/ */
public PacketExtensionFilter(ExtensionElement packetExtension) { public PacketExtensionFilter(ExtensionElement packetExtension) {
this(packetExtension.getElementName(), packetExtension.getNamespace()); this(packetExtension.getElementName(), packetExtension.getNamespace());

View file

@ -59,7 +59,7 @@ public class StanzaExtensionFilter implements StanzaFilter {
/** /**
* Creates a new stanza extension filter for the given stanza extension. * Creates a new stanza extension filter for the given stanza extension.
* *
* @param packetExtension * @param packetExtension TODO javadoc me please
*/ */
public StanzaExtensionFilter(ExtensionElement packetExtension) { public StanzaExtensionFilter(ExtensionElement packetExtension) {
this(packetExtension.getElementName(), packetExtension.getNamespace()); this(packetExtension.getElementName(), packetExtension.getNamespace());

View file

@ -431,6 +431,7 @@ public abstract class AbstractXmppStateMachineConnection extends AbstractXMPPCon
/** /**
* Check if the state should be activated. * Check if the state should be activated.
* *
* @param walkStateGraphContext the context of the current state graph walk.
* @return <code>null</code> if the state should be activated. * @return <code>null</code> if the state should be activated.
* @throws SmackException in case a Smack exception occurs. * @throws SmackException in case a Smack exception occurs.
*/ */

View file

@ -252,14 +252,6 @@ public abstract class IQ extends Stanza {
*/ */
protected abstract IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml); protected abstract IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml);
/**
* @deprecated use {@link #initializeAsResultFor(IQ)} instead.
*/
@Deprecated
protected final void initialzeAsResultFor(IQ request) {
initializeAsResultFor(request);
}
protected final void initializeAsResultFor(IQ request) { protected final void initializeAsResultFor(IQ request) {
assert this != request; assert this != request;

View file

@ -46,7 +46,6 @@ import org.jxmpp.stringprep.XmppStringprepException;
* </ul> * </ul>
* *
* For each message type, different message fields are typically used as follows: * For each message type, different message fields are typically used as follows:
* <p>
* <table border="1"> * <table border="1">
* <caption>Message Types</caption> * <caption>Message Types</caption>
* <tr><td>&nbsp;</td><td colspan="5"><b>Message type</b></td></tr> * <tr><td>&nbsp;</td><td colspan="5"><b>Message type</b></td></tr>
@ -120,8 +119,8 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
/** /**
* Creates a new message with the specified recipient and extension element. * Creates a new message with the specified recipient and extension element.
* *
* @param to * @param to TODO javadoc me please
* @param extensionElement * @param extensionElement TODO javadoc me please
* @since 4.2 * @since 4.2
*/ */
public Message(Jid to, ExtensionElement extensionElement) { public Message(Jid to, ExtensionElement extensionElement) {
@ -136,7 +135,7 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
* instance. * instance.
* </p> * </p>
* *
* @param other * @param other TODO javadoc me please
*/ */
public Message(Message other) { public Message(Message other) {
super(other); super(other);

View file

@ -56,7 +56,7 @@ public interface Packet extends TopLevelStreamElement {
/** /**
* Set the stanza ID. * Set the stanza ID.
* @param packetID * @param packetID TODO javadoc me please
* @deprecated use {@link #setStanzaId(String)} instead. * @deprecated use {@link #setStanzaId(String)} instead.
*/ */
@Deprecated @Deprecated
@ -195,8 +195,8 @@ public interface Packet extends TopLevelStreamElement {
* The argument <code>elementName</code> may be null. * The argument <code>elementName</code> may be null.
* </p> * </p>
* *
* @param elementName * @param elementName TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return true if a stanza extension exists, false otherwise. * @return true if a stanza extension exists, false otherwise.
*/ */
boolean hasExtension(String elementName, String namespace); boolean hasExtension(String elementName, String namespace);
@ -204,7 +204,7 @@ public interface Packet extends TopLevelStreamElement {
/** /**
* Check if a stanza extension with the given namespace exists. * Check if a stanza extension with the given namespace exists.
* *
* @param namespace * @param namespace TODO javadoc me please
* @return true if a stanza extension exists, false otherwise. * @return true if a stanza extension exists, false otherwise.
*/ */
boolean hasExtension(String namespace); boolean hasExtension(String namespace);
@ -212,8 +212,8 @@ public interface Packet extends TopLevelStreamElement {
/** /**
* Remove the stanza extension with the given elementName and namespace. * Remove the stanza extension with the given elementName and namespace.
* *
* @param elementName * @param elementName TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return the removed stanza extension or null. * @return the removed stanza extension or null.
*/ */
ExtensionElement removeExtension(String elementName, String namespace); ExtensionElement removeExtension(String elementName, String namespace);

View file

@ -124,7 +124,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
* instance. * instance.
* </p> * </p>
* *
* @param other * @param other TODO javadoc me please
*/ */
public Presence(Presence other) { public Presence(Presence other) {
super(other); super(other);

View file

@ -130,7 +130,7 @@ public abstract class Stanza implements TopLevelStreamElement {
/** /**
* Set the stanza ID. * Set the stanza ID.
* @param packetID * @param packetID TODO javadoc me please
* @deprecated use {@link #setStanzaId(String)} instead. * @deprecated use {@link #setStanzaId(String)} instead.
*/ */
@Deprecated @Deprecated
@ -422,8 +422,8 @@ public abstract class Stanza implements TopLevelStreamElement {
* The argument <code>elementName</code> may be null. * The argument <code>elementName</code> may be null.
* </p> * </p>
* *
* @param elementName * @param elementName TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return true if a stanza extension exists, false otherwise. * @return true if a stanza extension exists, false otherwise.
*/ */
public boolean hasExtension(String elementName, String namespace) { public boolean hasExtension(String elementName, String namespace) {
@ -439,7 +439,7 @@ public abstract class Stanza implements TopLevelStreamElement {
/** /**
* Check if a stanza extension with the given namespace exists. * Check if a stanza extension with the given namespace exists.
* *
* @param namespace * @param namespace TODO javadoc me please
* @return true if a stanza extension exists, false otherwise. * @return true if a stanza extension exists, false otherwise.
*/ */
public boolean hasExtension(String namespace) { public boolean hasExtension(String namespace) {
@ -456,8 +456,8 @@ public abstract class Stanza implements TopLevelStreamElement {
/** /**
* Remove the stanza extension with the given elementName and namespace. * Remove the stanza extension with the given elementName and namespace.
* *
* @param elementName * @param elementName TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @return the removed stanza extension or null. * @return the removed stanza extension or null.
*/ */
public ExtensionElement removeExtension(String elementName, String namespace) { public ExtensionElement removeExtension(String elementName, String namespace) {
@ -546,6 +546,7 @@ public abstract class Stanza implements TopLevelStreamElement {
* Append an XMPPError is this stanza has one set. * Append an XMPPError is this stanza has one set.
* *
* @param xml the XmlStringBuilder to append the error to. * @param xml the XmlStringBuilder to append the error to.
* @param enclosingXmlEnvironment the enclosing XML environment.
*/ */
protected void appendErrorIfExists(XmlStringBuilder xml, XmlEnvironment enclosingXmlEnvironment) { protected void appendErrorIfExists(XmlStringBuilder xml, XmlEnvironment enclosingXmlEnvironment) {
StanzaError error = getError(); StanzaError error = getError();

View file

@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
/** /**
* Represents an XMPP error sub-packet. Typically, a server responds to a request that has * Represents an XMPP error sub-packet. Typically, a server responds to a request that has
* problems by sending the stanza back and including an error packet. Each error has a type, * problems by sending the stanza back and including an error packet. Each error has a type,
* error condition as well as as an optional text explanation. Typical errors are:<p> * error condition as well as as an optional text explanation. Typical errors are:
* *
* <table border=1> * <table border=1>
* <caption>XMPP Errors</caption> * <caption>XMPP Errors</caption>
@ -116,9 +116,9 @@ public class StanzaError extends AbstractError implements ExtensionElement {
* *
* @param type the error type. * @param type the error type.
* @param condition the error condition. * @param condition the error condition.
* @param conditionText * @param conditionText TODO javadoc me please
* @param errorGenerator * @param errorGenerator TODO javadoc me please
* @param descriptiveTexts * @param descriptiveTexts TODO javadoc me please
* @param extensions list of stanza extensions * @param extensions list of stanza extensions
* @param stanza the stanza carrying this XMPP error. * @param stanza the stanza carrying this XMPP error.
*/ */

View file

@ -26,7 +26,7 @@ import org.jivesoftware.smack.util.XmlStringBuilder;
/** /**
* Represents a stream error packet. Stream errors are unrecoverable errors where the server * Represents a stream error packet. Stream errors are unrecoverable errors where the server
* will close the underlying TCP connection after the stream error was sent to the client. * will close the underlying TCP connection after the stream error was sent to the client.
* These is the list of stream errors as defined in the XMPP spec:<p> * These is the list of stream errors as defined in the XMPP spec:
* *
* <table border=1> * <table border=1>
* <caption>Stream Errors</caption> * <caption>Stream Errors</caption>

View file

@ -39,7 +39,7 @@ public interface ParsingExceptionCallback {
* Called when parsing a stanza caused an exception. * Called when parsing a stanza caused an exception.
* *
* @param stanzaData the raw stanza data that caused the exception * @param stanzaData the raw stanza data that caused the exception
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
void handleUnparsableStanza(UnparseableStanza stanzaData) throws IOException; void handleUnparsableStanza(UnparseableStanza stanzaData) throws IOException;

View file

@ -140,8 +140,8 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
* @param authzid the optional authorization identity. * @param authzid the optional authorization identity.
* @param sslSession the optional SSL/TLS session (if one was established) * @param sslSession the optional SSL/TLS session (if one was established)
* @throws SmackSaslException if a SASL related error occurs. * @throws SmackSaslException if a SASL related error occurs.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public final void authenticate(String username, String host, DomainBareJid serviceName, String password, public final void authenticate(String username, String host, DomainBareJid serviceName, String password,
EntityBareJid authzid, SSLSession sslSession) EntityBareJid authzid, SSLSession sslSession)
@ -170,8 +170,8 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
* @param authzid the optional authorization identity. * @param authzid the optional authorization identity.
* @param sslSession the optional SSL/TLS session (if one was established) * @param sslSession the optional SSL/TLS session (if one was established)
* @throws SmackSaslException if a SASL related error occurs. * @throws SmackSaslException if a SASL related error occurs.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void authenticate(String host, DomainBareJid serviceName, CallbackHandler cbh, EntityBareJid authzid, SSLSession sslSession) public void authenticate(String host, DomainBareJid serviceName, CallbackHandler cbh, EntityBareJid authzid, SSLSession sslSession)
throws SmackSaslException, NotConnectedException, InterruptedException { throws SmackSaslException, NotConnectedException, InterruptedException {
@ -210,7 +210,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
* empty array here. * empty array here.
* *
* @return the initial response or null * @return the initial response or null
* @throws SmackSaslException * @throws SmackSaslException if a SASL specific error occured.
*/ */
protected abstract byte[] getAuthenticationText() throws SmackSaslException; protected abstract byte[] getAuthenticationText() throws SmackSaslException;
@ -222,7 +222,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
* @param finalChallenge true if this is the last challenge send by the server within the success stanza * @param finalChallenge true if this is the last challenge send by the server within the success stanza
* @throws SmackSaslException if a SASL related error occurs. * @throws SmackSaslException if a SASL related error occurs.
* @throws InterruptedException if the connection is interrupted * @throws InterruptedException if the connection is interrupted
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
*/ */
public final void challengeReceived(String challengeString, boolean finalChallenge) throws SmackSaslException, InterruptedException, NotConnectedException { public final void challengeReceived(String challengeString, boolean finalChallenge) throws SmackSaslException, InterruptedException, NotConnectedException {
byte[] challenge = Base64.decode((challengeString != null && challengeString.equals("=")) ? "" : challengeString); byte[] challenge = Base64.decode((challengeString != null && challengeString.equals("=")) ? "" : challengeString);

View file

@ -1,6 +1,6 @@
/** /**
* *
* Copyright 2016 Florian Schmaus * Copyright 2016-2019 Florian Schmaus
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -25,10 +25,10 @@ public interface ScramHmac {
/** /**
* RFC 5802 § 2.2 HMAC(key, str). * RFC 5802 § 2.2 HMAC(key, str).
* *
* @param key * @param key TODO javadoc me please
* @param str * @param str TODO javadoc me please
* @return the HMAC-SHA1 value of the input. * @return the HMAC-SHA1 value of the input.
* @throws InvalidKeyException * @throws InvalidKeyException in case there was an invalid key.
*/ */
byte[] hmac(byte[] key, byte[] str) throws InvalidKeyException; byte[] hmac(byte[] key, byte[] str) throws InvalidKeyException;

View file

@ -259,7 +259,7 @@ public abstract class ScramMechanism extends SASLMechanism {
/** /**
* *
* @return the Channel Binding data. * @return the Channel Binding data.
* @throws SmackSaslException * @throws SmackSaslException if a SASL specific error occured.
*/ */
protected byte[] getChannelBindingData() throws SmackSaslException { protected byte[] getChannelBindingData() throws SmackSaslException {
return null; return null;
@ -327,7 +327,7 @@ public abstract class ScramMechanism extends SASLMechanism {
* "The characters ',' or '=' in usernames are sent as '=2C' and '=3D' respectively." * "The characters ',' or '=' in usernames are sent as '=2C' and '=3D' respectively."
* </p> * </p>
* *
* @param string * @param string TODO javadoc me please
* @return the escaped string * @return the escaped string
*/ */
private static String escape(String string) { private static String escape(String string) {
@ -352,10 +352,10 @@ public abstract class ScramMechanism extends SASLMechanism {
/** /**
* RFC 5802 § 2.2 HMAC(key, str) * RFC 5802 § 2.2 HMAC(key, str)
* *
* @param key * @param key TODO javadoc me please
* @param str * @param str TODO javadoc me please
* @return the HMAC-SHA1 value of the input. * @return the HMAC-SHA1 value of the input.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
*/ */
private byte[] hmac(byte[] key, byte[] str) throws SmackSaslException { private byte[] hmac(byte[] key, byte[] str) throws SmackSaslException {
try { try {
@ -374,8 +374,8 @@ public abstract class ScramMechanism extends SASLMechanism {
* </p> * </p>
* *
* @param normalizedPassword the normalized password. * @param normalizedPassword the normalized password.
* @param salt * @param salt TODO javadoc me please
* @param iterations * @param iterations TODO javadoc me please
* @return the result of the Hi function. * @return the result of the Hi function.
* @throws SmackSaslException if a SASL related error occurs. * @throws SmackSaslException if a SASL related error occurs.
*/ */

View file

@ -24,7 +24,7 @@ public class Async {
/** /**
* Creates a new thread with the given Runnable, marks it daemon, starts it and returns the started thread. * Creates a new thread with the given Runnable, marks it daemon, starts it and returns the started thread.
* *
* @param runnable * @param runnable TODO javadoc me please
* @return the started thread. * @return the started thread.
*/ */
public static Thread go(Runnable runnable) { public static Thread go(Runnable runnable) {
@ -37,7 +37,7 @@ public class Async {
* Creates a new thread with the given Runnable, marks it daemon, sets the name, starts it and returns the started * Creates a new thread with the given Runnable, marks it daemon, sets the name, starts it and returns the started
* thread. * thread.
* *
* @param runnable * @param runnable TODO javadoc me please
* @param threadName the thread name. * @param threadName the thread name.
* @return the started thread. * @return the started thread.
*/ */

View file

@ -1,6 +1,6 @@
/** /**
* *
* Copyright © 2014 Florian Schmaus * Copyright © 2014-2019 Florian Schmaus
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -21,13 +21,11 @@ public class ByteUtils {
/** /**
* Concatenate two byte arrays. * Concatenate two byte arrays.
* *
* @deprecated use {@link #concat(byte[], byte[])} instead. * @param arrayOne the first input array.
* @param arrayTwo the second input array
* @return the concatenation of the first and second input array.
*
*/ */
@Deprecated
public static byte[] concact(byte[] arrayOne, byte[] arrayTwo) {
return concat(arrayOne, arrayTwo);
}
public static byte[] concat(byte[] arrayOne, byte[] arrayTwo) { public static byte[] concat(byte[] arrayOne, byte[] arrayTwo) {
int combinedLength = arrayOne.length + arrayTwo.length; int combinedLength = arrayOne.length + arrayTwo.length;
byte[] res = new byte[combinedLength]; byte[] res = new byte[combinedLength];
@ -35,4 +33,5 @@ public class ByteUtils {
System.arraycopy(arrayTwo, 0, res, arrayOne.length, arrayTwo.length); System.arraycopy(arrayTwo, 0, res, arrayOne.length, arrayTwo.length);
return res; return res;
} }
} }

View file

@ -51,7 +51,7 @@ public class DNSUtil {
/** /**
* Set the DNS resolver that should be used to perform DNS lookups. * Set the DNS resolver that should be used to perform DNS lookups.
* *
* @param resolver * @param resolver TODO javadoc me please
*/ */
public static void setDNSResolver(DNSResolver resolver) { public static void setDNSResolver(DNSResolver resolver) {
dnsResolver = Objects.requireNonNull(resolver); dnsResolver = Objects.requireNonNull(resolver);
@ -69,7 +69,7 @@ public class DNSUtil {
/** /**
* Set the DANE provider that should be used when DANE is enabled. * Set the DANE provider that should be used when DANE is enabled.
* *
* @param daneProvider * @param daneProvider TODO javadoc me please
*/ */
public static void setDaneProvider(SmackDaneProvider daneProvider) { public static void setDaneProvider(SmackDaneProvider daneProvider) {
DNSUtil.daneProvider = Objects.requireNonNull(daneProvider); DNSUtil.daneProvider = Objects.requireNonNull(daneProvider);
@ -189,7 +189,7 @@ public class DNSUtil {
* Note that we follow the RFC with one exception. In a group of the same priority, only the first entry * Note that we follow the RFC with one exception. In a group of the same priority, only the first entry
* is calculated by random. The others are ore simply ordered by their priority. * is calculated by random. The others are ore simply ordered by their priority.
* *
* @param records * @param records TODO javadoc me please
* @return the list of resolved HostAddresses * @return the list of resolved HostAddresses
*/ */
private static List<HostAddress> sortSRVRecords(List<SRVRecord> records) { private static List<HostAddress> sortSRVRecords(List<SRVRecord> records) {

View file

@ -47,7 +47,7 @@ public class EventManger<K, R, E extends Exception> {
* @param action the action to perform prior waiting for the event, must not be null. * @param action the action to perform prior waiting for the event, must not be null.
* @return the event value, may be null. * @return the event value, may be null.
* @throws InterruptedException if interrupted while waiting for the event. * @throws InterruptedException if interrupted while waiting for the event.
* @throws E * @throws E depending on the concrete use case.
*/ */
public R performActionAndWaitForEvent(K eventKey, long timeout, Callback<E> action) throws InterruptedException, E { public R performActionAndWaitForEvent(K eventKey, long timeout, Callback<E> action) throws InterruptedException, E {
final Reference<R> reference = new Reference<>(); final Reference<R> reference = new Reference<>();

View file

@ -108,9 +108,9 @@ public final class FileUtils {
/** /**
* Reads the contents of a File. * Reads the contents of a File.
* *
* @param file * @param file TODO javadoc me please
* @return the content of file or null in case of an error * @return the content of file or null in case of an error
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
@SuppressWarnings("DefaultCharset") @SuppressWarnings("DefaultCharset")
public static String readFileOrThrow(File file) throws IOException { public static String readFileOrThrow(File file) throws IOException {

View file

@ -93,7 +93,7 @@ public class MultiMap<K, V> {
/** /**
* Get the first value for the given key, or <code>null</code> if there are no entries. * Get the first value for the given key, or <code>null</code> if there are no entries.
* *
* @param key * @param key TODO javadoc me please
* @return the first value or null. * @return the first value or null.
*/ */
public V getFirst(K key) { public V getFirst(K key) {
@ -111,7 +111,7 @@ public class MultiMap<K, V> {
* Changes to the returned set will update the underlying MultiMap if the return set is not empty. * Changes to the returned set will update the underlying MultiMap if the return set is not empty.
* </p> * </p>
* *
* @param key * @param key TODO javadoc me please
* @return all values for the given key. * @return all values for the given key.
*/ */
public List<V> getAll(K key) { public List<V> getAll(K key) {
@ -140,7 +140,7 @@ public class MultiMap<K, V> {
/** /**
* Removes all mappings for the given key and returns the first value if there where mappings or <code>null</code> if not. * Removes all mappings for the given key and returns the first value if there where mappings or <code>null</code> if not.
* *
* @param key * @param key TODO javadoc me please
* @return the first value of the given key or null. * @return the first value of the given key or null.
*/ */
public V remove(K key) { public V remove(K key) {
@ -158,8 +158,8 @@ public class MultiMap<K, V> {
* Returns <code>true</code> if the mapping was removed and <code>false</code> if the mapping did not exist. * Returns <code>true</code> if the mapping was removed and <code>false</code> if the mapping did not exist.
* </p> * </p>
* *
* @param key * @param key TODO javadoc me please
* @param value * @param value TODO javadoc me please
* @return true if the mapping was removed, false otherwise. * @return true if the mapping was removed, false otherwise.
*/ */
public boolean removeOne(K key, V value) { public boolean removeOne(K key, V value) {

View file

@ -21,7 +21,7 @@ public class NumberUtil {
/** /**
* Checks if the given long is within the range of an unsigned 32-bit integer, the XML type "xs:unsignedInt". * Checks if the given long is within the range of an unsigned 32-bit integer, the XML type "xs:unsignedInt".
* *
* @param value * @param value TODO javadoc me please
* @deprecated use {@link #requireUInt32(long)} instead. * @deprecated use {@link #requireUInt32(long)} instead.
*/ */
@Deprecated @Deprecated
@ -33,7 +33,8 @@ public class NumberUtil {
/** /**
* Checks if the given long is within the range of an unsigned 32-bit integer, the XML type "xs:unsignedInt". * Checks if the given long is within the range of an unsigned 32-bit integer, the XML type "xs:unsignedInt".
* *
* @param value * @param value TODO javadoc me please
* @return the input value.
*/ */
public static long requireUInt32(long value) { public static long requireUInt32(long value) {
if (value < 0) { if (value < 0) {
@ -48,7 +49,8 @@ public class NumberUtil {
/** /**
* Checks if the given int is within the range of an unsigned 16-bit integer, the XML type "xs:unsignedShort". * Checks if the given int is within the range of an unsigned 16-bit integer, the XML type "xs:unsignedShort".
* *
* @param value * @param value TODO javadoc me please
* @return the input value.
*/ */
public static int requireUShort16(int value) { public static int requireUShort16(int value) {
if (value < 0) { if (value < 0) {

View file

@ -54,7 +54,7 @@ public class Objects {
* @param collection collection * @param collection collection
* @param message error message * @param message error message
* @param <T> Collection type * @param <T> Collection type
* @return collection * @return collection TODO javadoc me please
*/ */
public static <T extends Collection<?>> T requireNonNullNorEmpty(T collection, String message) { public static <T extends Collection<?>> T requireNonNullNorEmpty(T collection, String message) {
if (requireNonNull(collection).isEmpty()) { if (requireNonNull(collection).isEmpty()) {

View file

@ -99,12 +99,12 @@ public class PacketParserUtils {
* *
* connection is optional and is used to return feature-not-implemented errors for unknown IQ stanzas. * connection is optional and is used to return feature-not-implemented errors for unknown IQ stanzas.
* *
* @param parser * @param parser TODO javadoc me please
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return a stanza which is either a Message, IQ or Presence. * @return a stanza which is either a Message, IQ or Presence.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
public static Stanza parseStanza(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, SmackParsingException, IOException { public static Stanza parseStanza(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, SmackParsingException, IOException {
ParserUtils.assertAtStartTag(parser); ParserUtils.assertAtStartTag(parser);
@ -131,9 +131,9 @@ public class PacketParserUtils {
* @param parser the XML parser, positioned at the start of a message packet. * @param parser the XML parser, positioned at the start of a message packet.
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return a Message packet. * @return a Message packet.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static Message parseMessage(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { public static Message parseMessage(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
ParserUtils.assertAtStartTag(parser); ParserUtils.assertAtStartTag(parser);
@ -212,10 +212,10 @@ public class PacketParserUtils {
* This method is used for the parts where the XMPP specification requires elements that contain * This method is used for the parts where the XMPP specification requires elements that contain
* only text or are the empty element. * only text or are the empty element.
* *
* @param parser * @param parser TODO javadoc me please
* @return the textual content of the element as String * @return the textual content of the element as String
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
public static String parseElementText(XmlPullParser parser) throws XmlPullParserException, IOException { public static String parseElementText(XmlPullParser parser) throws XmlPullParserException, IOException {
assert parser.getEventType() == XmlPullParser.Event.START_ELEMENT; assert parser.getEventType() == XmlPullParser.Event.START_ELEMENT;
@ -253,8 +253,8 @@ public class PacketParserUtils {
* *
* @param parser the XML pull parser * @param parser the XML pull parser
* @return the element as string * @return the element as string
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
public static CharSequence parseElement(XmlPullParser parser) throws XmlPullParserException, IOException { public static CharSequence parseElement(XmlPullParser parser) throws XmlPullParserException, IOException {
return parseElement(parser, false); return parseElement(parser, false);
@ -288,12 +288,12 @@ public class PacketParserUtils {
* In particular Android's XmlPullParser does not support XML_ROUNDTRIP. * In particular Android's XmlPullParser does not support XML_ROUNDTRIP.
* </p> * </p>
* *
* @param parser * @param parser TODO javadoc me please
* @param depth * @param depth TODO javadoc me please
* @param fullNamespaces * @param fullNamespaces TODO javadoc me please
* @return the content of the current depth * @return the content of the current depth
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
public static CharSequence parseContentDepth(XmlPullParser parser, int depth, boolean fullNamespaces) throws XmlPullParserException, IOException { public static CharSequence parseContentDepth(XmlPullParser parser, int depth, boolean fullNamespaces) throws XmlPullParserException, IOException {
if (parser.supportsRoundtrip()) { if (parser.supportsRoundtrip()) {
@ -418,9 +418,9 @@ public class PacketParserUtils {
* @param parser the XML parser, positioned at the start of a presence packet. * @param parser the XML parser, positioned at the start of a presence packet.
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return a Presence packet. * @return a Presence packet.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static Presence parsePresence(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { public static Presence parsePresence(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
ParserUtils.assertAtStartTag(parser); ParserUtils.assertAtStartTag(parser);
@ -511,10 +511,10 @@ public class PacketParserUtils {
* @param parser the XML parser, positioned at the start of an IQ packet. * @param parser the XML parser, positioned at the start of an IQ packet.
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return an IQ object. * @return an IQ object.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws XmppStringprepException * @throws XmppStringprepException if the provided string is invalid.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static IQ parseIQ(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, XmppStringprepException, IOException, SmackParsingException { public static IQ parseIQ(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, XmppStringprepException, IOException, SmackParsingException {
ParserUtils.assertAtStartTag(parser); ParserUtils.assertAtStartTag(parser);
@ -596,8 +596,8 @@ public class PacketParserUtils {
* *
* @param parser the XML parser, positioned at the start of the mechanisms stanza. * @param parser the XML parser, positioned at the start of the mechanisms stanza.
* @return a collection of Stings with the mechanisms included in the mechanisms stanza. * @return a collection of Stings with the mechanisms included in the mechanisms stanza.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
*/ */
public static Collection<String> parseMechanisms(XmlPullParser parser) public static Collection<String> parseMechanisms(XmlPullParser parser)
throws XmlPullParserException, IOException { throws XmlPullParserException, IOException {
@ -626,7 +626,7 @@ public class PacketParserUtils {
* *
* @param parser the XML parser, positioned at the start of the compression stanza. * @param parser the XML parser, positioned at the start of the compression stanza.
* @return The CompressionFeature stream element * @return The CompressionFeature stream element
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException if an exception occurs while parsing the stanza. * @throws XmlPullParserException if an exception occurs while parsing the stanza.
*/ */
public static Compress.Feature parseCompressionFeature(XmlPullParser parser) public static Compress.Feature parseCompressionFeature(XmlPullParser parser)
@ -688,8 +688,8 @@ public class PacketParserUtils {
* *
* @param parser the XML parser. * @param parser the XML parser.
* @return a SASL Failure packet. * @return a SASL Failure packet.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
*/ */
public static SASLFailure parseSASLFailure(XmlPullParser parser) throws XmlPullParserException, IOException { public static SASLFailure parseSASLFailure(XmlPullParser parser) throws XmlPullParserException, IOException {
final int initialDepth = parser.getDepth(); final int initialDepth = parser.getDepth();
@ -731,9 +731,9 @@ public class PacketParserUtils {
* @param parser the XML parser. * @param parser the XML parser.
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return an stream error packet. * @return an stream error packet.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static StreamError parseStreamError(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { public static StreamError parseStreamError(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
final int initialDepth = parser.getDepth(); final int initialDepth = parser.getDepth();
@ -793,9 +793,9 @@ public class PacketParserUtils {
* @param parser the XML parser. * @param parser the XML parser.
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* @return an error sub-packet. * @return an error sub-packet.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static StanzaError.Builder parseError(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { public static StanzaError.Builder parseError(XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {
final int initialDepth = parser.getDepth(); final int initialDepth = parser.getDepth();
@ -856,9 +856,9 @@ public class PacketParserUtils {
* @param outerXmlEnvironment the outer XML environment (optional). * @param outerXmlEnvironment the outer XML environment (optional).
* *
* @return an extension element. * @return an extension element.
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
public static ExtensionElement parseExtensionElement(String elementName, String namespace, public static ExtensionElement parseExtensionElement(String elementName, String namespace,
XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { XmlPullParser parser, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException {

View file

@ -24,10 +24,10 @@ public class PacketUtil {
/** /**
* Get a extension element from a collection. * Get a extension element from a collection.
* @param collection * @param collection TODO javadoc me please
* @param element * @param element TODO javadoc me please
* @param namespace * @param namespace TODO javadoc me please
* @param <PE> * @param <PE> the type of the extension element.
* @return the extension element * @return the extension element
* @deprecated use {@link #extensionElementFrom(Collection, String, String)} instead. * @deprecated use {@link #extensionElementFrom(Collection, String, String)} instead.
*/ */

View file

@ -156,8 +156,8 @@ public class ParserUtils {
/** /**
* Get the boolean value of an argument. * Get the boolean value of an argument.
* *
* @param parser * @param parser TODO javadoc me please
* @param name * @param name TODO javadoc me please
* @return the boolean value or null of no argument of the given name exists * @return the boolean value or null of no argument of the given name exists
*/ */
public static Boolean getBooleanAttribute(XmlPullParser parser, String name) { public static Boolean getBooleanAttribute(XmlPullParser parser, String name) {

View file

@ -390,7 +390,7 @@ public class StringUtils {
/** /**
* Returns true if the given CharSequence is null or empty. * Returns true if the given CharSequence is null or empty.
* *
* @param cs * @param cs TODO javadoc me please
* @return true if the given CharSequence is null or empty * @return true if the given CharSequence is null or empty
*/ */
public static boolean isNullOrEmpty(CharSequence cs) { public static boolean isNullOrEmpty(CharSequence cs) {
@ -430,7 +430,7 @@ public class StringUtils {
/** /**
* Returns true if the given CharSequence is empty. * Returns true if the given CharSequence is empty.
* *
* @param cs * @param cs TODO javadoc me please
* @return true if the given CharSequence is empty * @return true if the given CharSequence is empty
*/ */
public static boolean isEmpty(CharSequence cs) { public static boolean isEmpty(CharSequence cs) {
@ -498,7 +498,7 @@ public class StringUtils {
* @param cs CharSequence * @param cs CharSequence
* @param message error message * @param message error message
* @param <CS> CharSequence type * @param <CS> CharSequence type
* @return cs * @return cs TODO javadoc me please
*/ */
@Deprecated @Deprecated
public static <CS extends CharSequence> CS requireNotNullOrEmpty(CS cs, String message) { public static <CS extends CharSequence> CS requireNotNullOrEmpty(CS cs, String message) {
@ -511,7 +511,7 @@ public class StringUtils {
* @param cs CharSequence * @param cs CharSequence
* @param message error message * @param message error message
* @param <CS> CharSequence type * @param <CS> CharSequence type
* @return cs * @return cs TODO javadoc me please
*/ */
public static <CS extends CharSequence> CS requireNotNullNorEmpty(CS cs, String message) { public static <CS extends CharSequence> CS requireNotNullNorEmpty(CS cs, String message) {
if (isNullOrEmpty(cs)) { if (isNullOrEmpty(cs)) {

View file

@ -99,8 +99,8 @@ public class TLSUtils {
* *
* @param builder a connection configuration builder. * @param builder a connection configuration builder.
* @param <B> Type of the ConnectionConfiguration builder. * @param <B> Type of the ConnectionConfiguration builder.
* @throws NoSuchAlgorithmException * @throws NoSuchAlgorithmException if no such algorithm is available.
* @throws KeyManagementException * @throws KeyManagementException if there was a key mangement error.
* @return the given builder. * @return the given builder.
*/ */
public static <B extends ConnectionConfiguration.Builder<B, ?>> B acceptAllCertificates(B builder) throws NoSuchAlgorithmException, KeyManagementException { public static <B extends ConnectionConfiguration.Builder<B, ?>> B acceptAllCertificates(B builder) throws NoSuchAlgorithmException, KeyManagementException {
@ -184,9 +184,9 @@ public class TLSUtils {
* *
* @param sslSession the SSL/TLS session from which the data should be retrieved. * @param sslSession the SSL/TLS session from which the data should be retrieved.
* @return the channel binding data. * @return the channel binding data.
* @throws SSLPeerUnverifiedException * @throws SSLPeerUnverifiedException if we TLS peer could not be verified.
* @throws CertificateEncodingException * @throws CertificateEncodingException if there was an encoding error with the certificate.
* @throws NoSuchAlgorithmException * @throws NoSuchAlgorithmException if no such algorithm is available.
* @see <a href="https://tools.ietf.org/html/rfc5929#section-4">RFC 5929 § 4.</a> * @see <a href="https://tools.ietf.org/html/rfc5929#section-4">RFC 5929 § 4.</a>
*/ */
public static byte[] getChannelBindingTlsServerEndPoint(final SSLSession sslSession) public static byte[] getChannelBindingTlsServerEndPoint(final SSLSession sslSession)

View file

@ -72,8 +72,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
/** /**
* Add a new element to this builder. * Add a new element to this builder.
* *
* @param name * @param name TODO javadoc me please
* @param content * @param content TODO javadoc me please
* @return the XmlStringBuilder * @return the XmlStringBuilder
*/ */
public XmlStringBuilder element(String name, String content) { public XmlStringBuilder element(String name, String content) {
@ -102,8 +102,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
/** /**
* Add a new element to this builder. * Add a new element to this builder.
* *
* @param name * @param name TODO javadoc me please
* @param content * @param content TODO javadoc me please
* @return the XmlStringBuilder * @return the XmlStringBuilder
*/ */
public XmlStringBuilder element(String name, CharSequence content) { public XmlStringBuilder element(String name, CharSequence content) {
@ -234,8 +234,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
/** /**
* Does nothing if value is null. * Does nothing if value is null.
* *
* @param name * @param name TODO javadoc me please
* @param value * @param value TODO javadoc me please
* @return the XmlStringBuilder * @return the XmlStringBuilder
*/ */
public XmlStringBuilder attribute(String name, String value) { public XmlStringBuilder attribute(String name, String value) {
@ -347,8 +347,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
/** /**
* Add the given attribute if {@code value => 0}. * Add the given attribute if {@code value => 0}.
* *
* @param name * @param name TODO javadoc me please
* @param value * @param value TODO javadoc me please
* @return a reference to this object * @return a reference to this object
*/ */
public XmlStringBuilder optIntAttribute(String name, int value) { public XmlStringBuilder optIntAttribute(String name, int value) {
@ -361,8 +361,8 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
/** /**
* Add the given attribute if value not null and {@code value => 0}. * Add the given attribute if value not null and {@code value => 0}.
* *
* @param name * @param name TODO javadoc me please
* @param value * @param value TODO javadoc me please
* @return a reference to this object * @return a reference to this object
*/ */
public XmlStringBuilder optLongAttribute(String name, Long value) { public XmlStringBuilder optLongAttribute(String name, Long value) {
@ -586,8 +586,9 @@ public class XmlStringBuilder implements Appendable, CharSequence, Element {
* the single parts one-by-one, avoiding allocation of a big continuous memory block holding the * the single parts one-by-one, avoiding allocation of a big continuous memory block holding the
* XmlStringBuilder contents. * XmlStringBuilder contents.
* *
* @param writer * @param writer TODO javadoc me please
* @throws IOException * @param enclosingNamespace the enclosing XML namespace.
* @throws IOException if an I/O error occured.
*/ */
public void write(Writer writer, String enclosingNamespace) throws IOException { public void write(Writer writer, String enclosingNamespace) throws IOException {
for (CharSequence csq : sb.getAsList()) { for (CharSequence csq : sb.getAsList()) {

View file

@ -38,7 +38,7 @@ public class IQResponseTest {
/** /**
* Test creating a simple and empty IQ response. * Test creating a simple and empty IQ response.
* @throws XmppStringprepException * @throws XmppStringprepException if the provided string is invalid.
*/ */
@Test @Test
public void testGeneratingSimpleResponse() throws XmppStringprepException { public void testGeneratingSimpleResponse() throws XmppStringprepException {
@ -58,7 +58,7 @@ public class IQResponseTest {
/** /**
* Test creating a error response based on an IQ request. * Test creating a error response based on an IQ request.
* @throws XmppStringprepException * @throws XmppStringprepException if the provided string is invalid.
*/ */
@Test @Test
public void testGeneratingValidErrorResponse() throws XmppStringprepException { public void testGeneratingValidErrorResponse() throws XmppStringprepException {
@ -83,7 +83,7 @@ public class IQResponseTest {
/** /**
* According to <a href="http://xmpp.org/rfcs/rfc3920.html#stanzas-semantics-iq" * According to <a href="http://xmpp.org/rfcs/rfc3920.html#stanzas-semantics-iq"
* >RFC3920: IQ Semantics</a> we shouldn't respond to an IQ of type result. * >RFC3920: IQ Semantics</a> we shouldn't respond to an IQ of type result.
* @throws XmppStringprepException * @throws XmppStringprepException if the provided string is invalid.
*/ */
@Test @Test
public void testGeneratingResponseBasedOnResult() throws XmppStringprepException { public void testGeneratingResponseBasedOnResult() throws XmppStringprepException {
@ -106,7 +106,7 @@ public class IQResponseTest {
/** /**
* According to <a href="http://xmpp.org/rfcs/rfc3920.html#stanzas-semantics-iq" * According to <a href="http://xmpp.org/rfcs/rfc3920.html#stanzas-semantics-iq"
* >RFC3920: IQ Semantics</a> we shouldn't respond to an IQ of type error. * >RFC3920: IQ Semantics</a> we shouldn't respond to an IQ of type error.
* @throws XmppStringprepException * @throws XmppStringprepException if the provided string is invalid.
*/ */
@Test @Test
public void testGeneratingErrorBasedOnError() throws XmppStringprepException { public void testGeneratingErrorBasedOnError() throws XmppStringprepException {

View file

@ -676,7 +676,7 @@ public class PacketParserUtilsTest {
* RFC6121 5.2.3 explicitly disallows mixed content in <body/> elements. Make sure that we throw * RFC6121 5.2.3 explicitly disallows mixed content in <body/> elements. Make sure that we throw
* an exception if we encounter such an element. * an exception if we encounter such an element.
* *
* @throws Exception * @throws Exception if an exception occurs.
*/ */
@Test @Test
public void invalidMessageBodyContainingTagTest() throws Exception { public void invalidMessageBodyContainingTagTest() throws Exception {

View file

@ -223,10 +223,10 @@ public final class CarbonManager extends Manager {
* Returns true if XMPP Carbons are supported by the server. * Returns true if XMPP Carbons are supported by the server.
* *
* @return true if supported * @return true if supported
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean isSupportedByServer() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public boolean isSupportedByServer() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(CarbonExtension.NAMESPACE); return ServiceDiscoveryManager.getInstanceFor(connection()).serverSupportsFeature(CarbonExtension.NAMESPACE);
@ -239,8 +239,8 @@ public final class CarbonManager extends Manager {
* You should first check for support using isSupportedByServer(). * You should first check for support using isSupportedByServer().
* *
* @param new_state whether carbons should be enabled or disabled * @param new_state whether carbons should be enabled or disabled
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @deprecated use {@link #enableCarbonsAsync(ExceptionCallback)} or {@link #disableCarbonsAsync(ExceptionCallback)} instead. * @deprecated use {@link #enableCarbonsAsync(ExceptionCallback)} or {@link #disableCarbonsAsync(ExceptionCallback)} instead.
*/ */
@Deprecated @Deprecated
@ -302,10 +302,10 @@ public final class CarbonManager extends Manager {
* You should first check for support using isSupportedByServer(). * You should first check for support using isSupportedByServer().
* *
* @param new_state whether carbons should be enabled or disabled * @param new_state whether carbons should be enabled or disabled
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* *
*/ */
public synchronized void setCarbonsEnabled(final boolean new_state) throws NoResponseException, public synchronized void setCarbonsEnabled(final boolean new_state) throws NoResponseException,
@ -322,9 +322,9 @@ public final class CarbonManager extends Manager {
/** /**
* Helper method to enable carbons. * Helper method to enable carbons.
* *
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
* @throws SmackException if there was no response from the server. * @throws SmackException if there was no response from the server.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void enableCarbons() throws XMPPException, SmackException, InterruptedException { public void enableCarbons() throws XMPPException, SmackException, InterruptedException {
setCarbonsEnabled(true); setCarbonsEnabled(true);
@ -333,9 +333,9 @@ public final class CarbonManager extends Manager {
/** /**
* Helper method to disable carbons. * Helper method to disable carbons.
* *
* @throws XMPPException * @throws XMPPException if an XMPP protocol error was received.
* @throws SmackException if there was no response from the server. * @throws SmackException if there was no response from the server.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void disableCarbons() throws XMPPException, SmackException, InterruptedException { public void disableCarbons() throws XMPPException, SmackException, InterruptedException {
setCarbonsEnabled(false); setCarbonsEnabled(false);

View file

@ -51,7 +51,7 @@ public class GcmPacketExtension extends AbstractJsonPacketExtension {
/** /**
* Retrieve the GCM stanza extension from the packet. * Retrieve the GCM stanza extension from the packet.
* *
* @param packet * @param packet TODO javadoc me please
* @return the GCM stanza extension or null. * @return the GCM stanza extension or null.
*/ */
public static GcmPacketExtension from(Stanza packet) { public static GcmPacketExtension from(Stanza packet) {

View file

@ -109,7 +109,7 @@ public final class HashManager extends Manager {
/** /**
* Announce support for the given list of algorithms. * Announce support for the given list of algorithms.
* @param algorithms * @param algorithms TODO javadoc me please
*/ */
public void addAlgorithmsToFeatures(List<ALGORITHM> algorithms) { public void addAlgorithmsToFeatures(List<ALGORITHM> algorithms) {
ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection()); ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection());
@ -120,7 +120,7 @@ public final class HashManager extends Manager {
/** /**
* Get an instance of the HashManager for the given connection. * Get an instance of the HashManager for the given connection.
* @param connection * @param connection TODO javadoc me please
* @return the manager for the given connection. * @return the manager for the given connection.
*/ */
public static synchronized HashManager getInstanceFor(XMPPConnection connection) { public static synchronized HashManager getInstanceFor(XMPPConnection connection) {
@ -189,7 +189,7 @@ public final class HashManager extends Manager {
/** /**
* Compensational method for static 'valueOf' function. * Compensational method for static 'valueOf' function.
* *
* @param s * @param s TODO javadoc me please
* @return the algorithm for the given string. * @return the algorithm for the given string.
* @throws IllegalArgumentException if no algorithm for the given string is known. * @throws IllegalArgumentException if no algorithm for the given string is known.
*/ */

View file

@ -56,10 +56,10 @@ public class HOXTManager {
* @param jid jid * @param jid jid
* @param connection connection * @param connection connection
* @return true if the given entity understands the HTTP ove XMPP transport format and exchange. * @return true if the given entity understands the HTTP ove XMPP transport format and exchange.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public static boolean isSupported(Jid jid, XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public static boolean isSupported(Jid jid, XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
return ServiceDiscoveryManager.getInstanceFor(connection).supportsFeature(jid, NAMESPACE); return ServiceDiscoveryManager.getInstanceFor(connection).supportsFeature(jid, NAMESPACE);

View file

@ -226,7 +226,7 @@ public abstract class AbstractHttpOverXmpp extends IQ {
/** /**
* Returns text of this element. * Returns text of this element.
* *
* @return text * @return text TODO javadoc me please
*/ */
public String getText() { public String getText() {
return text; return text;
@ -270,7 +270,7 @@ public abstract class AbstractHttpOverXmpp extends IQ {
/** /**
* Returns text of this element. * Returns text of this element.
* *
* @return text * @return text TODO javadoc me please
*/ */
public String getText() { public String getText() {
return text; return text;
@ -314,7 +314,7 @@ public abstract class AbstractHttpOverXmpp extends IQ {
/** /**
* Returns text of this element. * Returns text of this element.
* *
* @return text * @return text TODO javadoc me please
*/ */
public String getText() { public String getText() {
return text; return text;

View file

@ -55,9 +55,9 @@ public abstract class AbstractHttpOverXmppProvider<H extends AbstractHttpOverXmp
* *
* @param parser parser * @param parser parser
* @return HeadersExtension or null if no headers * @return HeadersExtension or null if no headers
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
* @throws SmackParsingException * @throws SmackParsingException if the Smack parser (provider) encountered invalid input.
*/ */
protected HeadersExtension parseHeaders(XmlPullParser parser) throws IOException, XmlPullParserException, SmackParsingException { protected HeadersExtension parseHeaders(XmlPullParser parser) throws IOException, XmlPullParserException, SmackParsingException {
HeadersExtension headersExtension = null; HeadersExtension headersExtension = null;
@ -76,8 +76,8 @@ public abstract class AbstractHttpOverXmppProvider<H extends AbstractHttpOverXmp
* @param parser parser * @param parser parser
* @return Data or null if no data * @return Data or null if no data
* *
* @throws XmlPullParserException * @throws XmlPullParserException if an error in the XML parser occured.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
protected AbstractHttpOverXmpp.Data parseData(XmlPullParser parser) throws XmlPullParserException, IOException { protected AbstractHttpOverXmpp.Data parseData(XmlPullParser parser) throws XmlPullParserException, IOException {
NamedElement child = null; NamedElement child = null;

View file

@ -178,10 +178,10 @@ public final class HttpFileUploadManager extends Manager {
* *
* @return true if upload service was discovered * @return true if upload service was discovered
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
* @throws SmackException.NotConnectedException * @throws SmackException.NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws SmackException.NoResponseException * @throws SmackException.NoResponseException if there was no response from the remote entity.
*/ */
public boolean discoverUploadService() throws XMPPException.XMPPErrorException, SmackException.NotConnectedException, public boolean discoverUploadService() throws XMPPException.XMPPErrorException, SmackException.NotConnectedException,
InterruptedException, SmackException.NoResponseException { InterruptedException, SmackException.NoResponseException {
@ -228,9 +228,9 @@ public final class HttpFileUploadManager extends Manager {
* *
* @param file file to be uploaded * @param file file to be uploaded
* @return public URL for sharing uploaded file * @return public URL for sharing uploaded file
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws IOException in case of HTTP upload errors * @throws IOException in case of HTTP upload errors
*/ */
public URL uploadFile(File file) throws InterruptedException, XMPPException.XMPPErrorException, public URL uploadFile(File file) throws InterruptedException, XMPPException.XMPPErrorException,
@ -248,10 +248,10 @@ public final class HttpFileUploadManager extends Manager {
* @param listener upload progress listener of null * @param listener upload progress listener of null
* @return public URL for sharing uploaded file * @return public URL for sharing uploaded file
* *
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws IOException * @throws IOException if an I/O error occured.
*/ */
public URL uploadFile(File file, UploadProgressListener listener) throws InterruptedException, public URL uploadFile(File file, UploadProgressListener listener) throws InterruptedException,
XMPPException.XMPPErrorException, SmackException, IOException { XMPPException.XMPPErrorException, SmackException, IOException {
@ -275,10 +275,10 @@ public final class HttpFileUploadManager extends Manager {
* @return file upload Slot in case of success * @return file upload Slot in case of success
* @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size * @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size
* supported by the service. * supported by the service.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
* @throws SmackException.NotConnectedException * @throws SmackException.NotConnectedException if the XMPP connection is not connected.
* @throws SmackException.NoResponseException * @throws SmackException.NoResponseException if there was no response from the remote entity.
*/ */
public Slot requestSlot(String filename, long fileSize) throws InterruptedException, public Slot requestSlot(String filename, long fileSize) throws InterruptedException,
XMPPException.XMPPErrorException, SmackException { XMPPException.XMPPErrorException, SmackException {
@ -298,10 +298,10 @@ public final class HttpFileUploadManager extends Manager {
* @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size * @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size
* supported by the service. * supported by the service.
* @throws SmackException.NotConnectedException * @throws SmackException.NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
* @throws SmackException.NoResponseException * @throws SmackException.NoResponseException if there was no response from the remote entity.
*/ */
public Slot requestSlot(String filename, long fileSize, String contentType) throws SmackException, public Slot requestSlot(String filename, long fileSize, String contentType) throws SmackException,
InterruptedException, XMPPException.XMPPErrorException { InterruptedException, XMPPException.XMPPErrorException {
@ -321,9 +321,9 @@ public final class HttpFileUploadManager extends Manager {
* @return file upload Slot in case of success * @return file upload Slot in case of success
* @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size * @throws IllegalArgumentException if fileSize is less than or equal to zero or greater than the maximum size
* supported by the service. * supported by the service.
* @throws SmackException * @throws SmackException if Smack detected an exceptional situation.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws XMPPException.XMPPErrorException * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
*/ */
public Slot requestSlot(String filename, long fileSize, String contentType, DomainBareJid uploadServiceAddress) public Slot requestSlot(String filename, long fileSize, String contentType, DomainBareJid uploadServiceAddress)
throws SmackException, InterruptedException, XMPPException.XMPPErrorException { throws SmackException, InterruptedException, XMPPException.XMPPErrorException {

View file

@ -101,13 +101,13 @@ public final class IoTControlManager extends IoTManager {
/** /**
* Control a thing by sending a collection of {@link SetData} instructions. * Control a thing by sending a collection of {@link SetData} instructions.
* *
* @param jid * @param jid TODO javadoc me please
* @param data * @param data TODO javadoc me please
* @return a IoTSetResponse * @return a IoTSetResponse
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @see #setUsingIq(FullJid, Collection) * @see #setUsingIq(FullJid, Collection)
*/ */
public IoTSetResponse setUsingIq(FullJid jid, SetData data) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public IoTSetResponse setUsingIq(FullJid jid, SetData data) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -120,10 +120,10 @@ public final class IoTControlManager extends IoTManager {
* @param jid the thing to control. * @param jid the thing to control.
* @param data a collection of {@link SetData} instructions. * @param data a collection of {@link SetData} instructions.
* @return the {@link IoTSetResponse} if successful. * @return the {@link IoTSetResponse} if successful.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public IoTSetResponse setUsingIq(FullJid jid, Collection<? extends SetData> data) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public IoTSetResponse setUsingIq(FullJid jid, Collection<? extends SetData> data) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
IoTSetRequest request = new IoTSetRequest(data); IoTSetRequest request = new IoTSetRequest(data);

View file

@ -164,10 +164,10 @@ public final class IoTDataManager extends IoTManager {
* *
* @param jid the full JID of the thing to read data from. * @param jid the full JID of the thing to read data from.
* @return a list with the read out data. * @return a list with the read out data.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<IoTFieldsExtension> requestMomentaryValuesReadOut(EntityFullJid jid) public List<IoTFieldsExtension> requestMomentaryValuesReadOut(EntityFullJid jid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

View file

@ -211,10 +211,10 @@ public final class IoTDiscoveryManager extends Manager {
* Try to find an XMPP IoT registry. * Try to find an XMPP IoT registry.
* *
* @return the JID of a Thing Registry if one could be found, <code>null</code> otherwise. * @return the JID of a Thing Registry if one could be found, <code>null</code> otherwise.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @see <a href="http://xmpp.org/extensions/xep-0347.html#findingregistry">XEP-0347 § 3.5 Finding Thing Registry</a> * @see <a href="http://xmpp.org/extensions/xep-0347.html#findingregistry">XEP-0347 § 3.5 Finding Thing Registry</a>
*/ */
public Jid findRegistry() public Jid findRegistry()
@ -283,10 +283,10 @@ public final class IoTDiscoveryManager extends Manager {
* @param metaTags a collection of meta tags used to identify the thing. * @param metaTags a collection of meta tags used to identify the thing.
* @param publicThing if this is a public thing. * @param publicThing if this is a public thing.
* @return a {@link IoTClaimed} if successful. * @return a {@link IoTClaimed} if successful.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public IoTClaimed claimThing(Jid registry, Collection<Tag> metaTags, boolean publicThing) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public IoTClaimed claimThing(Jid registry, Collection<Tag> metaTags, boolean publicThing) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
interactWithRegistry(registry); interactWithRegistry(registry);

View file

@ -284,7 +284,7 @@ public final class IoTProvisioningManager extends Manager {
* Set the configured provisioning server. Use <code>null</code> as provisioningServer to use * Set the configured provisioning server. Use <code>null</code> as provisioningServer to use
* automatic discovery of the provisioning server (the default behavior). * automatic discovery of the provisioning server (the default behavior).
* *
* @param provisioningServer * @param provisioningServer TODO javadoc me please
*/ */
public void setConfiguredProvisioningServer(Jid provisioningServer) { public void setConfiguredProvisioningServer(Jid provisioningServer) {
this.configuredProvisioningServer = provisioningServer; this.configuredProvisioningServer = provisioningServer;
@ -302,10 +302,10 @@ public final class IoTProvisioningManager extends Manager {
* Try to find a provisioning server component. * Try to find a provisioning server component.
* *
* @return the XMPP address of the provisioning server component if one was found. * @return the XMPP address of the provisioning server component if one was found.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0324.html#servercomponent">XEP-0324 § 3.1.2 Provisioning Server as a server component</a> * @see <a href="http://xmpp.org/extensions/xep-0324.html#servercomponent">XEP-0324 § 3.1.2 Provisioning Server as a server component</a>
*/ */
public DomainBareJid findProvisioningServerComponent() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public DomainBareJid findProvisioningServerComponent() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -326,10 +326,10 @@ public final class IoTProvisioningManager extends Manager {
* @param provisioningServer the provisioning server to ask. * @param provisioningServer the provisioning server to ask.
* @param friendInQuestion the JID to ask about. * @param friendInQuestion the JID to ask about.
* @return <code>true</code> if the JID is a friend, <code>false</code> otherwise. * @return <code>true</code> if the JID is a friend, <code>false</code> otherwise.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean isFriend(Jid provisioningServer, BareJid friendInQuestion) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public boolean isFriend(Jid provisioningServer, BareJid friendInQuestion) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
LruCache<BareJid, Void> cache = negativeFriendshipRequestCache.lookup(provisioningServer); LruCache<BareJid, Void> cache = negativeFriendshipRequestCache.lookup(provisioningServer);

View file

@ -72,7 +72,7 @@ public class Range implements NamedElement {
/** /**
* Return the index of the offset. * Return the index of the offset.
* This marks the begin of the specified range. * This marks the begin of the specified range.
* @return offset * @return offset TODO javadoc me please
*/ */
public int getOffset() { public int getOffset() {
return offset; return offset;
@ -80,7 +80,7 @@ public class Range implements NamedElement {
/** /**
* Return the length of the range. * Return the length of the range.
* @return length * @return length TODO javadoc me please
*/ */
public int getLength() { public int getLength() {
return length; return length;

View file

@ -45,7 +45,7 @@ public class JsonPacketExtension extends AbstractJsonPacketExtension {
/** /**
* Retrieve the JSON stanza extension from the packet. * Retrieve the JSON stanza extension from the packet.
* *
* @param packet * @param packet TODO javadoc me please
* @return the JSON stanza extension or null. * @return the JSON stanza extension or null.
*/ */
public static JsonPacketExtension from(Stanza packet) { public static JsonPacketExtension from(Stanza packet) {

View file

@ -492,11 +492,11 @@ public final class MamManager extends Manager {
* Get the form fields supported by the server. * Get the form fields supported by the server.
* *
* @return the list of form fields. * @return the list of form fields.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
*/ */
public List<FormField> retrieveFormFields() throws NoResponseException, XMPPErrorException, NotConnectedException, public List<FormField> retrieveFormFields() throws NoResponseException, XMPPErrorException, NotConnectedException,
InterruptedException, NotLoggedInException { InterruptedException, NotLoggedInException {
@ -508,11 +508,11 @@ public final class MamManager extends Manager {
* *
* @param node The PubSub node name, can be null * @param node The PubSub node name, can be null
* @return the list of form fields. * @return the list of form fields.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
*/ */
public List<FormField> retrieveFormFields(String node) public List<FormField> retrieveFormFields(String node)
throws NoResponseException, XMPPErrorException, NotConnectedException, throws NoResponseException, XMPPErrorException, NotConnectedException,
@ -700,10 +700,10 @@ public final class MamManager extends Manager {
* *
* @return true if MAM is supported, <code>false</code>otherwise. * @return true if MAM is supported, <code>false</code>otherwise.
* *
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.1 * @since 4.2.1
* @see <a href="https://xmpp.org/extensions/xep-0313.html#support">XEP-0313 § 7. Determining support</a> * @see <a href="https://xmpp.org/extensions/xep-0313.html#support">XEP-0313 § 7. Determining support</a>
*/ */
@ -725,11 +725,11 @@ public final class MamManager extends Manager {
* empty. * empty.
* *
* @return the ID of the lastest message or {@code null}. * @return the ID of the lastest message or {@code null}.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @since 4.3.0 * @since 4.3.0
*/ */
public String getMessageUidOfLatestMessage() throws NoResponseException, XMPPErrorException, NotConnectedException, NotLoggedInException, InterruptedException { public String getMessageUidOfLatestMessage() throws NoResponseException, XMPPErrorException, NotConnectedException, NotLoggedInException, InterruptedException {
@ -750,11 +750,11 @@ public final class MamManager extends Manager {
* Get the preferences stored in the server. * Get the preferences stored in the server.
* *
* @return the MAM preferences result * @return the MAM preferences result
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
*/ */
public MamPrefsResult retrieveArchivingPreferences() throws NoResponseException, XMPPErrorException, public MamPrefsResult retrieveArchivingPreferences() throws NoResponseException, XMPPErrorException,
NotConnectedException, InterruptedException, NotLoggedInException { NotConnectedException, InterruptedException, NotLoggedInException {
@ -765,20 +765,20 @@ public final class MamManager extends Manager {
/** /**
* Update the preferences in the server. * Update the preferences in the server.
* *
* @param alwaysJids * @param alwaysJids TODO javadoc me please
* is the list of JIDs that should always have messages to/from * is the list of JIDs that should always have messages to/from
* archived in the user's store * archived in the user's store
* @param neverJids * @param neverJids TODO javadoc me please
* is the list of JIDs that should never have messages to/from * is the list of JIDs that should never have messages to/from
* archived in the user's store * archived in the user's store
* @param defaultBehavior * @param defaultBehavior TODO javadoc me please
* can be "roster", "always", "never" (see XEP-0313) * can be "roster", "always", "never" (see XEP-0313)
* @return the MAM preferences result * @return the MAM preferences result
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
* @deprecated use {@link #updateArchivingPreferences(MamPrefs)} instead. * @deprecated use {@link #updateArchivingPreferences(MamPrefs)} instead.
*/ */
@Deprecated @Deprecated
@ -793,13 +793,13 @@ public final class MamManager extends Manager {
/** /**
* Update the preferences in the server. * Update the preferences in the server.
* *
* @param mamPrefs * @param mamPrefs TODO javadoc me please
* @return the currently active preferences after the operation. * @return the currently active preferences after the operation.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NotLoggedInException * @throws NotLoggedInException if the XMPP connection is not authenticated.
* @since 4.3.0 * @since 4.3.0
*/ */
public MamPrefsResult updateArchivingPreferences(MamPrefs mamPrefs) throws NoResponseException, XMPPErrorException, public MamPrefsResult updateArchivingPreferences(MamPrefs mamPrefs) throws NoResponseException, XMPPErrorException,

View file

@ -72,9 +72,9 @@ public class MamElements {
/** /**
* MAM result extension constructor. * MAM result extension constructor.
* *
* @param queryId * @param queryId TODO javadoc me please
* @param id * @param id TODO javadoc me please
* @param forwarded * @param forwarded TODO javadoc me please
*/ */
public MamResultExtension(String queryId, String id, Forwarded forwarded) { public MamResultExtension(String queryId, String id, Forwarded forwarded) {
if (StringUtils.isEmpty(id)) { if (StringUtils.isEmpty(id)) {
@ -160,7 +160,7 @@ public class MamElements {
/** /**
* Always JID list element constructor. * Always JID list element constructor.
* *
* @param alwaysJids * @param alwaysJids TODO javadoc me please
*/ */
AlwaysJidListElement(List<Jid> alwaysJids) { AlwaysJidListElement(List<Jid> alwaysJids) {
this.alwaysJids = alwaysJids; this.alwaysJids = alwaysJids;
@ -194,7 +194,7 @@ public class MamElements {
/** /**
* Never JID list element constructor. * Never JID list element constructor.
* *
* @param neverJids * @param neverJids TODO javadoc me please
*/ */
public NeverJidListElement(List<Jid> neverJids) { public NeverJidListElement(List<Jid> neverJids) {
this.neverJids = neverJids; this.neverJids = neverJids;

View file

@ -63,10 +63,10 @@ public class MamFinIQ extends IQ {
/** /**
* MamFinIQ constructor. * MamFinIQ constructor.
* *
* @param queryId * @param queryId TODO javadoc me please
* @param rsmSet * @param rsmSet TODO javadoc me please
* @param complete * @param complete TODO javadoc me please
* @param stable * @param stable TODO javadoc me please
*/ */
public MamFinIQ(String queryId, RSMSet rsmSet, boolean complete, boolean stable) { public MamFinIQ(String queryId, RSMSet rsmSet, boolean complete, boolean stable) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -79,9 +79,9 @@ public class MamPrefsIQ extends IQ {
/** /**
* MAM preferences IQ constructor. * MAM preferences IQ constructor.
* *
* @param alwaysJids * @param alwaysJids TODO javadoc me please
* @param neverJids * @param neverJids TODO javadoc me please
* @param defaultBehavior * @param defaultBehavior TODO javadoc me please
*/ */
public MamPrefsIQ(List<Jid> alwaysJids, List<Jid> neverJids, DefaultBehavior defaultBehavior) { public MamPrefsIQ(List<Jid> alwaysJids, List<Jid> neverJids, DefaultBehavior defaultBehavior) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -48,7 +48,7 @@ public class MamQueryIQ extends IQ {
/** /**
* MAM query IQ constructor. * MAM query IQ constructor.
* *
* @param queryId * @param queryId TODO javadoc me please
*/ */
public MamQueryIQ(String queryId) { public MamQueryIQ(String queryId) {
this(queryId, null, null); this(queryId, null, null);
@ -58,7 +58,7 @@ public class MamQueryIQ extends IQ {
/** /**
* MAM query IQ constructor. * MAM query IQ constructor.
* *
* @param form * @param form TODO javadoc me please
*/ */
public MamQueryIQ(DataForm form) { public MamQueryIQ(DataForm form) {
this(null, null, form); this(null, null, form);
@ -67,8 +67,8 @@ public class MamQueryIQ extends IQ {
/** /**
* MAM query IQ constructor. * MAM query IQ constructor.
* *
* @param queryId * @param queryId TODO javadoc me please
* @param form * @param form TODO javadoc me please
*/ */
public MamQueryIQ(String queryId, DataForm form) { public MamQueryIQ(String queryId, DataForm form) {
this(queryId, null, form); this(queryId, null, form);
@ -77,9 +77,9 @@ public class MamQueryIQ extends IQ {
/** /**
* MAM query IQ constructor. * MAM query IQ constructor.
* *
* @param queryId * @param queryId TODO javadoc me please
* @param node * @param node TODO javadoc me please
* @param dataForm * @param dataForm TODO javadoc me please
*/ */
public MamQueryIQ(String queryId, String node, DataForm dataForm) { public MamQueryIQ(String queryId, String node, DataForm dataForm) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -56,7 +56,7 @@ public class ListElement implements MarkupElement.MarkupChildElement {
/** /**
* Return a list of all list entries. * Return a list of all list entries.
* *
* @return entries * @return entries TODO javadoc me please
*/ */
public List<ListEntryElement> getEntries() { public List<ListEntryElement> getEntries() {
return entries; return entries;

View file

@ -51,7 +51,7 @@ public class MarkupElement implements ExtensionElement {
/** /**
* Return a list of all child elements. * Return a list of all child elements.
* @return children * @return children TODO javadoc me please
*/ */
public List<MarkupChildElement> getChildElements() { public List<MarkupChildElement> getChildElements() {
return childElements; return childElements;
@ -97,7 +97,7 @@ public class MarkupElement implements ExtensionElement {
* *
* @param start start index * @param start start index
* @param end end index * @param end end index
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder setDeleted(int start, int end) { public Builder setDeleted(int start, int end) {
return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.deleted)); return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.deleted));
@ -108,7 +108,7 @@ public class MarkupElement implements ExtensionElement {
* *
* @param start start index * @param start start index
* @param end end index * @param end end index
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder setEmphasis(int start, int end) { public Builder setEmphasis(int start, int end) {
return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.emphasis)); return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.emphasis));
@ -119,7 +119,7 @@ public class MarkupElement implements ExtensionElement {
* *
* @param start start index * @param start start index
* @param end end index * @param end end index
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder setCode(int start, int end) { public Builder setCode(int start, int end) {
return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.code)); return addSpan(start, end, Collections.singleton(SpanElement.SpanStyle.code));
@ -131,7 +131,7 @@ public class MarkupElement implements ExtensionElement {
* @param start start index * @param start start index
* @param end end index * @param end end index
* @param styles list of text styles for that span * @param styles list of text styles for that span
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder addSpan(int start, int end, Set<SpanElement.SpanStyle> styles) { public Builder addSpan(int start, int end, Set<SpanElement.SpanStyle> styles) {
verifyStartEnd(start, end); verifyStartEnd(start, end);
@ -152,7 +152,7 @@ public class MarkupElement implements ExtensionElement {
* *
* @param start start index * @param start start index
* @param end end index * @param end end index
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder setBlockQuote(int start, int end) { public Builder setBlockQuote(int start, int end) {
verifyStartEnd(start, end); verifyStartEnd(start, end);
@ -179,7 +179,7 @@ public class MarkupElement implements ExtensionElement {
* *
* @param start start index * @param start start index
* @param end end index * @param end end index
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder setCodeBlock(int start, int end) { public Builder setCodeBlock(int start, int end) {
verifyStartEnd(start, end); verifyStartEnd(start, end);
@ -232,7 +232,7 @@ public class MarkupElement implements ExtensionElement {
/** /**
* End the list. * End the list.
* *
* @return builder * @return builder TODO javadoc me please
*/ */
public Builder endList() { public Builder endList() {
if (entries.size() > 0) { if (entries.size() > 0) {

View file

@ -54,7 +54,7 @@ public class SpanElement implements MarkupElement.MarkupChildElement {
/** /**
* Return all styles of this span. * Return all styles of this span.
* *
* @return styles * @return styles TODO javadoc me please
*/ */
public Set<SpanStyle> getStyles() { public Set<SpanStyle> getStyles() {
return styles; return styles;

View file

@ -33,9 +33,9 @@ public class MUCLightRoomConfiguration {
/** /**
* MUC Light room configuration model constructor. * MUC Light room configuration model constructor.
* *
* @param roomName * @param roomName TODO javadoc me please
* @param subject * @param subject TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
*/ */
public MUCLightRoomConfiguration(String roomName, String subject, HashMap<String, String> customConfigs) { public MUCLightRoomConfiguration(String roomName, String subject, HashMap<String, String> customConfigs) {
this.roomName = roomName; this.roomName = roomName;

View file

@ -35,10 +35,10 @@ public class MUCLightRoomInfo {
/** /**
* MUC Light room info model constructor. * MUC Light room info model constructor.
* *
* @param version * @param version TODO javadoc me please
* @param roomJid * @param roomJid TODO javadoc me please
* @param configuration * @param configuration TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
*/ */
public MUCLightRoomInfo(String version, Jid roomJid, MUCLightRoomConfiguration configuration, public MUCLightRoomInfo(String version, Jid roomJid, MUCLightRoomConfiguration configuration,
HashMap<Jid, MUCLightAffiliation> occupants) { HashMap<Jid, MUCLightAffiliation> occupants) {

View file

@ -120,10 +120,10 @@ public class MultiUserChatLight {
/** /**
* Sends a message to the chat room. * Sends a message to the chat room.
* *
* @param text * @param text TODO javadoc me please
* the text of the message to send. * the text of the message to send.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void sendMessage(String text) throws NotConnectedException, InterruptedException { public void sendMessage(String text) throws NotConnectedException, InterruptedException {
Message message = createMessage(); Message message = createMessage();
@ -138,10 +138,10 @@ public class MultiUserChatLight {
* to the sender's room JID and delivering the message to the intended * to the sender's room JID and delivering the message to the intended
* recipient's full JID. * recipient's full JID.
* *
* @param occupant * @param occupant TODO javadoc me please
* occupant unique room JID (e.g. * occupant unique room JID (e.g.
* 'darkcave@macbeth.shakespeare.lit/Paul'). * 'darkcave@macbeth.shakespeare.lit/Paul').
* @param listener * @param listener TODO javadoc me please
* the listener is a message listener that will handle messages * the listener is a message listener that will handle messages
* for the newly created chat. * for the newly created chat.
* @return new Chat for sending private messages to a given room occupant. * @return new Chat for sending private messages to a given room occupant.
@ -165,10 +165,10 @@ public class MultiUserChatLight {
/** /**
* Sends a Message to the chat room. * Sends a Message to the chat room.
* *
* @param message * @param message TODO javadoc me please
* the message. * the message.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void sendMessage(Message message) throws NotConnectedException, InterruptedException { public void sendMessage(Message message) throws NotConnectedException, InterruptedException {
message.setTo(room); message.setTo(room);
@ -190,7 +190,7 @@ public class MultiUserChatLight {
* block (not return) until a message is available. * block (not return) until a message is available.
* *
* @return the next message. * @return the next message.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public Message nextMessage() throws InterruptedException { public Message nextMessage() throws InterruptedException {
return messageCollector.nextResult(); return messageCollector.nextResult();
@ -199,11 +199,11 @@ public class MultiUserChatLight {
/** /**
* Returns the next available message in the chat. * Returns the next available message in the chat.
* *
* @param timeout * @param timeout TODO javadoc me please
* the maximum amount of time to wait for the next message. * the maximum amount of time to wait for the next message.
* @return the next message, or null if the timeout elapses without a * @return the next message, or null if the timeout elapses without a
* message becoming available. * message becoming available.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public Message nextMessage(long timeout) throws InterruptedException { public Message nextMessage(long timeout) throws InterruptedException {
return messageCollector.nextResult(timeout); return messageCollector.nextResult(timeout);
@ -214,7 +214,7 @@ public class MultiUserChatLight {
* in the group chat. Only "group chat" messages addressed to this group * in the group chat. Only "group chat" messages addressed to this group
* chat will be delivered to the listener. * chat will be delivered to the listener.
* *
* @param listener * @param listener TODO javadoc me please
* a stanza listener. * a stanza listener.
* @return true if the listener was not already added. * @return true if the listener was not already added.
*/ */
@ -227,7 +227,7 @@ public class MultiUserChatLight {
* messages in the MUCLight. Only "group chat" messages addressed to this * messages in the MUCLight. Only "group chat" messages addressed to this
* MUCLight were being delivered to the listener. * MUCLight were being delivered to the listener.
* *
* @param listener * @param listener TODO javadoc me please
* a stanza listener. * a stanza listener.
* @return true if the listener was removed, otherwise the listener was not * @return true if the listener was removed, otherwise the listener was not
* added previously. * added previously.
@ -256,11 +256,11 @@ public class MultiUserChatLight {
/** /**
* Create new MUCLight. * Create new MUCLight.
* *
* @param roomName * @param roomName TODO javadoc me please
* @param subject * @param subject TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
* @throws Exception * @throws Exception TODO javadoc me please
*/ */
public void create(String roomName, String subject, HashMap<String, String> customConfigs, List<Jid> occupants) public void create(String roomName, String subject, HashMap<String, String> customConfigs, List<Jid> occupants)
throws Exception { throws Exception {
@ -279,9 +279,9 @@ public class MultiUserChatLight {
/** /**
* Create new MUCLight. * Create new MUCLight.
* *
* @param roomName * @param roomName TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
* @throws Exception * @throws Exception TODO javadoc me please
*/ */
public void create(String roomName, List<Jid> occupants) throws Exception { public void create(String roomName, List<Jid> occupants) throws Exception {
create(roomName, null, null, occupants); create(roomName, null, null, occupants);
@ -290,10 +290,10 @@ public class MultiUserChatLight {
/** /**
* Leave the MUCLight. * Leave the MUCLight.
* *
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
*/ */
public void leave() throws NotConnectedException, InterruptedException, NoResponseException, XMPPErrorException { public void leave() throws NotConnectedException, InterruptedException, NoResponseException, XMPPErrorException {
HashMap<Jid, MUCLightAffiliation> affiliations = new HashMap<>(); HashMap<Jid, MUCLightAffiliation> affiliations = new HashMap<>();
@ -311,12 +311,12 @@ public class MultiUserChatLight {
/** /**
* Get the MUC Light info. * Get the MUC Light info.
* *
* @param version * @param version TODO javadoc me please
* @return the room info * @return the room info
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public MUCLightRoomInfo getFullInfo(String version) public MUCLightRoomInfo getFullInfo(String version)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -333,10 +333,10 @@ public class MultiUserChatLight {
* Get the MUC Light info. * Get the MUC Light info.
* *
* @return the room info * @return the room info
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public MUCLightRoomInfo getFullInfo() public MUCLightRoomInfo getFullInfo()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -346,12 +346,12 @@ public class MultiUserChatLight {
/** /**
* Get the MUC Light configuration. * Get the MUC Light configuration.
* *
* @param version * @param version TODO javadoc me please
* @return the room configuration * @return the room configuration
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public MUCLightRoomConfiguration getConfiguration(String version) public MUCLightRoomConfiguration getConfiguration(String version)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -365,10 +365,10 @@ public class MultiUserChatLight {
* Get the MUC Light configuration. * Get the MUC Light configuration.
* *
* @return the room configuration * @return the room configuration
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public MUCLightRoomConfiguration getConfiguration() public MUCLightRoomConfiguration getConfiguration()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -378,12 +378,12 @@ public class MultiUserChatLight {
/** /**
* Get the MUC Light affiliations. * Get the MUC Light affiliations.
* *
* @param version * @param version TODO javadoc me please
* @return the room affiliations * @return the room affiliations
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public HashMap<Jid, MUCLightAffiliation> getAffiliations(String version) public HashMap<Jid, MUCLightAffiliation> getAffiliations(String version)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -399,10 +399,10 @@ public class MultiUserChatLight {
* Get the MUC Light affiliations. * Get the MUC Light affiliations.
* *
* @return the room affiliations * @return the room affiliations
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public HashMap<Jid, MUCLightAffiliation> getAffiliations() public HashMap<Jid, MUCLightAffiliation> getAffiliations()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -412,11 +412,11 @@ public class MultiUserChatLight {
/** /**
* Change the MUC Light affiliations. * Change the MUC Light affiliations.
* *
* @param affiliations * @param affiliations TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void changeAffiliations(HashMap<Jid, MUCLightAffiliation> affiliations) public void changeAffiliations(HashMap<Jid, MUCLightAffiliation> affiliations)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -427,10 +427,10 @@ public class MultiUserChatLight {
/** /**
* Destroy the MUC Light. Only will work if it is requested by the owner. * Destroy the MUC Light. Only will work if it is requested by the owner.
* *
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void destroy() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { public void destroy() throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
MUCLightDestroyIQ mucLightDestroyIQ = new MUCLightDestroyIQ(room); MUCLightDestroyIQ mucLightDestroyIQ = new MUCLightDestroyIQ(room);
@ -445,11 +445,11 @@ public class MultiUserChatLight {
/** /**
* Change the subject of the MUC Light. * Change the subject of the MUC Light.
* *
* @param subject * @param subject TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void changeSubject(String subject) public void changeSubject(String subject)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -460,11 +460,11 @@ public class MultiUserChatLight {
/** /**
* Change the name of the room. * Change the name of the room.
* *
* @param roomName * @param roomName TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void changeRoomName(String roomName) public void changeRoomName(String roomName)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -475,11 +475,11 @@ public class MultiUserChatLight {
/** /**
* Set the room configurations. * Set the room configurations.
* *
* @param customConfigs * @param customConfigs TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void setRoomConfigs(HashMap<String, String> customConfigs) public void setRoomConfigs(HashMap<String, String> customConfigs)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -489,12 +489,12 @@ public class MultiUserChatLight {
/** /**
* Set the room configurations. * Set the room configurations.
* *
* @param roomName * @param roomName TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void setRoomConfigs(String roomName, HashMap<String, String> customConfigs) public void setRoomConfigs(String roomName, HashMap<String, String> customConfigs)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

View file

@ -54,7 +54,7 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Get a instance of a MUC Light manager for the given connection. * Get a instance of a MUC Light manager for the given connection.
* *
* @param connection * @param connection TODO javadoc me please
* @return a MUCLight manager. * @return a MUCLight manager.
*/ */
public static synchronized MultiUserChatLightManager getInstanceFor(XMPPConnection connection) { public static synchronized MultiUserChatLightManager getInstanceFor(XMPPConnection connection) {
@ -79,7 +79,7 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Obtain the MUC Light. * Obtain the MUC Light.
* *
* @param jid * @param jid TODO javadoc me please
* @return the MUCLight. * @return the MUCLight.
*/ */
public synchronized MultiUserChatLight getMultiUserChatLight(EntityBareJid jid) { public synchronized MultiUserChatLight getMultiUserChatLight(EntityBareJid jid) {
@ -103,12 +103,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Returns true if Multi-User Chat Light feature is supported by the server. * Returns true if Multi-User Chat Light feature is supported by the server.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @return true if Multi-User Chat Light feature is supported by the server. * @return true if Multi-User Chat Light feature is supported by the server.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean isFeatureSupported(DomainBareJid mucLightService) public boolean isFeatureSupported(DomainBareJid mucLightService)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -119,12 +119,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Returns a List of the rooms the user occupies. * Returns a List of the rooms the user occupies.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @return a List of the rooms the user occupies. * @return a List of the rooms the user occupies.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<Jid> getOccupiedRooms(DomainBareJid mucLightService) public List<Jid> getOccupiedRooms(DomainBareJid mucLightService)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -144,10 +144,10 @@ public final class MultiUserChatLightManager extends Manager {
* Returns a collection with the XMPP addresses of the MUC Light services. * Returns a collection with the XMPP addresses of the MUC Light services.
* *
* @return a collection with the XMPP addresses of the MUC Light services. * @return a collection with the XMPP addresses of the MUC Light services.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<DomainBareJid> getLocalServices() public List<DomainBareJid> getLocalServices()
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -158,12 +158,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Get users and rooms blocked. * Get users and rooms blocked.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @return the list of users and rooms blocked * @return the list of users and rooms blocked
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<Jid> getUsersAndRoomsBlocked(DomainBareJid mucLightService) public List<Jid> getUsersAndRoomsBlocked(DomainBareJid mucLightService)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -184,12 +184,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Get rooms blocked. * Get rooms blocked.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @return the list of rooms blocked * @return the list of rooms blocked
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<Jid> getRoomsBlocked(DomainBareJid mucLightService) public List<Jid> getRoomsBlocked(DomainBareJid mucLightService)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -206,12 +206,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Get users blocked. * Get users blocked.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @return the list of users blocked * @return the list of users blocked
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public List<Jid> getUsersBlocked(DomainBareJid mucLightService) public List<Jid> getUsersBlocked(DomainBareJid mucLightService)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -242,12 +242,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Block a room. * Block a room.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param roomJid * @param roomJid TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void blockRoom(DomainBareJid mucLightService, Jid roomJid) public void blockRoom(DomainBareJid mucLightService, Jid roomJid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -259,12 +259,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Block rooms. * Block rooms.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param roomsJids * @param roomsJids TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void blockRooms(DomainBareJid mucLightService, List<Jid> roomsJids) public void blockRooms(DomainBareJid mucLightService, List<Jid> roomsJids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -286,12 +286,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Block a user. * Block a user.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param userJid * @param userJid TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void blockUser(DomainBareJid mucLightService, Jid userJid) public void blockUser(DomainBareJid mucLightService, Jid userJid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -303,12 +303,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Block users. * Block users.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param usersJids * @param usersJids TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void blockUsers(DomainBareJid mucLightService, List<Jid> usersJids) public void blockUsers(DomainBareJid mucLightService, List<Jid> usersJids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -330,12 +330,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Unblock a room. * Unblock a room.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param roomJid * @param roomJid TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void unblockRoom(DomainBareJid mucLightService, Jid roomJid) public void unblockRoom(DomainBareJid mucLightService, Jid roomJid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -347,12 +347,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Unblock rooms. * Unblock rooms.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param roomsJids * @param roomsJids TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void unblockRooms(DomainBareJid mucLightService, List<Jid> roomsJids) public void unblockRooms(DomainBareJid mucLightService, List<Jid> roomsJids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -374,12 +374,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Unblock a user. * Unblock a user.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param userJid * @param userJid TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void unblockUser(DomainBareJid mucLightService, Jid userJid) public void unblockUser(DomainBareJid mucLightService, Jid userJid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -391,12 +391,12 @@ public final class MultiUserChatLightManager extends Manager {
/** /**
* Unblock users. * Unblock users.
* *
* @param mucLightService * @param mucLightService TODO javadoc me please
* @param usersJids * @param usersJids TODO javadoc me please
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public void unblockUsers(DomainBareJid mucLightService, List<Jid> usersJids) public void unblockUsers(DomainBareJid mucLightService, List<Jid> usersJids)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

View file

@ -45,8 +45,8 @@ public class MUCLightAffiliationsIQ extends IQ {
/** /**
* MUC Light affiliations response IQ constructor. * MUC Light affiliations response IQ constructor.
* *
* @param version * @param version TODO javadoc me please
* @param affiliations * @param affiliations TODO javadoc me please
*/ */
public MUCLightAffiliationsIQ(String version, HashMap<Jid, MUCLightAffiliation> affiliations) { public MUCLightAffiliationsIQ(String version, HashMap<Jid, MUCLightAffiliation> affiliations) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -44,8 +44,8 @@ public class MUCLightBlockingIQ extends IQ {
/** /**
* MUC Light blocking IQ constructor. * MUC Light blocking IQ constructor.
* *
* @param rooms * @param rooms TODO javadoc me please
* @param users * @param users TODO javadoc me please
*/ */
public MUCLightBlockingIQ(HashMap<Jid, Boolean> rooms, HashMap<Jid, Boolean> users) { public MUCLightBlockingIQ(HashMap<Jid, Boolean> rooms, HashMap<Jid, Boolean> users) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -44,8 +44,8 @@ public class MUCLightChangeAffiliationsIQ extends IQ {
/** /**
* MUCLight change affiliations IQ constructor. * MUCLight change affiliations IQ constructor.
* *
* @param room * @param room TODO javadoc me please
* @param affiliations * @param affiliations TODO javadoc me please
*/ */
public MUCLightChangeAffiliationsIQ(Jid room, HashMap<Jid, MUCLightAffiliation> affiliations) { public MUCLightChangeAffiliationsIQ(Jid room, HashMap<Jid, MUCLightAffiliation> affiliations) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -39,8 +39,8 @@ public class MUCLightConfigurationIQ extends IQ {
/** /**
* MUC Light configuration response IQ constructor. * MUC Light configuration response IQ constructor.
* *
* @param version * @param version TODO javadoc me please
* @param configuration * @param configuration TODO javadoc me please
*/ */
public MUCLightConfigurationIQ(String version, MUCLightRoomConfiguration configuration) { public MUCLightConfigurationIQ(String version, MUCLightRoomConfiguration configuration) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -47,11 +47,11 @@ public class MUCLightCreateIQ extends IQ {
/** /**
* MUCLight create IQ constructor. * MUCLight create IQ constructor.
* *
* @param room * @param room TODO javadoc me please
* @param roomName * @param roomName TODO javadoc me please
* @param subject * @param subject TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
*/ */
public MUCLightCreateIQ(EntityJid room, String roomName, String subject, HashMap<String, String> customConfigs, public MUCLightCreateIQ(EntityJid room, String roomName, String subject, HashMap<String, String> customConfigs,
List<Jid> occupants) { List<Jid> occupants) {
@ -70,9 +70,9 @@ public class MUCLightCreateIQ extends IQ {
/** /**
* MUCLight create IQ constructor. * MUCLight create IQ constructor.
* *
* @param room * @param room TODO javadoc me please
* @param roomName * @param roomName TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
*/ */
public MUCLightCreateIQ(EntityJid room, String roomName, List<Jid> occupants) { public MUCLightCreateIQ(EntityJid room, String roomName, List<Jid> occupants) {
this(room, roomName, null, null, occupants); this(room, roomName, null, null, occupants);

View file

@ -36,7 +36,7 @@ public class MUCLightDestroyIQ extends IQ {
/** /**
* MUC Light destroy IQ constructor. * MUC Light destroy IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
*/ */
public MUCLightDestroyIQ(Jid roomJid) { public MUCLightDestroyIQ(Jid roomJid) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);

View file

@ -137,11 +137,11 @@ public abstract class MUCLightElements {
/** /**
* Configurations change extension constructor. * Configurations change extension constructor.
* *
* @param prevVersion * @param prevVersion TODO javadoc me please
* @param version * @param version TODO javadoc me please
* @param roomName * @param roomName TODO javadoc me please
* @param subject * @param subject TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
*/ */
public ConfigurationsChangeExtension(String prevVersion, String version, String roomName, String subject, public ConfigurationsChangeExtension(String prevVersion, String version, String roomName, String subject,
HashMap<String, String> customConfigs) { HashMap<String, String> customConfigs) {
@ -248,7 +248,7 @@ public abstract class MUCLightElements {
/** /**
* Configuration element constructor. * Configuration element constructor.
* *
* @param configuration * @param configuration TODO javadoc me please
*/ */
public ConfigurationElement(MUCLightRoomConfiguration configuration) { public ConfigurationElement(MUCLightRoomConfiguration configuration) {
this.configuration = configuration; this.configuration = configuration;
@ -289,7 +289,7 @@ public abstract class MUCLightElements {
/** /**
* Occupants element constructor. * Occupants element constructor.
* *
* @param occupants * @param occupants TODO javadoc me please
*/ */
public OccupantsElement(HashMap<Jid, MUCLightAffiliation> occupants) { public OccupantsElement(HashMap<Jid, MUCLightAffiliation> occupants) {
this.occupants = occupants; this.occupants = occupants;
@ -326,8 +326,8 @@ public abstract class MUCLightElements {
/** /**
* User with affiliations element constructor. * User with affiliations element constructor.
* *
* @param user * @param user TODO javadoc me please
* @param affiliation * @param affiliation TODO javadoc me please
*/ */
public UserWithAffiliationElement(Jid user, MUCLightAffiliation affiliation) { public UserWithAffiliationElement(Jid user, MUCLightAffiliation affiliation) {
this.user = user; this.user = user;
@ -362,9 +362,9 @@ public abstract class MUCLightElements {
/** /**
* Blocking element constructor. * Blocking element constructor.
* *
* @param jid * @param jid TODO javadoc me please
* @param allow * @param allow TODO javadoc me please
* @param isRoom * @param isRoom TODO javadoc me please
*/ */
public BlockingElement(Jid jid, Boolean allow, Boolean isRoom) { public BlockingElement(Jid jid, Boolean allow, Boolean isRoom) {
this.jid = jid; this.jid = jid;

View file

@ -38,8 +38,8 @@ public class MUCLightGetAffiliationsIQ extends IQ {
/** /**
* MUC Light get affiliations IQ constructor. * MUC Light get affiliations IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
* @param version * @param version TODO javadoc me please
*/ */
public MUCLightGetAffiliationsIQ(Jid roomJid, String version) { public MUCLightGetAffiliationsIQ(Jid roomJid, String version) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);
@ -51,7 +51,7 @@ public class MUCLightGetAffiliationsIQ extends IQ {
/** /**
* MUC Light get affiliations IQ constructor. * MUC Light get affiliations IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
*/ */
public MUCLightGetAffiliationsIQ(Jid roomJid) { public MUCLightGetAffiliationsIQ(Jid roomJid) {
this(roomJid, null); this(roomJid, null);

View file

@ -38,8 +38,8 @@ public class MUCLightGetConfigsIQ extends IQ {
/** /**
* MUC Light get configurations IQ constructor. * MUC Light get configurations IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
* @param version * @param version TODO javadoc me please
*/ */
public MUCLightGetConfigsIQ(Jid roomJid, String version) { public MUCLightGetConfigsIQ(Jid roomJid, String version) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);
@ -51,7 +51,7 @@ public class MUCLightGetConfigsIQ extends IQ {
/** /**
* MUC Light get configurations IQ constructor. * MUC Light get configurations IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
*/ */
public MUCLightGetConfigsIQ(Jid roomJid) { public MUCLightGetConfigsIQ(Jid roomJid) {
this(roomJid, null); this(roomJid, null);

View file

@ -38,8 +38,8 @@ public class MUCLightGetInfoIQ extends IQ {
/** /**
* MUC Light get info IQ constructor. * MUC Light get info IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
* @param version * @param version TODO javadoc me please
*/ */
public MUCLightGetInfoIQ(Jid roomJid, String version) { public MUCLightGetInfoIQ(Jid roomJid, String version) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);
@ -51,7 +51,7 @@ public class MUCLightGetInfoIQ extends IQ {
/** /**
* MUC Light get info IQ constructor. * MUC Light get info IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
*/ */
public MUCLightGetInfoIQ(Jid roomJid) { public MUCLightGetInfoIQ(Jid roomJid) {
this(roomJid, null); this(roomJid, null);

View file

@ -46,9 +46,9 @@ public class MUCLightInfoIQ extends IQ {
/** /**
* MUCLight info response IQ constructor. * MUCLight info response IQ constructor.
* *
* @param version * @param version TODO javadoc me please
* @param configuration * @param configuration TODO javadoc me please
* @param occupants * @param occupants TODO javadoc me please
*/ */
public MUCLightInfoIQ(String version, MUCLightRoomConfiguration configuration, public MUCLightInfoIQ(String version, MUCLightRoomConfiguration configuration,
HashMap<Jid, MUCLightAffiliation> occupants) { HashMap<Jid, MUCLightAffiliation> occupants) {

View file

@ -44,10 +44,10 @@ public class MUCLightSetConfigsIQ extends IQ {
/** /**
* MUC Light set configuration IQ constructor. * MUC Light set configuration IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
* @param roomName * @param roomName TODO javadoc me please
* @param subject * @param subject TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
*/ */
public MUCLightSetConfigsIQ(Jid roomJid, String roomName, String subject, HashMap<String, String> customConfigs) { public MUCLightSetConfigsIQ(Jid roomJid, String roomName, String subject, HashMap<String, String> customConfigs) {
super(ELEMENT, NAMESPACE); super(ELEMENT, NAMESPACE);
@ -61,9 +61,9 @@ public class MUCLightSetConfigsIQ extends IQ {
/** /**
* MUC Light set configuration IQ constructor. * MUC Light set configuration IQ constructor.
* *
* @param roomJid * @param roomJid TODO javadoc me please
* @param roomName * @param roomName TODO javadoc me please
* @param customConfigs * @param customConfigs TODO javadoc me please
*/ */
public MUCLightSetConfigsIQ(Jid roomJid, String roomName, HashMap<String, String> customConfigs) { public MUCLightSetConfigsIQ(Jid roomJid, String roomName, HashMap<String, String> customConfigs) {
this(roomJid, roomName, null, customConfigs); this(roomJid, roomName, null, customConfigs);

View file

@ -61,7 +61,7 @@ public final class PushNotificationsManager extends Manager {
/** /**
* Get the singleton instance of PushNotificationsManager. * Get the singleton instance of PushNotificationsManager.
* *
* @param connection * @param connection TODO javadoc me please
* @return the instance of PushNotificationsManager * @return the instance of PushNotificationsManager
*/ */
public static synchronized PushNotificationsManager getInstanceFor(XMPPConnection connection) { public static synchronized PushNotificationsManager getInstanceFor(XMPPConnection connection) {
@ -83,10 +83,10 @@ public final class PushNotificationsManager extends Manager {
* Returns true if Push Notifications are supported by this account. * Returns true if Push Notifications are supported by this account.
* *
* @return true if Push Notifications are supported by this account. * @return true if Push Notifications are supported by this account.
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
* @since 4.2.2 * @since 4.2.2
*/ */
public boolean isSupported() public boolean isSupported()
@ -98,13 +98,13 @@ public final class PushNotificationsManager extends Manager {
/** /**
* Enable push notifications. * Enable push notifications.
* *
* @param pushJid * @param pushJid TODO javadoc me please
* @param node * @param node TODO javadoc me please
* @return true if it was successfully enabled, false if not * @return true if it was successfully enabled, false if not
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean enable(Jid pushJid, String node) public boolean enable(Jid pushJid, String node)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -114,14 +114,14 @@ public final class PushNotificationsManager extends Manager {
/** /**
* Enable push notifications. * Enable push notifications.
* *
* @param pushJid * @param pushJid TODO javadoc me please
* @param node * @param node TODO javadoc me please
* @param publishOptions * @param publishOptions TODO javadoc me please
* @return true if it was successfully enabled, false if not * @return true if it was successfully enabled, false if not
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean enable(Jid pushJid, String node, HashMap<String, String> publishOptions) public boolean enable(Jid pushJid, String node, HashMap<String, String> publishOptions)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -133,12 +133,12 @@ public final class PushNotificationsManager extends Manager {
/** /**
* Disable all push notifications. * Disable all push notifications.
* *
* @param pushJid * @param pushJid TODO javadoc me please
* @return true if it was successfully disabled, false if not * @return true if it was successfully disabled, false if not
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean disableAll(Jid pushJid) public boolean disableAll(Jid pushJid)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
@ -148,13 +148,13 @@ public final class PushNotificationsManager extends Manager {
/** /**
* Disable push notifications of an specific node. * Disable push notifications of an specific node.
* *
* @param pushJid * @param pushJid TODO javadoc me please
* @param node * @param node TODO javadoc me please
* @return true if it was successfully disabled, false if not * @return true if it was successfully disabled, false if not
* @throws NoResponseException * @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException * @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException * @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException * @throws InterruptedException if the calling thread was interrupted.
*/ */
public boolean disable(Jid pushJid, String node) public boolean disable(Jid pushJid, String node)
throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException { throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {

View file

@ -56,12 +56,12 @@ public class ReferenceElement implements ExtensionElement {
/** /**
* XEP-incompliant (v0.2) constructor. This is needed for SIMS. * XEP-incompliant (v0.2) constructor. This is needed for SIMS.
* *
* @param begin * @param begin TODO javadoc me please
* @param end * @param end TODO javadoc me please
* @param type * @param type TODO javadoc me please
* @param anchor * @param anchor TODO javadoc me please
* @param uri * @param uri TODO javadoc me please
* @param child * @param child TODO javadoc me please
*/ */
public ReferenceElement(Integer begin, Integer end, Type type, String anchor, URI uri, ExtensionElement child) { public ReferenceElement(Integer begin, Integer end, Type type, String anchor, URI uri, ExtensionElement child) {
if (begin != null && begin < 0) { if (begin != null && begin < 0) {
@ -89,11 +89,11 @@ public class ReferenceElement implements ExtensionElement {
/** /**
* XEP-Compliant constructor. * XEP-Compliant constructor.
* *
* @param begin * @param begin TODO javadoc me please
* @param end * @param end TODO javadoc me please
* @param type * @param type TODO javadoc me please
* @param anchor * @param anchor TODO javadoc me please
* @param uri * @param uri TODO javadoc me please
*/ */
public ReferenceElement(Integer begin, Integer end, Type type, String anchor, URI uri) { public ReferenceElement(Integer begin, Integer end, Type type, String anchor, URI uri) {
this(begin, end, type, anchor, uri, null); this(begin, end, type, anchor, uri, null);

View file

@ -66,7 +66,7 @@ public final class StableUniqueStanzaIdManager extends Manager {
/** /**
* Private constructor. * Private constructor.
* @param connection * @param connection TODO javadoc me please
*/ */
private StableUniqueStanzaIdManager(XMPPConnection connection) { private StableUniqueStanzaIdManager(XMPPConnection connection) {
super(connection); super(connection);

View file

@ -37,6 +37,7 @@ public class OriginIdElement extends StableAndUniqueIdElement {
* Add an origin-id element to a message and set the stanzas id to the same id as in the origin-id element. * Add an origin-id element to a message and set the stanzas id to the same id as in the origin-id element.
* *
* @param message message. * @param message message.
* @return the added origin-id element.
*/ */
public static OriginIdElement addOriginId(Message message) { public static OriginIdElement addOriginId(Message message) {
OriginIdElement originId = new OriginIdElement(); OriginIdElement originId = new OriginIdElement();

View file

@ -60,7 +60,7 @@ public final class SpoilerManager extends Manager {
* Return the connections instance of the SpoilerManager. * Return the connections instance of the SpoilerManager.
* *
* @param connection xmpp connection * @param connection xmpp connection
* @return SpoilerManager * @return SpoilerManager TODO javadoc me please
*/ */
public static synchronized SpoilerManager getInstanceFor(XMPPConnection connection) { public static synchronized SpoilerManager getInstanceFor(XMPPConnection connection) {
SpoilerManager manager = INSTANCES.get(connection); SpoilerManager manager = INSTANCES.get(connection);

View file

@ -57,7 +57,7 @@ public class ReferenceTest extends SmackTestSuite {
/** /**
* TODO: The uri might not be following the XMPP schema. * TODO: The uri might not be following the XMPP schema.
* That shouldn't matter though. * That shouldn't matter though.
* @throws Exception * @throws Exception if an exception occurs.
*/ */
@Test @Test
public void providerDataTest() throws Exception { public void providerDataTest() throws Exception {

View file

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

View file

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

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