gradle: Add workaround for gpg signatory not supporting 'required'

Also move configuration files into "${rootProject}/config/checkstyle"
to follow convention over configuration.

See https://github.com/gradle/gradle/issues/8286#issuecomment-458145619

.travis.yml

@@ -1,24 +1,40 @@
 language: android
+dist: trusty
 android:
   components:
     - android-19
 jdk:
   - oraclejdk8
-  - openjdk8
-sudo: false
+  - openjdk9
+  - openjdk11
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
 cache:
   directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.android/build-cache
     - $HOME/.m2
 
 before_install:
-  - export GRADLE_VERSION=5.2.1
+  - export GRADLE_VERSION=5.5.1
   - wget https://services.gradle.org/distributions/gradle-${GRADLE_VERSION}-all.zip
   - unzip -q gradle-${GRADLE_VERSION}-all.zip
   - export PATH="$(pwd)/gradle-${GRADLE_VERSION}/bin:$PATH"
-  - sudo apt install graphviz
+  - sudo apt-get install graphviz
+
+addons:
+  apt:
+    update: true
 
 install: gradle assemble --stacktrace
-script: gradle check --stacktrace
+
+# Run the test suite and also install the artifacts in the local maven
+# archive to additionaly test if artifact creation is
+# functional. Which hasn't always be the case in the past, see
+# 90cbcaebc7a89f4f771f733a33ac9f389df85be2
+script: gradle check install --stacktrace
 
 after_success:
   - JAVAC_VERSION=$((javac -version) 2>&1)

build.gradle

@@ -289,23 +289,6 @@ configure (junit4Projects) {
 	}
 }
 
-gradle.taskGraph.whenReady { taskGraph ->
-	if (signingRequired
-		&& taskGraph.allTasks.any { it instanceof Sign }) {
-		// Use Java 6's console to read from the console (no good for a CI environment)
-		def console = System.console()
-		if (console == null) {
-			throw new Exception("Could not obtain system console (Console is 'null'). Did you build with gradle daemon? Try the same Gradle command with \"--no-daemon\".")
-		}
-		console.printf '\n\nWe have to sign some things in this build.\n\nPlease enter your signing details.\n\n'
-		def password = console.readPassword('GnuPG Private Key Password: ')
-
-		allprojects { ext.'signing.password' = password }
-
-		console.printf '\nThanks.\n\n'
-	}
-}
-
 task copyAllJavadocDocFiles(type: Copy) {
 	from javadocAllProjects.collect { project ->
 		"${project.projectDir}/src/javadoc" }
@@ -399,7 +382,6 @@ subprojects {
 	apply plugin: 'org.kordamp.gradle.clirr'
 
 	checkstyle {
-		configFile = new File(rootConfigDir, 'checkstyle.xml')
 		toolVersion = '8.10'
 	}
 	task sourcesJar(type: Jar, dependsOn: classes) {
@@ -502,7 +484,17 @@ subprojects {
 			include "$libsDirName/*${version}-sources.jar"
 		}
 	}
+
+	// Workaround for gpg signatory not supporting the 'required' option
+	// See https://github.com/gradle/gradle/issues/5064#issuecomment-381924984
+	// Note what we use 'signing.gnupg.keyName' instead of 'signing.keyId'.
+	tasks.withType(Sign) {
+		onlyIf {
+			project.hasProperty('signing.gnupg.keyName')
+		}
+	}
 	signing {
+		useGpgCmd()
 		required { signingRequired }
 		sign configurations.archives
 	}

config/checkstyle/checkstyle.xml

@@ -4,7 +4,7 @@
      "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 <module name="Checker">
 	<module name="SuppressionFilter">
-		<property name="file" value="config/suppressions.xml"/>
+		<property name="file" value="${config_loc}/suppressions.xml"/>
 	</module>
 	<module name="SuppressWithPlainTextCommentFilter">
 		<property name="offCommentFormat" value="CHECKSTYLE\:OFF\:(\w+)"/>
@@ -12,7 +12,7 @@
 		<property name="checkFormat" value="$1"/>
 	</module>
 	<module name="Header">
-		<property name="headerFile" value="config/${checkstyleLicenseHeader}.txt"/>
+		<property name="headerFile" value="${config_loc}/${checkstyleLicenseHeader}.txt"/>
 		<property name="ignoreLines" value="3"/>
 		<property name="fileExtensions" value="java"/>
 	</module>

smack-android/build.gradle

@@ -7,7 +7,7 @@ smack-extensions and smack-experimental."""
 // Note that the test dependencies (junit, …) are inferred from the
 // sourceSet.test of the core subproject
 dependencies {
-	api project(':smack-xmlparser-xpp3')
+	implementation project(':smack-xmlparser-xpp3')
 	// Depend on minidns-android21 as optional dependency, even if may
 	// not need it. Can't hurt to have it in the programm path with
 	// the correct MiniDNS version as it won't hurt even if the

smack-android/src/main/java/org/jivesoftware/smackx/debugger/android/AndroidDebugger.java

@@ -29,7 +29,7 @@ import android.util.Log;
  * </p>
  * It is possible to not only print the raw sent and received stanzas but also the interpreted
  * packets by Smack. By default interpreted packets won't be printed. To enable this feature
- * just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
+ * just change the <code>printInterpreted</code> static variable to <code>true</code>.
  *
  */
 public class AndroidDebugger extends AbstractDebugger {

smack-core/src/main/java/org/jivesoftware/smack/AbstractXmppNioConnection.java

@@ -47,8 +47,4 @@ public abstract class AbstractXmppNioConnection extends AbstractXmppStateMachine
         SMACK_REACTOR.setInterestOps(selectionKey, interestOps);
     }
 
-    @Override
-    protected void finalize() {
-        disconnect();
-    }
 }

smack-core/src/main/java/org/jivesoftware/smack/ConnectionConfiguration.java

@@ -286,7 +286,7 @@ public abstract class ConnectionConfiguration {
     }
 
     /**
-     * Returns the keystore type, or <tt>null</tt> if it's not set.
+     * Returns the keystore type, or <code>null</code> if it's not set.
      *
      * @return the keystore type.
      */
@@ -902,7 +902,7 @@ public abstract class ConnectionConfiguration {
          * Sets if an initial available presence will be sent to the server. By default
          * an available presence will be sent to the server indicating that this presence
          * is not online and available to receive messages. If you want to log in without
-         * being 'noticed' then pass a <tt>false</tt> value.
+         * being 'noticed' then pass a <code>false</code> value.
          *
          * @param sendPresence true if an initial available presence will be sent while logging in.
          * @return a reference to this builder.

smack-core/src/main/java/org/jivesoftware/smack/SmackConfiguration.java

@@ -84,7 +84,7 @@ public final class SmackConfiguration {
      * <li> Interpreted Packets -- shows XML packets from the server as parsed by Smack.
      * </ul>
      * Debugging can be enabled by setting this field to true, or by setting the Java system
-     * property <tt>smack.debugEnabled</tt> to true. The system property can be set on the
+     * property <code>smack.debugEnabled</code> to true. The system property can be set on the
      * command line such as "java SomeApp -Dsmack.debugEnabled=true".
      */
     public static boolean DEBUG = false;

smack-core/src/main/java/org/jivesoftware/smack/StanzaCollector.java

@@ -63,7 +63,7 @@ public final class StanzaCollector implements AutoCloseable {
     private Exception connectionException;
 
     /**
-     * Creates a new stanza collector. If the stanza filter is <tt>null</tt>, then
+     * Creates a new stanza collector. If the stanza filter is <code>null</code>, then
      * all packets will match this collector.
      *
      * @param connection the connection the collector is tied to.
@@ -110,11 +110,11 @@ public final class StanzaCollector implements AutoCloseable {
 
     /**
      * Polls to see if a stanza is currently available and returns it, or
-     * immediately returns <tt>null</tt> if no packets are currently in the
+     * immediately returns <code>null</code> if no packets are currently in the
      * result queue.
      *
      * @param <P> type of the result stanza.
-     * @return the next stanza result, or <tt>null</tt> if there are no more
+     * @return the next stanza result, or <code>null</code> if there are no more
      *      results.
      */
     @SuppressWarnings("unchecked")
@@ -124,7 +124,7 @@ public final class StanzaCollector implements AutoCloseable {
 
     /**
      * Polls to see if a stanza is currently available and returns it, or
-     * immediately returns <tt>null</tt> if no packets are currently in the
+     * immediately returns <code>null</code> if no packets are currently in the
      * result queue.
      * <p>
      * Throws an XMPPErrorException in case the polled stanzas did contain an XMPPError.
@@ -183,8 +183,8 @@ public final class StanzaCollector implements AutoCloseable {
 
     /**
      * Returns the next available stanza. The method call will block (not return) until a stanza is available or the
-     * <tt>timeout</tt> has elapsed or if the connection was terminated because of an error. If the timeout elapses without a
-     * result or if there was an connection error, <tt>null</tt> will be returned.
+     * <code>timeout</code> has elapsed or if the connection was terminated because of an error. If the timeout elapses without a
+     * result or if there was an connection error, <code>null</code> will be returned.
      *
      * @param <P> type of the result stanza.
      * @param timeout the timeout in milliseconds.
@@ -230,7 +230,7 @@ public final class StanzaCollector implements AutoCloseable {
 
     /**
      * Returns the next available stanza. The method call will block until a stanza is
-     * available or the <tt>timeout</tt> has elapsed. This method does also cancel the
+     * available or the <code>timeout</code> has elapsed. This method does also cancel the
      * collector in every case.
      * <p>
      * Three things can happen when waiting for an response:

smack-core/src/main/java/org/jivesoftware/smack/XMPPConnection.java

@@ -123,7 +123,7 @@ public interface XMPPConnection {
 
     /**
      * Returns the full XMPP address of the user that is logged in to the connection or
-     * <tt>null</tt> if not logged in yet. An XMPP address is in the form
+     * <code>null</code> if not logged in yet. An XMPP address is in the form
      * username@server/resource.
      *
      * @return the full XMPP address of the user logged in.
@@ -132,9 +132,9 @@ public interface XMPPConnection {
 
     /**
      * Returns the stream ID for this connection, which is the value set by the server
-     * when opening an XMPP stream. This value will be <tt>null</tt> if not connected to the server.
+     * when opening an XMPP stream. This value will be <code>null</code> if not connected to the server.
      *
-     * @return the ID of this connection returned from the XMPP server or <tt>null</tt> if
+     * @return the ID of this connection returned from the XMPP server or <code>null</code> if
      *      not connected to the server.
      * @see <a href="http://xmpp.org/rfcs/rfc6120.html#streams-attr-id">RFC 6120 § 4.7.3. id</a>
      */
@@ -471,7 +471,7 @@ public interface XMPPConnection {
     /**
      * Get the connection counter of this XMPPConnection instance. Those can be used as ID to
      * identify the connection, but beware that the ID may not be unique if you create more then
-     * <tt>2*Integer.MAX_VALUE</tt> instances as the counter could wrap.
+     * <code>2*Integer.MAX_VALUE</code> instances as the counter could wrap.
      *
      * @return the connection counter of this XMPPConnection
      */

smack-core/src/main/java/org/jivesoftware/smack/debugger/ConsoleDebugger.java

@@ -29,7 +29,7 @@ import org.jivesoftware.smack.util.ExceptionUtil;
  * <p>
  * It is possible to not only print the raw sent and received stanzas but also the interpreted
  * packets by Smack. By default interpreted packets won't be printed. To enable this feature
- * just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
+ * just change the <code>printInterpreted</code> static variable to <code>true</code>.
  * </p>
  *
  * @author Gaston Dombiak

smack-core/src/main/java/org/jivesoftware/smack/debugger/JulDebugger.java

@@ -28,7 +28,7 @@ import org.jivesoftware.smack.XMPPConnection;
  * <p>
  * It is possible to not only print the raw sent and received stanzas but also the interpreted
  * packets by Smack. By default interpreted packets won't be printed. To enable this feature
- * just change the <tt>printInterpreted</tt> static variable to <tt>true</tt>.
+ * just change the <code>printInterpreted</code> static variable to <code>true</code>.
  * </p>
  *
  * @author Gaston Dombiak

smack-core/src/main/java/org/jivesoftware/smack/filter/PacketTypeFilter.java

@@ -25,9 +25,9 @@ import org.jivesoftware.smack.packet.Stanza;
  * Filters for packets of a particular type. The type is given as a Class object, so
  * example types would:
  * <ul>
- *      <li><tt>Message.class</tt>
- *      <li><tt>IQ.class</tt>
- *      <li><tt>Presence.class</tt>
+ *      <li><code>Message.class</code>
+ *      <li><code>IQ.class</code>
+ *      <li><code>Presence.class</code>
  * </ul>
  *
  * @author Matt Tucker
@@ -43,7 +43,7 @@ public class PacketTypeFilter implements StanzaFilter {
 
     /**
      * Creates a new stanza type filter that will filter for packets that are the
-     * same type as <tt>packetType</tt>.
+     * same type as <code>packetType</code>.
      *
      * @param packetType the Class type.
      */

smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java

@@ -57,7 +57,7 @@ public interface StanzaFilter {
      * Tests whether or not the specified stanza should pass the filter.
      *
      * @param stanza the stanza to test.
-     * @return true if and only if <tt>stanza</tt> passes the filter.
+     * @return true if and only if <code>stanza</code> passes the filter.
      */
     boolean accept(Stanza stanza);
 }

smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaTypeFilter.java

@@ -26,9 +26,9 @@ import org.jivesoftware.smack.packet.Stanza;
  * Filters for Stanzas of a particular type. The type is given as a Class object, so
  * example types would:
  * <ul>
- *      <li><tt>Message.class</tt>
- *      <li><tt>IQ.class</tt>
- *      <li><tt>Presence.class</tt>
+ *      <li><code>Message.class</code>
+ *      <li><code>IQ.class</code>
+ *      <li><code>Presence.class</code>
  * </ul>
  *
  * @author Matt Tucker
@@ -43,7 +43,7 @@ public final class StanzaTypeFilter implements StanzaFilter {
 
     /**
      * Creates a new stanza type filter that will filter for packets that are the
-     * same type as <tt>packetType</tt>.
+     * same type as <code>packetType</code>.
      *
      * @param packetType the Class type.
      */

smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractError.java

@@ -93,12 +93,12 @@ public class AbstractError {
 
     /**
      * Returns the first stanza extension that matches the specified element name and
-     * namespace, or <tt>null</tt> if it doesn't exist.
+     * namespace, or <code>null</code> if it doesn't exist.
      *
      * @param elementName the XML element name of the stanza extension.
      * @param namespace the XML element namespace of the stanza extension.
      * @param <PE> type of the ExtensionElement.
-     * @return the extension, or <tt>null</tt> if it doesn't exist.
+     * @return the extension, or <code>null</code> if it doesn't exist.
      */
     public <PE extends ExtensionElement> PE getExtension(String elementName, String namespace) {
         return PacketUtil.extensionElementFrom(extensions, elementName, namespace);

smack-core/src/main/java/org/jivesoftware/smack/packet/Message.java

@@ -438,9 +438,9 @@ public final class Message extends Stanza implements TypedCloneable<Message> {
 
     /**
      * Returns the thread id of the message, which is a unique identifier for a sequence
-     * of "chat" messages. If no thread id is set, <tt>null</tt> will be returned.
+     * of "chat" messages. If no thread id is set, <code>null</code> will be returned.
      *
-     * @return the thread id of the message, or <tt>null</tt> if it doesn't exist.
+     * @return the thread id of the message, or <code>null</code> if it doesn't exist.
      */
     public String getThread() {
         return thread;

smack-core/src/main/java/org/jivesoftware/smack/packet/Packet.java

@@ -63,11 +63,11 @@ public interface Packet extends TopLevelStreamElement {
     void setPacketID(String packetID);
 
     /**
-     * Returns who the stanza is being sent "to", or <tt>null</tt> if
+     * Returns who the stanza is being sent "to", or <code>null</code> if
      * the value is not set. The XMPP protocol often makes the "to"
      * attribute optional, so it does not always need to be set.<p>
      *
-     * @return who the stanza is being sent to, or <tt>null</tt> if the
+     * @return who the stanza is being sent to, or <code>null</code> if the
      *      value has not been set.
      */
     String getTo();
@@ -81,11 +81,11 @@ public interface Packet extends TopLevelStreamElement {
     void setTo(String to);
 
     /**
-     * Returns who the stanza is being sent "from" or <tt>null</tt> if
+     * Returns who the stanza is being sent "from" or <code>null</code> if
      * the value is not set. The XMPP protocol often makes the "from"
      * attribute optional, so it does not always need to be set.<p>
      *
-     * @return who the stanza is being sent from, or <tt>null</tt> if the
+     * @return who the stanza is being sent from, or <code>null</code> if the
      *      value has not been set.
      */
     String getFrom();
@@ -100,10 +100,10 @@ public interface Packet extends TopLevelStreamElement {
     void setFrom(String from);
 
     /**
-     * Returns the error associated with this packet, or <tt>null</tt> if there are
+     * Returns the error associated with this packet, or <code>null</code> if there are
      * no errors.
      *
-     * @return the error sub-packet or <tt>null</tt> if there isn't an error.
+     * @return the error sub-packet or <code>null</code> if there isn't an error.
      */
     StanzaError getError();
     /**
@@ -160,7 +160,7 @@ public interface Packet extends TopLevelStreamElement {
 
     /**
      * Returns the first stanza extension that matches the specified element name and
-     * namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
+     * namespace, or <code>null</code> if it doesn't exist. If the provided elementName is null,
      * only the namespace is matched. Stanza extensions are
      * are arbitrary XML sub-documents in standard XMPP packets. By default, a
      * DefaultPacketExtension instance will be returned for each extension. However,
@@ -172,7 +172,7 @@ public interface Packet extends TopLevelStreamElement {
      * @param elementName the XML element name of the stanza extension. (May be null)
      * @param namespace the XML element namespace of the stanza extension.
      * @param <PE> type of the ExtensionElement.
-     * @return the extension, or <tt>null</tt> if it doesn't exist.
+     * @return the extension, or <code>null</code> if it doesn't exist.
      */
     <PE extends ExtensionElement> PE getExtension(String elementName, String namespace);
     /**

smack-core/src/main/java/org/jivesoftware/smack/packet/Presence.java

@@ -138,7 +138,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
      * Returns true if the {@link Type presence type} is available (online) and
      * false if the user is unavailable (offline), or if this is a presence packet
      * involved in a subscription operation. This is a convenience method
-     * equivalent to <tt>getType() == Presence.Type.available</tt>. Note that even
+     * equivalent to <code>getType() == Presence.Type.available</code>. Note that even
      * when the user is available, their presence mode may be {@link Mode#away away},
      * {@link Mode#xa extended away} or {@link Mode#dnd do not disturb}. Use
      * {@link #isAway()} to determine if the user is away.
@@ -155,7 +155,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
      * {@link Mode#dnd do not disturb}. False will be returned when the type or mode
      * is any other value, including when the presence type is unavailable (offline).
      * This is a convenience method equivalent to
-     * <tt>type == Type.available &amp;&amp; (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd)</tt>.
+     * <code>type == Type.available &amp;&amp; (mode == Mode.away || mode == Mode.xa || mode == Mode.dnd)</code>.
      *
      * @return true if the presence type is available and the presence mode is away, xa, or dnd.
      */
@@ -182,7 +182,7 @@ public final class Presence extends Stanza implements TypedCloneable<Presence> {
     }
 
     /**
-     * Returns the status message of the presence update, or <tt>null</tt> if there
+     * Returns the status message of the presence update, or <code>null</code> if there
      * is not a status. The status is free-form text describing a user's presence
      * (i.e., "gone to lunch").
      *

smack-core/src/main/java/org/jivesoftware/smack/packet/Stanza.java

@@ -164,11 +164,11 @@ public abstract class Stanza implements TopLevelStreamElement {
     }
 
     /**
-     * Returns who the stanza is being sent "to", or <tt>null</tt> if
+     * Returns who the stanza is being sent "to", or <code>null</code> if
      * the value is not set. The XMPP protocol often makes the "to"
      * attribute optional, so it does not always need to be set.<p>
      *
-     * @return who the stanza is being sent to, or <tt>null</tt> if the
+     * @return who the stanza is being sent to, or <code>null</code> if the
      *      value has not been set.
      */
     public Jid getTo() {
@@ -206,11 +206,11 @@ public abstract class Stanza implements TopLevelStreamElement {
     }
 
     /**
-     * Returns who the stanza is being sent "from" or <tt>null</tt> if
+     * Returns who the stanza is being sent "from" or <code>null</code> if
      * the value is not set. The XMPP protocol often makes the "from"
      * attribute optional, so it does not always need to be set.<p>
      *
-     * @return who the stanza is being sent from, or <tt>null</tt> if the
+     * @return who the stanza is being sent from, or <code>null</code> if the
      *      value has not been set.
      */
     public Jid getFrom() {
@@ -250,10 +250,10 @@ public abstract class Stanza implements TopLevelStreamElement {
     }
 
     /**
-     * Returns the error associated with this packet, or <tt>null</tt> if there are
+     * Returns the error associated with this packet, or <code>null</code> if there are
      * no errors.
      *
-     * @return the error sub-packet or <tt>null</tt> if there isn't an error.
+     * @return the error sub-packet or <code>null</code> if there isn't an error.
      */
     public StanzaError getError() {
         return error;
@@ -346,14 +346,14 @@ public abstract class Stanza implements TopLevelStreamElement {
 
     /**
      * Returns the first extension that matches the specified element name and
-     * namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
+     * namespace, or <code>null</code> if it doesn't exist. If the provided elementName is null,
      * only the namespace is matched. Extensions are
      * are arbitrary XML elements in standard XMPP stanzas.
      *
      * @param elementName the XML element name of the extension. (May be null)
      * @param namespace the XML element namespace of the extension.
      * @param <PE> type of the ExtensionElement.
-     * @return the extension, or <tt>null</tt> if it doesn't exist.
+     * @return the extension, or <code>null</code> if it doesn't exist.
      */
     @SuppressWarnings("unchecked")
     public <PE extends ExtensionElement> PE getExtension(String elementName, String namespace) {

smack-core/src/main/java/org/jivesoftware/smack/provider/EmbeddedExtensionProvider.java

@@ -60,8 +60,8 @@ import org.jivesoftware.smack.xml.XmlPullParserException;
  * </message>
  *
  * I would have a classes
- * <tt>ItemsProvider</tt> extends {@link EmbeddedExtensionProvider}
- * <tt>ItemProvider</tt> extends {@link EmbeddedExtensionProvider}
+ * <code>ItemsProvider</code> extends {@link EmbeddedExtensionProvider}
+ * <code>ItemProvider</code> extends {@link EmbeddedExtensionProvider}
  * and
  * AtomProvider extends {@link ExtensionElementProvider}
  *

smack-core/src/main/java/org/jivesoftware/smack/sasl/SASLMechanism.java

@@ -94,7 +94,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
     protected SSLSession sslSession;
 
     /**
-     * Builds and sends the <tt>auth</tt> stanza to the server. Note that this method of
+     * Builds and sends the <code>auth</code> stanza to the server. Note that this method of
      * authentication is not recommended, since it is very inflexible. Use
      * {@link #authenticate(String, DomainBareJid, CallbackHandler, EntityBareJid, SSLSession)} whenever possible.
      *
@@ -161,7 +161,7 @@ public abstract class SASLMechanism implements Comparable<SASLMechanism> {
     }
 
     /**
-     * Builds and sends the <tt>auth</tt> stanza to the server. The callback handler will handle
+     * Builds and sends the <code>auth</code> stanza to the server. The callback handler will handle
      * any additional information, such as the authentication ID or realm, if it is needed.
      *
      * @param host     the hostname where the user account resides.

smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/ChatMarkersListener.java

@@ -32,7 +32,7 @@ public interface ChatMarkersListener {
      *
      * @param chatMarkersState the current state of the message.
      * @param message          the new incoming message with a markable XML tag.
-     * @param chat             associated to the message. This element can be <tt>NULL</tt>.
+     * @param chat             associated to the message. This element can be <code>NULL</code>.
      */
     void newChatMarkerMessage(ChatMarkersState chatMarkersState, Message message, Chat chat);
 }

smack-experimental/src/main/java/org/jivesoftware/smackx/chat_markers/filter/EligibleForChatMarkerFilter.java

@@ -42,7 +42,7 @@ public final class EligibleForChatMarkerFilter extends StanzaExtensionFilter {
      * From XEP-0333, Protocol Format: The Chat Marker MUST have an 'id' which is the 'id' of the
      * message being marked.<br>
      * In order to make Chat Markers works together with XEP-0085 as it said in
-     * 8.5 Interaction with Chat States, only messages with <tt>active</tt> chat
+     * 8.5 Interaction with Chat States, only messages with <code>active</code> chat
      * state are accepted.
      *
      * @param message to be analyzed.

smack-extensions/src/main/java/org/jivesoftware/smackx/address/MultipleRecipientInfo.java

@@ -58,12 +58,12 @@ public class MultipleRecipientInfo {
     }
 
     /**
-     * Returns the JID of a MUC room to which responses should be sent or <tt>null</tt>  if
+     * Returns the JID of a MUC room to which responses should be sent or <code>null</code>  if
      * no specific address was provided. When no specific address was provided then the reply
      * can be sent to any or all recipients. Otherwise, the user should join the specified room
      * and send the reply to the room.
      *
-     * @return the JID of a MUC room to which responses should be sent or <tt>null</tt>  if
+     * @return the JID of a MUC room to which responses should be sent or <code>null</code>  if
      *         no specific address was provided.
      */
     // TODO should return EntityBareJid
@@ -84,11 +84,11 @@ public class MultipleRecipientInfo {
     }
 
     /**
-     * Returns the address to which all replies are requested to be sent or <tt>null</tt> if
+     * Returns the address to which all replies are requested to be sent or <code>null</code> if
      * no specific address was provided. When no specific address was provided then the reply
      * can be sent to any or all recipients.
      *
-     * @return the address to which all replies are requested to be sent or <tt>null</tt> if
+     * @return the address to which all replies are requested to be sent or <code>null</code> if
      *         no specific address was provided.
      */
     public MultipleAddresses.Address getReplyAddress() {

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

@@ -56,11 +56,11 @@ public class MultipleRecipientManager {
      *
      * @param connection the connection to use to send the packet.
      * @param packet     the stanza to send to the list of recipients.
-     * @param to         the collection of JIDs to include in the TO list or <tt>null</tt> if no TO
+     * @param to         the collection of JIDs to include in the TO list or <code>null</code> if no TO
      *                   list exists.
-     * @param cc         the collection of JIDs to include in the CC list or <tt>null</tt> if no CC
+     * @param cc         the collection of JIDs to include in the CC list or <code>null</code> if no CC
      *                   list exists.
-     * @param bcc        the collection of JIDs to include in the BCC list or <tt>null</tt> if no BCC
+     * @param bcc        the collection of JIDs to include in the BCC list or <code>null</code> if no BCC
      *                   list exists.
      * @throws FeatureNotSupportedException if special XEP-33 features where requested, but the
      *         server does not support them.
@@ -84,13 +84,13 @@ public class MultipleRecipientManager {
      *
      * @param connection the connection to use to send the packet.
      * @param packet the stanza to send to the list of recipients.
-     * @param to the collection of JIDs to include in the TO list or <tt>null</tt> if no TO list exists.
-     * @param cc the collection of JIDs to include in the CC list or <tt>null</tt> if no CC list exists.
-     * @param bcc the collection of JIDs to include in the BCC list or <tt>null</tt> if no BCC list
+     * @param to the collection of JIDs to include in the TO list or <code>null</code> if no TO list exists.
+     * @param cc the collection of JIDs to include in the CC list or <code>null</code> if no CC list exists.
+     * @param bcc the collection of JIDs to include in the BCC list or <code>null</code> if no BCC list
      *        exists.
-     * @param replyTo address to which all replies are requested to be sent or <tt>null</tt>
+     * @param replyTo address to which all replies are requested to be sent or <code>null</code>
      *        indicating that they can reply to any address.
-     * @param replyRoom JID of a MUC room to which responses should be sent or <tt>null</tt>
+     * @param replyRoom JID of a MUC room to which responses should be sent or <code>null</code>
      *        indicating that they can reply to any address.
      * @param noReply true means that receivers should not reply to the message.
      * @throws XMPPErrorException if server does not support XEP-33: Extended Stanza Addressing and
@@ -195,11 +195,11 @@ public class MultipleRecipientManager {
 
     /**
      * Returns the {@link MultipleRecipientInfo} contained in the specified stanza or
-     * <tt>null</tt> if none was found. Only packets sent to multiple recipients will
+     * <code>null</code> if none was found. Only packets sent to multiple recipients will
      * contain such information.
      *
      * @param packet the stanza to check.
-     * @return the MultipleRecipientInfo contained in the specified stanza or <tt>null</tt>
+     * @return the MultipleRecipientInfo contained in the specified stanza or <code>null</code>
      *         if none was found.
      */
     public static MultipleRecipientInfo getMultipleRecipientInfo(Stanza packet) {
@@ -278,7 +278,7 @@ public class MultipleRecipientManager {
      *
      * @param connection the connection to use for disco. The connected server is going to be
      *                   queried.
-     * @return the address of the multiple recipients service or <tt>null</tt> if none was found.
+     * @return the address of the multiple recipients service or <code>null</code> if none was found.
      * @throws NoResponseException if there was no response from the server.
      * @throws XMPPErrorException
      * @throws NotConnectedException

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

@@ -37,7 +37,7 @@ import org.jxmpp.jid.Jid;
  * list and the result is stored as a form in the command instance, i.e. the
  * <code>getForm</code> method retrieves a form with all the users.
  * <p>
- * Each command has a <tt>node</tt> that should be unique within a given JID.
+ * Each command has a <code>node</code> that should be unique within a given JID.
  * </p>
  * <p>
  * Commands may have zero or more stages. Each stage is usually used for
@@ -87,7 +87,7 @@ public abstract class AdHocCommand {
     }
 
     /**
-     * Returns the specific condition of the <code>error</code> or <tt>null</tt> if the
+     * Returns the specific condition of the <code>error</code> or <code>null</code> if the
      * error doesn't have any.
      *
      * @param error the error the get the specific condition from.

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

@@ -184,9 +184,9 @@ public final class AdHocCommandManager extends Manager {
 
     /**
      * Registers a new command with this command manager, which is related to a
-     * connection. The <tt>node</tt> is an unique identifier of that command for
-     * the connection related to this command manager. The <tt>name</tt> is the
-     * human readable name of the command. The <tt>class</tt> is the class of
+     * connection. The <code>node</code> is an unique identifier of that command for
+     * the connection related to this command manager. The <code>name</code> is the
+     * human readable name of the command. The <code>class</code> is the class of
      * the command, which must extend {@link LocalCommand} and have a default
      * constructor.
      *
@@ -205,9 +205,9 @@ public final class AdHocCommandManager extends Manager {
 
     /**
      * Registers a new command with this command manager, which is related to a
-     * connection. The <tt>node</tt> is an unique identifier of that
-     * command for the connection related to this command manager. The <tt>name</tt>
-     * is the human readable name of the command. The <tt>factory</tt> generates
+     * connection. The <code>node</code> is an unique identifier of that
+     * command for the connection related to this command manager. The <code>name</code>
+     * is the human readable name of the command. The <code>factory</code> generates
      * new instances of the command.
      *
      * @param node the unique identifier of the command.

smack-extensions/src/main/java/org/jivesoftware/smackx/commands/LocalCommand.java

@@ -114,7 +114,7 @@ public abstract class LocalCommand extends AdHocCommand {
     /**
      * Returns true if the current stage is the last one. If it is then the
      * execution of some action will complete the execution of the command.
-     * Commands that don't have multiple stages can always return <tt>true</tt>.
+     * Commands that don't have multiple stages can always return <code>true</code>.
      *
      * @return true if the command is in the last stage.
      */

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

@@ -121,7 +121,7 @@ public class RemoteCommand extends AdHocCommand {
     /**
      * Executes the <code>action</code> with the <code>form</code>.
      * The action could be any of the available actions. The form must
-     * be the answer of the previous stage. It can be <tt>null</tt> if it is the first stage.
+     * be the answer of the previous stage. It can be <code>null</code> if it is the first stage.
      *
      * @param action the action to execute.
      * @param form the form with the information.

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

@@ -62,7 +62,7 @@ public class DelayInformation implements ExtensionElement {
 
     /**
      * Returns the JID of the entity that originally sent the stanza or that delayed the
-     * delivery of the stanza or <tt>null</tt> if this information is not available.
+     * delivery of the stanza or <code>null</code> if this information is not available.
      *
      * @return the JID of the entity that originally sent the stanza or that delayed the
      *         delivery of the packet.
@@ -82,10 +82,10 @@ public class DelayInformation implements ExtensionElement {
     }
 
     /**
-     * Returns a natural-language description of the reason for the delay or <tt>null</tt> if
+     * Returns a natural-language description of the reason for the delay or <code>null</code> if
      * this information is not available.
      *
-     * @return a natural-language description of the reason for the delay or <tt>null</tt>.
+     * @return a natural-language description of the reason for the delay or <code>null</code>.
      */
     public String getReason() {
         return reason;

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

@@ -312,7 +312,7 @@ public final class ServiceDiscoveryManager extends Manager {
 
     /**
      * Returns the NodeInformationProvider responsible for providing information
-     * (ie items) related to a given node or <tt>null</null> if none.<p>
+     * (ie items) related to a given node or <code>null</null> if none.<p>
      *
      * In MUC, a node could be 'http://jabber.org/protocol/muc#rooms' which means that the
      * NodeInformationProvider will provide information about the rooms where the user has joined.

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

@@ -194,11 +194,11 @@ public final class AccountManager extends Manager {
     }
 
     /**
-     * Returns the value of a given account attribute or <tt>null</tt> if the account
+     * Returns the value of a given account attribute or <code>null</code> if the account
      * attribute wasn't found.
      *
      * @param name the name of the account attribute to return its value.
-     * @return the value of the account attribute or <tt>null</tt> if an account
+     * @return the value of the account attribute or <code>null</code> if an account
      * attribute wasn't found for the requested name.
      * @throws XMPPErrorException
      * @throws NoResponseException
@@ -213,11 +213,11 @@ public final class AccountManager extends Manager {
     }
 
     /**
-     * Returns the instructions for creating a new account, or <tt>null</tt> if there
+     * Returns the instructions for creating a new account, or <code>null</code> if there
      * are no instructions. If present, instructions should be displayed to the end-user
      * that will complete the registration process.
      *
-     * @return the account creation instructions, or <tt>null</tt> if there are none.
+     * @return the account creation instructions, or <code>null</code> if there are none.
      * @throws XMPPErrorException
      * @throws NoResponseException
      * @throws NotConnectedException

smack-extensions/src/main/java/org/jivesoftware/smackx/iqregister/packet/Registration.java

@@ -68,11 +68,11 @@ public class Registration extends IQ {
     }
 
     /**
-     * Returns the registration instructions, or <tt>null</tt> if no instructions
+     * Returns the registration instructions, or <code>null</code> if no instructions
      * have been set. If present, instructions should be displayed to the end-user
      * that will complete the registration process.
      *
-     * @return the registration instructions, or <tt>null</tt> if there are none.
+     * @return the registration instructions, or <code>null</code> if there are none.
      */
     public String getInstructions() {
         return instructions;

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

@@ -70,7 +70,7 @@ public class JivePropertiesManager {
      *
      * @param packet
      * @param name
-     * @return the property or <tt>null</tt> if none found.
+     * @return the property or <code>null</code> if none found.
      */
     public static Object getProperty(Stanza packet, String name) {
         Object res = null;

smack-extensions/src/main/java/org/jivesoftware/smackx/jiveproperties/packet/JivePropertiesExtension.java

@@ -60,13 +60,13 @@ public class JivePropertiesExtension implements ExtensionElement {
     }
 
     /**
-     * Returns the stanza property with the specified name or <tt>null</tt> if the
+     * Returns the stanza property with the specified name or <code>null</code> if the
      * property doesn't exist. Property values that were originally primitives will
      * be returned as their object equivalent. For example, an int property will be
      * returned as an Integer, a double as a Double, etc.
      *
      * @param name the name of the property.
-     * @return the property, or <tt>null</tt> if the property doesn't exist.
+     * @return the property, or <code>null</code> if the property doesn't exist.
      */
     public synchronized Object getProperty(String name) {
         if (properties == null) {

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

@@ -781,12 +781,12 @@ public class MultiUserChat {
     }
 
     /**
-     * Returns the room's configuration form that the room's owner can use or <tt>null</tt> if
+     * Returns the room's configuration form that the room's owner can use or <code>null</code> if
      * no configuration is possible. The configuration form allows to set the room's language,
      * enable logging, specify room's type, etc..
      *
      * @return the Form that contains the fields to complete together with the instrucions or
-     * <tt>null</tt> if no configuration is possible.
+     * <code>null</code> if no configuration is possible.
      * @throws XMPPErrorException if an error occurs asking the configuration form for the room.
      * @throws NoResponseException if there was no response from the server.
      * @throws NotConnectedException
@@ -822,7 +822,7 @@ public class MultiUserChat {
 
     /**
      * Returns the room's registration form that an unaffiliated user, can use to become a member
-     * of the room or <tt>null</tt> if no registration is possible. Some rooms may restrict the
+     * of the room or <code>null</code> if no registration is possible. Some rooms may restrict the
      * privilege to register members and allow only room admins to add new members.<p>
      *
      * If the user requesting registration requirements is not allowed to register with the room
@@ -830,7 +830,7 @@ public class MultiUserChat {
      * error to the user (error code 405).
      *
      * @return the registration Form that contains the fields to complete together with the
-     * instrucions or <tt>null</tt> if no registration is possible.
+     * instrucions or <code>null</code> if no registration is possible.
      * @throws XMPPErrorException if an error occurs asking the registration form for the room or a
      * 405 error if the user is not allowed to register with the room.
      * @throws NoResponseException if there was no response from the server.
@@ -1043,7 +1043,7 @@ public class MultiUserChat {
     }
 
     /**
-     * Returns the last known room's subject or <tt>null</tt> if the user hasn't joined the room
+     * Returns the last known room's subject or <code>null</code> if the user hasn't joined the room
      * or the room does not have a subject yet. In case the room has a subject, as soon as the
      * user joins the room a message with the current room's subject will be received.<p>
      *
@@ -1052,7 +1052,7 @@ public class MultiUserChat {
      *
      * To change the room's subject use {@link #changeSubject(String)}.
      *
-     * @return the room's subject or <tt>null</tt> if the user hasn't joined the room or the
+     * @return the room's subject or <code>null</code> if the user hasn't joined the room or the
      * room does not have a subject yet.
      */
     public String getSubject() {
@@ -1065,7 +1065,7 @@ public class MultiUserChat {
      * cases it may be desirable for the user to discover the reserved nickname before attempting
      * to enter the room.
      *
-     * @return the reserved room nickname or <tt>null</tt> if none.
+     * @return the reserved room nickname or <code>null</code> if none.
      * @throws SmackException if there was no response from the server.
      * @throws InterruptedException
      */
@@ -1088,7 +1088,7 @@ public class MultiUserChat {
     }
 
     /**
-     * Returns the nickname that was used to join the room, or <tt>null</tt> if not
+     * Returns the nickname that was used to join the room, or <code>null</code> if not
      * currently joined.
      *
      * @return the nickname currently being used.
@@ -1690,12 +1690,12 @@ public class MultiUserChat {
     }
 
     /**
-     * Returns the presence info for a particular user, or <tt>null</tt> if the user
+     * Returns the presence info for a particular user, or <code>null</code> if the user
      * is not in the room.<p>
      *
      * @param user the room occupant to search for his presence. The format of user must
      * be: roomName@service/nickname (e.g. darkcave@macbeth.shakespeare.lit/thirdwitch).
-     * @return the occupant's current presence, or <tt>null</tt> if the user is unavailable
+     * @return the occupant's current presence, or <code>null</code> if the user is unavailable
      *      or if no presence information is available.
      */
     public Presence getOccupantPresence(EntityFullJid user) {
@@ -1703,13 +1703,13 @@ public class MultiUserChat {
     }
 
     /**
-     * Returns the Occupant information for a particular occupant, or <tt>null</tt> if the
+     * Returns the Occupant information for a particular occupant, or <code>null</code> if the
      * user is not in the room. The Occupant object may include information such as full
      * JID of the user as well as the role and affiliation of the user in the room.<p>
      *
      * @param user the room occupant to search for his presence. The format of user must
      * be: roomName@service/nickname (e.g. darkcave@macbeth.shakespeare.lit/thirdwitch).
-     * @return the Occupant or <tt>null</tt> if the user is unavailable (i.e. not in the room).
+     * @return the Occupant or <code>null</code> if the user is unavailable (i.e. not in the room).
      */
     public Occupant getOccupant(EntityFullJid user) {
         Presence presence = getOccupantPresence(user);
@@ -1933,7 +1933,7 @@ public class MultiUserChat {
     }
 
     /**
-    * Polls for and returns the next message, or <tt>null</tt> if there isn't
+    * Polls for and returns the next message, or <code>null</code> if there isn't
     * a message immediately available. This method provides significantly different
     * functionalty than the {@link #nextMessage()} method since it's non-blocking.
     * In other words, the method call will always return immediately, whereas the
@@ -1941,7 +1941,7 @@ public class MultiUserChat {
     * a specific timeout).
     *
     * @return the next message if one is immediately available and
-    *      <tt>null</tt> otherwise.
+    *      <code>null</code> otherwise.
      * @throws MucNotJoinedException
     */
     public Message pollMessage() throws MucNotJoinedException {
@@ -1968,11 +1968,11 @@ public class MultiUserChat {
 
     /**
      * Returns the next available message in the chat. The method call will block
-     * (not return) until a stanza is available or the <tt>timeout</tt> has elapased.
-     * If the timeout elapses without a result, <tt>null</tt> will be returned.
+     * (not return) until a stanza is available or the <code>timeout</code> has elapased.
+     * If the timeout elapses without a result, <code>null</code> will be returned.
      *
      * @param timeout the maximum amount of time to wait for the next message.
-     * @return the next message, or <tt>null</tt> if the timeout elapses without a
+     * @return the next message, or <code>null</code> if the timeout elapses without a
      *      message becoming available.
      * @throws MucNotJoinedException
      * @throws InterruptedException

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

@@ -41,7 +41,7 @@ import org.jivesoftware.smack.xml.XmlPullParserException;
  * </pre>
  *
  * To listen for group chat invitations, use a StanzaExtensionFilter for the
- * <tt>x</tt> element name and <tt>jabber:x:conference</tt> namespace, as in the
+ * <code>x</code> element name and <code>jabber:x:conference</code> namespace, as in the
  * following code example:
  *
  * <pre>
@@ -72,9 +72,9 @@ public class GroupChatInvitation implements ExtensionElement {
 
     /**
      * Creates a new group chat invitation to the specified room address.
-     * GroupChat room addresses are in the form <tt>room@service</tt>,
-     * where <tt>service</tt> is the name of group chat server, such as
-     * <tt>chat.example.com</tt>.
+     * GroupChat room addresses are in the form <code>room@service</code>,
+     * where <code>service</code> is the name of group chat server, such as
+     * <code>chat.example.com</code>.
      *
      * @param roomAddress the address of the group chat room.
      */
@@ -84,8 +84,8 @@ public class GroupChatInvitation implements ExtensionElement {
 
     /**
      * Returns the address of the group chat room. GroupChat room addresses
-     * are in the form <tt>room@service</tt>, where <tt>service</tt> is
-     * the name of group chat server, such as <tt>chat.example.com</tt>.
+     * are in the form <code>room@service</code>, where <code>service</code> is
+     * the name of group chat server, such as <code>chat.example.com</code>.
      *
      * @return the address of the group chat room.
      */

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

@@ -110,11 +110,11 @@ public class OfflineMessageManager {
     }
 
     /**
-     * Returns a List of <tt>OfflineMessageHeader</tt> that keep information about the
+     * Returns a List of <code>OfflineMessageHeader</code> that keep information about the
      * offline message. The OfflineMessageHeader includes a stamp that could be used to retrieve
      * the complete message or delete the specific message.
      *
-     * @return a List of <tt>OfflineMessageHeader</tt> that keep information about the offline
+     * @return a List of <code>OfflineMessageHeader</code> that keep information about the offline
      *         message.
      * @throws XMPPErrorException If the user is not allowed to make this request or the server does
      *                       not support offline message retrieval.
@@ -133,13 +133,13 @@ public class OfflineMessageManager {
     }
 
     /**
-     * Returns a List of the offline <tt>Messages</tt> whose stamp matches the specified
+     * Returns a List of the offline <code>Messages</code> whose stamp matches the specified
      * request. The request will include the list of stamps that uniquely identifies
      * the offline messages to retrieve. The returned offline messages will not be deleted
      * from the server. Use {@link #deleteMessages(java.util.List)} to delete the messages.
      *
      * @param nodes the list of stamps that uniquely identifies offline message.
-     * @return a List with the offline <tt>Messages</tt> that were received as part of
+     * @return a List with the offline <code>Messages</code> that were received as part of
      *         this request.
      * @throws XMPPErrorException If the user is not allowed to make this request or the server does
      *                       not support offline message retrieval.
@@ -184,11 +184,11 @@ public class OfflineMessageManager {
     }
 
     /**
-     * Returns a List of Messages with all the offline <tt>Messages</tt> of the user. The returned offline
+     * Returns a List of Messages with all the offline <code>Messages</code> of the user. The returned offline
      * messages will not be deleted from the server. Use {@link #deleteMessages(java.util.List)}
      * to delete the messages.
      *
-     * @return a List with all the offline <tt>Messages</tt> of the user.
+     * @return a List with all the offline <code>Messages</code> of the user.
      * @throws XMPPErrorException If the user is not allowed to make this request or the server does
      *                       not support offline message retrieval.
      * @throws NoResponseException if there was no response from the server.

smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/packet/Privacy.java

@@ -107,9 +107,9 @@ public class Privacy extends IQ {
     }
 
     /**
-     * Returns the active privacy list or <tt>null</tt> if none was found.
+     * Returns the active privacy list or <code>null</code> if none was found.
      *
-     * @return list with {@link PrivacyItem} or <tt>null</tt> if none was found.
+     * @return list with {@link PrivacyItem} or <code>null</code> if none was found.
      */
     public List<PrivacyItem> getActivePrivacyList() {
         // Check if we have the default list
@@ -123,9 +123,9 @@ public class Privacy extends IQ {
     }
 
     /**
-     * Returns the default privacy list or <tt>null</tt> if none was found.
+     * Returns the default privacy list or <code>null</code> if none was found.
      *
-     * @return list with {@link PrivacyItem} or <tt>null</tt> if none was found.
+     * @return list with {@link PrivacyItem} or <code>null</code> if none was found.
      */
     public List<PrivacyItem> getDefaultPrivacyList() {
         // Check if we have the default list

smack-extensions/src/main/java/org/jivesoftware/smackx/privacy/provider/PrivacyProvider.java

@@ -31,8 +31,8 @@ import org.jivesoftware.smackx.privacy.packet.PrivacyItem;
 
 /**
  * The PrivacyProvider parses {@link Privacy} packets. {@link Privacy}
- * Parses the <tt>query</tt> sub-document and creates an instance of {@link Privacy}.
- * For each <tt>item</tt> in the <tt>list</tt> element, it creates an instance
+ * Parses the <code>query</code> sub-document and creates an instance of {@link Privacy}.
+ * For each <code>item</code> in the <code>list</code> element, it creates an instance
  * of {@link PrivacyItem}.
  *
  * @author Francisco Vives

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

@@ -23,7 +23,7 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider;
 
 /**
  * This class represents an item that has been, or will be published to a
- * PubSub node.  An <tt>Item</tt> has several properties that are dependent
+ * PubSub node.  An <code>Item</code> has several properties that are dependent
  * on the configuration of the node to which it has been or will be published.
  *
  * <h3>An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}</h3>
@@ -74,10 +74,10 @@ public class Item extends NodeExtension {
     private final String itemId;
 
     /**
-     * Create an empty <tt>Item</tt> with no id.  This is a valid item for nodes which are configured
+     * Create an empty <code>Item</code> with no id.  This is a valid item for nodes which are configured
      * so that {@link ConfigureForm#isDeliverPayloads()} is false.  In most cases an id will be generated by the server.
      * For nodes configured with {@link ConfigureForm#isDeliverPayloads()} and {@link ConfigureForm#isPersistItems()}
-     * set to false, no <tt>Item</tt> is sent to the node, you have to use the {@link LeafNode#publish()}
+     * set to false, no <code>Item</code> is sent to the node, you have to use the {@link LeafNode#publish()}
      * method in this case.
      */
     public Item() {
@@ -85,7 +85,7 @@ public class Item extends NodeExtension {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id but no payload.  This is a valid item for nodes which are configured
+     * Create an <code>Item</code> with an id but no payload.  This is a valid item for nodes which are configured
      * so that {@link ConfigureForm#isDeliverPayloads()} is false.
      *
      * @param itemId The id if the item.  It must be unique within the node unless overwriting and existing item.
@@ -96,7 +96,7 @@ public class Item extends NodeExtension {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id but no payload.  This is a valid item for nodes which are configured
+     * Create an <code>Item</code> with an id but no payload.  This is a valid item for nodes which are configured
      * so that {@link ConfigureForm#isDeliverPayloads()} is false.
      *
      * @param itemId The id if the item.  It must be unique within the node unless overwriting and existing item.
@@ -107,7 +107,7 @@ public class Item extends NodeExtension {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id and a node id.
+     * Create an <code>Item</code> with an id and a node id.
      * <p>
      * <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
      * one as part of {@link Message}.  If used to create an Item to publish
@@ -122,7 +122,7 @@ public class Item extends NodeExtension {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id and a node id.
+     * Create an <code>Item</code> with an id and a node id.
      * <p>
      * <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
      * one as part of {@link Message}.  If used to create an Item to publish

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemDeleteEvent.java

@@ -28,7 +28,7 @@ public class ItemDeleteEvent extends SubscriptionEvent {
     private List<String> itemIds = Collections.emptyList();
 
     /**
-     * Constructs an <tt>ItemDeleteEvent</tt> that indicates the the supplied
+     * Constructs an <code>ItemDeleteEvent</code> that indicates the the supplied
      * items (by id) have been deleted, and that the event matches the listed
      * subscriptions.  The subscriptions would have been created by calling
      * {@link LeafNode#subscribe(String)}.

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemPublishEvent.java

@@ -30,7 +30,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
     private Date originalDate;
 
     /**
-     * Constructs an <tt>ItemPublishEvent</tt> with the provided list
+     * Constructs an <code>ItemPublishEvent</code> with the provided list
      * of {@link Item} that were published.
      *
      * @param nodeId The id of the node the event came from
@@ -42,7 +42,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
     }
 
     /**
-     * Constructs an <tt>ItemPublishEvent</tt> with the provided list
+     * Constructs an <code>ItemPublishEvent</code> with the provided list
      * of {@link Item} that were published.  The list of subscription ids
      * represents the subscriptions that matched the event, in the case
      * of the user having multiple subscriptions.
@@ -57,7 +57,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent {
     }
 
     /**
-     * Constructs an <tt>ItemPublishEvent</tt> with the provided list
+     * Constructs an <code>ItemPublishEvent</code> with the provided list
      * of {@link Item} that were published in the past.  The published
      * date signifies that this is delayed event.  The list of subscription ids
      * represents the subscriptions that matched the event, in the case

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/NodeExtension.java

@@ -33,7 +33,7 @@ public class NodeExtension implements ExtensionElement {
     private final String node;
 
     /**
-     * Constructs a <tt>NodeExtension</tt> with an element name specified
+     * Constructs a <code>NodeExtension</code> with an element name specified
      * by {@link PubSubElementType} and the specified node id.
      *
      * @param elem Defines the element name and namespace
@@ -45,7 +45,7 @@ public class NodeExtension implements ExtensionElement {
     }
 
     /**
-     * Constructs a <tt>NodeExtension</tt> with an element name specified
+     * Constructs a <code>NodeExtension</code> with an element name specified
      * by {@link PubSubElementType}.
      *
      * @param elem Defines the element name and namespace

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

@@ -24,7 +24,7 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider;
 
 /**
  * This class represents an item that has been, or will be published to a
- * pubsub node.  An <tt>Item</tt> has several properties that are dependent
+ * pubsub node.  An <code>Item</code> has several properties that are dependent
  * on the configuration of the node to which it has been or will be published.
  *
  * <h3>An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}</h3>
@@ -53,7 +53,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     private final E payload;
 
     /**
-     * Create an <tt>Item</tt> with no id and a payload  The id will be set by the server.
+     * Create an <code>Item</code> with no id and a payload  The id will be set by the server.
      *
      * @param payloadExt A {@link ExtensionElement} which represents the payload data.
      */
@@ -66,7 +66,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id and payload.
+     * Create an <code>Item</code> with an id and payload.
      *
      * @param itemId The id of this item.  It can be null if we want the server to set the id.
      * @param payloadExt A {@link ExtensionElement} which represents the payload data.
@@ -80,7 +80,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id, node id and payload.
+     * Create an <code>Item</code> with an id, node id and payload.
      *
      * <p>
      * <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
@@ -98,7 +98,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     }
 
     /**
-     * Create an <tt>Item</tt> with an id, node id and payload.
+     * Create an <code>Item</code> with an id, node id and payload.
      *
      * <p>
      * <b>Note:</b> This is not valid for publishing an item to a node, only receiving from
@@ -120,7 +120,7 @@ public class PayloadItem<E extends ExtensionElement> extends Item {
     }
 
     /**
-     * Get the payload associated with this <tt>Item</tt>.  Customising the payload
+     * Get the payload associated with this <code>Item</code>.  Customising the payload
      * parsing from the server can be accomplished as described in {@link ItemProvider}.
      *
      * @return The payload as a {@link ExtensionElement}.

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/RetractItem.java

@@ -29,7 +29,7 @@ public class RetractItem implements ExtensionElement {
     private final String id;
 
     /**
-     * Construct a <tt>RetractItem</tt> with the specified id.
+     * Construct a <code>RetractItem</code> with the specified id.
      *
      * @param itemId The id if the item deleted
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/SimplePayload.java

@@ -38,7 +38,7 @@ public class SimplePayload implements ExtensionElement {
     private final String payload;
 
     /**
-     * Construct a <tt>SimplePayload</tt> object with the specified element name,
+     * Construct a <code>SimplePayload</code> object with the specified element name,
      * namespace and content.  The content must be well formed XML.
      *
      * @param xmlPayload The payload data
@@ -60,7 +60,7 @@ public class SimplePayload implements ExtensionElement {
     }
 
     /**
-     * Construct a <tt>SimplePayload</tt> object with the specified element name,
+     * Construct a <code>SimplePayload</code> object with the specified element name,
      * namespace and content.  The content must be well formed XML.
      *
      * @param elementName The root element name (of the payload)

smack-extensions/src/main/java/org/jivesoftware/smackx/time/packet/Time.java

@@ -61,7 +61,7 @@ public class Time extends IQ {
     }
 
     /**
-     * Returns the local time or <tt>null</tt> if the time hasn't been set.
+     * Returns the local time or <code>null</code> if the time hasn't been set.
      *
      * @return the local time.
      */

smack-extensions/src/main/java/org/jivesoftware/smackx/xdata/Form.java

@@ -52,7 +52,7 @@ public class Form {
      * extension that matches the elementName and namespace "x","jabber:x:data".
      *
      * @param packet the stanza used for gathering data.
-     * @return the data form parsed from the stanza or <tt>null</tt> if there was not
+     * @return the data form parsed from the stanza or <code>null</code> if there was not
      *      a form in the packet.
      */
     public static Form getFormFrom(Stanza packet) {

smack-im/src/main/java/org/jivesoftware/smack/chat/Chat.java

@@ -65,7 +65,7 @@ public class Chat {
 
     /**
      * Returns the thread id associated with this chat, which corresponds to the
-     * <tt>thread</tt> field of XMPP messages. This method may return <tt>null</tt>
+     * <code>thread</code> field of XMPP messages. This method may return <code>null</code>
      * if there is no thread ID is associated with this Chat.
      *
      * @return the thread ID of this chat.

smack-im/src/main/java/org/jivesoftware/smack/roster/Roster.java

@@ -637,7 +637,7 @@ public final class Roster extends Manager {
      *
      * @param user   the user. (e.g. johndoe@jabber.org)
      * @param name   the nickname of the user.
-     * @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
+     * @param groups the list of group names the entry will belong to, or <code>null</code> if the
      *               the roster entry won't belong to a group.
      * @throws NoResponseException if there was no response from the server.
      * @throws XMPPErrorException if an XMPP exception occurs.
@@ -662,7 +662,7 @@ public final class Roster extends Manager {
      *
      * @param jid the XMPP address of the contact (e.g. johndoe@jabber.org)
      * @param name the nickname of the user.
-     * @param groups the list of group names the entry will belong to, or <tt>null</tt> if the the roster entry won't
+     * @param groups the list of group names the entry will belong to, or <code>null</code> if the the roster entry won't
      *        belong to a group.
      * @throws NoResponseException if there was no response from the server.
      * @throws XMPPErrorException if an XMPP exception occurs.
@@ -695,7 +695,7 @@ public final class Roster extends Manager {
      *
      * @param jid the XMPP address of the contact (e.g. johndoe@jabber.org)
      * @param name   the nickname of the user.
-     * @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
+     * @param groups the list of group names the entry will belong to, or <code>null</code> if the
      *               the roster entry won't belong to a group.
      * @throws NoResponseException if there was no response from the server.
      * @throws XMPPErrorException if an XMPP exception occurs.
@@ -716,7 +716,7 @@ public final class Roster extends Manager {
      *
      * @param user   the user. (e.g. johndoe@jabber.org)
      * @param name   the nickname of the user.
-     * @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
+     * @param groups the list of group names the entry will belong to, or <code>null</code> if the
      *               the roster entry won't belong to a group.
      * @throws NoResponseException if there was no response from the server.
      * @throws XMPPErrorException if an XMPP exception occurs.
@@ -913,11 +913,11 @@ public final class Roster extends Manager {
 
     /**
      * Returns the roster entry associated with the given XMPP address or
-     * <tt>null</tt> if the user is not an entry in the roster.
+     * <code>null</code> if the user is not an entry in the roster.
      *
      * @param jid the XMPP address of the user (eg "jsmith@example.com"). The address could be
      *             in any valid format (e.g. "domain/resource", "user@domain" or "user@domain/resource").
-     * @return the roster entry or <tt>null</tt> if it does not exist.
+     * @return the roster entry or <code>null</code> if it does not exist.
      */
     public RosterEntry getEntry(BareJid jid) {
         if (jid == null) {
@@ -939,7 +939,7 @@ public final class Roster extends Manager {
     }
 
     /**
-     * Returns the roster group with the specified name, or <tt>null</tt> if the
+     * Returns the roster group with the specified name, or <code>null</code> if the
      * group doesn't exist.
      *
      * @param name the name of the group.

smack-im/src/main/java/org/jivesoftware/smack/roster/RosterGroup.java

@@ -114,10 +114,10 @@ public class RosterGroup extends Manager {
 
     /**
      * Returns the roster entry associated with the given XMPP address or
-     * <tt>null</tt> if the user is not an entry in the group.
+     * <code>null</code> if the user is not an entry in the group.
      *
      * @param user the XMPP address of the user (eg "jsmith@example.com").
-     * @return the roster entry or <tt>null</tt> if it does not exist in the group.
+     * @return the roster entry or <code>null</code> if it does not exist in the group.
      */
     public RosterEntry getEntry(Jid user) {
         if (user == null) {

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentRoster.java

@@ -201,12 +201,12 @@ public class AgentRoster {
     }
 
     /**
-     * Returns the presence info for a particular agent, or <tt>null</tt> if the agent
+     * Returns the presence info for a particular agent, or <code>null</code> if the agent
      * is unavailable (offline) or if no presence information is available.<p>
      *
      * @param user a fully qualified xmpp JID. The address could be in any valid format (e.g.
      *             "domain/resource", "user@domain" or "user@domain/resource").
-     * @return the agent's current presence, or <tt>null</tt> if the agent is unavailable
+     * @return the agent's current presence, or <code>null</code> if the agent is unavailable
      *         or if no presence information is available..
      */
     public Presence getPresence(Jid user) {

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/AgentSession.java

@@ -119,7 +119,7 @@ public class AgentSession {
 
     /**
      * Constructs a new agent session instance. Note, the {@link #setOnline(boolean)}
-     * method must be called with an argument of <tt>true</tt> to mark the agent
+     * method must be called with an argument of <code>true</code> to mark the agent
      * as available to accept chat requests.
      *
      * @param connection   a connection instance which must have already gone through
@@ -307,7 +307,7 @@ public class AgentSession {
      * Allows the retrieval of meta data for a specified key.
      *
      * @param key the meta data key
-     * @return the meta data value associated with the key or <tt>null</tt> if the meta-data
+     * @return the meta data value associated with the key or <code>null</code> if the meta-data
      *         doesn't exist..
      */
     public List<String> getMetaData(String key) {

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/agent/WorkgroupQueue.java

@@ -122,7 +122,7 @@ public class WorkgroupQueue {
 
     /**
      * Returns the date of the oldest request waiting in the queue. If there
-     * are no requests waiting to be routed, this method will return <tt>null</tt>.
+     * are no requests waiting to be routed, this method will return <code>null</code>.
      *
      * @return the date of the oldest request in the queue.
      */

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/packet/OfferRequestProvider.java

@@ -159,7 +159,7 @@ public class OfferRequestProvider extends IQProvider<IQ> {
 
         /**
          * Returns the session ID associated with the request and ensuing chat. If the offer
-         * does not contain a session ID, <tt>null</tt> will be returned.
+         * does not contain a session ID, <code>null</code> will be returned.
          *
          * @return the session id associated with the request.
          */

smack-legacy/src/main/java/org/jivesoftware/smackx/workgroup/user/Workgroup.java

@@ -334,7 +334,7 @@ public class Workgroup {
      *
      * @param answerForm the completed form associated with the join request.
      * @param userID     String that represents the ID of the user when using anonymous sessions
-     *                   or <tt>null</tt> if a userID should not be used.
+     *                   or <code>null</code> if a userID should not be used.
      * @throws XMPPErrorException if an error occurred joining the queue. An error may indicate
      *                       that a connection failure occurred or that the server explicitly rejected the
      *                       request to join the queue.
@@ -383,7 +383,7 @@ public class Workgroup {
      *
      * @param metadata metadata to create a dataform from.
      * @param userID   String that represents the ID of the user when using anonymous sessions
-     *                 or <tt>null</tt> if a userID should not be used.
+     *                 or <code>null</code> if a userID should not be used.
      * @throws XMPPException if an error occurred joining the queue. An error may indicate
      *                       that a connection failure occurred or that the server explicitly rejected the
      *                       request to join the queue.

smack-legacy/src/main/java/org/jivesoftware/smackx/xevent/MessageEventManager.java

@@ -103,7 +103,7 @@ public final class MessageEventManager extends Manager {
 
     /**
      * Adds event notification requests to a message. For each event type that
-     * the user wishes event notifications from the message recipient for, <tt>true</tt>
+     * the user wishes event notifications from the message recipient for, <code>true</code>
      * should be passed in to this method.
      *
      * @param message the message to add the requested notifications.

smack-legacy/src/main/java/org/jivesoftware/smackx/xroster/RemoteRosterEntry.java

@@ -45,7 +45,7 @@ public class RemoteRosterEntry {
      *
      * @param user the user.
      * @param name the user's name.
-     * @param groups the list of group names the entry will belong to, or <tt>null</tt> if the
+     * @param groups the list of group names the entry will belong to, or <code>null</code> if the
      *      the roster entry won't belong to a group.
      */
     public RemoteRosterEntry(Jid user, String name, String[] groups) {

smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/element/OpenPgpContentElement.java

@@ -122,14 +122,14 @@ public abstract class OpenPgpContentElement implements ExtensionElement {
 
     /**
      * Returns the first extension that matches the specified element name and
-     * namespace, or <tt>null</tt> if it doesn't exist. If the provided elementName is null,
+     * namespace, or <code>null</code> if it doesn't exist. If the provided elementName is null,
      * only the namespace is matched. Extensions are
      * are arbitrary XML elements in standard XMPP stanzas.
      *
      * @param elementName the XML element name of the extension. (May be null)
      * @param namespace the XML element namespace of the extension.
      * @param <PE> type of the ExtensionElement.
-     * @return the extension, or <tt>null</tt> if it doesn't exist.
+     * @return the extension, or <code>null</code> if it doesn't exist.
      */
     @SuppressWarnings("unchecked")
     public <PE extends ExtensionElement> PE getExtension(String elementName, String namespace) {

smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/store/abstr/AbstractOpenPgpStore.java

@@ -23,7 +23,6 @@ import java.security.NoSuchProviderException;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Observable;
 
 import org.jivesoftware.smack.util.Objects;
 
@@ -46,7 +45,7 @@ import org.pgpainless.key.collection.PGPKeyRing;
 import org.pgpainless.key.protection.SecretKeyRingProtector;
 import org.pgpainless.key.protection.UnprotectedKeysProtector;
 
-public abstract class AbstractOpenPgpStore extends Observable implements OpenPgpStore {
+public abstract class AbstractOpenPgpStore implements OpenPgpStore {
 
     protected final OpenPgpKeyStore keyStore;
     protected final OpenPgpMetadataStore metadataStore;

smack-xmlparser-stax/src/main/java/org/jivesoftware/smack/xml/stax/StaxXmlPullParserFactory.java

@@ -27,7 +27,7 @@ import org.jivesoftware.smack.xml.XmlPullParserFactory;
 
 public class StaxXmlPullParserFactory implements XmlPullParserFactory {
 
-    private static final XMLInputFactory xmlInputFactory = XMLInputFactory.newFactory();
+    private static final XMLInputFactory xmlInputFactory = XMLInputFactory.newInstance();
 
     static {
         // XPP3 appears to coalescing hence we need to configure our StAX parser to also return all available text on

smack-xmlparser/src/main/java/org/jivesoftware/smack/xml/XmlPullParser.java

@@ -41,7 +41,8 @@ import javax.xml.namespace.QName;
  * <p>
  * The following table shows the mapping of Smack's XmlPullParser events to StAX and XPP3 events:
  * </p>
- * <table summary="XmlPullParser event mapping">
+ * <table>
+ * <caption>XmlPullParser event mapping</caption>
  * <tr><th>Smack's {@link XmlPullParser.Event}</th><th>StAX Event</th><th>XPP3 Event</th></tr>
  * <tr><td>{@link XmlPullParser.Event#START_DOCUMENT}</td><td>START_DOCUMENT (7)</td><td>START_DOCUMENT (0)</td></tr>
  * <tr><td>{@link XmlPullParser.Event#END_DOCUMENT}</td><td>END_DOCUMENT (8)</td><td>END_DOCUMENT (1)</td></tr>

version.gradle

@@ -1,6 +1,6 @@
 allprojects {
 	ext {
-		shortVersion = '4.4.0-alpha2'
+		shortVersion = '4.4.0-alpha3'
 		isSnapshot = true
 		// When using dynamic versions for those, do *not* use [1.0,
 		// 2.0), since this will also pull in 2.0-alpha1. Instead use