[hornetq-commits] JBoss hornetq SVN: r8667 - in trunk/src/main/org/hornetq: core/management and 1 other directories.

Author: jmesnil Date: 2009-12-10 11:19:49 -0500 (Thu, 10 Dec 2009) New Revision: 8667 Modified: trunk/src/main/org/hornetq/core/client/ConnectionLoadBalancingPolicy.java trunk/src/main/org/hornetq/core/management/BridgeControl.java trunk/src/main/org/hornetq/core/management/DivertControl.java trunk/src/main/org/hornetq/core/management/HornetQServerControl.java trunk/src/main/org/hornetq/core/management/QueueControl.java trunk/src/main/org/hornetq/utils/SimpleString.java Log: HORNETQ-185 + HORNETQ-186: API review + javadoc * added javadoc for ConnectionLoadBalancingPolicy API * fixed javadoc warnings Modified: trunk/src/main/org/hornetq/core/client/ConnectionLoadBalancingPolicy.java =================================================================== --- trunk/src/main/org/hornetq/core/client/ConnectionLoadBalancingPolicy.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/core/client/ConnectionLoadBalancingPolicy.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -14,15 +14,16 @@ package org.hornetq.core.client; /** - * A ConnectionLoadBalancingPolicy + * A ConnectionLoadBalancingPolicy defines a policy to load balance between connections. * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> - * - * Created 28 Nov 2008 10:19:56 - * - * */ public interface ConnectionLoadBalancingPolicy { + /** + * Returns the selected index according to the policy implementation. + * + * @param max maximum position index that can be selected + */ int select(int max); } Modified: trunk/src/main/org/hornetq/core/management/BridgeControl.java =================================================================== --- trunk/src/main/org/hornetq/core/management/BridgeControl.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/core/management/BridgeControl.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -43,9 +43,7 @@ String getFilterString(); /** - * Return the name of the Transformer implementation associated to this bridge. - * - * @see org.hornetq.core.server.cluster.Transformer + * Return the name of the org.hornetq.core.server.cluster.Transformer implementation associated to this bridge. */ String getTransformerClassName(); Modified: trunk/src/main/org/hornetq/core/management/DivertControl.java =================================================================== --- trunk/src/main/org/hornetq/core/management/DivertControl.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/core/management/DivertControl.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -54,9 +54,7 @@ String getForwardingAddress(); /** - * Return the name of the Transformer implementation associated to this bridge. - * - * @see org.hornetq.core.server.cluster.Transformer + * Return the name of the org.hornetq.core.server.cluster.Transformer implementation associated to this bridge. */ String getTransformerClassName(); } Modified: trunk/src/main/org/hornetq/core/management/HornetQServerControl.java =================================================================== --- trunk/src/main/org/hornetq/core/management/HornetQServerControl.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/core/management/HornetQServerControl.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -169,7 +169,7 @@ /** * Sets the maximum number of days kept in memory for message counter. * - * @count value must be greater than 0 + * @param count value must be greater than 0 */ void setMessageCounterMaxDayCount(int count) throws Exception; @@ -401,7 +401,8 @@ * The Strings are Base-64 representation of the transaction XID and can be * used to heuristically commit or rollback the transactions. * - * @see #commitPreparedTransaction(String), {@link #rollbackPreparedTransaction(String)} + * @see #commitPreparedTransaction(String) + * @see #rollbackPreparedTransaction(String) */ @Operation(desc = "List all the prepared transaction, sorted by date, oldest first") String[] listPreparedTransactions() throws Exception; Modified: trunk/src/main/org/hornetq/core/management/QueueControl.java =================================================================== --- trunk/src/main/org/hornetq/core/management/QueueControl.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/core/management/QueueControl.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -218,7 +218,7 @@ /** * Changes the message's priority corresponding to the specified message ID to the specified priority. * - * @param priority between 0 and 9 inclusive. + * @param newPriority between 0 and 9 inclusive. * * @return {@code true}�if the message priority was changed */ Modified: trunk/src/main/org/hornetq/utils/SimpleString.java =================================================================== --- trunk/src/main/org/hornetq/utils/SimpleString.java 2009-12-10 16:10:36 UTC (rev 8666) +++ trunk/src/main/org/hornetq/utils/SimpleString.java 2009-12-10 16:19:49 UTC (rev 8667) @@ -261,7 +261,6 @@ * * i.e. "a.b" would return "a" and "b" if . was the delimeter * @param delim - * @return */ public SimpleString[] split(final char delim) { @@ -341,7 +340,7 @@ /** * concatanates a SimpleString and a char * - * @param toAdd the char to concate with. + * @param c the char to concate with. * @return the concatanated SimpleString */ public SimpleString concat(final char c)