diff options
| author | Robert Gemmell <robbie@apache.org> | 2014-08-08 16:39:32 +0000 |
|---|---|---|
| committer | Robert Gemmell <robbie@apache.org> | 2014-08-08 16:39:32 +0000 |
| commit | 6b61650c1ad38eacda87dca9a8921a148d6d3bec (patch) | |
| tree | e4404ad4f82e8b034a7c5132d00d50aac0670b0f | |
| parent | dba548b498b8718242353fb3b492d5e29b31e9e9 (diff) | |
| download | qpid-python-6b61650c1ad38eacda87dca9a8921a148d6d3bec.tar.gz | |
QPID-5980: port javadoc fixups from trunk to the 0.30 branch
git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/0.30@1616823 13f79535-47bb-0310-9956-ffa450edef68
114 files changed, 417 insertions, 740 deletions
diff --git a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java index 7c3857f6c9..d2a741d96c 100644 --- a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java +++ b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java @@ -25,7 +25,7 @@ import javax.naming.NamingException; /** * A default implementation of {@link NameParser} - * <p/> + * <p> * Based on class from ActiveMQ. */ public class NameParserImpl implements NameParser diff --git a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java index 4e0f994b94..d0f7ddb216 100644 --- a/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java +++ b/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java @@ -45,13 +45,13 @@ import javax.naming.spi.NamingManager; /** * Based on class from ActiveMQ. * A read-only Context - * <p/> + * <p> * This version assumes it and all its subcontext are read-only and any attempt * to modify (e.g. through bind) will result in an OperationNotSupportedException. * Each Context in the tree builds a cache of the entries in all sub-contexts * to optimise the performance of lookup. - * </p> - * <p>This implementation is intended to optimise the performance of lookup(String) + * <p> + * This implementation is intended to optimise the performance of lookup(String) * to about the level of a HashMap get. It has been observed that the scheme * resolution phase performed by the JVM takes considerably longer, so for * optimum performance lookups should be coded like:</p> @@ -148,11 +148,6 @@ public class ReadOnlyContext implements Context, Serializable * to bind the remaining name. It returns a map containing all the bindings from the next context, plus * the context it just created (if it in fact created it). (the names are suitably extended by the segment * originally lopped off). - * - * @param name - * @param value - * @return - * @throws javax.naming.NamingException */ protected Map internalBind(String name, Object value) throws NamingException { diff --git a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java index 80802b6a0c..4717aab472 100644 --- a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java +++ b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/BDBBackup.java @@ -41,41 +41,38 @@ import java.util.Properties; /** * BDBBackup is a utility for taking hot backups of the current state of a BDB transaction log database. - * - * <p/>This utility makes the following assumptions/performs the following actions: - * - * <p/><ul> <li>The from and to directory locations will already exist. This scripts does not create them. <li>If this + * <p> + * This utility makes the following assumptions/performs the following actions: + * <p> + * <ul> <li>The from and to directory locations will already exist. This scripts does not create them. <li>If this * script fails to complete in one minute it will terminate. <li>This script always exits with code 1 on error, code 0 * on success (standard unix convention). <li>This script will log out at info level, when it starts and ends and a list * of all files backed up. <li>This script logs all errors at error level. <li>This script does not perform regular * backups, wrap its calling script in a cron job or similar to do this. </ul> - * - * <p/>This utility is build around the BDB provided backup helper utility class, DbBackup. This utility class provides + * <p> + * This utility is build around the BDB provided backup helper utility class, DbBackup. This utility class provides * an ability to force BDB to stop writing to the current log file set, whilst the backup is taken, to ensure that a * consistent snapshot is acquired. Preventing BDB from writing to the current log file set, does not stop BDB from * continuing to run concurrently while the backup is running, it simply moves onto a new set of log files; this * provides a 'hot' backup facility. - * - * <p/>DbBackup can also help with incremental backups, by providing the number of the last log file backed up. + * <p> + * DbBackup can also help with incremental backups, by providing the number of the last log file backed up. * Subsequent backups can be taken, from later log files only. In a messaging application, messages are not expected to * be long-lived in most cases, so the log files will usually have been completely turned over between backups. This * utility does not support incremental backups for this reason. - * - * <p/>If the database is locked by BDB, as is required when using transactions, and therefore will always be the case + * <p> + * If the database is locked by BDB, as is required when using transactions, and therefore will always be the case * in Qpid, this utility cannot make use of the DbBackup utility in a seperate process. DbBackup, needs to ensure that * the BDB envinronment used to take the backup has exclusive write access to the log files. This utility can take a * backup as a standalone utility against log files, when a broker is not running, using the {@link #takeBackup(String, *String,com.sleepycat.je.Environment)} method. - * - * <p/>A seperate backup machanism is provided by the {@link #takeBackupNoLock(String,String)} method which can take a + * <p> + * A seperate backup machanism is provided by the {@link #takeBackupNoLock(String,String)} method which can take a * hot backup against a running broker. This works by finding out the set of files to copy, and then opening them all to * read, and repeating this process until a consistent set of open files is obtained. This is done to avoid the * situation where the BDB cleanup thread deletes a file, between the directory listing and opening of the file to copy. * All consistently opened files are copied. This is the default mechanism the the {@link #main} method of this utility * uses. - * - * <p/><table id="crc><caption>CRC Card</caption> <tr><th> Responsibilities <th> Collaborations <tr><td> Hot copy all - * BDB log files from one directory to another. </table> */ public class BDBBackup { @@ -102,10 +99,10 @@ public class BDBBackup /** * Runs a backup of the BDB log files in a specified directory, copying the backed up files to another specified * directory. - * - * <p/>The following arguments must be specified: - * - * <p/><table><caption>Command Line</caption> <tr><th> Option <th> Comment <tr><td> -fromdir <td> The path to the + * <p> + * The following arguments must be specified: + * <table> + * <caption>Command Line</caption> <tr><th> Option <th> Comment <tr><td> -fromdir <td> The path to the * directory to back the bdb log file from. <tr><td> -todir <td> The path to the directory to save the backed up * bdb log files to. </table> * diff --git a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java index 366b6a1c97..1e4bfec09c 100644 --- a/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java +++ b/qpid/java/bdbstore/src/main/java/org/apache/qpid/server/store/berkeleydb/upgrade/UpgradeFrom5To6.java @@ -110,8 +110,8 @@ public class UpgradeFrom5To6 extends AbstractStoreUpgrade * * Message content is moved from the database messageContentDb_v5 to * MESSAGE_CONTENT. The structure of the database changes from ( message-id: - * long, chunk-id: int ) -> ( size: int, byte[] data ) to ( message-id: - * long) -> ( byte[] data ) + * long, chunk-id: int ) {@literal ->} ( size: int, byte[] data ) to ( message-id: + * long) {@literal ->} ( byte[] data ) * * That is we keep only one record per message, which contains all the * message content diff --git a/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java b/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java index 1a34bd8063..dc7724bd71 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java +++ b/qpid/java/broker-core/src/main/java/org/apache/log4j/QpidCompositeRollingAppender.java @@ -51,7 +51,7 @@ import java.util.zip.GZIPOutputStream; * <p>A of few additional optional features have been added:<br> -- Attach date pattern for current log file (@see * staticLogFileName)<br> -- Backup number increments for newer files (@see countDirection)<br> -- Infinite number of * backups by file size (@see maxSizeRollBackups)<br> <br> <p>A few notes and warnings: For large or infinite number of - * backups countDirection > 0 is highly recommended, with staticLogFileName = false if time based rolling is also used + * backups countDirection {@literal >} 0 is highly recommended, with staticLogFileName = false if time based rolling is also used * -- this will reduce the number of file renamings to few or none. Changing staticLogFileName or countDirection * without clearing the directory could have nasty side effects. If Date/Time based rolling is enabled, * CompositeRollingAppender will attempt to roll existing files in the directory without a date/time tag based on the @@ -358,9 +358,9 @@ public class QpidCompositeRollingAppender extends FileAppender } /** - * By default newer files have lower numbers. (countDirection < 0) ie. log.1 is most recent, log.5 is the 5th - * backup, etc... countDirection > 0 does the opposite ie. log.1 is the first backup made, log.5 is the 5th backup - * made, etc. For infinite backups use countDirection > 0 to reduce rollOver costs. + * By default newer files have lower numbers. (countDirection {@literal <} 0) ie. log.1 is most recent, log.5 is the 5th + * backup, etc... countDirection {@literal >} 0 does the opposite ie. log.1 is the first backup made, log.5 is the 5th backup + * made, etc. For infinite backups use countDirection {@literal >} 0 to reduce rollOver costs. */ public int getCountDirection() { @@ -686,9 +686,9 @@ public class QpidCompositeRollingAppender extends FileAppender /** * Implements roll overs base on file size. * - * <p>If the maximum number of size based backups is reached (<code>curSizeRollBackups == maxSizeRollBackups</code) + * <p>If the maximum number of size based backups is reached (<code>curSizeRollBackups {@literal ==} maxSizeRollBackups</code>) * then the oldest file is deleted -- it's index determined by the sign of countDirection.<br> If - * <code>countDirection</code> < 0, then files {<code>File.1</code>, ..., <code>File.curSizeRollBackups -1</code>} + * <code>countDirection</code> {@literal <} 0, then files {<code>File.1</code>, ..., <code>File.curSizeRollBackups -1</code>} * are renamed to {<code>File.2</code>, ..., <code>File.curSizeRollBackups</code>}. Moreover, <code>File</code> is * renamed <code>File.1</code> and closed.<br> * @@ -697,7 +697,7 @@ public class QpidCompositeRollingAppender extends FileAppender * <p>If <code>maxSizeRollBackups</code> is equal to zero, then the <code>File</code> is truncated with no backup * files created. * - * <p>If <code>maxSizeRollBackups</code> < 0, then <code>File</code> is renamed if needed and no files are deleted. + * <p>If <code>maxSizeRollBackups</code> {@literal <} 0, then <code>File</code> is renamed if needed and no files are deleted. */ // synchronization not necessary since doAppend is already synched diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java index 74c393c10f..83c6b9fd00 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/exchange/HeadersExchange.java @@ -45,7 +45,7 @@ import org.apache.qpid.server.virtualhost.VirtualHostImpl; * An exchange that binds queues based on a set of required headers and header values * and routes messages to these queues by matching the headers of the message against * those with which the queues were bound. - * <p/> + * <p> * <pre> * The Headers Exchange * diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java index 09a277e520..462b45d678 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/LogSubject.java @@ -30,7 +30,7 @@ public interface LogSubject /** * Provides the log message as as String. * - * @returns String the display representation of this LogSubject + * @return String the display representation of this LogSubject */ public String toLogString(); }
\ No newline at end of file diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java index 5b411e2d8d..467cd15d2e 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/logging/log4j/LoggingManagementFacade.java @@ -122,11 +122,11 @@ public class LoggingManagementFacade /** The log4j XML configuration file DTD defines three possible element * combinations for specifying optional logger+level settings. * Must account for the following: - * - * <category name="x"> <priority value="y"/> </category> OR - * <category name="x"> <level value="y"/> </category> OR - * <logger name="x"> <level value="y"/> </logger> - * + * <p> + * {@literal <category name="x"> <priority value="y"/> </category>} OR + * {@literal <category name="x"> <level value="y"/> </category>} OR + * {@literal <logger name="x"> <level value="y"/> </logger>} + * <p> * Noting also that the level/priority child element is optional too, * and not the only possible child element. */ @@ -171,10 +171,10 @@ public class LoggingManagementFacade * The log4j XML configuration file DTD defines 2 possible element * combinations for specifying the optional root logger level settings * Must account for the following: - * - * <root> <priority value="y"/> </root> OR - * <root> <level value="y"/> </root> - * + * <p> + * {@literal <root> <priority value="y"/> </root> } OR + * {@literal <root> <level value="y"/> </root>} + * <p> * Noting also that the level/priority child element is optional too, * and not the only possible child element. */ diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java index 7f6629e33d..3f04ef6f78 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/message/MessageSource.java @@ -54,13 +54,8 @@ public interface MessageSource extends TransactionLogResource, MessageNode /** * ExistingExclusiveConsumer signals a failure to create a consumer, because an exclusive consumer * already exists. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent failure to create a consumer, because an exclusive consumer already exists. - * </table> - * * - * @todo Move to top level, used outside this class. + * <p> + * TODO Move to top level, used outside this class. */ static final class ExistingExclusiveConsumer extends Exception { @@ -73,13 +68,8 @@ public interface MessageSource extends TransactionLogResource, MessageNode /** * ExistingConsumerPreventsExclusive signals a failure to create an exclusive consumer, as a consumer * already exists. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent failure to create an exclusive consumer, as a consumer already exists. - * </table> - * * - * @todo Move to top level, used outside this class. + * <p> + * TODO Move to top level, used outside this class. */ static final class ExistingConsumerPreventsExclusive extends Exception { diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java index 9711250bd7..acfe7856c3 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/registry/ApplicationRegistry.java @@ -41,7 +41,7 @@ import org.apache.qpid.util.SystemUtils; /** * An abstract application registry that provides access to configuration information and handles the * construction and caching of configurable objects. - * <p/> + * <p> * Subclasses should handle the construction of the "registered objects" such as the exchange registry. */ public class ApplicationRegistry implements IApplicationRegistry diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java index 8243fc3f75..85fa80ec8e 100755 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java @@ -32,7 +32,7 @@ public interface AuthorizationHolder /** * Returns the {@link Subject} of the authorized user. This is guaranteed to * contain at least one {@link org.apache.qpid.server.security.auth.UsernamePrincipal}, representing the the identity - * used when the user logged on to the application, and zero or more {@link org.apache.qpid.server.security.auth.sasl.GroupPrincipal} + * used when the user logged on to the application, and zero or more {@link org.apache.qpid.server.security.group.GroupPrincipal} * representing the group(s) to which the user belongs. * * @return the Subject diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java index 3e8b2e210e..d7db81c3dd 100644 --- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java +++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/security/auth/manager/ldap/AbstractLDAPSSLSocketFactory.java @@ -35,19 +35,16 @@ import javax.net.ssl.SSLSocketFactory; * <p> * Concrete implementations of this class are <b>generated dynamically</b> at runtime by * the {@link LDAPSSLSocketFactoryGenerator#createSubClass(String, SSLSocketFactory)} method. - * </p> * <p> * Callers will create new instances of the concrete implementations by using the static * <code>#getDefault()</code> method. This will return an instance of the sub-class that is * associated with the {@link SSLSocketFactory}. - * </p> * <p> * If callers are passing the sub-class to an API via class-name (i.e. String), the caller * <b>must</b> ensure that the context classloader of the thread to set to the classloader * of sub-class for the duration of the API call(s). - * </p> + * <p> * For more details see {@link LDAPSSLSocketFactoryGenerator}. - * </p> */ public abstract class AbstractLDAPSSLSocketFactory extends SSLSocketFactory { diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java index 4fff0bebf5..e09935cf5c 100644 --- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java +++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/Action.java @@ -33,8 +33,8 @@ import org.apache.qpid.server.security.access.Operation; * * An action consists of an {@link Operation} on an {@link ObjectType} with certain properties, stored in a {@link java.util.Map}. * The operation and object should be an allowable combination, based on the {@link ObjectType#isAllowed(Operation)} - * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal {@link #propertiesMatch(Map)} - * and {@link #valueMatches(String, String)} methods are used to determine wildcarded matching of properties, with + * method of the object, which is exposed as the {@link #isAllowed()} method here. The internal #propertiesMatch(Map) + * and #valueMatches(String, String) methods are used to determine wildcarded matching of properties, with * the empty string or "*" matching all values, and "*" at the end of a rule value indicating prefix matching. * <p> * The {@link #matches(Action)} method is intended to be used when determining precedence of rules, and diff --git a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java index 7bf5626197..fd122ef8d2 100644 --- a/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java +++ b/qpid/java/broker-plugins/access-control/src/main/java/org/apache/qpid/server/security/access/config/RuleSet.java @@ -49,9 +49,6 @@ import org.apache.qpid.server.security.access.Permission; /** * Models the rule configuration for the access control plugin. - * - * The access control rule definitions are loaded from an external configuration file, passed in as the - * target to the {@link load(ConfigurationFile)} method. The file specified */ public class RuleSet implements EventLoggerProvider { diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java index 8faf1a7c65..42250190b4 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/AMQNoMethodHandlerException.java @@ -27,14 +27,10 @@ import org.apache.qpid.protocol.AMQMethodEvent; /**
* AMQNoMethodHandlerException represents the case where no method handler exists to handle an AQMP method.
*
- * <p/><table id="crc"><caption>CRC Card</caption>
- * <tr><th> Responsibilities <th> Collaborations
- * <tr><td> Represents failure to handle an AMQP method.
- * </table>
- *
- * @todo Not an AMQP exception as no status code.
- *
- * @todo Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a
+ * <p>
+ * TODO Not an AMQP exception as no status code.
+ * <p>
+ * TODO Missing method handler. Unlikely to ever happen, and if it does its a coding error. Consider replacing with a
* Runtime.
*/
public class AMQNoMethodHandlerException extends AMQException
diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java index 3de89a1d70..ae63c16025 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/ConsumerTarget_0_8.java @@ -43,8 +43,10 @@ import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; /** - * Encapsulation of a subscription to a queue. <p/> Ties together the protocol session of a subscriber, the consumer tag - * that was given out by the broker and the channel id. <p/> + * Encapsulation of a subscription to a queue. + * <p> + * Ties together the protocol session of a subscriber, the consumer tag + * that was given out by the broker and the channel id. */ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implements FlowCreditManager.FlowCreditManagerListener { @@ -170,10 +172,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen * This method can be called by each of the publisher threads. As a result all changes to the channel object must be * thread safe. * - * * @param entry The message to send * @param batch - * @throws org.apache.qpid.AMQException */ @Override public void send(MessageInstance entry, boolean batch) @@ -286,10 +286,8 @@ public abstract class ConsumerTarget_0_8 extends AbstractConsumerTarget implemen * This method can be called by each of the publisher threads. As a result all changes to the channel object must be * thread safe. * - * * @param entry The message to send * @param batch - * @throws org.apache.qpid.AMQException */ @Override public void send(MessageInstance entry, boolean batch) diff --git a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java index 328064b6dc..cb9295ac49 100644 --- a/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java +++ b/qpid/java/broker-plugins/amqp-0-8-protocol/src/main/java/org/apache/qpid/server/protocol/v0_8/state/AMQStateManager.java @@ -43,8 +43,9 @@ import org.apache.qpid.server.security.SubjectCreator; import org.apache.qpid.server.util.ServerScopedRuntimeException; /** - * The state manager is responsible for managing the state of the protocol session. <p/> For each AMQProtocolHandler - * there is a separate state manager. + * The state manager is responsible for managing the state of the protocol session. + * <p> + * For each AMQProtocolHandler there is a separate state manager. */ public class AMQStateManager implements AMQMethodListener { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java index 6bae0166d1..67885777f0 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java @@ -25,13 +25,8 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQAuthenticationException represents all failures to authenticate access to a broker. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent failure to authenticate the client. - * </table> - * - * @todo Will this alwyas have the same status code, NOT_ALLOWED 530? Might set this up to always use that code. + * <p> + * TODO Will this alwyas have the same status code, NOT_ALLOWED 530? Might set this up to always use that code. */ public class AMQAuthenticationException extends AMQException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQConnection.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQConnection.java index 0dc5cc68c1..7d9dfcd600 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQConnection.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQConnection.java @@ -224,7 +224,7 @@ public class AMQConnection extends Closeable implements Connection, QueueConnect } /** - * @todo Some horrible stuff going on here with setting exceptions to be non-null to detect if an exception + * TODO Some horrible stuff going on here with setting exceptions to be non-null to detect if an exception * was thrown during the connection! Intention not clear. Use a flag anyway, not exceptions... Will fix soon. */ public AMQConnection(ConnectionURL connectionURL) throws AMQException diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java index 08867b5de7..c50425c1a8 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java @@ -25,11 +25,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQNoConsumersException indicates failure to pass an immediate message to a consumer. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents failure to pass an immediate message to a consumer. - * <tr><td> */ public class AMQNoConsumersException extends AMQUndeliveredException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java index 42ed9c3df7..e5f780c203 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java @@ -25,11 +25,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQNoRouteException indicates that a mandatory message could not be routed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents failure to route a mandatory message. - * <tr><td> */ public class AMQNoRouteException extends AMQUndeliveredException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSession.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSession.java index 5723ce9b11..945645ccb1 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSession.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSession.java @@ -79,20 +79,15 @@ import org.apache.qpid.thread.Threading; import org.apache.qpid.transport.SessionException; import org.apache.qpid.transport.TransportException; -/** - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> - * </table> - * - * @todo Different FailoverSupport implementation are needed on the same method call, in different situations. For +/* + * TODO Different FailoverSupport implementation are needed on the same method call, in different situations. For * example, when failing-over and reestablishing the bindings, the bind cannot be interrupted by a second * fail-over, if it fails with an exception, the fail-over process should also fail. When binding outside of * the fail-over process, the retry handler could be used to automatically retry the operation once the connection * has been reestablished. All fail-over protected operations should be placed in private methods, with * FailoverSupport passed in by the caller to provide the correct support for the calling context. Sometimes the * fail-over process sets a nowait flag and uses an async method call instead. - * @todo Two new objects created on every failover supported method call. Consider more efficient ways of doing this, + * TODO Two new objects created on every failover supported method call. Consider more efficient ways of doing this, * after looking at worse bottlenecks first. */ public abstract class AMQSession<C extends BasicMessageConsumer, P extends BasicMessageProducer> extends Closeable implements Session, QueueSession, TopicSession @@ -613,14 +608,14 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @param multiple <tt>true</tt> to acknowledge all messages up to and including the one specified by the * delivery tag, <tt>false</tt> to just acknowledge that message. * - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ public abstract void acknowledgeMessage(long deliveryTag, boolean multiple); /** * Binds the named queue, with the specified routing key, to the named exchange. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param queueName The name of the queue to bind. * @param routingKey The routing key to bind the queue with. @@ -628,8 +623,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @param exchangeName The exchange to bind the queue on. * * @throws AMQException If the queue cannot be bound for any reason. - * @todo Be aware of possible changes to parameter order as versions change. - * @todo Document the additional arguments that may be passed in the field table. Are these for headers exchanges? + * TODO Be aware of possible changes to parameter order as versions change. + * TODO Document the additional arguments that may be passed in the field table. Are these for headers exchanges? */ public void bindQueue(final AMQShortString queueName, final AMQShortString routingKey, final FieldTable arguments, final AMQShortString exchangeName, final AMQDestination destination) throws AMQException @@ -666,18 +661,18 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Closes the session. - * - * <p/>Note that this operation succeeds automatically if a fail-over interrupts the synchronous request to close + * <p> + * Note that this operation succeeds automatically if a fail-over interrupts the synchronous request to close * the channel. This is because the channel is marked as closed before the request to close it is made, so the * fail-over should not re-open it. * * @param timeout The timeout in milliseconds to wait for the session close acknowledgement from the broker. * * @throws JMSException If the JMS provider fails to close the session due to some internal error. - * @todo Be aware of possible changes to parameter order as versions change. - * @todo Not certain about the logic of ignoring the failover exception, because the channel won't be + * TODO Be aware of possible changes to parameter order as versions change. + * TODO Not certain about the logic of ignoring the failover exception, because the channel won't be * re-opened. May need to examine this more carefully. - * @todo Note that taking the failover mutex doesn't prevent this operation being interrupted by a failover, + * TODO Note that taking the failover mutex doesn't prevent this operation being interrupted by a failover, * because the failover process sends the failover event before acquiring the mutex itself. */ public void close(long timeout) throws JMSException @@ -802,8 +797,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic } /** * Commits all messages done in this transaction and releases any locks currently held. - * - * <p/>If the commit fails, because the commit itself is interrupted by a fail-over between requesting that the + * <p> + * If the commit fails, because the commit itself is interrupted by a fail-over between requesting that the * commit be done, and receiving an acknowledgement that it has been done, then a JMSException will be thrown. * The client will be unable to determine whether or not the commit actually happened on the broker in this case. * @@ -1237,8 +1232,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Declares the named queue. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param name The name of the queue to declare. * @param autoDelete @@ -1246,7 +1241,7 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @param exclusive Flag to indicate that the queue is exclusive to this client. * * @throws AMQException If the queue cannot be declared for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ public void createQueue(final AMQShortString name, final boolean autoDelete, final boolean durable, final boolean exclusive) throws AMQException @@ -1256,8 +1251,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Declares the named queue. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param name The name of the queue to declare. * @param autoDelete @@ -1266,7 +1261,7 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @param arguments Arguments used to set special properties of the queue * * @throws AMQException If the queue cannot be declared for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ public void createQueue(final AMQShortString name, final boolean autoDelete, final boolean durable, final boolean exclusive, final Map<String, Object> arguments) throws AMQException @@ -1684,11 +1679,11 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message. - * - * <p/>All consumers deliver messages in a serial order. Acknowledging a received message automatically acknowledges + * <p> + * All consumers deliver messages in a serial order. Acknowledging a received message automatically acknowledges * all messages that have been delivered to the client. - * - * <p/>Restarting a session causes it to take the following actions: + * <p> + * Restarting a session causes it to take the following actions: * * <ul> * <li>Stop message delivery.</li> @@ -1697,14 +1692,15 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * Redelivered messages do not have to be delivered in exactly their original delivery order.</li> * </ul> * - * <p/>If the recover operation is interrupted by a fail-over, between asking that the broker begin recovery and + * <p> + * If the recover operation is interrupted by a fail-over, between asking that the broker begin recovery and * receiving acknowledgment that it has then a JMSException will be thrown. In this case it will not be possible * for the client to determine whether the broker is going to recover the session or not. * * @throws JMSException If the JMS provider fails to stop and restart message delivery due to some internal error. * Not that this does not necessarily mean that the recovery has failed, but simply that it is * not possible to tell if it has or not. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. * * Strategy for handling recover. * Flush any acks not yet sent. @@ -1806,15 +1802,15 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Commits all messages done in this transaction and releases any locks currently held. - * - * <p/>If the rollback fails, because the rollback itself is interrupted by a fail-over between requesting that the + * <p> + * If the rollback fails, because the rollback itself is interrupted by a fail-over between requesting that the * rollback be done, and receiving an acknowledgement that it has been done, then a JMSException will be thrown. * The client will be unable to determine whether or not the rollback actually happened on the broker in this case. * * @throws JMSException If the JMS provider fails to rollback the transaction due to some internal error. This does * not mean that the rollback is known to have failed, merely that it is not known whether it * failed or not. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ public void rollback() throws JMSException { @@ -2120,8 +2116,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Tests whether or not the specified queue is bound to the specified exchange under a particular routing key. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param exchangeName The exchange name to test for binding against. * @param queueName The queue name to check if bound. @@ -2130,7 +2126,7 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @return <tt>true</tt> if the queue is bound to the exchange and routing key, <tt>false</tt> if not. * * @throws JMSException If the query fails for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ public abstract boolean isQueueBound(final AMQShortString exchangeName, final AMQShortString queueName, final AMQShortString routingKey) throws JMSException; @@ -2141,7 +2137,9 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Called to mark the session as being closed. Useful when the session needs to be made invalid, e.g. after failover - * when the client has veoted resubscription. <p/> The caller of this method must already hold the failover mutex. + * when the client has veoted resubscription. + * <p> + * The caller of this method must already hold the failover mutex. */ void markClosed() { @@ -2296,7 +2294,7 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * Starts the session, which ensures that it is not suspended and that its event dispatcher is running. * * @throws AMQException If the session cannot be started for any reason. - * @todo This should be controlled by _stopped as it pairs with the stop method fixme or check the + * TODO This should be controlled by _stopped as it pairs with the stop method fixme or check the * FlowControlledBlockingQueue _queue to see if we have flow controlled. will result in sending Flow messages * for each subsequent call to flow.. only need to do this if we have called stop. */ @@ -2638,8 +2636,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Returns the number of messages currently queued for the given destination. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param amqd The destination to be checked * @@ -2685,8 +2683,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Declares the named exchange and type of exchange. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param name The name of the exchange to declare. * @param type The type of the exchange to declare. @@ -2695,7 +2693,7 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * @param autoDelete * @param internal * @throws AMQException If the exchange cannot be declared for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ private void declareExchange(final AMQShortString name, final AMQShortString type, final boolean nowait, final boolean durable, @@ -2716,12 +2714,12 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Declares a queue for a JMS destination. - * - * <p/>Note that for queues but not topics the name is generated in the client rather than the server. This allows + * <p> + * Note that for queues but not topics the name is generated in the client rather than the server. This allows * the name to be reused on failover if required. In general, the destination indicates whether it wants a name * generated or not. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * * @param amqd The destination to declare as a queue. @@ -2731,8 +2729,8 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic * * * @throws AMQException If the queue cannot be declared for any reason. - * @todo Verify the destiation is valid or throw an exception. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Verify the destiation is valid or throw an exception. + * TODO Be aware of possible changes to parameter order as versions change. */ protected AMQShortString declareQueue(final AMQDestination amqd, final boolean noLocal) throws AMQException @@ -2752,13 +2750,13 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Undeclares the specified queue. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param queueName The name of the queue to delete. * * @throws JMSException If the queue could not be deleted for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ protected void deleteQueue(final AMQShortString queueName) throws JMSException { @@ -2781,13 +2779,13 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Undeclares the specified temporary queue/topic. - * - * <p/>Note that this operation automatically retries in the event of fail-over. + * <p> + * Note that this operation automatically retries in the event of fail-over. * * @param amqQueue The name of the temporary destination to delete. * * @throws JMSException If the queue could not be deleted for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ protected void deleteTemporaryDestination(final TemporaryDestination amqQueue) throws JMSException { @@ -3014,11 +3012,11 @@ public abstract class AMQSession<C extends BasicMessageConsumer, P extends Basic /** * Suspends or unsuspends this session. * - * @param suspend <tt>true</tt> indicates that the session should be suspended, <tt>false<tt> indicates that it + * @param suspend true indicates that the session should be suspended, false indicates that it * should be unsuspended. * * @throws AMQException If the session cannot be suspended for any reason. - * @todo Be aware of possible changes to parameter order as versions change. + * TODO Be aware of possible changes to parameter order as versions change. */ protected void suspendChannel(boolean suspend) throws AMQException // , FailoverException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSessionDirtyException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSessionDirtyException.java index a1b240ed54..a33d05f0c7 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSessionDirtyException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQSessionDirtyException.java @@ -27,11 +27,6 @@ import org.apache.qpid.protocol.AMQConstant; * AMQSessionDirtyException represents all failures to send data on a transacted session that is * no longer in a state that the client expects. i.e. failover has occured so previously sent messages * will not be part of the transaction. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent attempt to perform additional sends on a dirty session. - * </table> */ public class AMQSessionDirtyException extends AMQException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQTopic.java b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQTopic.java index d5724a2910..1a7b6bea80 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/AMQTopic.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/AMQTopic.java @@ -218,7 +218,7 @@ public class AMQTopic extends AMQDestination implements Topic * Override since the queue is always private and we must ensure it remains null. If not, * reuse of the topic when registering consumers will make all consumers listen on the same (private) queue rather * than getting their own (private) queue. - * <p/> + * <p> * This is relatively nasty but it is difficult to come up with a more elegant solution, given * the requirement in the case on AMQQueue and possibly other AMQDestination subclasses to * use the underlying queue name even where it is server generated. diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/BasicMessageConsumer.java b/qpid/java/client/src/main/java/org/apache/qpid/client/BasicMessageConsumer.java index 5086063a5a..01e89b78c1 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/BasicMessageConsumer.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/BasicMessageConsumer.java @@ -1024,8 +1024,11 @@ public abstract class BasicMessageConsumer<U> extends Closeable implements Messa } /** - * Used in the blocking receive methods to receive a message from the Session thread. <p/> Or to notify of errors - * <p/> Argument true indicates we want strict FIFO semantics + * Used in the blocking receive methods to receive a message from the Session thread. + * <p> + * Or to notify of errors. + * <p> + * Argument true indicates we want strict FIFO semantics */ protected BlockingQueue getSynchronousQueue() { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/Closeable.java b/qpid/java/client/src/main/java/org/apache/qpid/client/Closeable.java index 2f7fbad30c..2a3eb40a07 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/Closeable.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/Closeable.java @@ -27,18 +27,11 @@ import java.util.concurrent.atomic.AtomicBoolean; /** * Captures the 'closed' state of an object, that is initially open, can be tested to see if it is closed, and provides * a 'close' method to close it. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Mark an object as closed. - * <tr><td> Check if an object is closed. - * <tr><td> Raise a JMS exception if an object is closed. - * </table> - * - * @todo Might be better to make this an interface. This whole class doesn't really encapsulate a terribly neat + * <p> + * TODO Might be better to make this an interface. This whole class doesn't really encapsulate a terribly neat * piece of re-usable functionality. A simple interface defining a close method would suffice. - * - * @todo The convenience method {@link #checkNotClosed} is not that helpfull, what if the caller wants to do something + * <p> + * TODO The convenience method {@link #checkNotClosed} is not that helpfull, what if the caller wants to do something * other than throw an exception? It doesn't really represent a very usefull re-usable piece of code. Consider * inlining it and dropping the method. */ diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/JMSAMQException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/JMSAMQException.java index 1151a97cf4..8bb88a273e 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/JMSAMQException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/JMSAMQException.java @@ -28,11 +28,6 @@ import javax.jms.JMSException; * JMSException does not accept wrapped exceptions in its constructor. Presumably this is because it is a relatively old * Java exception class, before this was added as a default to Throwable. This exception class accepts wrapped exceptions * as well as error messages, through its constructor, but is a JMSException. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Accept wrapped exceptions as a JMSException. - * </table> */ public class JMSAMQException extends JMSException { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/RejectBehaviour.java b/qpid/java/client/src/main/java/org/apache/qpid/client/RejectBehaviour.java index e3c958044e..e58a356bdc 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/RejectBehaviour.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/RejectBehaviour.java @@ -23,7 +23,7 @@ package org.apache.qpid.client; /** * This enum can be used only with for 0-8/0-9/0-9-1 protocols connections to notify * the client to delegate the requeue/DLQ decision to the server - * if <code>SERVER</server> value is specified. Otherwise the messages won't be moved to + * if <code>SERVER</code> value is specified. Otherwise the messages won't be moved to * the DLQ (or dropped) when delivery count exceeds the maximum. */ public enum RejectBehaviour diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/XAResourceImpl.java b/qpid/java/client/src/main/java/org/apache/qpid/client/XAResourceImpl.java index 6c745feea8..7e82981ad3 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/XAResourceImpl.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/XAResourceImpl.java @@ -121,7 +121,7 @@ public class XAResourceImpl implements AMQXAResource * The transaction context is in a suspended state and must be resumed via the start method with TMRESUME specified. * <li> If TMFAIL is specified, the portion of work has failed. The resource manager may mark the transaction as rollback-only * <li> If TMSUCCESS is specified, the portion of work has completed successfully. - * /ul> + * </ul> * * @param xid A global transaction identifier that is the same as the identifier used previously in the start method * @param flag One of TMSUCCESS, TMFAIL, or TMSUSPEND. @@ -312,7 +312,7 @@ public class XAResourceImpl implements AMQXAResource /** * Obtains a list of prepared transaction branches. - * <p/> + * <p> * The transaction manager calls this method during recovery to obtain the list of transaction branches * that are currently in prepared or heuristically completed states. * diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java index 037b0dc2d1..31a2868c13 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverException.java @@ -24,13 +24,8 @@ package org.apache.qpid.client.failover; * FailoverException is used to indicate that a synchronous request has failed to receive the reply that it is waiting * for because the fail-over process has been started whilst it was waiting for its reply. Synchronous methods generally * raise this exception to indicate that they must be re-tried once the fail-over process has completed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Used to indicate failure of a synchronous request due to fail-over. - * </table> - * - * @todo This exception is created and passed as an argument to a method, rather than thrown. The exception is being + * <p> + * TODO This exception is created and passed as an argument to a method, rather than thrown. The exception is being * used to represent an event, passed out to other threads. Use of exceptions as arguments rather than as * exceptions is extremly confusing. Ideally use a condition or set a flag and check it instead. * This exceptions-as-events pattern seems to be in a similar style to Mina code, which is not pretty, but diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverHandler.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverHandler.java index 4099da18d2..315e3c4a3f 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverHandler.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverHandler.java @@ -36,13 +36,13 @@ import java.util.concurrent.CountDownLatch; * connections, failing over to a new connection if the transport connection fails. The procedure to establish a new * connection is expressed as a continuation, in order that it may be run in a seperate thread to the i/o thread that * detected the failure and is used to handle the communication to establish a new connection. - * - * </p>The reason this needs to be a separate thread is because this work cannot be done inside the i/o processor + * <p> + * The reason this needs to be a separate thread is because this work cannot be done inside the i/o processor * thread. The significant task is the connection setup which involves a protocol exchange until a particular state * is achieved. This procedure waits until the state is achieved which would prevent the i/o thread doing the work * it needs to do to achieve the new state. - * - * <p/>The failover procedure does the following: + * <p> + * The failover procedure does the following: * * <ol> * <li>Sets the failing over condition to true.</li> @@ -57,21 +57,17 @@ import java.util.concurrent.CountDownLatch; * <li>Resets the failing over condition and releases the mutex.</li> * </ol> * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Update fail-over state <td> {@link AMQProtocolHandler} - * </table> - * - * @todo The failover latch and mutex are used like a lock and condition. If the retrotranlator supports lock/condition + * <p> + * TODO The failover latch and mutex are used like a lock and condition. If the retrotranlator supports lock/condition * then could change over to using them. 1.4 support still needed. - * - * @todo If the condition is set to null on a vetoes fail-over and there are already other threads waiting on the + * <p> + * TODO If the condition is set to null on a vetoes fail-over and there are already other threads waiting on the * condition, they will never be released. It might be an idea to reset the condition in a finally block. - * - * @todo Creates a {@link AMQDisconnectedException} and passes it to the AMQConnection. No need to use an + * <p> + * TODO Creates a {@link AMQDisconnectedException} and passes it to the AMQConnection. No need to use an * exception-as-argument here, could just as easily call a specific method for this purpose on AMQConnection. - * - * @todo Creates a {@link FailoverException} and propagates it to the MethodHandlers. No need to use an + * <p> + * TODO Creates a {@link FailoverException} and propagates it to the MethodHandlers. No need to use an * exception-as-argument here, could just as easily call a specific method for this purpose on * {@link org.apache.qpid.protocol.AMQMethodListener}. */ diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverProtectedOperation.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverProtectedOperation.java index e9c5f24791..d7e4128183 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverProtectedOperation.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverProtectedOperation.java @@ -25,16 +25,11 @@ package org.apache.qpid.client.failover; * FailoverProtectedOperation is a continuation for an operation that may throw a {@link FailoverException} because * it has been interrupted by the fail-over process. The {@link FailoverRetrySupport} class defines support wrappers * for failover protected operations, in order to provide different handling schemes when failovers occurr. - * - * <p/>The type of checked exception that the operation may perform has been generified, in order that fail over + * <p> + * The type of checked exception that the operation may perform has been generified, in order that fail over * protected operations can be defined that raise arbitrary exceptions. The actuall exception types used should not * be sub-classes of FailoverException, or else catching FailoverException in the {@link FailoverRetrySupport} classes * will mask the exception. - * - * <p><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Perform an operation that may be interrupted by fail-over. - * </table> */ public interface FailoverProtectedOperation<T, E extends Exception> { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverRetrySupport.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverRetrySupport.java index d3d33d3c75..ffe0baecd8 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverRetrySupport.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverRetrySupport.java @@ -32,40 +32,34 @@ import org.apache.qpid.client.AMQConnection; * FailoverRetrySupport automatcally rechecks the condition and re-acquires the mutex and re-runs the continution. This * automatic retrying is continued until the continuation succeeds, or throws an exception (different to * FailoverException, which is used to signal the failure of the original condition). - * - * <p/>The blocking condition used is that the connection is not currently failing over, and the mutex used is the + * <p> + * The blocking condition used is that the connection is not currently failing over, and the mutex used is the * connection failover mutex, which guards against the fail-over process being run during fail-over vulnerable methods. * These are used like a lock and condition variable. - * - * <p/>The wrapped operation may throw a FailoverException, this is an exception that can be raised by a + * <p> + * The wrapped operation may throw a FailoverException, this is an exception that can be raised by a * {@link org.apache.qpid.client.protocol.BlockingMethodFrameListener}, in response to it being notified that a * fail-over wants to start whilst it was waiting. Methods that are vulnerable to fail-over are those that are * synchronous, where a failure will prevent them from getting the reply they are waiting for and asynchronous * methods that should not be attempted when a fail-over is in progress. - * - * <p/>Wrapping a synchronous method in a FailoverRetrySupport will have the effect that the operation will not be + * <p> + * Wrapping a synchronous method in a FailoverRetrySupport will have the effect that the operation will not be * started during fail-over, but be delayed until any current fail-over has completed. Should a fail-over process want * to start whilst waiting for the synchrnous reply, the FailoverRetrySupport will detect this and rety the operation * until it succeeds. Synchronous methods are usually coordinated with a * {@link org.apache.qpid.client.protocol.BlockingMethodFrameListener} which is notified when a fail-over process wants * to start and throws a FailoverException in response to this. - * - * <p/>Wrapping an asynchronous method in a FailoverRetrySupport will have the effect that the operation will not be + * <p> + * Wrapping an asynchronous method in a FailoverRetrySupport will have the effect that the operation will not be * started during fail-over, but be delayed until any current fail-over has completed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Provide a continuation synchronized on a fail-over lock and condition. - * <tr><td> Automatically retry the continuation accross fail-overs until it succeeds, or raises an exception. - * </table> - * - * @todo Another continuation. Could use an interface Continuation (as described in other todos) + * <p> + * TODO Another continuation. Could use an interface Continuation (as described in other todos) * Then have a wrapping continuation (this), which blocks on an arbitrary * Condition or Latch (specified in constructor call), that this blocks on before calling the wrapped Continuation. * Must work on Java 1.4, so check retrotranslator works on Lock/Condition or latch first. Argument and return type * to match wrapped condition as type parameters. Rename to AsyncConditionalContinuation or something like that. - * - * @todo InterruptedException not handled well. + * <p> + * TODO InterruptedException not handled well. */ public class FailoverRetrySupport<T, E extends Exception> implements FailoverSupport<T, E> { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverState.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverState.java index 807a5f7d13..268bac6155 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverState.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverState.java @@ -22,11 +22,6 @@ package org.apache.qpid.client.failover; /** * Defines the possible states of the failover process; not started, in progress, failed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent a one of the states of the fail-over process. - * </table> */ public final class FailoverState { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverSupport.java b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverSupport.java index ef2e7e1d65..be3fa230e1 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverSupport.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/failover/FailoverSupport.java @@ -26,13 +26,8 @@ package org.apache.qpid.client.failover; * behaviour for handling fail-overs during operations that can be interrupted by the fail-over process. For example, * the support could automatically retry once the fail-over process completes, could prevent an operation from being * started whilst fail-over is running, or could quietly abandon the operation or raise an exception, and so on. - * - * <p><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Perform a fail-over protected operation with handling for fail-over conditions. - * </table> - * - * @todo Continuation, extend some sort of re-usable Continuation interface, which might look very like this one. + * <p> + * TODO Continuation, extend some sort of re-usable Continuation interface, which might look very like this one. */ public interface FailoverSupport<T, E extends Exception> { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolHandler.java b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolHandler.java index ba5a98411f..c8ebb7f9c7 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolHandler.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolHandler.java @@ -77,23 +77,24 @@ import java.util.concurrent.TimeUnit; * event on to more specific handlers for the type. In this sense, it channels the richer event model of AMQP, * expressed in terms of methods and so on, through the cruder, general purpose event model of MINA, expressed in * terms of "message received" and so on. - * - * <p/>There is a 1:1 mapping between an AMQProtocolHandler and an {@link AMQConnection}. The connection class is + * <p> + * There is a 1:1 mapping between an AMQProtocolHandler and an {@link AMQConnection}. The connection class is * exposed to the end user of the AMQP client API, and also implements the JMS Connection API, so provides the public * API calls through which an individual connection can be manipulated. This protocol handler talks to the network * through MINA, in a behind the scenes role; it is not an exposed part of the client API. - * - * <p/>There is a 1:many mapping between an AMQProtocolHandler and a set of {@link AMQSession}s. At the MINA level, + * <p> + * There is a 1:many mapping between an AMQProtocolHandler and a set of {@link AMQSession}s. At the MINA level, * there is one session per connection. At the AMQP level there can be many channels which are also called sessions in * JMS parlance. The {@link AMQSession}s are managed through an {@link AMQProtocolSession} instance. The protocol * session is similar to the MINA per-connection session, except that it can span the lifecycle of multiple MINA sessions * in the event of failover. See below for more information about this. - * - * <p/>Mina provides a session container that can be used to store/retrieve arbitrary objects as String named + * <p> + * Mina provides a session container that can be used to store/retrieve arbitrary objects as String named * attributes. A more convenient, type-safe, container for session data is provided in the form of * {@link AMQProtocolSession}. * - * <p/>A common way to use MINA is to have a single instance of the event handler, and for MINA to pass in its session + * <p> + * A common way to use MINA is to have a single instance of the event handler, and for MINA to pass in its session * object with every event, and for per-connection data to be held in the MINA session (perhaps using a type-safe wrapper * as described above). This event handler is different, because dealing with failover complicates things. To the * end client of an AMQConnection, a failed over connection is still handled through the same connection instance, but @@ -101,19 +102,13 @@ import java.util.concurrent.TimeUnit; * be used to track the state of the fail-over process, because it is destroyed and a new one is created, as the old * connection is shutdown and a new one created. For this reason, an AMQProtocolHandler is created per AMQConnection * and the protocol session data is held outside of the MINA IOSession. - * - * <p/>This handler is responsible for setting up the filter chain to filter all events for this handler through. + * <p> + * This handler is responsible for setting up the filter chain to filter all events for this handler through. * The filter chain is set up as a stack of event handers that perform the following functions (working upwards from * the network traffic at the bottom), handing off incoming events to an asynchronous thread pool to do the work, * optionally handling secure sockets encoding/decoding, encoding/decoding the AMQP format itself. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Maintain fail-over state. - * <tr><td> - * </table> - * - * @todo Use a single handler instance, by shifting everything to do with the 'protocol session' state, including + * <p> + * TODO Use a single handler instance, by shifting everything to do with the 'protocol session' state, including * failover state, into AMQProtocolSession, and tracking that from AMQConnection? The lifecycles of * AMQProtocolSesssion and AMQConnection will be the same, so if there is high cohesion between them, they could * be merged, although there is sense in keeping the session model separate. Will clarify things by having data @@ -203,8 +198,8 @@ public class AMQProtocolHandler implements ProtocolEngine * where the connection died, an attempt to failover automatically to a new connection may be started. The failover * process will be started, provided that it is the clients policy to allow failover, and provided that a failover * has not already been started or failed. - * - * @todo Clarify: presumably exceptionCaught is called when the client is sending during a connection failure and + * <p> + * TODO Clarify: presumably exceptionCaught is called when the client is sending during a connection failure and * not otherwise? The above comment doesn't make that clear. */ public void closed() @@ -396,7 +391,7 @@ public class AMQProtocolHandler implements ProtocolEngine * protocol level waits. * * This will would normally be used to notify all Frame Listeners that Failover is about to occur and they should - * stop waiting and relinquish the Failover lock {@see FailoverHandler}. + * stop waiting and relinquish the Failover lock. See {@link FailoverHandler}. * * Once the {@link FailoverHandler} has re-established the connection then the listeners will be able to re-attempt * their protocol request and so listen again for the correct frame. @@ -727,8 +722,8 @@ public class AMQProtocolHandler implements ProtocolEngine /** * Closes the connection. - * - * <p/>If a failover exception occurs whilst closing the connection it is ignored, as the connection is closed + * <p> + * If a failover exception occurs whilst closing the connection it is ignored, as the connection is closed * anyway. * * @param timeout The timeout to wait for an acknowledgment to the close request. diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java index 4027ccb725..121715d439 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java @@ -55,8 +55,9 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; /** - * Wrapper for protocol session that provides type-safe access to session attributes. <p/> The underlying protocol - * session is still available but clients should not use it to obtain session attributes. + * Wrapper for protocol session that provides type-safe access to session attributes. + * <p> + * The underlying protocol session is still available but clients should not use it to obtain session attributes. */ public class AMQProtocolSession implements AMQVersionAwareProtocolSession { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/BlockingMethodFrameListener.java b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/BlockingMethodFrameListener.java index b865c51cb7..603e2ee10c 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/BlockingMethodFrameListener.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/protocol/BlockingMethodFrameListener.java @@ -32,31 +32,24 @@ import org.apache.qpid.protocol.AMQMethodListener; * incoming methods to a method listener implemented as a sub-class of this and hands off the processed method or * error to a consumer. The producer of the event does not have to wait for the consumer to take the event, so this * differs from a 'rendezvous' in that sense. - * - * <p/>BlockingMethodFrameListeners are used to coordinate waiting for replies to method calls that expect a response. + * <p> + * BlockingMethodFrameListeners are used to coordinate waiting for replies to method calls that expect a response. * They are always used in a 'one-shot' manner, that is, to recieve just one response. Usually the caller has to register * them as method listeners with an event dispatcher and remember to de-register them (in a finally block) once they * have been completed. - * - * <p/>The {@link #processMethod} must return <tt>true</tt> on any incoming method that it handles. This indicates to + * <p> + * The {@link #processMethod} must return <tt>true</tt> on any incoming method that it handles. This indicates to * this listeners that the method it is waiting for has arrived. Incoming methods are also filtered by channel prior to * being passed to the {@link #processMethod} method, so responses are only received for a particular channel. The * channel id must be passed to the constructor. - * - * <p/>Errors from the producer are rethrown to the consumer. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Accept notification of AMQP method events. <td> {@link AMQMethodEvent} - * <tr><td> Delegate handling of the method to another method listener. <td> {@link AMQMethodBody} - * <tr><td> Block until a method is handled by the delegated to handler. - * <tr><td> Propagate the most recent exception to the consumer. - * </table> - * - * @todo Might be neater if this method listener simply wrapped another that provided the method handling using a + * <p> + * Errors from the producer are rethrown to the consumer. + * <p> + * TODO Might be neater if this method listener simply wrapped another that provided the method handling using a * methodRecevied method. The processMethod takes an additional channelId, however none of the implementations * seem to use it. So wrapping the listeners is possible. - * @todo If the retrotranslator can handle it, could use a SynchronousQueue to implement this rendezvous. Need to + * <p> + * TODO If the retrotranslator can handle it, could use a SynchronousQueue to implement this rendezvous. Need to * check that SynchronousQueue has a non-blocking put method available. */ public abstract class BlockingMethodFrameListener extends BlockingWaiter<AMQMethodEvent> implements AMQMethodListener diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/security/CallbackHandlerRegistry.java b/qpid/java/client/src/main/java/org/apache/qpid/client/security/CallbackHandlerRegistry.java index ce6d9bdc50..6f99e53055 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/security/CallbackHandlerRegistry.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/security/CallbackHandlerRegistry.java @@ -44,23 +44,17 @@ import java.util.TreeMap; * authentication. It is capable of reading its configuration from a properties file containing call back handler * implementing class names for different SASL mechanism names. Instantiating this registry also has the effect of * configuring and registering the SASL client factory implementations using {@link DynamicSaslRegistrar}. - * - * <p/>The callback configuration should be specified in a properties file, refered to by the System property + * <p> + * The callback configuration should be specified in a properties file, refered to by the System property * "amp.callbackhandler.properties". The format of the properties file is: - * - * <p/><pre> + * <p> + * <pre> * CallbackHanlder.n.mechanism=fully.qualified.class.name where n is an ordinal * </pre> - * - * <p/>Where mechanism is an IANA-registered mechanism name and the fully qualified class name refers to a + * <p> + * Where mechanism is an IANA-registered mechanism name and the fully qualified class name refers to a * class that implements org.apache.qpid.client.security.AMQCallbackHanlder and provides a call back handler for the * specified mechanism. - * - * <p><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Parse callback properties. - * <tr><td> Provide mapping from SASL mechanisms to callback implementations. - * </table> */ public class CallbackHandlerRegistry { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/security/DynamicSaslRegistrar.java b/qpid/java/client/src/main/java/org/apache/qpid/client/security/DynamicSaslRegistrar.java index b43229292f..2be9a0ffde 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/security/DynamicSaslRegistrar.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/security/DynamicSaslRegistrar.java @@ -40,19 +40,16 @@ import java.util.TreeMap; * DynamicSaslRegistrar provides a collection of helper methods for reading a configuration file that contains a mapping * from SASL mechanism names to implementing client factory class names and registering a security provider with the * Java runtime system, that uses the configured client factory implementations. - * - * <p/>The sasl configuration should be specified in a properties file, refered to by the System property + * <p> + * The sasl configuration should be specified in a properties file, refered to by the System property * "amp.dynamicsaslregistrar.properties". The format of the properties file is: - * - * <p/><pre> + * <p> + * <pre> * mechanism=fully.qualified.class.name * </pre> - * - * <p/>Where mechanism is an IANA-registered mechanism name and the fully qualified class name refers to a class that + * <p> + * Where mechanism is an IANA-registered mechanism name and the fully qualified class name refers to a class that * implements javax.security.sasl.SaslClientFactory and provides the specified mechanism. - * - * <p><table id="crc"><caption>CRC Card</caption> <tr><th> Responsibilities <th> Collaborations <tr><td> Parse SASL - * mechanism properties. <tr><td> Create and register security provider for SASL mechanisms. </table> */ public class DynamicSaslRegistrar { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java b/qpid/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java index ed75e1f4c3..fab0bcd71f 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java @@ -34,18 +34,20 @@ import java.util.Set; import java.util.concurrent.CopyOnWriteArrayList; /** - * The state manager is responsible for managing the state of the protocol session. <p/> + * The state manager is responsible for managing the state of the protocol session. + * <p> * For each {@link org.apache.qpid.client.protocol.AMQProtocolHandler} there is a separate state manager. - * + * <p> * The AMQStateManager is now attached to the {@link org.apache.qpid.client.protocol.AMQProtocolHandler} and that is the sole point of reference so that * As the {@link AMQProtocolSession} changes due to failover the AMQStateManager need not be copied around. - * + * <p> * The StateManager works by any component can wait for a state change to occur by using the following sequence. - * - * <li>StateWaiter waiter = stateManager.createWaiter(Set<AMQState> states); + * <ul> + * <li>{@literal StateWaiter waiter = stateManager.createWaiter(Set<AMQState> states); } * <li> // Perform action that will cause state change * <li>waiter.await(); - * + * </ul> + * <p> * The two step process is required as there is an inherit race condition between starting a process that will cause * the state to change and then attempting to wait for that change. The interest in the change must be first set up so * that any asynchronous errors that occur can be delivered to the correct waiters. diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/state/StateWaiter.java b/qpid/java/client/src/main/java/org/apache/qpid/client/state/StateWaiter.java index fd2f003a56..75b863ca2b 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/state/StateWaiter.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/state/StateWaiter.java @@ -93,8 +93,8 @@ public class StateWaiter extends BlockingWaiter<AMQState> /** * Await for the required State to be achieved. - * - * <b>It is the responsibility of this class to remove the waiter from the StateManager + * <p> + * It is the responsibility of this class to remove the waiter from the StateManager * * @param timeout The time in milliseconds to wait for any of the states to be achieved. * @return The achieved state that was requested. diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/url/URLParser_0_10.java b/qpid/java/client/src/main/java/org/apache/qpid/client/url/URLParser_0_10.java index d81868f924..af5dbebb01 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/url/URLParser_0_10.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/url/URLParser_0_10.java @@ -25,30 +25,32 @@ import java.util.ArrayList; import java.util.List; /** - * The format Qpid URL is based on the AMQP one. - * The grammar is as follows: - * <p> qpid_url = "qpid:" [client_props "@"] port_addr_list ["/" future-parameters] - * <p> port_addr_list = [port_addr ","]* port_addr - * <p> port_addr = tcp_port_addr | tls_prot_addr | future_prot_addr - * <p> tcp_port_addr = tcp_id tcp_addr - * <p> tcp_id = "tcp:" | "" - * <p> tcp_addr = host [":" port] - * <p> host = <as per http://www.apps.ietf.org/> - * <p> port = number - * <p> tls_prot_addr = tls_id tls_addr - * <p> tls_id = "tls:" | "" - * <p> tls_addr = host [":" port] - * <p> future_prot_addr = future_prot_id future_prot_addr - * <p> future_prot_id = <placeholder, must end in ":". Example "sctp:"> - * <p> future_prot_addr = <placeholder, protocl-specific address> - * <p> future_parameters = <placeholder, not used in failover addresses> - * <p> client_props = [client_prop ";"]* client_prop - * <p> client_prop = prop "=" val - * <p> prop = chars as per <as per http://www.apps.ietf.org/> - * <p> val = valid as per <as per http://www.apps.ietf.org/> - * <p/> - * Ex: qpid:virtualhost=tcp:host-foo,test,client_id=foo@tcp:myhost.com:5672,virtualhost=prod; - * keystore=/opt/keystore@client_id2@tls:mysecurehost.com:5672 + * The format Qpid URL is based on the AMQP one. The grammar is as follows: + * <p> + * <p>{@literal qpid_url = "qpid:" [client_props "@"] port_addr_list ["/" future-parameters] } + * <p>{@literal port_addr_list = [port_addr ","]* port_addr } + * <p>{@literal port_addr = tcp_port_addr | tls_prot_addr | future_prot_addr } + * <p>{@literal tcp_port_addr = tcp_id tcp_addr } + * <p>{@literal tcp_id = "tcp:" | "" } + * <p>{@literal tcp_addr = host [":" port] } + * <p>{@literal host = <as per http://www.apps.ietf.org/> } + * <p>{@literal port = number } + * <p>{@literal tls_prot_addr = tls_id tls_addr } + * <p>{@literal tls_id = "tls:" | "" } + * <p>{@literal tls_addr = host [":" port] } + * <p>{@literal future_prot_addr = future_prot_id future_prot_addr } + * <p>{@literal future_prot_id = <placeholder, must end in ":". Example "sctp:"> } + * <p>{@literal future_prot_addr = <placeholder, protocl-specific address> } + * <p>{@literal future_parameters = <placeholder, not used in failover addresses> } + * <p>{@literal client_props = [client_prop ";"]* client_prop } + * <p>{@literal client_prop = prop "=" val } + * <p>{@literal prop = chars as per <as per http://www.apps.ietf.org/> } + * <p>{@literal val = valid as per <as per http://www.apps.ietf.org/> } + * <p> + * Ex: + * <p> + * {@literal qpid:virtualhost=tcp:host-foo,test,client_id=foo@tcp:myhost.com:5672,virtualhost=prod; + * keystore=/opt/keystore@client_id2@tls:mysecurehost.com:5672 } */ public class URLParser_0_10 { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/util/BlockingWaiter.java b/qpid/java/client/src/main/java/org/apache/qpid/client/util/BlockingWaiter.java index 22dc17e53c..53b6730ef7 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/util/BlockingWaiter.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/util/BlockingWaiter.java @@ -37,29 +37,22 @@ import java.util.concurrent.locks.ReentrantLock; * incoming Objects to a listener implemented as a sub-class of this and hands off the process or * error to a consumer. The producer of the event does not have to wait for the consumer to take the event, so this * differs from a 'rendezvous' in that sense. - * - * <p/>BlockingWaiters are used to coordinate when waiting for an an event that expect a response. + * <p> + * BlockingWaiters are used to coordinate when waiting for an an event that expect a response. * They are always used in a 'one-shot' manner, that is, to receive just one response. Usually the caller has to register * them as method listeners with an event dispatcher and remember to de-register them (in a finally block) once they * have been completed. - * - * <p/>The {@link #process} must return <tt>true</tt> on any incoming method that it handles. This indicates to + * <p> + * The {@link #process} must return <tt>true</tt> on any incoming method that it handles. This indicates to * this listeners that the object just processed ends the waiting process. - * - * <p/>Errors from the producer are rethrown to the consumer. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations </td> - * <tr><td> Accept generic objects as events for processing via {@link #process}. <td> - * <tr><td> Delegate handling and understanding of the object to a concrete implementation. <td> - * <tr><td> Block until {@link #process} determines that waiting is no longer required <td> - * <tr><td> Propagate the most recent exception to the consumer.<td> - * </table> - * - * @todo Interruption is caught but not handled. This could be allowed to fall through. This might actually be useful + * <p> + * Errors from the producer are rethrown to the consumer. + * <p> + * TODO Interruption is caught but not handled. This could be allowed to fall through. This might actually be useful * for fail-over where a thread is blocking when failure happens, it could be interrupted to abandon or retry * when this happens. At the very least, restore the interrupted status flag. - * @todo If the retrotranslator can handle it, could use a SynchronousQueue to implement this rendezvous. Need to + * <p> + * TODO If the retrotranslator can handle it, could use a SynchronousQueue to implement this rendezvous. Need to * check that SynchronousQueue has a non-blocking put method available. */ public abstract class BlockingWaiter<T> diff --git a/qpid/java/client/src/main/java/org/apache/qpid/client/util/FlowControllingBlockingQueue.java b/qpid/java/client/src/main/java/org/apache/qpid/client/util/FlowControllingBlockingQueue.java index c8d12142e6..b194ac88de 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/client/util/FlowControllingBlockingQueue.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/client/util/FlowControllingBlockingQueue.java @@ -30,10 +30,12 @@ import java.util.concurrent.ConcurrentLinkedQueue; /** * A blocking queue that emits events above a user specified threshold allowing the caller to take action (e.g. flow * control) to try to prevent the queue growing (much) further. The underlying queue itself is not bounded therefore the - * caller is not obliged to react to the events. <p/> This implementation is <b>only</b> safe where we have a single + * caller is not obliged to react to the events. + * <p> + * This implementation is <b>only</b> safe where we have a single * thread adding items and a single (different) thread removing items. - * - * @todo Make this implement java.util.Queue and hide the implementation. Then different queue types can be substituted. + * <p> + * TODO Make this implement java.util.Queue and hide the implementation. Then different queue types can be substituted. */ public class FlowControllingBlockingQueue { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/jms/ConnectionURL.java b/qpid/java/client/src/main/java/org/apache/qpid/jms/ConnectionURL.java index 3050e84419..2901a5f983 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/jms/ConnectionURL.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/jms/ConnectionURL.java @@ -25,9 +25,9 @@ import org.apache.qpid.framing.AMQShortString; /** Connection URL format - amqp://[user:pass@][clientid]/virtualhost?brokerlist='tcp://host:port?option=\'value\'&option=\'value\';tcp://host:port/virtualpath?option=\'value\''&failover='method?option=\'value\'&option='value''" + {@literal amqp://[user:pass@][clientid]/virtualhost?brokerlist='tcp://host:port?option=\'value\'&option=\'value\';tcp://host:port/virtualpath?option=\'value\''&failover='method?option=\'value\'&option='value''" } Options are of course optional except for requiring a single broker in the broker list. - The option seperator is defined to be either '&' or ',' + The option seperator is defined to be either {@literal '&' or ','} */ public interface ConnectionURL { diff --git a/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java b/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java index a3174aec7a..d7b16fcd6d 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java @@ -25,7 +25,7 @@ import javax.naming.NamingException; /** * A default implementation of {@link NameParser} - * <p/> + * <p> * Based on class from ActiveMQ. */ public class NameParserImpl implements NameParser diff --git a/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java b/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java index 76ec5f9498..1d7525ca91 100644 --- a/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java +++ b/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java @@ -44,13 +44,13 @@ import java.util.Map; /** * Based on class from ActiveMQ. * A read-only Context - * <p/> + * <p> * This version assumes it and all its subcontext are read-only and any attempt * to modify (e.g. through bind) will result in an OperationNotSupportedException. * Each Context in the tree builds a cache of the entries in all sub-contexts * to optimise the performance of lookup. - * </p> - * <p>This implementation is intended to optimise the performance of lookup(String) + * <p> + * This implementation is intended to optimise the performance of lookup(String) * to about the level of a HashMap get. It has been observed that the scheme * resolution phase performed by the JVM takes considerably longer, so for * optimum performance lookups should be coded like:</p> @@ -147,11 +147,6 @@ public class ReadOnlyContext implements Context, Serializable * to bind the remaining name. It returns a map containing all the bindings from the next context, plus * the context it just created (if it in fact created it). (the names are suitably extended by the segment * originally lopped off). - * - * @param name - * @param value - * @return - * @throws javax.naming.NamingException */ protected Map internalBind(String name, Object value) throws NamingException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java index 1b2eabdc86..73a906b81c 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java @@ -24,13 +24,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQChannelClosedException indicates that an operation cannot be performed becauase a channel has been closed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents a failed operation on a closed channel. - * </table> - * - * @todo Does this duplicate AMQChannelException? */ public class AMQChannelClosedException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java index df71ece787..55f0fe57b0 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java @@ -28,13 +28,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQChannelException indicates that an error that requires the channel to be closed has occurred. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents an error that rquires the channel to be closed. - * </table> - * - * @todo Does this duplicate AMQChannelClosedException? */ public class AMQChannelException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java index b2ce3c1b32..4417c0a141 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java @@ -25,15 +25,8 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQConnectionClosedException indicates that a connection has been closed. * - * <p/>This exception is really used as an event, in order that the method handler that raises it creates an event + * <p>This exception is really used as an event, in order that the method handler that raises it creates an event * which is propagated to the io handler, in order to notify it of the connection closure. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents a the closure of a connection. - * </table> - * - * @todo Should review where exceptions-as-events */ public class AMQConnectionClosedException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java index ef108eeb67..096c4ede80 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java @@ -29,13 +29,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQConnectionException indicates that an error that requires the channel to be closed has occurred. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents an error that rquires the channel to be closed. - * </table> - * - * @todo Does this duplicate AMQChannelClosedException? */ public class AMQConnectionException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java index d9a9ee0782..efadaae611 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java @@ -26,13 +26,6 @@ import java.util.Collection; /** * AMQConnectionFailureException indicates that a connection to a broker could not be formed. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents failure to connect to a broker. - * </table> - * - * @todo Not an AMQP exception as no status code. */ public class AMQConnectionFailureException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java index 5ec5c42ab9..38fbc8fc57 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java @@ -22,13 +22,6 @@ package org.apache.qpid; /** * AMQDisconnectedException indicates that a broker disconnected without failover. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents disconnection without failover by the broker. - * </table> - * - * @todo Not an AMQP exception as no status code. */ public class AMQDisconnectedException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java index 591202d934..3741cb9902 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java @@ -26,14 +26,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQException forms the root exception of all exceptions relating to the AMQ protocol. It provides space to associate * a required AMQ error code with the exception, which is a numeric value, with a meaning defined by the protocol. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents an exception condition associated with an AMQ protocol status code. - * </table> - * - * @todo This exception class is also used as a generic exception throughout Qpid code. This usage may not be strictly - * correct if this is to signify a protocol exception. Should review. */ public class AMQException extends Exception { @@ -117,9 +109,9 @@ public class AMQException extends Exception * Rethrown this exception as a new exception. * * Attempt to create a new exception of the same class if they have the default constructor of: - * {AMQConstant.class, String.class, Throwable.class} - * <p> - * Individual subclasses may override as requried to create a new instance. + * {AMQConstant.class, String.class, Throwable.class}. + * + * @return cloned exception */ public AMQException cloneForCurrentThread() { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java index 2bbaaef1fc..2592ab7662 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java @@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQInvalidArgumentException indicates that an invalid argument has been passed to an AMQP method. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents an error due to an invalid argument being passed to an AMQP method. - * </table> */ public class AMQInvalidArgumentException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java index c117968a29..d0a61cfeeb 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java @@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQInvalidRoutingKeyException indicates an error with a routing key having an invalid format. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents a format error in a routing key. - * </table> */ public class AMQInvalidRoutingKeyException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java index ab5141be9d..533a704a80 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java @@ -23,12 +23,7 @@ package org.apache.qpid; /** * AMQPInvalidClassException indicates an error when trying to store an illegally typed argument in a field table. * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents illegal argument type for field table values. - * </table> - * - * @todo Could just re-use an exising exception like IllegalArgumentException or ClassCastException. + * <p>TODO Could just re-use an exising exception like IllegalArgumentException or ClassCastException. */ public class AMQPInvalidClassException extends RuntimeException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java index 4ae8282af5..c36d2c5907 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java @@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQTimeoutException indicates that an expected response from a broker took too long. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Indicates that an expected response from a broker took too long. - * </table> */ public class AMQTimeoutException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java index 01a569b693..68cbc57216 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java @@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQUndeliveredException indicates that a message, marked immediate or mandatory, could not be delivered. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents failure to delivery a message that must be delivered. - * </table> */ public class AMQUndeliveredException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java index 82ffe583c3..902b12300f 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java @@ -22,15 +22,10 @@ package org.apache.qpid; /** * AMQUnresolvedAddressException indicates failure to resolve a socket address. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents failre to resolve a socket address. - * </table> - * - * @todo Not an AMQP exception as no status code. - * - * @todo Why replace java.nio.UnresolvedAddressException with this? This is checked, which may explain why, but it + * <p> + * TODO Not an AMQP exception as no status code. + * <p> + * TODO Why replace java.nio.UnresolvedAddressException with this? This is checked, which may explain why, but it * doesn't wrap the underlying exception. */ public class AMQUnresolvedAddressException extends AMQException diff --git a/qpid/java/common/src/main/java/org/apache/qpid/api/Message.java b/qpid/java/common/src/main/java/org/apache/qpid/api/Message.java index c0427c2f37..fff62424ca 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/api/Message.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/api/Message.java @@ -47,6 +47,7 @@ public interface Message * <li> To Socket (Stream) * </ul> * @param src - the data to append + * @throws IOException if there is an issue appending the data */ public void appendData(byte[] src) throws IOException; @@ -63,6 +64,7 @@ public interface Message * <li> To Socket (Stream) * </ul> * @param src - the data to append + * @throws IOException if there is an issue appending the data */ public void appendData(ByteBuffer src) throws IOException; @@ -78,6 +80,7 @@ public interface Message * <li> From Socket as and when it gets streamed * </ul> * @param target The target byte[] which the data gets copied to + * @throws IOException if there is an issue reading the data */ public void readData(byte[] target) throws IOException; @@ -94,7 +97,7 @@ public interface Message * </ul> * * @return A ByteBuffer containing data - * @throws IOException + * @throws IOException if there is an issue reading the data */ public ByteBuffer readData() throws IOException; diff --git a/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQCodecFactory.java b/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQCodecFactory.java index c81af9760b..220e33724a 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQCodecFactory.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQCodecFactory.java @@ -25,11 +25,6 @@ import org.apache.qpid.protocol.AMQVersionAwareProtocolSession; /** * AMQCodecFactory is a Mina codec factory. It supplies the encoders and decoders need to read and write the bytes to * the wire. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations. - * <tr><td> Supply the protocol decoder. <td> {@link AMQDecoder} - * </table> */ public class AMQCodecFactory { @@ -44,6 +39,7 @@ public class AMQCodecFactory * * @param expectProtocolInitiation <tt>true</tt> if the first frame received is going to be a protocol initiation * frame, <tt>false</tt> if it is going to be a standard AMQ data block. + * @param session protocol session (connection) */ public AMQCodecFactory(boolean expectProtocolInitiation, AMQVersionAwareProtocolSession session) { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQDecoder.java b/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQDecoder.java index ffdb7e6573..3ccd7e2031 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQDecoder.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQDecoder.java @@ -46,17 +46,11 @@ import java.util.ListIterator; * protocol initiation decoder. It is a cumulative decoder, which means that it can accumulate data to decode in the * buffer until there is enough data to decode. * - * <p/>One instance of this class is created per session, so any changes or configuration done at run time to the + * <p>One instance of this class is created per session, so any changes or configuration done at run time to the * decoder will only affect decoding of the protocol session data to which is it bound. * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Delegate protocol initiation to its decoder. <td> {@link ProtocolInitiation.Decoder} - * <tr><td> Delegate AMQP data to its decoder. <td> {@link AMQDataBlockDecoder} - * <tr><td> Accept notification that protocol initiation has completed. - * </table> - * - * @todo If protocol initiation decoder not needed, then don't create it. Probably not a big deal, but it adds to the + * <p> + * TODO If protocol initiation decoder not needed, then don't create it. Probably not a big deal, but it adds to the * per-session overhead. */ public class AMQDecoder @@ -78,6 +72,7 @@ public class AMQDecoder * Creates a new AMQP decoder. * * @param expectProtocolInitiation <tt>true</tt> if this decoder needs to handle protocol initiation. + * @param session protocol session (connection) */ public AMQDecoder(boolean expectProtocolInitiation, AMQVersionAwareProtocolSession session) { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/common/AMQPFilterTypes.java b/qpid/java/common/src/main/java/org/apache/qpid/common/AMQPFilterTypes.java index f50e65214c..483fbaea50 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/common/AMQPFilterTypes.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/common/AMQPFilterTypes.java @@ -24,11 +24,6 @@ import org.apache.qpid.framing.AMQShortString; /** * Specifies the different filter types for consumers that filter their messages. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent different consumer filter types. - * </table> */ public enum AMQPFilterTypes { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/common/QpidProperties.java b/qpid/java/common/src/main/java/org/apache/qpid/common/QpidProperties.java index 2c783aeaa4..25baf86fe6 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/common/QpidProperties.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/common/QpidProperties.java @@ -35,17 +35,13 @@ import java.util.Properties; * idea behind this, is that every build has these values incorporated directly into its jar file, so that code in the * wild can be identified, should its origination be forgotten. * - * <p/>To get the build version of any Qpid code call the {@link #main} method. This version string is usually also + * <p>To get the build version of any Qpid code call the {@link #main} method. This version string is usually also * printed to the console on broker start up. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><td>Load build versioning information into the runtime, for code identification purposes. - * </table> - * - * @todo Code to locate/load/log properties can be factored into a reusable properties utils class. Avoid having this + * <p> + * TODO Code to locate/load/log properties can be factored into a reusable properties utils class. Avoid having this * same snippet of loading code scattered in many places. - * - * @todo Could also add a build number property for a sequential build number assigned by an automated build system, for + * <p> + * TODO Could also add a build number property for a sequential build number assigned by an automated build system, for * build reproducability purposes. */ public class QpidProperties diff --git a/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyException.java b/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyException.java index b8181e3b87..cf08dafb49 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyException.java @@ -26,12 +26,8 @@ import org.apache.qpid.AMQException; * Indicates a failure to parse a property expansion. See {@link PropertyUtils} for the code that does property * expansions. * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaboration - * <tr><td> Represent failure to expand a property name into a value. - * </table> - * - * @todo Not an AMQP exception as no status code. + * <p> + * TODO Not an AMQP exception as no status code. */ public class PropertyException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyUtils.java b/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyUtils.java index 81702ee1ea..da366ffd0f 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyUtils.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/configuration/PropertyUtils.java @@ -26,15 +26,11 @@ import java.util.Iterator; /** * PropertyUtils provides helper methods for dealing with Java properties. * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Expand system properties into strings with named expansions. - * </table> - * - * @todo Make the lookup method generic by passing in the properties to use for the expansion, rather than hard coding + * <p> + * TODO Make the lookup method generic by passing in the properties to use for the expansion, rather than hard coding * as system properties. The expansion code has greater potential for re-use that way. - * - * @todo Some more property related code could be added to this utils class, which might more appropriately reside under + * <p> + * TODO Some more property related code could be added to this utils class, which might more appropriately reside under * org.apache.qpid.util. For example standardised code to load properties from a resource name, currently found in * QpidProperties and possibly other places could be moved here. */ diff --git a/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java b/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java index 3590254d27..2d017b1cd4 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java @@ -99,14 +99,14 @@ public class XidImpl implements Xid * +---+---+---+---+---+---+---+- -+---+---+- -+---+ * 0 4 5 6 6+g 6+g+b * format_id: an implementation specific format identifier - * <p/> + * <p> * gtrid_length: how many bytes of this form the transaction id - * <p/> + * <p> * bqual_length: how many bytes of this form the branch id - * <p/> + * <p> * data: a sequence of octets of at most 128 bytes containing the txn id and the * branch id - * <p/> + * <p> * Note - The sum of the two lengths must equal the length of the data field. * * @param xid an XID STring Form @@ -239,14 +239,14 @@ public class XidImpl implements Xid * +---+---+---+---+---+---+---+- -+---+---+- -+---+ * 0 4 5 6 6+g 6+g+b * format_id: an implementation specific format identifier - * <p/> + * <p> * gtrid_length: how many bytes of this form the transaction id - * <p/> + * <p> * bqual_length: how many bytes of this form the branch id - * <p/> + * <p> * data: a sequence of octets of at most 128 bytes containing the txn id and the * branch id - * <p/> + * <p> * Note - The sum of the two lengths must equal the length of the data field. * * @param xid an Xid to convert. diff --git a/qpid/java/common/src/main/java/org/apache/qpid/exchange/ExchangeDefaults.java b/qpid/java/common/src/main/java/org/apache/qpid/exchange/ExchangeDefaults.java index 5e59628fb6..9384002a72 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/exchange/ExchangeDefaults.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/exchange/ExchangeDefaults.java @@ -20,19 +20,12 @@ */ package org.apache.qpid.exchange; -import org.apache.qpid.framing.AMQShortString; - /** * Defines the names of the standard AMQP exchanges that every AMQP broker should provide. These exchange names * and type are given in the specification. * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Defines the standard AMQP exchange names. - * <tr><td> Defines the standard AMQP exchange types. - * </table> - * - * @todo A type safe enum, might be more appropriate for the exchange types. + * <p> + * TODO A type safe enum, might be more appropriate for the exchange types. */ public class ExchangeDefaults { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/ArithmeticExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/ArithmeticExpression.java index 47d970cfbd..35a7c93043 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/ArithmeticExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/ArithmeticExpression.java @@ -30,10 +30,6 @@ public abstract class ArithmeticExpression extends BinaryExpression protected static final int LONG = 2; protected static final int DOUBLE = 3; - /** - * @param left - * @param right - */ public ArithmeticExpression(Expression left, Expression right) { super(left, right); @@ -262,11 +258,6 @@ public abstract class ArithmeticExpression extends BinaryExpression return evaluate(lvalue, rvalue); } - /** - * @param lvalue - * @param rvalue - * @return - */ protected abstract Object evaluate(Object lvalue, Object rvalue); } diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/BinaryExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/BinaryExpression.java index 6467bbbe1f..47f97ea908 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/BinaryExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/BinaryExpression.java @@ -83,7 +83,7 @@ public abstract class BinaryExpression implements Expression * Returns the symbol that represents this binary expression. For example, addition is * represented by "+" * - * @return + * @return the expression symbol */ public abstract String getExpressionSymbol(); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/BooleanExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/BooleanExpression.java index 13e1604d5f..5b1cf54680 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/BooleanExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/BooleanExpression.java @@ -28,7 +28,7 @@ public interface BooleanExpression extends Expression { /** - * @param message + * @param message message to match * @return true if the expression evaluates to Boolean.TRUE. */ public boolean matches(FilterableMessage message); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/ComparisonExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/ComparisonExpression.java index 2cfb97dc6c..76f743000b 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/ComparisonExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/ComparisonExpression.java @@ -74,9 +74,6 @@ public abstract class ComparisonExpression extends BinaryExpression implements B private Pattern likePattern; - /** - * @param right - */ public LikeExpression(Expression right, String like, int escape) { super(right); @@ -316,9 +313,9 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } /** - * Only Numeric expressions can be used in >, >=, < or <= expressions.s + * Only Numeric expressions can be used in {@literal >, >=, < or <=} expressions. * - * @param expr + * @param expr expression to check */ public static void checkLessThanOperand(Expression expr) { @@ -341,10 +338,10 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } /** - * Validates that the expression can be used in == or <> expression. + * Validates that the expression can be used in {@literal == or <>} expression. * Cannot not be NULL TRUE or FALSE literals. * - * @param expr + * @param expr expression to check */ public static void checkEqualOperand(Expression expr) { @@ -374,10 +371,6 @@ public abstract class ComparisonExpression extends BinaryExpression implements B } } - /** - * @param left - * @param right - */ public ComparisonExpression(Expression left, Expression right) { super(left, right); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/ConstantExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/ConstantExpression.java index 20c9f1438a..978ad3af7d 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/ConstantExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/ConstantExpression.java @@ -181,8 +181,8 @@ public class ConstantExpression implements Expression * Encodes the value of string so that it looks like it would look like * when it was provided in a selector. * - * @param s - * @return + * @param s string to encode + * @return encoded string */ public static String encodeString(String s) { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/Expression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/Expression.java index 1030c7b588..64630c142e 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/Expression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/Expression.java @@ -27,6 +27,7 @@ public interface Expression { /** + * @param message message to evaluate * @return the value of this expression */ public Object evaluate(FilterableMessage message); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/filter/LogicExpression.java b/qpid/java/common/src/main/java/org/apache/qpid/filter/LogicExpression.java index f8ec19d23b..6de3a03ee0 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/filter/LogicExpression.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/filter/LogicExpression.java @@ -36,10 +36,6 @@ public abstract class LogicExpression extends BinaryExpression implements Boolea return new AndExpression(lvalue, rvalue); } - /** - * @param left - * @param right - */ public LogicExpression(BooleanExpression left, BooleanExpression right) { super(left, right); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java index fd42084429..c234a5e829 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java @@ -39,7 +39,8 @@ public abstract class AMQDataBlock implements EncodableAMQDataBlock /** * Writes the datablock to the specified buffer. - * @param buffer + * @param buffer the buffer to write to + * @throws IOException if there is a problem writing the output */ public abstract void writePayload(DataOutput buffer) throws IOException; diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java index 2373edb478..34e9211d1c 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java @@ -26,11 +26,6 @@ import org.apache.qpid.protocol.AMQConstant; /** * AMQFrameDecodingException indicates that an AMQP frame cannot be decoded because it does not have the correct * format as defined by the protocol. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represents a format error in a protocol frame. - * </table> */ public class AMQFrameDecodingException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java index 966a03605c..250b8e87d1 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java @@ -32,9 +32,12 @@ public interface AMQMethodBody extends AMQBody { public static final byte TYPE = 1; - /** AMQP version */ + /** AMQP major version + * @return the major version*/ public byte getMajor(); + /** AMQP minor version + * @return the minor version*/ public byte getMinor(); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBodyImpl.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBodyImpl.java index 571570d7b4..b1e8a73a0d 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBodyImpl.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBodyImpl.java @@ -46,7 +46,9 @@ public abstract class AMQMethodBodyImpl implements AMQMethodBody } - /** unsigned short */ + /** unsigned short + * + * @return body size*/ abstract protected int getBodySize(); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java index ab09c1de6d..0586a11619 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java @@ -22,13 +22,8 @@ package org.apache.qpid.framing; /** * AMQProtocolInstanceException indicates that the protocol class is incorrect in a header. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent incorrect protocol class in frame header. - * </table> - * - * @todo Not an AMQP exception as no status code. + * <p> + * TODO Not an AMQP exception as no status code. */ public class AMQProtocolClassException extends AMQProtocolHeaderException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java index 6b819364da..b0c92d9aab 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java @@ -24,13 +24,8 @@ import org.apache.qpid.AMQException; /** * AMQProtocolHeaderException indicates a format error in an AMQP frame header. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent format error in frame header. - * </table> - * - * @todo Not an AMQP exception as no status code. + * <p> + * TODO Not an AMQP exception as no status code. */ public class AMQProtocolHeaderException extends AMQException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java index 3165c373a9..cbc9e724de 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java @@ -22,13 +22,8 @@ package org.apache.qpid.framing; /** * AMQProtocolInstanceException indicates that the protocol instance is incorrect in a header. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent incorrect protocol instance in frame header. - * </table> - * - * @todo Not an AMQP exception as no status code. + * <p> + * TODO Not an AMQP exception as no status code. */ public class AMQProtocolInstanceException extends AMQProtocolHeaderException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java index c9b0973ea6..37c384bfc9 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java @@ -22,13 +22,8 @@ package org.apache.qpid.framing; /** * AMQProtocolInstanceException indicates that the client and server differ on expected protocol version in a header. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Represent incorrect protocol version in frame header. - * </table> - * - * @todo Not an AMQP exception as no status code. + * <p> + * TODO Not an AMQP exception as no status code. */ public class AMQProtocolVersionException extends AMQProtocolHeaderException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java index b681e782a3..71b5c5a623 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java @@ -30,16 +30,6 @@ import java.util.Collection; * AMQType is a type that represents the different possible AMQP field table types. It provides operations for each * of the types to perform tasks such as calculating the size of an instance of the type, converting types between AMQP * and Java native types, and reading and writing instances of AMQP types in binary formats to and from byte buffers. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Get the equivalent one byte identifier for a type. - * <tr><td> Calculate the size of an instance of an AMQP parameter type. <td> {@link EncodingUtils} - * <tr><td> Convert an instance of an AMQP parameter into a compatable Java object tagged with its AMQP type. - * <td> {@link AMQTypedValue} - * <tr><td> Write an instance of an AMQP parameter type to a byte buffer. <td> {@link EncodingUtils} - * <tr><td> Read an instance of an AMQP parameter from a byte buffer. <td> {@link EncodingUtils} - * </table> */ public enum AMQType { @@ -827,6 +817,7 @@ public enum AMQType * * @param value An instance of the type. * @param buffer The byte buffer to write it to. + * @throws IOException if there is a problem writing to the buffer */ public void writeToBuffer(Object value, DataOutput buffer) throws IOException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQTypedValue.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQTypedValue.java index 42a82eccba..e60ead7ad1 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQTypedValue.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQTypedValue.java @@ -33,15 +33,6 @@ import java.util.Map; * value. It provides the ability to read and write fully typed parameters to and from byte buffers. It also provides * the ability to create such parameters from Java native value and a type tag or to extract the native value and type * from one. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Create a fully typed AMQP value from a native type and a type tag. <td> {@link AMQType} - * <tr><td> Create a fully typed AMQP value from a binary representation in a byte buffer. <td> {@link AMQType} - * <tr><td> Write a fully typed AMQP value to a binary representation in a byte buffer. <td> {@link AMQType} - * <tr><td> Extract the type from a fully typed AMQP value. - * <tr><td> Extract the value from a fully typed AMQP value. - * </table> */ public abstract class AMQTypedValue { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/ContentHeaderBody.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/ContentHeaderBody.java index 131d796af4..f2a443d5fd 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/ContentHeaderBody.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/ContentHeaderBody.java @@ -76,11 +76,14 @@ public class ContentHeaderBody implements AMQBody } /** - * Helper method that is used currently by the persistence layer (by BDB at the moment). - * @param buffer - * @param size - * @return - * @throws AMQFrameDecodingException + * Helper method that is used currently by the persistence layer. + * @param buffer buffer to decode + * @param size size of the body + * + * @return the decoded header body + * @throws AMQFrameDecodingException if there is a decoding issue + * @throws AMQProtocolVersionException if there is a version issue + * @throws IOException if there is an IO issue */ public static ContentHeaderBody createFromBuffer(DataInputStream buffer, long size) throws AMQFrameDecodingException, AMQProtocolVersionException, IOException @@ -152,7 +155,9 @@ public class ContentHeaderBody implements AMQBody return weight; } - /** unsigned long but java can't handle that anyway when allocating byte array */ + /** unsigned long but java can't handle that anyway when allocating byte array + * + * @return the body size */ public long getBodySize() { return bodySize; diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/EncodingUtils.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/EncodingUtils.java index 1ecd8a13b7..f0dcad4916 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/EncodingUtils.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/EncodingUtils.java @@ -594,9 +594,9 @@ public class EncodingUtils /** * This is used for writing longstrs. - * - * @param buffer - * @param data + * @param buffer buffer to write to + * @param data data to write + * @throws IOException if there is an issue writing the output */ public static void writeLongstr(DataOutput buffer, byte[] data) throws IOException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/FieldTable.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/FieldTable.java index 588f33d755..c4220894a8 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/FieldTable.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/FieldTable.java @@ -73,7 +73,8 @@ public class FieldTable * Construct a new field table. * * @param buffer the buffer from which to read data. The length byte must be read already - * @param length the length of the field table. Must be > 0. + * @param length the length of the field table. Must be great than 0. + * @throws IOException if there is an issue reading the buffer */ public FieldTable(DataInput buffer, long length) throws IOException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/framing/ProtocolInitiation.java b/qpid/java/common/src/main/java/org/apache/qpid/framing/ProtocolInitiation.java index 0a06f0f1e9..0bb72aa88f 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/framing/ProtocolInitiation.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/framing/ProtocolInitiation.java @@ -137,6 +137,7 @@ public class ProtocolInitiation extends AMQDataBlock implements EncodableAMQData * @param in input buffer * @return true if we have enough data to decode the PI frame fully, false if more * data is required + * @throws IOException if there is an issue reading the input */ public boolean decodable(MarkableDataInput in) throws IOException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java b/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java index 0df9a85676..a6df71464b 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java @@ -33,28 +33,19 @@ import java.util.concurrent.TimeUnit; * the references taken, instantiating the service on the first reference, and shutting it down when the last * reference is released. * - * <p/>It is important to ensure that an executor service is correctly shut down as failing to do so prevents the JVM + * <p>It is important to ensure that an executor service is correctly shut down as failing to do so prevents the JVM * from terminating due to the existence of non-daemon threads. * - * <p/><table id="crc><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Provide a shared executor service. <td> {@link Executors} - * <tr><td> Shutdown the executor service when not needed. <td> {@link ExecutorService} - * <tr><td> Track references to the executor service. - * <tr><td> Provide configuration of the executor service. - * </table> - * - * @todo Might be more elegant to make this actually implement ExecutorService, providing better hiding of the + * <p> + * TODO Might be more elegant to make this actually implement ExecutorService, providing better hiding of the * implementation details. Also this class introduces a pattern (albeit specific to this usage) that could be * generalized to reference count anything. That is, on first instance call a create method, on release of last * instance call a destroy method. This could definitely be abstracted out as a re-usable piece of code; a * reference counting factory. It could then be re-used to do reference counting in other places (such as * messages). Countable objects have a simple create/destroy life cycle, capturable by an interface that the * ref counting factory can call to manage the lifecycle. - * - * @todo {@link #_poolSize} should be static? - * - * @todo The {@link #getPool()} method breaks the encapsulation of the reference counter. Generally when getPool is used + * <p> + * TODO The {@link #getPool()} method breaks the encapsulation of the reference counter. Generally when getPool is used * further checks are applied to ensure that the executor service has not been shutdown. This passes responsibility * for managing the lifecycle of the reference counted object onto the caller rather than neatly encapsulating it * here. Could think about adding more state to the lifecycle, to mark ref counted objects as invalid, and have an diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQConstant.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQConstant.java index 2a2342ca14..5e39409382 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQConstant.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQConstant.java @@ -28,20 +28,14 @@ import java.util.Map; /** * Defines constants for AMQP codes and also acts as a factory for creating such constants from the raw codes. Each * constant also defines a short human readable description of the constant. - * - * @todo Why would a constant be defined that is not in the map? Seems more natural that getConstant should raise an + * <p> + * TODO Why would a constant be defined that is not in the map? Seems more natural that getConstant should raise an * exception for an unknown constant. Or else provide an explanation of why this is so. Also, there is no way for * callers to determine the unknown status of a code except by comparing its name to "unknown code", which would * seem to render this scheme a little bit pointless? - * - * @todo Java has a nice enum construct for doing this sort of thing. Maybe this is done in the old style for Java 1.4 + * <p> + * TODO Java has a nice enum construct for doing this sort of thing. Maybe this is done in the old style for Java 1.4 * backward compatability? Now that is handled through retrotranslater it may be time to use enum. - * - * <p/><tabld id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Define the set of AMQP status codes. - * <tr><td> Provide a factory to lookup constants by their code. - * <tr><td> */ public final class AMQConstant { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodEvent.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodEvent.java index fd6907a152..9b38f7926b 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodEvent.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodEvent.java @@ -25,19 +25,14 @@ import org.apache.qpid.framing.AMQMethodBody; /** * AMQMethodEvent encapsulates an AMQP method call, and the channel on which that method call occurred. * - * <p/>Supplies the: + * <p>Supplies the: * <ul> * <li>channel id</li> * <li>protocol method</li> * </ul> * - * <p/>As the event contains the context in which it occurred, event listeners do not need to be statefull. + * <p>As the event contains the context in which it occurred, event listeners do not need to be statefull. * to listeners. Events are often handled by {@link AMQMethodListener}s. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Encapsulate an AMQP method call and the channel as the context for the method call. - * </table> */ public class AMQMethodEvent<M extends AMQMethodBody> { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java index 8cc9709c9c..3e7c67493d 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQMethodListener.java @@ -27,17 +27,11 @@ import org.apache.qpid.framing.AMQMethodBody; * AMQMethodListener is a listener that receives notifications of AMQP methods. The methods are packaged as events in * {@link AMQMethodEvent}. * - * <p/>An event listener may be associated with a particular context, usually an AMQP channel, and in addition to + * <p>An event listener may be associated with a particular context, usually an AMQP channel, and in addition to * receiving method events will be notified of errors on that context. This enables listeners to perform any clean * up that they need to do before the context is closed or retried. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Accept notification of AMQP method events. <td> {@link AMQMethodEvent} - * <tr><td> Accept notification of errors on the event context. - * </table> - * - * @todo Document why the exception is passed to the error method. Is it so that the exception can be passed + * <p> + * TODO Document why the exception is passed to the error method. Is it so that the exception can be passed * from the event handling thread to another thread and rethown from there? It is unusual to pass exceptions as * method arguments, because they have their own mechanism for propagating through the call stack, so some * explanation ought to be provided. @@ -49,14 +43,14 @@ public interface AMQMethodListener * * @param evt The AMQP method event (contains the method and channel). * - * @return <tt>true</tt> if the handler processes the method frame, <tt>false<tt> otherwise. Note that this does + * @return true if the handler processes the method frame, false otherwise. Note that this does * not prohibit the method event being delivered to subsequent listeners but can be used to determine if * nobody has dealt with an incoming method frame. * - * @throws Exception if an error has occurred. This exception may be delivered to all registered listeners using + * @throws AMQException if an error has occurred. This exception may be delivered to all registered listeners using * the error() method (see below) allowing them to perform cleanup if necessary. - * - * @todo Consider narrowing the exception. + * <p> + * TODO Consider narrowing the exception. */ <B extends AMQMethodBody> boolean methodReceived(AMQMethodEvent<B> evt) throws AMQException; diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQProtocolWriter.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQProtocolWriter.java index 65884e4950..0a050becdc 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQProtocolWriter.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQProtocolWriter.java @@ -26,11 +26,6 @@ import org.apache.qpid.framing.AMQDataBlock; * AMQProtocolWriter provides a method to write a frame of data 'to the wire', in the context of the object * that implements the method, usually some sort of session. The block of data, encapsulated by {@link AMQDataBlock}, * will be encoded as it is written. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Write an encoded block of data to the write, in the context of a session. - * </table> */ public interface AMQProtocolWriter { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQVersionAwareProtocolSession.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQVersionAwareProtocolSession.java index 33604b05d9..0c643f6322 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQVersionAwareProtocolSession.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/AMQVersionAwareProtocolSession.java @@ -34,13 +34,8 @@ import java.nio.ByteBuffer; /** * AMQVersionAwareProtocolSession is implemented by all AMQP session classes, that need to provide an awareness to * callers of the version of the AMQP protocol that they are able to work with. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Provide the method registry for a specific version of the AMQP. - * </table> - * - * @todo Why is this a seperate interface to {@link ProtocolVersionAware}, could they be combined into a single + * <p> + * TODO Why is this a seperate interface to {@link ProtocolVersionAware}, could they be combined into a single * interface and one of them eliminated? Move getRegistry method to ProtocolVersionAware, make the sessions * implement AMQProtocolWriter directly and drop this interface. */ diff --git a/qpid/java/common/src/main/java/org/apache/qpid/protocol/ProtocolVersionAware.java b/qpid/java/common/src/main/java/org/apache/qpid/protocol/ProtocolVersionAware.java index 56f950dd85..f12cd9af8e 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/protocol/ProtocolVersionAware.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/protocol/ProtocolVersionAware.java @@ -25,11 +25,6 @@ import org.apache.qpid.framing.ProtocolVersion; /** * ProtocolVersionAware is implemented by all AMQP handling classes, that need to provide an awareness to callers of * the version of the AMQP protocol that they are able to handle. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities - * <tr><td> Report the major and minor AMQP version handled. - * </table> */ public interface ProtocolVersionAware { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/Connection.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/Connection.java index 3547205df1..7c604e8e8e 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/Connection.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/Connection.java @@ -54,7 +54,7 @@ import java.util.concurrent.atomic.AtomicBoolean; * * @author Rafael H. Schloming * - * @todo the channels map should probably be replaced with something + * TODO the channels map should probably be replaced with something * more efficient, e.g. an array or a map implementation that can use * short instead of Short */ diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/ConnectionSettings.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/ConnectionSettings.java index 2ff08fd751..d410e19a24 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/ConnectionSettings.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/ConnectionSettings.java @@ -109,6 +109,7 @@ public class ConnectionSettings * Gets the heartbeat interval (seconds) for 0-8/9/9-1 protocols. * 0 means heartbeating is disabled. * null means use the broker-supplied value. + * @return the heartbeat interval */ public Integer getHeartbeatInterval08() { @@ -129,6 +130,7 @@ public class ConnectionSettings /** * Gets the heartbeat interval (seconds) for the 0-10 protocol. * 0 means heartbeating is disabled. + * @return the heartbeat interval */ public int getHeartbeatInterval010() { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/Session.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/Session.java index 8b29d6e424..90288eedcc 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/Session.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/Session.java @@ -1206,6 +1206,7 @@ public class Session extends SessionInvoker /** * An auxiliary method for test purposes only + * @return true if flow is blocked */ public boolean isFlowBlocked() { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Decoder.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Decoder.java index fb3f91a3ce..6c027adcad 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Decoder.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Decoder.java @@ -82,7 +82,7 @@ public interface Decoder * The uuid type encodes a universally unique id as defined by RFC-4122. * The format and operations for this type can be found in section 4.1.2 of RFC-4122. * - * return a universally unique id as defined by RFC-4122. + * @return a universally unique id as defined by RFC-4122. */ UUID readUuid(); @@ -114,14 +114,14 @@ public interface Decoder * Note that the encoded size refers to the number of octets of unicode, not necessarily the number of unicode * characters since the UTF-8 unicode may include multi-byte character sequences. * - * return a string. + * @return a string. */ String readStr16(); /** * The vbin8 type encodes up to 255 octets of opaque binary data. * - * return a byte array. + * @return a byte array. */ byte[] readVbin8(); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Encoder.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Encoder.java index 5a3cec5616..a9eea13104 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Encoder.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/codec/Encoder.java @@ -60,7 +60,7 @@ public interface Encoder /** * The uint64 type is a 64-bit unsigned integral value encoded in network byte order. * - * @param b the unsigned integer to be encoded. + * @param l the unsigned integer to be encoded. */ void writeUint64(long l); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/transport/network/NetworkConnection.java b/qpid/java/common/src/main/java/org/apache/qpid/transport/network/NetworkConnection.java index 1b8bbebdf5..2810e7a9e1 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/transport/network/NetworkConnection.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/transport/network/NetworkConnection.java @@ -34,12 +34,12 @@ public interface NetworkConnection void close(); /** - * Returns the remote address of the underlying socket. + * @return the remote address of the underlying socket. */ SocketAddress getRemoteAddress(); /** - * Returns the local address of the underlying socket. + * @return the local address of the underlying socket. */ SocketAddress getLocalAddress(); diff --git a/qpid/java/common/src/main/java/org/apache/qpid/typedmessage/TypedBytesContentReader.java b/qpid/java/common/src/main/java/org/apache/qpid/typedmessage/TypedBytesContentReader.java index 0ba865f1e6..674a0e9468 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/typedmessage/TypedBytesContentReader.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/typedmessage/TypedBytesContentReader.java @@ -54,7 +54,7 @@ public class TypedBytesContentReader implements TypedBytesCodes * Check that there is at least a certain number of bytes available to read * * @param len the number of bytes - * @throws javax.jms.MessageEOFException if there are less than len bytes available to read + * @throws EOFException if there are less than len bytes available to read */ public void checkAvailable(int len) throws EOFException { @@ -183,7 +183,8 @@ public class TypedBytesContentReader implements TypedBytesCodes * Note that this method reads a unicode character as two bytes from the stream * * @return the character read from the stream - * @throws javax.jms.JMSException + * @throws EOFException if there are less than the required bytes available to read + * @throws TypedBytesFormatException if the current write type is not compatible */ public char readChar() throws EOFException, TypedBytesFormatException { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/util/CommandLineParser.java b/qpid/java/common/src/main/java/org/apache/qpid/util/CommandLineParser.java index 3d17bbf6ea..0482ac7878 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/util/CommandLineParser.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/util/CommandLineParser.java @@ -31,13 +31,13 @@ import java.util.regex.Pattern; /** * CommandLineParser provides a utility for specifying the format of a command line and parsing command lines to ensure - * that they fit their specified format. A command line is made up of flags and options, both may be refered to as + * that they fit their specified format. A command line is made up of flags and options, both may be referred to as * options. A flag is an option that does not take an argument (specifying it means it has the value 'true' and not * specifying it means it has the value 'false'). Options must take arguments but they can be set up with defaults so - * that they take a default value when not set. Options may be mandatory in wich case it is an error not to specify + * that they take a default value when not set. Options may be mandatory in which case it is an error not to specify * them on the command line. Flags are never mandatory because they are implicitly set to false when not specified. * - * <p/>Some example command lines are: + * <p>Some example command lines are: * * <ul> * <li>This one has two options that expect arguments: @@ -52,14 +52,15 @@ import java.util.regex.Pattern; * <pre> * jar -tvf mytar.tar * </pre> + * </ul> * - * <p/>The parsing rules are: + * <p>The parsing rules are: * * <ol> * <li>Flags may be combined after a single '-' because they never take arguments. Normally such flags are single letter * flags but this is only a convention and not enforced. Flags of more than one letter are usually specified on their own. * <li>Options expecting arguments must always be on their own. - * <li>The argument to an option may be seperated from it by whitespace or appended directly onto the option. + * <li>The argument to an option may be separated from it by whitespace or appended directly onto the option. * <li>The argument to an option may never begin with a '-' character. * <li>All other arguments not beginning with a '-' character are free arguments that do not belong to any option. * <li>The second or later of a set of duplicate or repeated flags are ignored. @@ -70,18 +71,8 @@ import java.util.regex.Pattern; * the "bar" argument. * </ol> * - * <p/>By default, unknown options are simply ignored if specified on the command line. This behaviour may be changed + * <p>By default, unknown options are simply ignored if specified on the command line. This behaviour may be changed * so that the parser reports all unknowns as errors by using the {@link #setErrorsOnUnknowns} method. - * - * <p><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Accept a command line specification. - * <tr><td> Parse a command line into properties, validating it against its specification. - * <tr><td> Report all errors between a command line and its specification. - * <tr><td> Provide a formatted usage string for a command line. - * <tr><td> Provide a formatted options in force string for a command line. - * <tr><td> Allow errors on unknowns behaviour to be turned on or off. - * </table> */ public class CommandLineParser { @@ -106,7 +97,7 @@ public class CommandLineParser * array may therefore easily be used to configure the command line parser in a single method call with an easily * readable format. * - * <p/>Each array of strings must be 2, 3, 4 or 5 elements long. If any of the last three elements are missing they + * <p>Each array of strings must be 2, 3, 4 or 5 elements long. If any of the last three elements are missing they * are assumed to be null. The elements specify the following parameters: * <ol> * <li>The name of the option without the leading '-'. For example, "file". To specify the format of the 'free' @@ -121,7 +112,7 @@ public class CommandLineParser * this is ignored for flags. * <li>A regular expression describing the format that the argument must take. Ignored if null. * </ol> - * <p/>An example call to this constructor is: + * <p>An example call to this constructor is: * * <pre> * CommandLineParser commandLine = new CommandLineParser( @@ -234,7 +225,7 @@ public class CommandLineParser * Parses a set of command line arguments into a set of properties, keyed by the argument flag. The free arguments * are keyed by integers as strings starting at "1" and then "2", ... and so on. * - * <p/>See the class level comment for a description of the parsing rules. + * <p>See the class level comment for a description of the parsing rules. * * @param args The command line arguments. * @@ -488,6 +479,7 @@ public class CommandLineParser /** * If a command line has been parsed, calling this method sets all of its parsed options into the specified properties. + * @param properties properties */ public void addCommandLineToProperties(Properties properties) { @@ -508,7 +500,7 @@ public class CommandLineParser * to be called to use this parser a second time which is not likely seeing as a command line is usually only * specified once. However, it is exposed as a public method for the rare case where this may be done. * - * <p/>Cleans the internal state of this parser, removing all stored errors and information about the options in + * <p>Cleans the internal state of this parser, removing all stored errors and information about the options in * force. */ public void reset() @@ -643,11 +635,6 @@ public class CommandLineParser * Holds information about a command line options. This includes what its name is, whether or not it is a flag, * whether or not it is mandatory, what its user comment is, what its argument reminder text is and what its * regular expression format is. - * - * <p><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Hold details of a command line option. - * </table> */ protected static class CommandLineOption { diff --git a/qpid/java/common/src/main/java/org/apache/qpid/util/FileUtils.java b/qpid/java/common/src/main/java/org/apache/qpid/util/FileUtils.java index f48103c650..dd347b54eb 100644 --- a/qpid/java/common/src/main/java/org/apache/qpid/util/FileUtils.java +++ b/qpid/java/common/src/main/java/org/apache/qpid/util/FileUtils.java @@ -37,12 +37,6 @@ import java.util.List; * FileUtils provides some simple helper methods for working with files. It follows the convention of wrapping all * checked exceptions as runtimes, so code using these methods is free of try-catch blocks but does not expect to * recover from errors. - * - * <p/><table id="crc"><caption>CRC Card</caption> - * <tr><th> Responsibilities <th> Collaborations - * <tr><td> Read a text file as a string. - * <tr><td> Open a file or default resource as an input stream. - * </table> */ public class FileUtils { @@ -214,7 +208,7 @@ public class FileUtils * * @param src The source file name. * @param dst The destination file name. - * @throws IOException + * @throws IOException if there is an issue copying the file */ public static void copyCheckedEx(File src, File dst) throws IOException { @@ -228,7 +222,7 @@ public class FileUtils * * @param in The InputStream * @param dst The destination file name. - * @throws IOException + * @throws IOException if there is an issue copying the stream */ public static void copy(InputStream in, File dst) throws IOException { @@ -383,7 +377,7 @@ public class FileUtils * @param file the file to search * @param search the search String * - * @throws java.io.IOException + * @throws java.io.IOException if there is an issue searching the file * @return the list of matching entries */ public static List<String> searchFile(File file, String search) diff --git a/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java b/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java index c4cfeaba48..a972d6cda0 100644 --- a/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java +++ b/qpid/java/jca/src/main/java/org/apache/qpid/ra/QpidRASessionImpl.java @@ -1230,7 +1230,6 @@ public class QpidRASessionImpl implements Session, QueueSession, TopicSession, X /** * Get the XA resource * @return The XA resource - * @exception IllegalStateException If non XA connection */ public XAResource getXAResource() { @@ -1713,8 +1712,8 @@ public class QpidRASessionImpl implements Session, QueueSession, TopicSession, X } /** - * @throws SystemException - * @throws RollbackException + * throws SystemException + * throws RollbackException * */ public void checkState() throws JMSException diff --git a/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java b/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java index 3d9a88adb5..9654d06ef3 100644 --- a/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java +++ b/qpid/java/jca/src/main/java/org/apache/qpid/ra/inflow/QpidActivationSpec.java @@ -452,7 +452,7 @@ public class QpidActivationSpec extends ConnectionFactoryProperties implements A /** * Set the prefetch low - * @param value The value + * @param prefetchLow The value */ public void setPrefetchLow(final Integer prefetchLow) { @@ -480,7 +480,7 @@ public class QpidActivationSpec extends ConnectionFactoryProperties implements A /** * Set the prefetch high - * @param value The value + * @param prefetchHigh The value */ public void setPrefetchHigh(final Integer prefetchHigh) { diff --git a/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java b/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java index 32e5fbd125..b6e1ed22ff 100644 --- a/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java +++ b/qpid/java/management/common/src/main/java/org/apache/qpid/management/common/mbeans/ManagedExchange.java @@ -134,8 +134,8 @@ public interface ManagedExchange /** * Removes an exchange binding from a queue. * - * @param exchangeName the Exchange name - * @param routingKey the routing key + * @param queueName the Queue name + * @param binding the binding key * @throws IOException * @throws JMException * @since Qpid JMX API 1.8 diff --git a/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java b/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java index faac704dbc..977cc38c2f 100644 --- a/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java +++ b/qpid/java/management/example/src/main/java/org/apache/qpid/example/jmxexample/QueueInformation.java @@ -64,13 +64,15 @@ public class QueueInformation /** * Params: - * 0: host, e.g. eqd-myserver.mydomain.com - * 1: port, e.g. 8999 - * 2: vhost e.g. dev-only - * 3: username, e.g. guest - * 4: pwd, e.g. guest - * 5: loop pause, no value indicates one-off, any other value is millisecs - * ..: attributes=<csv attribute list> , queue=<csv queue list> + * <p> + * <p>0: host, e.g. eqd-myserver.mydomain.com + * <p>1: port, e.g. 8999 + * <p>2: vhost e.g. dev-only + * <p>3: username, e.g. guest + * <p>4: pwd, e.g. guest + * <p>5: loop pause, no value indicates one-off, any other value is millisecs + * <p>..: {@literal attributes=<csv attribute list> , queue=<csv queue list>} + * <p> * The queue list can use wildcards such as * and ?. Basically any value * that JMX will accept in the query string for t name='' value of the queue. */ diff --git a/qpid/java/perftests/src/main/java/org/apache/qpid/disttest/ConfigFileHelper.java b/qpid/java/perftests/src/main/java/org/apache/qpid/disttest/ConfigFileHelper.java index ee374e180d..a465813159 100644 --- a/qpid/java/perftests/src/main/java/org/apache/qpid/disttest/ConfigFileHelper.java +++ b/qpid/java/perftests/src/main/java/org/apache/qpid/disttest/ConfigFileHelper.java @@ -27,7 +27,7 @@ public class ConfigFileHelper { /** * Returns absolute paths to the config file(s). - * <p/> + * <p> * If testConfigPath is a directory, its .js and .json files are returned. * Otherwise, the returned list just contains testConfigPath. */ diff --git a/qpid/java/qpid-systests-parent/pom.xml b/qpid/java/qpid-systests-parent/pom.xml index d5d3d60198..d59e373ed4 100644 --- a/qpid/java/qpid-systests-parent/pom.xml +++ b/qpid/java/qpid-systests-parent/pom.xml @@ -229,6 +229,13 @@ </configuration> </plugin> + <plugin> + <artifactId>maven-javadoc-plugin</artifactId> + <configuration> + <!--The systests arent currently deployed, and their javadoc is rather broken anyway --> + <skip>true</skip> + </configuration> + </plugin> </plugins> </build> diff --git a/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java b/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java index 72ca48e1c9..0c94030ec6 100644 --- a/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java +++ b/qpid/java/tools/src/main/java/org/apache/qpid/testkit/TestLauncher.java @@ -56,7 +56,7 @@ import org.apache.qpid.thread.Threading; * or both, each on it's own separate thread. * * If con_count == ssn_count, then each entity created will have - * it's own Connection. Else if con_count < ssn_count, then + * it's own Connection. Else if con_count {@literal <} ssn_count, then * a connection will be shared by ssn_count/con_count # of entities. * * The if both sender and receiver options are set, it will |