[hornetq-commits] JBoss hornetq SVN: r8777 - in trunk/src/main/org/hornetq/api: core/client and 4 other directories.

Author: jmesnil Date: 2010-01-08 06:02:17 -0500 (Fri, 08 Jan 2010) New Revision: 8777 Modified: trunk/src/main/org/hornetq/api/core/FilterConstants.java trunk/src/main/org/hornetq/api/core/HornetQBuffers.java trunk/src/main/org/hornetq/api/core/client/HornetQClient.java trunk/src/main/org/hornetq/api/core/client/loadbalance/RoundRobinConnectionLoadBalancingPolicy.java trunk/src/main/org/hornetq/api/core/management/HornetQComponentControl.java trunk/src/main/org/hornetq/api/core/management/ManagementHelper.java trunk/src/main/org/hornetq/api/core/management/NotificationType.java trunk/src/main/org/hornetq/api/core/management/Operation.java trunk/src/main/org/hornetq/api/core/management/Parameter.java trunk/src/main/org/hornetq/api/core/management/ResourceNames.java trunk/src/main/org/hornetq/api/jms/HornetQJMSClient.java trunk/src/main/org/hornetq/api/jms/HornetQJMSConstants.java trunk/src/main/org/hornetq/api/jms/management/JMSManagementHelper.java trunk/src/main/org/hornetq/api/jms/management/SubscriptionInfo.java Log: javadoc fixes Modified: trunk/src/main/org/hornetq/api/core/FilterConstants.java =================================================================== --- trunk/src/main/org/hornetq/api/core/FilterConstants.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/FilterConstants.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -15,7 +15,7 @@ /** * Constants representing pre-defined message attributes that can be referenced in HornetQ core - * filter expressions + * filter expressions. * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @@ -23,19 +23,47 @@ */ public class FilterConstants { + /** + * Name of the HornetQ Message expiration header. + */ public static final SimpleString HORNETQ_EXPIRATION = new SimpleString("HQExpiration"); + /** + * Name of the HornetQ Message durable header. + */ public static final SimpleString HORNETQ_DURABLE = new SimpleString("HQDurable"); + /** + * Value for the Durable header when the message is non-durable. + */ public static final SimpleString NON_DURABLE = new SimpleString("NON_DURABLE"); + /** + * Value for the Durable header when the message is durable. + */ public static final SimpleString DURABLE = new SimpleString("DURABLE"); + /** + * Name of the HornetQ Message timestamp header. + */ public static final SimpleString HORNETQ_TIMESTAMP = new SimpleString("HQTimestamp"); + /** + * Name of the HornetQ Message priority header. + */ public static final SimpleString HORNETQ_PRIORITY = new SimpleString("HQPriority"); + /** + * Name of the HornetQ Message size header. + */ public static final SimpleString HORNETQ_SIZE = new SimpleString("HQSize"); + /** + * All HornetQ headers are prepended by this prefix. + */ public static final SimpleString HORNETQ_PREFIX = new SimpleString("HQ"); + + private FilterConstants() + { + } } Modified: trunk/src/main/org/hornetq/api/core/HornetQBuffers.java =================================================================== --- trunk/src/main/org/hornetq/api/core/HornetQBuffers.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/HornetQBuffers.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -90,4 +90,8 @@ { return new ChannelBufferWrapper(ChannelBuffers.buffer(size)); } + + private HornetQBuffers() + { + } } Modified: trunk/src/main/org/hornetq/api/core/client/HornetQClient.java =================================================================== --- trunk/src/main/org/hornetq/api/core/client/HornetQClient.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/client/HornetQClient.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -138,7 +138,7 @@ * Creates a ClientConnectionFactory using a TransportConfiguration of the server and a backup if needed. * * @param connectorConfig The TransportConfiguration of the server to connect to. - * @param backupConnectorConfig The TransportConfiguration of the backup server to connect to (or {@code null}�if there is no backup) + * @param backupConnectorConfig The TransportConfiguration of the backup server to connect to (or {@code null} if there is no backup) * @return The ClientSessionFactory. */ public static ClientSessionFactory createClientSessionFactory(final TransportConfiguration connectorConfig, @@ -158,5 +158,7 @@ return new ClientSessionFactoryImpl(connectorConfig); } - + private HornetQClient() + { + } } Modified: trunk/src/main/org/hornetq/api/core/client/loadbalance/RoundRobinConnectionLoadBalancingPolicy.java =================================================================== --- trunk/src/main/org/hornetq/api/core/client/loadbalance/RoundRobinConnectionLoadBalancingPolicy.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/client/loadbalance/RoundRobinConnectionLoadBalancingPolicy.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -19,7 +19,7 @@ * RoundRobinConnectionLoadBalancingPolicy corresponds to a round-robin load-balancing policy. * * <br> - * The first call to {@link #select(int)} will return a random integer between {@code 0} (inclusive) and {@code max}�(exclusive). + * The first call to {@link #select(int)} will return a random integer between {@code 0} (inclusive) and {@code max} (exclusive). * Subsequent calls will then return an integer in a round-robin fashion. * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> Modified: trunk/src/main/org/hornetq/api/core/management/HornetQComponentControl.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/HornetQComponentControl.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/HornetQComponentControl.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -14,7 +14,7 @@ package org.hornetq.api.core.management; /** - * A HornetQComponentControl is used to manage the lifecycle of a HornetQ components. + * A HornetQComponentControl is used to manage the life cycle of a HornetQ component. * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> */ Modified: trunk/src/main/org/hornetq/api/core/management/ManagementHelper.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/ManagementHelper.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/ManagementHelper.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -24,10 +24,9 @@ import org.hornetq.utils.json.JSONArray; import org.hornetq.utils.json.JSONObject; -/* +/** + * Helper class to use HornetQ Core messages to manage server resources. * - * Operation params and results are encoded as JSON arrays - * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @@ -359,7 +358,7 @@ /** * Returns the result of an operation invocation or an attribute value. - * + * <br> * If an error occurred on the server, {@link #hasOperationSucceeded(Message)} will return {@code false}. * and the result will be a String corresponding to the server exception. */ @@ -383,7 +382,7 @@ /** * Returns the result of an operation invocation or an attribute value. - * + * <br> * If an error occurred on the server, {@link #hasOperationSucceeded(Message)} will return {@code false}. * and the result will be a String corresponding to the server exception. */ @@ -456,6 +455,10 @@ // Constructors -------------------------------------------------- + private ManagementHelper() + { + } + // Public -------------------------------------------------------- // Package protected --------------------------------------------- Modified: trunk/src/main/org/hornetq/api/core/management/NotificationType.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/NotificationType.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/NotificationType.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -14,8 +14,9 @@ package org.hornetq.api.core.management; /** + * Types of notification emmitted by HornetQ servers. + * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> - * */ public enum NotificationType { Modified: trunk/src/main/org/hornetq/api/core/management/Operation.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/Operation.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/Operation.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -23,14 +23,11 @@ /** * Info for a MBean Operation. - * + * <b> * This annotation is used only for methods which can be invoked * through a GUI. * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> - * - * @version <tt>$Revision$</tt> - * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) Modified: trunk/src/main/org/hornetq/api/core/management/Parameter.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/Parameter.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/Parameter.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -20,11 +20,11 @@ /** * Info for a MBean Operation Parameter. + * <b> + * This annotation is used only for methods which can be invoked + * through a GUI. * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> - * - * @version <tt>$Revision$</tt> - * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.PARAMETER) Modified: trunk/src/main/org/hornetq/api/core/management/ResourceNames.java =================================================================== --- trunk/src/main/org/hornetq/api/core/management/ResourceNames.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/core/management/ResourceNames.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -15,7 +15,7 @@ /** * Helper class used to build resource names used by management messages. - * + * <br> * Resource's name is build by appending its <em>name</em> to its corresponding type. * For example, the resource name of the "foo" queue is {@code CORE_QUEUE + "foo"}. * @@ -58,6 +58,10 @@ // Constructors -------------------------------------------------- + private ResourceNames() + { + } + // Public -------------------------------------------------------- // Package protected --------------------------------------------- Modified: trunk/src/main/org/hornetq/api/jms/HornetQJMSClient.java =================================================================== --- trunk/src/main/org/hornetq/api/jms/HornetQJMSClient.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/jms/HornetQJMSClient.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -27,10 +27,9 @@ import org.hornetq.jms.client.HornetQTopic; /** - * A utility class for creating HornetQ Client Side JMS Objects. + * A utility class for creating HornetQ client-side JMS managed resources. * * @author <a href="mailto:andy.taylor@jboss.org">Andy Taylor</a> - * Created Jan 5, 2010 */ public class HornetQJMSClient { @@ -72,7 +71,7 @@ /** * Creates a ClientSessionFactory using a List of TransportConfigurations and backups. * - * @param staticConnectors The list of TransportConfiguration's to use. + * @param staticConnectors The list of TransportConfiguration to use. * @return The ConnectionFactory. */ public static ConnectionFactory createConnectionFactory(final List<Pair<TransportConfiguration, TransportConfiguration>> staticConnectors) @@ -81,7 +80,7 @@ } /** - * Creates a ConnectionFactory using a List of TransportConfigurations and backups. + * Creates a ConnectionFactory using a single pair of live-backup TransportConfiguration. * * @param connectorConfig The TransportConfiguration of the server to connect to. * @param backupConnectorConfig The TransportConfiguration of the backup server to connect to. can be null. @@ -94,7 +93,7 @@ } /** - * Create a ConnectionFactory using the TransportConfiguration of the server to connect to. + * Creates a ConnectionFactory to connect to a single live server. * * @param connectorConfig The TransportConfiguration of the server. * @return The ConnectionFactory. @@ -105,7 +104,7 @@ } /** - * Create a client side representation of a JMS Topic. + * Creates a client-side representation of a JMS Topic. * * @param name the name of the topic * @return The Topic @@ -116,7 +115,7 @@ } /** - * Create a client side representation of a JMS Queue. + * Creates a client-side representation of a JMS Queue. * * @param name the name of the queue * @return The Queue @@ -126,4 +125,7 @@ return new HornetQQueue(name); } + private HornetQJMSClient() + { + } } Modified: trunk/src/main/org/hornetq/api/jms/HornetQJMSConstants.java =================================================================== --- trunk/src/main/org/hornetq/api/jms/HornetQJMSConstants.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/jms/HornetQJMSConstants.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -14,7 +14,7 @@ package org.hornetq.api.jms; /** - * Constants for HornetQ for property keys used for HornetQ specific extensions to JMS + * Constants for HornetQ for property keys used for HornetQ specific extensions to JMS. * * @author Tim Fox * Modified: trunk/src/main/org/hornetq/api/jms/management/JMSManagementHelper.java =================================================================== --- trunk/src/main/org/hornetq/api/jms/management/JMSManagementHelper.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/jms/management/JMSManagementHelper.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -152,7 +152,7 @@ /** * Returns the result of an operation invocation or an attribute value. - * + * <br> * If an error occurred on the server, {@link #hasOperationSucceeded(Message)} will return {@code false}. * and the result will be a String corresponding to the server exception. */ @@ -163,7 +163,7 @@ /** * Returns the result of an operation invocation or an attribute value. - * + * <br> * If an error occurred on the server, {@link #hasOperationSucceeded(Message)} will return {@code false}. * and the result will be a String corresponding to the server exception. */ @@ -174,6 +174,10 @@ // Constructors -------------------------------------------------- + private JMSManagementHelper() + { + } + // Public -------------------------------------------------------- // Package protected --------------------------------------------- Modified: trunk/src/main/org/hornetq/api/jms/management/SubscriptionInfo.java =================================================================== --- trunk/src/main/org/hornetq/api/jms/management/SubscriptionInfo.java 2010-01-08 09:40:20 UTC (rev 8776) +++ trunk/src/main/org/hornetq/api/jms/management/SubscriptionInfo.java 2010-01-08 11:02:17 UTC (rev 8777) @@ -13,7 +13,6 @@ package org.hornetq.api.jms.management; -import org.hornetq.api.core.management.AddressControl; import org.hornetq.utils.json.JSONArray; import org.hornetq.utils.json.JSONObject;