[hornetq-commits] JBoss hornetq SVN: r10991 - branches/HORNETQ-720_Replication/hornetq-core/src/main/java/org/hornetq/api/core/client.

Author: borges Date: 2011-07-18 12:30:35 -0400 (Mon, 18 Jul 2011) New Revision: 10991 Modified: branches/HORNETQ-720_Replication/hornetq-core/src/main/java/org/hornetq/api/core/client/ClientSession.java Log: Correct the parameter order in the javadoc. Modified: branches/HORNETQ-720_Replication/hornetq-core/src/main/java/org/hornetq/api/core/client/ClientSession.java =================================================================== --- branches/HORNETQ-720_Replication/hornetq-core/src/main/java/org/hornetq/api/core/client/ClientSession.java 2011-07-15 22:47:48 UTC (rev 10990) +++ branches/HORNETQ-720_Replication/hornetq-core/src/main/java/org/hornetq/api/core/client/ClientSession.java 2011-07-18 16:30:35 UTC (rev 10991) @@ -22,18 +22,18 @@ /** * A ClientSession is a single-thread object required for producing and consuming messages. - * + * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @author <a href="mailto:clebert.suconic@jboss.org">Clebert Suconic</a> * @author <a href="mailto:ataylor@redhat.com">Andy Taylor</a> * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> - * + * */ public interface ClientSession extends XAResource { /** * Information returned by a binding query - * + * * @see ClientSession#bindingQuery(SimpleString) */ public interface BindingQuery @@ -51,7 +51,7 @@ /** * Information returned by a queue query - * + * * @see ClientSession#queueQuery(SimpleString) */ public interface QueueQuery @@ -92,7 +92,7 @@ /** * 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 */ void start() throws HornetQException; @@ -100,35 +100,35 @@ /** * 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 */ void stop() throws HornetQException; /** * Closes the session. - * + * * @throws HornetQException if an exception occurs while closing the session */ void close() throws HornetQException; /** * Returns whether the session is closed or not. - * + * * @return <code>true</code> if the session is closed, <code>false</code> else */ boolean isClosed(); /** * 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); /** * 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 */ @@ -136,7 +136,7 @@ /** * Returns the server's incrementingVersion. - * + * * @return the server's <code>incrementingVersion</code> */ int getVersion(); @@ -145,7 +145,7 @@ /** * Creates a <em>non-temporary</em> queue. - * + * * @param address the queue will be bound to this address * @param queueName the name of the queue * @param durable whether the queue is durable or not @@ -155,7 +155,7 @@ /** * Creates a <em>non-temporary</em> queue. - * + * * @param address the queue will be bound to this address * @param queueName the name of the queue * @param durable whether the queue is durable or not @@ -165,16 +165,16 @@ /** * 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 * @throws HornetQException in an exception occurs while creating the queue */ void createQueue(String address, String queueName) throws HornetQException; - + /** * 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 * @throws HornetQException in an exception occurs while creating the queue @@ -183,18 +183,17 @@ /** * Creates a <em>non-temporary</em> queue. - * * @param address the queue will be bound to this address * @param queueName the name of the queue - * @param durable whether the queue is durable or not * @param filter only messages which match this filter will be put in the queue + * @param durable whether the queue is durable or not * @throws HornetQException in an exception occurs while creating the queue */ void createQueue(SimpleString address, SimpleString queueName, SimpleString filter, boolean durable) throws HornetQException; /** * Creates a <em>non-temporary</em>queue. - * + * * @param address the queue will be bound to this address * @param queueName the name of the queue * @param durable whether the queue is durable or not @@ -205,7 +204,7 @@ /** * Creates a <em>temporary</em> queue. - * + * * @param address the queue will be bound to this address * @param queueName the name of the queue * @throws HornetQException in an exception occurs while creating the queue @@ -214,7 +213,7 @@ /** * Creates a <em>temporary</em> queue. - * + * * @param address the queue will be bound to this address * @param queueName the name of the queue * @throws HornetQException in an exception occurs while creating the queue @@ -223,7 +222,7 @@ /** * 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 * @param filter only messages which match this filter will be put in the queue @@ -233,7 +232,7 @@ /** * 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 * @param filter only messages which match this filter will be put in the queue @@ -243,7 +242,7 @@ /** * 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 */ @@ -251,7 +250,7 @@ /** * 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 */ @@ -261,7 +260,7 @@ /** * 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 * @throws HornetQException if an exception occurs while creating the ClientConsumer @@ -270,7 +269,7 @@ /** * 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 * @throws HornetQException if an exception occurs while creating the ClientConsumer @@ -279,7 +278,7 @@ /** * 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 * @return a ClientConsumer @@ -289,7 +288,7 @@ /** * 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 * @return a ClientConsumer @@ -303,7 +302,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param browseOnly whether the ClientConsumer will only browse the queue or consume messages. * @return a ClientConsumer @@ -317,7 +316,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param browseOnly whether the ClientConsumer will only browse the queue or consume messages. * @return a ClientConsumer @@ -331,7 +330,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed * @param browseOnly whether the ClientConsumer will only browse the queue or consume messages. @@ -346,7 +345,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed * @param browseOnly whether the ClientConsumer will only browse the queue or consume messages. @@ -361,7 +360,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed * @param windowSize the consumer window size @@ -382,7 +381,7 @@ * 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 * the messages will effectively be removed from the queue. - * + * * @param queueName name of the queue to consume messages from * @param filter only messages which match this filter will be consumed * @param windowSize the consumer window size @@ -398,7 +397,7 @@ /** * Creates a producer with no default address. * Address must be specified every time a message is sent - * + * * @return a ClientProducer * * @see ClientProducer#send(SimpleString, org.hornetq.api.core.Message) @@ -407,7 +406,7 @@ /** * Creates a producer which sends messages to the given address - * + * * @param address the address to send messages to * @return a ClientProducer * @throws HornetQException if an exception occurs while creating the ClientProducer @@ -416,7 +415,7 @@ /** * Creates a producer which sends messages to the given address - * + * * @param address the address to send messages to * @return a ClientProducer * @throws HornetQException if an exception occurs while creating the ClientProducer @@ -425,7 +424,7 @@ /** * Creates a producer which sends messages to the given address - * + * * @param address the address to send messages to * @param rate the producer rate * @return a ClientProducer @@ -437,7 +436,7 @@ /** * Creates a ClientMessage. - * + * * @param durable whether the created message is durable or not * @return a ClientMessage */ @@ -445,7 +444,7 @@ /** * Creates a ClientMessage. - * + * * @param type type of the message * @param durable whether the created message is durable or not * @return a ClientMessage @@ -454,7 +453,7 @@ /** * Creates a ClientMessage. - * + * * @param type type of the message * @param durable whether the created message is durable or not * @param expiration the message expiration @@ -468,20 +467,20 @@ /** * Queries information on a queue. - * + * * @param queueName the name of the queue to query * @return a QueueQuery containing information on the given queue - * + * * @throws HornetQException if an exception occurs while querying the queue */ QueueQuery queueQuery(SimpleString queueName) throws HornetQException; /** * 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 - * + * * @throws HornetQException if an exception occurs while querying the binding */ BindingQuery bindingQuery(SimpleString address) throws HornetQException; @@ -490,44 +489,44 @@ /** * Returns the XAResource associated to the session. - * + * * @return the XAResource associated to the session */ XAResource getXAResource(); /** * Return <code>true</code> if the session supports XA, <code>false</code> else. - * + * * @return <code>true</code> if the session supports XA, <code>false</code> else. */ boolean isXA(); /** * Commits the current transaction. - * + * * @throws HornetQException if an exception occurs while committing the transaction */ void commit() throws HornetQException; /** * Rolls back the current transaction. - * + * * @throws HornetQException if an exception occurs while rolling back the transaction */ void rollback() throws HornetQException; /** * Rolls back the current transaction. - * + * * @param considerLastMessageAsDelivered the first message on deliveringMessage Buffer is considered as delivered - * + * * @throws HornetQException if an exception occurs while rolling back the transaction */ void rollback(boolean considerLastMessageAsDelivered) throws HornetQException; /** * 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(); @@ -535,7 +534,7 @@ /** * 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 */ boolean isAutoCommitSends(); @@ -543,28 +542,28 @@ /** * 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 */ boolean isAutoCommitAcks(); /** * 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(); /** * Sets a <code>SendAcknowledgementHandler</code> for this session. - * + * * @param handler a SendAcknowledgementHandler */ void setSendAcknowledgementHandler(SendAcknowledgementHandler handler); /** * Attach any metadata to the session. - * @throws HornetQException + * @throws HornetQException */ void addMetaData(String key, String data) throws HornetQException; @@ -572,7 +571,7 @@ * Attach any metadata to the session. * Sends a Metadata using the older version * @deprecated Use {@link ClientSession#addMetaData(String, String)} - * @throws HornetQException + * @throws HornetQException */ void addMetaDataV1(String key, String data) throws HornetQException; }