Author: jmesnil Date: 2009-12-09 05:24:09 -0500 (Wed, 09 Dec 2009) New Revision: 8633 Modified: trunk/src/main/org/hornetq/core/buffers/HornetQBuffer.java trunk/src/main/org/hornetq/core/buffers/HornetQBuffers.java trunk/src/main/org/hornetq/core/client/ClientConsumer.java trunk/src/main/org/hornetq/core/client/ClientRequestor.java trunk/src/main/org/hornetq/core/client/ClientSession.java trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java Log: HORNETQ-186: fill in Javadocs for core API * fixed javadoc tense Modified: trunk/src/main/org/hornetq/core/buffers/HornetQBuffer.java =================================================================== --- trunk/src/main/org/hornetq/core/buffers/HornetQBuffer.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/buffers/HornetQBuffer.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -32,7 +32,7 @@ public interface HornetQBuffer { /** - * Return the underlying Netty's ChannelBuffer + * Returns the underlying Netty's ChannelBuffer * * @return the underlying Netty's ChannelBuffer */ Modified: trunk/src/main/org/hornetq/core/buffers/HornetQBuffers.java =================================================================== --- trunk/src/main/org/hornetq/core/buffers/HornetQBuffers.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/buffers/HornetQBuffers.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -27,7 +27,7 @@ public class HornetQBuffers { /** - * Create a <em>self-expanding</em> HornetQBuffer with the given initial size + * Creates a <em>self-expanding</em> HornetQBuffer with the given initial size * * @param size the initial size of the created HornetQBuffer * @return a self-expanding HornetQBuffer starting with the given size @@ -38,7 +38,7 @@ } /** - * Create a <em>self-expanding</em> HornetQBuffer filled with the given byte array + * Creates a <em>self-expanding</em> HornetQBuffer filled with the given byte array * * @param bytes the created buffer will be initially filled with this byte array * @return a self-expanding HornetQBuffer filled with the given byte array @@ -53,7 +53,7 @@ } /** - * Create a HornetQBuffer wrapping the underlying NIO ByteBuffer + * Creates a HornetQBuffer wrapping the underlying NIO ByteBuffer * * The position on this buffer won't affect the position on the inner buffer * @@ -70,7 +70,7 @@ } /** - * Create a HornetQBuffer wrapping the underlying byte array + * Creates a HornetQBuffer wrapping the underlying byte array * * @param underlying the underlying byte array * @return a HornetQBuffer wrapping the underlying byte array @@ -81,7 +81,7 @@ } /** - * Create a <em>fixed</em> HornetQBuffer of the given size + * Creates a <em>fixed</em> HornetQBuffer of the given size * * @param size the size of the created HornetQBuffer * @return a fixed HornetQBuffer with the given size Modified: trunk/src/main/org/hornetq/core/client/ClientConsumer.java =================================================================== --- trunk/src/main/org/hornetq/core/client/ClientConsumer.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/client/ClientConsumer.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -79,7 +79,7 @@ ClientMessage receiveImmediate() throws HornetQException; /** - * Return the MessageHandler associated to this consumer. + * Returns the MessageHandler associated to this consumer. * * Calling this method on a closed consumer will throw a HornetQException. * @@ -90,7 +90,7 @@ MessageHandler getMessageHandler() throws HornetQException; /** - * Set the MessageHandler for this consumer to consume messages asynchronously. + * Sets the MessageHandler for this consumer to consume messages asynchronously. * * Calling this method on a closed consumer will throw a HornetQException. * @@ -100,7 +100,7 @@ void setMessageHandler(MessageHandler handler) throws HornetQException; /** - * Close the consumer. + * Closes the consumer. * * Once this consumer is closed, it can not receive messages, whether synchronously or asynchronously. * @@ -109,14 +109,14 @@ void close() throws HornetQException; /** - * Return whether the consumer is closed or not. + * Returns whether the consumer is closed or not. * * @return <code>true</code> if this consumer is closed, <code>false</code> else */ boolean isClosed(); /** - * Return the last exception thrown by a call to this consumer's MessageHandler + * Returns the last exception thrown by a call to this consumer's MessageHandler. * * @return the last exception thrown by a call to this consumer's MessageHandler or <code>null</code> */ Modified: trunk/src/main/org/hornetq/core/client/ClientRequestor.java =================================================================== --- trunk/src/main/org/hornetq/core/client/ClientRequestor.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/client/ClientRequestor.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -67,7 +67,7 @@ } /** - * Send a message to the request address and wait indefinitely for a reply. + * Sends a message to the request address and wait indefinitely for a reply. * The temporary queue is used for the REPLYTO_HEADER_NAME, and only one reply per request is expected * * @param request the message to send @@ -80,7 +80,7 @@ } /** - * Send a message to the request address and wait for the given timeout for a reply. + * Sends a message to the request address and wait for the given timeout for a reply. * The temporary queue is used for the REPLYTO_HEADER_NAME, and only one reply per request is expected * * @param request the message to send @@ -96,7 +96,7 @@ } /** - * Close the ClientRequestor and its session. + * Closes the ClientRequestor and its session. * * @throws Exception if an exception occurs while closing the ClientRequestor */ Modified: trunk/src/main/org/hornetq/core/client/ClientSession.java =================================================================== --- trunk/src/main/org/hornetq/core/client/ClientSession.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/client/ClientSession.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -39,14 +39,14 @@ public interface BindingQuery { /** - * Return <code>true</code> if the binding exists, <code>false</code> else. + * Returns <code>true</code> if the binding exists, <code>false</code> else. * * @return <code>true</code> if the binding exists, <code>false</code> else */ boolean isExists(); /** - * Return the names of the queues bound to the binding. + * Returns the names of the queues bound to the binding. * * @return the names of the queues bound to the binding */ @@ -61,42 +61,42 @@ public interface QueueQuery { /** - * Return <code>true</code> if the queue exists, <code>false</code> else. + * Returns <code>true</code> if the queue exists, <code>false</code> else. * * @return <code>true</code> if the queue exists, <code>false</code> else */ boolean isExists(); /** - * Return <code>true</code> if the queue is durable, <code>false</code> else. + * Returns <code>true</code> if the queue is durable, <code>false</code> else. * * @return <code>true</code> if the queue is durable, <code>false</code> else */ boolean isDurable(); /** - * Return the number of consumers attached to the queue. + * Returns the number of consumers attached to the queue. * * @return the number of consumers attached to the queue */ int getConsumerCount(); /** - * Return the number of messages in the queue. + * Returns the number of messages in the queue. * * @return the number of messages in the queue */ int getMessageCount(); /** - * Return the queue's filter string (or <code>null</code> if the queue has no filter). + * Returns the queue's filter string (or <code>null</code> if the queue has no filter). * * @return the queue's filter string (or <code>null</code> if the queue has no filter) */ SimpleString getFilterString(); /** - * Return the address that the queue is bound to. + * Returns the address that the queue is bound to. * * @return the address that the queue is bound to */ @@ -106,7 +106,7 @@ // Lifecycle operations ------------------------------------------ /** - * Start the session. + * Starts the session. * The session must be started before ClientConsumers created by the session can consume messages from the queue. * * @throws HornetQException if an exception occurs while starting the session @@ -114,7 +114,7 @@ void start() throws HornetQException; /** - * Stop the session. + * Stops the session. * ClientConsumers created by the session can not consume messages when the session is stopped. * * @throws HornetQException if an exception occurs while stopping the session @@ -122,28 +122,28 @@ void stop() throws HornetQException; /** - * Close the session. + * Closes the session. * * @throws HornetQException if an exception occurs while closing the session */ void close() throws HornetQException; /** - * Indicate if the session is closed or not. + * Returns whether the session is closed or not. * * @return <code>true</code> if the session is closed, <code>false</code> else */ boolean isClosed(); /** - * Add a FailureListener to the session which is notified if a failure occurs on the session. + * Adds a FailureListener to the session which is notified if a failure occurs on the session. * * @param listener the listener to add */ void addFailureListener(SessionFailureListener listener); /** - * Remove a FailureListener to the session. + * Removes a FailureListener to the session. * * @param listener the listener to remove * @return <code>true</code> if the listener was removed, <code>false</code> else @@ -160,7 +160,7 @@ // Queue Operations ---------------------------------------------- /** - * Create a <em>non-temporary</em> queue. + * Creates a <em>non-temporary</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -170,7 +170,7 @@ void createQueue(SimpleString address, SimpleString queueName, boolean durable) throws HornetQException; /** - * Create a <em>non-temporary</em> queue. + * Creates a <em>non-temporary</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -180,7 +180,7 @@ void createQueue(String address, String queueName, boolean durable) throws HornetQException; /** - * Create a <em>non-temporary</em> queue <em>non-durable</em> queue. + * Creates a <em>non-temporary</em> queue <em>non-durable</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -189,7 +189,7 @@ void createQueue(String address, String queueName) throws HornetQException; /** - * Create a <em>non-temporary</em> queue. + * Creates a <em>non-temporary</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -200,7 +200,7 @@ void createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable) throws HornetQException; /** - * Create a <em>non-temporary</em>queue. + * Creates a <em>non-temporary</em>queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -211,7 +211,7 @@ void createQueue(String address, String queueName, String filter, boolean durable) throws HornetQException; /** - * Create a <em>temporary</em> queue. + * Creates a <em>temporary</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -220,7 +220,7 @@ void createTemporaryQueue(SimpleString address, SimpleString queueName) throws HornetQException; /** - * Create a <em>temporary</em> queue. + * Creates a <em>temporary</em> queue. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -229,7 +229,7 @@ void createTemporaryQueue(String address, String queueName) throws HornetQException; /** - * Create a <em>temporary</em> queue with a filter. + * Creates a <em>temporary</em> queue with a filter. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -239,7 +239,7 @@ void createTemporaryQueue(SimpleString address, SimpleString queueName, SimpleString filter) throws HornetQException; /** - * Create a <em>temporary</em> queue with a filter. + * Creates a <em>temporary</em> queue with a filter. * * @param address the queue will be bound to this address * @param queueName the name of the queue @@ -249,7 +249,7 @@ void createTemporaryQueue(String address, String queueName, String filter) throws HornetQException; /** - * Delete the queue. + * Deletes the queue. * * @param queueName the name of the queue to delete * @throws HornetQException if there is no queue for the given name or if the queue has consumers @@ -257,7 +257,7 @@ void deleteQueue(SimpleString queueName) throws HornetQException; /** - * Delete the queue. + * Deletes the queue. * * @param queueName the name of the queue to delete * @throws HornetQException if there is no queue for the given name or if the queue has consumers @@ -267,7 +267,7 @@ // Consumer Operations ------------------------------------------- /** - * Create a ClientConsumer to consume message from the queue with the given name. + * Creates a ClientConsumer to consume message from the queue with the given name. * * @param queueName name of the queue to consume messages from * @return a ClientConsumer @@ -276,7 +276,7 @@ ClientConsumer createConsumer(SimpleString queueName) throws HornetQException; /** - * Create a ClientConsumer to consume messages from the queue with the given name. + * Creates a ClientConsumer to consume messages from the queue with the given name. * * @param queueName name of the queue to consume messages from * @return a ClientConsumer @@ -285,7 +285,7 @@ ClientConsumer createConsumer(String queueName) throws HornetQException; /** - * Create a ClientConsumer to consume messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume messages matching the filter from the queue with the given name. * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed @@ -295,7 +295,7 @@ ClientConsumer createConsumer(SimpleString queueName, SimpleString filter) throws HornetQException; /** - * Create a ClientConsumer to consume messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume messages matching the filter from the queue with the given name. * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed @@ -305,7 +305,7 @@ ClientConsumer createConsumer(String queueName, String filter) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -319,7 +319,7 @@ ClientConsumer createConsumer(SimpleString queueName, boolean browseOnly) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -333,7 +333,7 @@ ClientConsumer createConsumer(String queueName, boolean browseOnly) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -348,7 +348,7 @@ ClientConsumer createConsumer(String queueName, String filter, boolean browseOnly) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -363,7 +363,7 @@ ClientConsumer createConsumer(SimpleString queueName, SimpleString filter, boolean browseOnly) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -384,7 +384,7 @@ boolean browseOnly) throws HornetQException; /** - * Create a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. + * Creates a ClientConsumer to consume or browse messages matching the filter from the queue with the given name. * If <code>browseOnly</code> is <code>true</code>, the ClientConsumer will receive the messages from the queue * but they will not be consumed (the messages will remain in the queue). * If <code>browseOnly</code> is <code>false</code>, the ClientConsumer will behave like consume the messages from the queue and @@ -403,7 +403,7 @@ // Producer Operations ------------------------------------------- /** - * Create a producer with no default address. + * Creates a producer with no default address. * Address must be specified every time a message is sent * * @return a ClientProducer @@ -413,7 +413,7 @@ ClientProducer createProducer() throws HornetQException; /** - * Create a produce which sends messages to the given address + * Creates a producer which sends messages to the given address * * @param address the address to send messages to * @return a ClientProducer @@ -422,7 +422,7 @@ ClientProducer createProducer(SimpleString address) throws HornetQException; /** - * Create a produce which sends messages to the given address + * Creates a producer which sends messages to the given address * * @param address the address to send messages to * @return a ClientProducer @@ -431,7 +431,7 @@ ClientProducer createProducer(String address) throws HornetQException; /** - * Create a produce which sends messages to the given address + * Creates a producer which sends messages to the given address * * @param address the address to send messages to * @param rate the producer rate @@ -443,7 +443,7 @@ // Message operations -------------------------------------------- /** - * Create a ClientMessage. + * Creates a ClientMessage. * * @param durable whether the created message is durable or not * @return a ClientMessage @@ -451,7 +451,7 @@ ClientMessage createMessage(boolean durable); /** - * Create a ClientMessage. + * Creates a ClientMessage. * * @param type type of the message * @param durable whether the created message is durable or not @@ -460,7 +460,7 @@ ClientMessage createMessage(byte type, boolean durable); /** - * Create a ClientMessage with the given HornetQBuffer as its body. + * Creates a ClientMessage. * * @param durable whether the created message is durable or not * @param expiration the message expiration @@ -473,7 +473,7 @@ // Query operations ---------------------------------------------- /** - * Query information on a queue. + * Queries information on a queue. * * @param queueName the name of the queue to query * @return a QueueQuery containing information on the given queue @@ -483,7 +483,7 @@ QueueQuery queueQuery(SimpleString queueName) throws HornetQException; /** - * Query information on a binding. + * Queries information on a binding. * * @param address the address of the biding to query * @return a BindingQuery containing information on the binding attached to the given address @@ -509,21 +509,21 @@ boolean isXA(); /** - * Commit the current transaction. + * Commits the current transaction. * * @throws HornetQException if an exception occurs while committing the transaction */ void commit() throws HornetQException; /** - * Rollback the current transaction. + * Rolls back the current transaction. * * @throws HornetQException if an exception occurs while rolling back the transaction */ void rollback() throws HornetQException; /** - * Rollback the current transaction. + * Rolls back the current transaction. * * @param considerLastMessageAsDelivered the first message on deliveringMessage Buffer is considered as delivered * @@ -532,14 +532,14 @@ void rollback(boolean considerLastMessageAsDelivered) throws HornetQException; /** - * Return <code>true</code> if the current transaction has been flagged to rollback, <code>false</code> else. + * Returns <code>true</code> if the current transaction has been flagged to rollback, <code>false</code> else. * * @return <code>true</code> if the current transaction has been flagged to rollback, <code>false</code> else. */ boolean isRollbackOnly(); /** - * Return whether the session will <em>automatically</em> commit its transaction every time a message is sent + * Returns whether the session will <em>automatically</em> commit its transaction every time a message is sent * by a ClientProducer created by this session, <code>false</code> else * * @return <code>true</code> if the session <em>automatically</em> commit its transaction every time a message is sent, <code>false</code> else @@ -547,7 +547,7 @@ boolean isAutoCommitSends(); /** - * Return whether the session will <em>automatically</em> commit its transaction every time a message is acknowledged + * Returns whether the session will <em>automatically</em> commit its transaction every time a message is acknowledged * by a ClientConsumer created by this session, <code>false</code> else * * @return <code>true</code> if the session <em>automatically</em> commit its transaction every time a message is acknowledged, <code>false</code> else @@ -555,14 +555,14 @@ boolean isAutoCommitAcks(); /** - * Return whether the ClientConsumer created by the session will <em>block</em> when they acknowledge a message. + * Returns whether the ClientConsumer created by the session will <em>block</em> when they acknowledge a message. * * @return <code>true</code> if the session's ClientConsumer block when they acknowledge a message, <code>false</code> else */ boolean isBlockOnAcknowledge(); /** - * Set a <code>SendAcknowledgementHandler</code> for this session. + * Sets a <code>SendAcknowledgementHandler</code> for this session. * * @param handler a SendAcknowledgementHandler */ Modified: trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java =================================================================== --- trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java 2009-12-09 10:13:02 UTC (rev 8632) +++ trunk/src/main/org/hornetq/core/client/ClientSessionFactory.java 2009-12-09 10:24:09 UTC (rev 8633) @@ -17,7 +17,6 @@ import org.hornetq.core.config.TransportConfiguration; import org.hornetq.core.exception.HornetQException; -import org.hornetq.core.message.impl.MessageImpl; import org.hornetq.core.remoting.Interceptor; import org.hornetq.utils.Pair; @@ -32,7 +31,7 @@ public interface ClientSessionFactory { /** - * Create a session with XA transaction semantics. + * Creates a session with XA transaction semantics. * * @return a ClientSession with XA transaction semantics * @@ -41,7 +40,7 @@ ClientSession createXASession() throws HornetQException; /** - * Create a <em>transacted</em> session. + * Creates a <em>transacted</em> session. * * It is up to the client to commit when sending and acknowledging messages. @@ -54,7 +53,7 @@ /** - * Create a <em>non-transacted</em> session. + * Creates a <em>non-transacted</em> session. * * Message sends and acknowledgments are automatically committed by the session. <em>This does not * mean that messages are automatically acknowledged</em>, only that when messages are acknowledged, @@ -66,7 +65,7 @@ ClientSession createSession() throws HornetQException; /** - * Create a session. + * Creates a session. * * @param autoCommitSends <code>true</code> to automatically commit message sends, <code>false</code> to commit manually * @param autoCommitAcks <code>true</code> to automatically commit message acknowledgement, <code>false</code> to commit manually @@ -76,7 +75,7 @@ ClientSession createSession(boolean autoCommitSends, boolean autoCommitAcks) throws HornetQException; /** - * Create a session. + * Creates a session. * * @param autoCommitSends <code>true</code> to automatically commit message sends, <code>false</code> to commit manually * @param autoCommitAcks <code>true</code> to automatically commit message acknowledgement, <code>false</code> to commit manually @@ -87,9 +86,9 @@ ClientSession createSession(boolean autoCommitSends, boolean autoCommitAcks, int ackBatchSize) throws HornetQException; /** - * Create a session. + * Creates a session. * - * @param xa wether the session support XA transaction semantic or not + * @param xa whether the session support XA transaction semantic or not * @param autoCommitSends <code>true</code> to automatically commit message sends, <code>false</code> to commit manually * @param autoCommitAcks <code>true</code> to automatically commit message acknowledgement, <code>false</code> to commit manually * @return a ClientSession @@ -98,13 +97,13 @@ ClientSession createSession(boolean xa, boolean autoCommitSends, boolean autoCommitAcks) throws HornetQException; /** - * Create a session. + * Creates a session. * * It is possible to <em>pre-acknowledge messages on the server</em> so that the client can avoid additional network trip * to the server to acknowledge messages. While this increase performance, this does not guarantee delivery (as messages * can be lost after being pre-acknowledged on the server). Use with caution if your application design permits it. * - * @param xa wether the session support XA transaction semantic or not + * @param xa whether the session support XA transaction semantic or not * @param autoCommitSends <code>true</code> to automatically commit message sends, <code>false</code> to commit manually * @param autoCommitAcks <code>true</code> to automatically commit message acknowledgement, <code>false</code> to commit manually * @param preAcknowledge <code>true</code> to pre-acknowledge messages on the server, <code>false</code> to let the client acknowledge the messages @@ -114,7 +113,7 @@ ClientSession createSession(boolean xa, boolean autoCommitSends, boolean autoCommitAcks, boolean preAcknowledge) throws HornetQException; /** - * Create an <em>authenticated</em> session. + * Creates an <em>authenticated</em> session. * * It is possible to <em>pre-acknowledge messages on the server</em> so that the client can avoid additional network trip * to the server to acknowledge messages. While this increase performance, this does not guarantee delivery (as messages @@ -138,7 +137,7 @@ int ackBatchSize) throws HornetQException; /** - * Return the list of <em>live - backup</em> connectors pairs configured + * Returns the list of <em>live - backup</em> connectors pairs configured * that sessions created by this factory will use to connect * to HornetQ servers or <code>null</code> if the factory is using discovery group. * @@ -150,7 +149,7 @@ List<Pair<TransportConfiguration, TransportConfiguration>> getStaticConnectors(); /** - * Set the static list of live - backup connectors pairs that sessions created by this factory will use to connect + * Sets the static list of live - backup connectors pairs that sessions created by this factory will use to connect * to HornetQ servers. * * The backup configuration (returned by {@link Pair#b}) can be <code>null</code> if there is no @@ -161,7 +160,7 @@ void setStaticConnectors(List<Pair<TransportConfiguration, TransportConfiguration>> staticConnectors); /** - * Return the period used to check if a client has failed to receive pings from the server. + * Returns the period used to check if a client has failed to receive pings from the server. * * Period is in milliseconds, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_CLIENT_FAILURE_CHECK_PERIOD}. * @@ -170,7 +169,7 @@ long getClientFailureCheckPeriod(); /** - * Set the period (in milliseconds) used to check if a client has failed to receive pings from the server. + * Sets the period (in milliseconds) used to check if a client has failed to receive pings from the server. * * Value must be -1 (to disable) or greater than 0. * @@ -190,14 +189,14 @@ boolean isCacheLargeMessagesClient(); /** - * Set wether large messages received by consumers created through this factory will be cached in temporary files or not. + * Sets whether large messages received by consumers created through this factory will be cached in temporary files or not. * * @param cached <code>true</code> to cache large messages in temporary files, <code>false</code> else */ void setCacheLargeMessagesClient(boolean cached); /** - * Return the connection <em>time-to-live</em>. + * Returns the connection <em>time-to-live</em>. * This TTL determines how long the server will keep a connection alive in the absence of any data arriving from the client. * * Value is in milliseconds, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_CONNECTION_TTL}. @@ -207,7 +206,7 @@ long getConnectionTTL(); /** - * Set this factory's connections <em>time-to-live</em>. + * Sets this factory's connections <em>time-to-live</em>. * * Value must be -1 (to disable) or greater or equals to 0. * @@ -226,7 +225,7 @@ long getCallTimeout(); /** - * Set the blocking call timeout. + * Sets the blocking call timeout. * * Value must be greater or equals to 0 * @@ -235,7 +234,7 @@ void setCallTimeout(long callTimeout); /** - * Return the large message size threshold. + * Returns the large message size threshold. * * Messages whose size is if greater than this value will be handled as <em>large messages</em>. * @@ -246,7 +245,7 @@ int getMinLargeMessageSize(); /** - * Set the large message size threshold. + * Sets the large message size threshold. * * Value must be greater than 0. * @@ -255,7 +254,7 @@ void setMinLargeMessageSize(int minLargeMessageSize); /** - * Return the window size for flow control of the consumers created through this factory. + * Returns the window size for flow control of the consumers created through this factory. * * Value is in bytes, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_CONSUMER_WINDOW_SIZE}. * @@ -264,7 +263,7 @@ int getConsumerWindowSize(); /** - * Set the window size for flow control of the consumers created through this factory. + * Sets the window size for flow control of the consumers created through this factory. * * Value must be -1 (to disable flow control), 0 (to not buffer any messages) or greater than 0 (to set the maximum size of the buffer) * @@ -273,7 +272,7 @@ void setConsumerWindowSize(int consumerWindowSize); /** - * Return the maximum rate of message consumption for consumers created through this factory. + * Returns the maximum rate of message consumption for consumers created through this factory. * * This value controls the rate at which a consumer can consume messages. A consumer will never consume messages at a rate faster than the rate specified. * @@ -285,7 +284,7 @@ int getConsumerMaxRate(); /** - * Set the maximum rate of message consumption for consumers created through this factory. + * Sets the maximum rate of message consumption for consumers created through this factory. * * Value must -1 (to disable) or a positive integer corresponding to the maximum desired message consumption rate specified in units of messages per second. * @@ -294,7 +293,7 @@ void setConsumerMaxRate(int consumerMaxRate); /** - * Return the size for the confirmation window of clients using this factory. + * Returns the size for the confirmation window of clients using this factory. * * Value is in bytes or -1 (to disable the window). Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_CONFIRMATION_WINDOW_SIZE}. * @@ -303,7 +302,7 @@ int getConfirmationWindowSize(); /** - * Set the size for the confirmation window buffer of clients using this factory. + * Sets the size for the confirmation window buffer of clients using this factory. * * Value must be -1 (to disable the window) or greater than 0. @@ -312,7 +311,7 @@ void setConfirmationWindowSize(int confirmationWindowSize); /** - * Return the window size for flow control of the producers created through this factory. + * Returns the window size for flow control of the producers created through this factory. * * Value must be -1 (to disable flow control) or greater than 0 to determine the maximum amount of bytes at any give time (to prevent overloading the connection). * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_PRODUCER_WINDOW_SIZE}. @@ -322,7 +321,7 @@ int getProducerWindowSize(); /** - * Return the window size for flow control of the producers created through this factory. + * Returns the window size for flow control of the producers created through this factory. * * Value must be -1 (to disable flow control) or greater than 0. * @@ -331,7 +330,7 @@ void setProducerWindowSize(int producerWindowSize); /** - * Return the maximum rate of message production for producers created through this factory. + * Returns the maximum rate of message production for producers created through this factory. * * This value controls the rate at which a producer can produce messages. A producer will never produce messages at a rate faster than the rate specified. * @@ -343,7 +342,7 @@ int getProducerMaxRate(); /** - * Set the maximum rate of message production for producers created through this factory. + * Sets the maximum rate of message production for producers created through this factory. * * Value must -1 (to disable) or a positive integer corresponding to the maximum desired message production rate specified in units of messages per second. * @@ -352,7 +351,7 @@ void setProducerMaxRate(int producerMaxRate); /** - * Return whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. + * Returns whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. * * If the consumer are configured to send message acknowledgement asynchronously, you can set a SendAcknowledgementHandler on the ClientSession * to be notified once the acknowledgement has been handled by the server. @@ -364,14 +363,14 @@ boolean isBlockOnAcknowledge(); /** - * Set whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. + * Sets whether consumers created through this factory will block while sending message acknowledgements or do it asynchronously. * * @param blockOnAcknowledge <code>true</code> to block when sending message acknowledgements or <code>false</code> to send them asynchronously */ void setBlockOnAcknowledge(boolean blockOnAcknowledge); /** - * Return whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously. + * Returns whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_BLOCK_ON_DURABLE_SEND}. * @@ -380,14 +379,14 @@ boolean isBlockOnDurableSend(); /** - * Set whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously. + * Sets whether producers created through this factory will block while sending <em>durable</em> messages or do it asynchronously. * * @param blockOnDurableSend <code>true</code> to block when sending durable messages or <code>false</code> to send them asynchronously */ void setBlockOnDurableSend(boolean blockOnDurableSend); /** - * Return whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously. + * Returns whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_BLOCK_ON_NON_DURABLE_SEND}. * @@ -396,14 +395,14 @@ boolean isBlockOnNonDurableSend(); /** - * Set whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously. + * Sets whether producers created through this factory will block while sending <em>non-durable</em> messages or do it asynchronously. * * @param blockOnNonDurableSend <code>true</code> to block when sending non-durable messages or <code>false</code> to send them asynchronously */ void setBlockOnNonDurableSend(boolean blockOnNonDurableSend); /** - * Return whether producers created through this factory will automatically + * Returns whether producers created through this factory will automatically * assign a group ID to the messages they sent. * * if <code>true</code>, a random unique group ID is created and set on each message for the property @@ -415,7 +414,7 @@ boolean isAutoGroup(); /** - * Set whether producers created through this factory will automatically + * Sets whether producers created through this factory will automatically * assign a group ID to the messages they sent. * * @param autoGroup <code>true</code> to automatically assign a group ID to each messages sent through this factory, <code>false</code> else @@ -423,7 +422,7 @@ void setAutoGroup(boolean autoGroup); /** - * Return the group ID that will be eventually set on each message for the property {@link org.hornetq.core.message.impl.MessageImpl#HDR_GROUP_ID}. + * Returns the group ID that will be eventually set on each message for the property {@link org.hornetq.core.message.impl.MessageImpl#HDR_GROUP_ID}. * * Default value is is <code>null</code> and no group ID will be set on the messages. * @@ -432,21 +431,21 @@ String getGroupID(); /** - * Set the group ID that will be set on each message sent through this factory. + * Sets the group ID that will be set on each message sent through this factory. * * @param groupID the group ID to use */ void setGroupID(String groupID); /** - * Return whether messages will pre-acknowledged on the server before they are sent to the consumers or not. + * Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_PRE_ACKNOWLEDGE} */ boolean isPreAcknowledge(); /** - * Set to <code>true</code> to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to <code>false</code> to let + * Sets to <code>true</code> to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to <code>false</code> to let * clients acknowledge the message they consume. * * @param preAcknowledge <code>true</code> to enable pre-acknowledgement, <code>false</code> else @@ -454,25 +453,25 @@ void setPreAcknowledge(boolean preAcknowledge); /** - * Return the acknowledgements batch size. + * Returns the acknowledgements batch size. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_ACK_BATCH_SIZE}. * - * @return acknowledgements batch size + * @return the acknowledgements batch size */ int getAckBatchSize(); /** - * Return the acknowledgements batch size. + * Sets the acknowledgements batch size. * * Value must be greater than 0. * - * @param ackBatchSize the acknowledgements batch size + * @param ackBatchSize acknowledgements batch size */ void setAckBatchSize(int ackBatchSize); /** - * Return the address to listen to discover which connectors this factory can use. + * Returns the address to listen to discover which connectors this factory can use. * The discovery address must be set to enable this factory to discover HornetQ servers. * * @return the address to listen to discover which connectors this factory can use @@ -480,14 +479,14 @@ String getDiscoveryAddress(); /** - * Set the address to listen to discover which connectors this factory can use. + * Sets the address to listen to discover which connectors this factory can use. * - * @param discoveryAddress the address to listen to discover which connectors this factory can use + * @param discoveryAddress address to listen to discover which connectors this factory can use */ void setDiscoveryAddress(String discoveryAddress); /** - * Return the port to listen to discover which connectors this factory can use. + * Returns the port to listen to discover which connectors this factory can use. * The discovery port must be set to enable this factory to discover HornetQ servers. * * @return the port to listen to discover which connectors this factory can use @@ -496,14 +495,14 @@ /** - * Set the port to listen to discover which connectors this factory can use. + * Sets the port to listen to discover which connectors this factory can use. * - * @param discoveryPort the port to listen to discover which connectors this factory can use + * @param discoveryPort port to listen to discover which connectors this factory can use */ void setDiscoveryPort(int discoveryPort); /** - * Return the refresh timeout for discovered HornetQ servers. + * Returns the refresh timeout for discovered HornetQ servers. * * If this factory uses discovery to find HornetQ servers, the list of discovered servers * will be refreshed according to this timeout. @@ -515,7 +514,7 @@ long getDiscoveryRefreshTimeout(); /** - * Set the refresh timeout for discovered HornetQ servers. + * Sets the refresh timeout for discovered HornetQ servers. * * Value must be greater than 0. * @@ -524,7 +523,7 @@ void setDiscoveryRefreshTimeout(long discoveryRefreshTimeout); /** - * Return the initial wait timeout if this factory is configured to use discovery. + * Returns the initial wait timeout if this factory is configured to use discovery. * * Value is in milliseconds, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_DISCOVERY_INITIAL_WAIT_TIMEOUT}. * @@ -533,7 +532,7 @@ long getDiscoveryInitialWaitTimeout(); /** - * Set the initial wait timeout if this factory is configured to use discovery. + * Sets the initial wait timeout if this factory is configured to use discovery. * * Value is in milliseconds and must be greater than 0. * @@ -542,7 +541,7 @@ void setDiscoveryInitialWaitTimeout(long initialWaitTimeout); /** - * Return whether this factory will use global thread pools (shared among all the factories in the same JVM) + * Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) * or its own pools. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_USE_GLOBAL_POOLS}. @@ -552,7 +551,7 @@ boolean isUseGlobalPools(); /** - * Set whether this factory will use global thread pools (shared among all the factories in the same JVM) + * Sets whether this factory will use global thread pools (shared among all the factories in the same JVM) * or its own pools. * * @param useGlobalPools <code>true</code> to let this factory uses global thread pools, <code>false</code> else @@ -560,16 +559,16 @@ void setUseGlobalPools(boolean useGlobalPools); /** - * Return the maximum size of the scheduled thread pool. + * Returns the maximum size of the scheduled thread pool. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE}. * - * @return maximum size of the scheduled thread pool. + * @return the maximum size of the scheduled thread pool. */ int getScheduledThreadPoolMaxSize(); /** - * Set the maximum size of the scheduled thread pool. + * Sets the maximum size of the scheduled thread pool. * * This setting is relevant only if this factory does not use global pools. * Value must be greater than 0. @@ -579,16 +578,16 @@ void setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize); /** - * Return the maximum size of the thread pool. + * Returns the maximum size of the thread pool. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_THREAD_POOL_MAX_SIZE}. * - * @return maximum size of the thread pool. + * @return the maximum size of the thread pool. */ int getThreadPoolMaxSize(); /** - * Set the maximum size of the thread pool. + * Sets the maximum size of the thread pool. * * This setting is relevant only if this factory does not use global pools. * Value must be -1 (for unlimited thread pool) or greater than 0. @@ -598,7 +597,7 @@ void setThreadPoolMaxSize(int threadPoolMaxSize); /** - * Return the time to retry connections created by this factory after failure. + * Returns the time to retry connections created by this factory after failure. * * Value is in milliseconds, default is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_RETRY_INTERVAL}. * @@ -607,7 +606,7 @@ long getRetryInterval(); /** - * Set the time to retry connections created by this factory after failure. + * Sets the time to retry connections created by this factory after failure. * * Value must be greater than 0. * @@ -616,7 +615,7 @@ void setRetryInterval(long retryInterval); /** - * Return the multiplier to apply to successive retry intervals. + * Returns the multiplier to apply to successive retry intervals. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_RETRY_INTERVAL_MULTIPLIER}. * @@ -625,7 +624,7 @@ double getRetryIntervalMultiplier(); /** - * Set the multiplier to apply to successive retry intervals. + * Sets the multiplier to apply to successive retry intervals. * * Value must be positive. * @@ -634,7 +633,7 @@ void setRetryIntervalMultiplier(double retryIntervalMultiplier); /** - * Return the maximum retry interval (in the case a retry interval multiplier has been specified). + * Returns the maximum retry interval (in the case a retry interval multiplier has been specified). * * Value is in milliseconds, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_MAX_RETRY_INTERVAL}. * @@ -643,7 +642,7 @@ long getMaxRetryInterval(); /** - * Set the maximum retry interval. + * Sets the maximum retry interval. * * Value must be greater than 0. * @@ -652,7 +651,7 @@ void setMaxRetryInterval(long maxRetryInterval); /** - * Return the maximum number of attempts to retry connection in case of failure. + * Returns the maximum number of attempts to retry connection in case of failure. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_RECONNECT_ATTEMPTS}. * @@ -661,7 +660,7 @@ int getReconnectAttempts(); /** - * Set the maximum number of attempts to retry connection in case of failure. + * Sets the maximum number of attempts to retry connection in case of failure. * * Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0. * @@ -670,7 +669,7 @@ void setReconnectAttempts(int reconnectAttempts); /** - * Return whether connections created by this factory must failover in case the server they are + * Returns whether connections created by this factory must failover in case the server they are * connected to <em>has normally shut down</em>. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_FAILOVER_ON_SERVER_SHUTDOWN}. @@ -680,7 +679,7 @@ boolean isFailoverOnServerShutdown(); /** - * Set whether connections created by this factory must failover in case the server they are + * Sets whether connections created by this factory must failover in case the server they are * connected to <em>has normally shut down</em> * * @param failoverOnServerShutdown <code>true</code> if connections must failover if the server has normally shut down, <code>false</code> else @@ -688,7 +687,7 @@ void setFailoverOnServerShutdown(boolean failoverOnServerShutdown); /** - * Return the class name of the connection load balancing policy. + * Returns the class name of the connection load balancing policy. * * Default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_CONNECTION_LOAD_BALANCING_POLICY_CLASS_NAME}. * @@ -697,7 +696,7 @@ String getConnectionLoadBalancingPolicyClassName(); /** - * Set the class name of the connection load balancing policy. + * Sets the class name of the connection load balancing policy. * * Value must be the name of a class implementing {@link ConnectionLoadBalancingPolicy}. * @@ -706,7 +705,7 @@ void setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName); /** - * Return the initial size of messages created through this factory. + * Returns the initial size of messages created through this factory. * * Value is in bytes, default value is {@value org.hornetq.core.client.impl.ClientSessionFactoryImpl#DEFAULT_INITIAL_MESSAGE_PACKET_SIZE}. * @@ -715,7 +714,7 @@ int getInitialMessagePacketSize(); /** - * Set the initial size of messages created through this factory. + * Sets the initial size of messages created through this factory. * * Value must be greater than 0. * @@ -724,14 +723,14 @@ void setInitialMessagePacketSize(int size); /** - * Add an interceptor which will be executed <em>after packets are received from the server</em>. + * Adds an interceptor which will be executed <em>after packets are received from the server</em>. * * @param interceptor an Interceptor */ void addInterceptor(Interceptor interceptor); /** - * Remove an interceptor. + * Removes an interceptor. * * @param interceptor interceptor to remove * @@ -740,7 +739,7 @@ boolean removeInterceptor(Interceptor interceptor); /** - * Close this factory and release all its resources + * Closes this factory and release all its resources */ void close();