You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ro...@apache.org on 2014/08/08 17:06:08 UTC
svn commit: r1616791 - in /qpid/trunk/qpid/java:
amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/
client/src/main/java/org/apache/qpid/jndi/
common/src/main/java/org/apache/qpid/
common/src/main/java/org/apache/qpid/dtx/ common/src/...
Author: robbie
Date: Fri Aug 8 15:06:07 2014
New Revision: 1616791
URL: http://svn.apache.org/r1616791
Log:
QPID-5980: initial javadoc fixups
Modified:
qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java
qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java
qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java
qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java
qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java
Modified: qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java (original)
+++ qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/NameParserImpl.java Fri Aug 8 15:06:07 2014
@@ -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
Modified: qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java (original)
+++ qpid/trunk/qpid/java/amqp-1-0-client-jms/src/main/java/org/apache/qpid/amqp_1_0/jms/jndi/ReadOnlyContext.java Fri Aug 8 15:06:07 2014
@@ -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
* 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
{
Modified: qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java (original)
+++ qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/NameParserImpl.java Fri Aug 8 15:06:07 2014
@@ -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
Modified: qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java (original)
+++ qpid/trunk/qpid/java/client/src/main/java/org/apache/qpid/jndi/ReadOnlyContext.java Fri Aug 8 15:06:07 2014
@@ -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
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelClosedException.java Fri Aug 8 15:06:07 2014
@@ -24,13 +24,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQChannelException.java Fri Aug 8 15:06:07 2014
@@ -28,13 +28,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionClosedException.java Fri Aug 8 15:06:07 2014
@@ -25,15 +25,8 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionException.java Fri Aug 8 15:06:07 2014
@@ -29,13 +29,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQConnectionFailureException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQDisconnectedException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java Fri Aug 8 15:06:07 2014
@@ -26,14 +26,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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 Except
* 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()
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidArgumentException.java Fri Aug 8 15:06:07 2014
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQInvalidRoutingKeyException.java Fri Aug 8 15:06:07 2014
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQPInvalidClassException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQTimeoutException.java Fri Aug 8 15:06:07 2014
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUndeliveredException.java Fri Aug 8 15:06:07 2014
@@ -24,11 +24,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/AMQUnresolvedAddressException.java Fri Aug 8 15:06:07 2014
@@ -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
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/dtx/XidImpl.java Fri Aug 8 15:06:07 2014
@@ -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.
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQDataBlock.java Fri Aug 8 15:06:07 2014
@@ -39,7 +39,8 @@ public abstract class AMQDataBlock imple
/**
* 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;
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQFrameDecodingException.java Fri Aug 8 15:06:07 2014
@@ -26,11 +26,6 @@ import org.apache.qpid.protocol.AMQConst
/**
* 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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQMethodBody.java Fri Aug 8 15:06:07 2014
@@ -32,9 +32,12 @@ public interface AMQMethodBody extends A
{
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();
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolClassException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolHeaderException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolInstanceException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQProtocolVersionException.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/framing/AMQType.java Fri Aug 8 15:06:07 2014
@@ -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
{
Modified: qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java?rev=1616791&r1=1616790&r2=1616791&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java (original)
+++ qpid/trunk/qpid/java/common/src/main/java/org/apache/qpid/pool/ReferenceCountingExecutorService.java Fri Aug 8 15:06:07 2014
@@ -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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org