Author: borges
Date: 2011-06-27 09:39:55 -0400 (Mon, 27 Jun 2011)
New Revision: 10882
Modified:
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/CoreRemotingConnection.java
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Packet.java
trunk/hornetq-core/src/main/java/org/hornetq/core/replication/impl/ReplicationManagerImpl.java
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Acceptor.java
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Connector.java
Log:
Small javadoc fixes.
Modified:
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/CoreRemotingConnection.java
===================================================================
---
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/CoreRemotingConnection.java 2011-06-27
13:38:04 UTC (rev 10881)
+++
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/CoreRemotingConnection.java 2011-06-27
13:39:55 UTC (rev 10882)
@@ -24,7 +24,7 @@
*
*/
public interface CoreRemotingConnection extends RemotingConnection
-{
+{
/**
* return the channel with the channel id specified.
* <p/>
@@ -74,7 +74,7 @@
long getIDGeneratorSequence();
/**
- * return the current tomeout for blocking calls
+ * Return the current timeout for blocking calls.
*
* @return the timeout in milliseconds
*/
@@ -86,7 +86,7 @@
* @return the lock
*/
Object getTransferLock();
-
+
/**
* Called periodically to flush any data in the batch buffer
*/
Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Packet.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Packet.java 2011-06-27
13:38:04 UTC (rev 10881)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Packet.java 2011-06-27
13:39:55 UTC (rev 10882)
@@ -17,21 +17,22 @@
import org.hornetq.spi.core.protocol.RemotingConnection;
/**
- * A Packet represents a pcaket of data transmitted over a connection.
+ * A Packet represents a packet of data transmitted over a connection.
*
* @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a>
*/
public interface Packet
{
/**
- * This sets the channel id that should be used once the packet has been successfully
decoded it is sent to the correct channel.
- *
+ * Sets the channel id that should be used once the packet has been successfully
decoded it is
+ * sent to the correct channel.
+ *
* @param channelID the id of the channel to handle the packet
*/
void setChannelID(long channelID);
/**
- * returns the channel id of the channel that should handle this pcaket
+ * Returns the channel id of the channel that should handle this packet.
*
* @return the id of the channel
*/
@@ -81,6 +82,6 @@
* @return true if confirmation is required
*/
boolean isRequiresConfirmations();
-
+
boolean isAsyncExec();
}
Modified:
trunk/hornetq-core/src/main/java/org/hornetq/core/replication/impl/ReplicationManagerImpl.java
===================================================================
---
trunk/hornetq-core/src/main/java/org/hornetq/core/replication/impl/ReplicationManagerImpl.java 2011-06-27
13:38:04 UTC (rev 10881)
+++
trunk/hornetq-core/src/main/java/org/hornetq/core/replication/impl/ReplicationManagerImpl.java 2011-06-27
13:39:55 UTC (rev 10882)
@@ -51,11 +51,9 @@
import org.hornetq.utils.ExecutorFactory;
/**
- * A RepplicationManagerImpl
- *
+ * A ReplicationManagerImpl
+ *
* @author <mailto:clebert.suconic@jboss.org">Clebert Suconic</a>
- *
- *
*/
public class ReplicationManagerImpl implements ReplicationManager
{
Modified: trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Acceptor.java
===================================================================
---
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Acceptor.java 2011-06-27
13:38:04 UTC (rev 10881)
+++
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Acceptor.java 2011-06-27
13:39:55 UTC (rev 10882)
@@ -17,11 +17,12 @@
import org.hornetq.core.server.management.NotificationService;
/**
- * An Acceptor is used by the Remoting Service to allow clients to connect. It should
take care of dispatching client requests
- * to the Remoting Service's Dispatcher.
- *
+ * An Acceptor is used by the Remoting Service to allow clients to connect. It should
take care of
+ * dispatching client requests to the Remoting Service's Dispatcher.
+ *
* @author <a href="ataylor(a)redhat.com">Andy Taylor</a>
* @author <a href="tim.fox(a)jboss.com">Tim Fox</a>
+ * @see Connector
*/
public interface Acceptor extends HornetQComponent
{
Modified: trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Connector.java
===================================================================
---
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Connector.java 2011-06-27
13:38:04 UTC (rev 10881)
+++
trunk/hornetq-core/src/main/java/org/hornetq/spi/core/remoting/Connector.java 2011-06-27
13:39:55 UTC (rev 10882)
@@ -20,17 +20,17 @@
public interface Connector
{
/**
- * starts the connector
+ * Starts the connector.
*/
void start();
/**
- * closes the connector
+ * Closes the connector.
*/
void close();
/**
- * returns true if the connector is started, oterwise false.
+ * Returns true if the connector is started, otherwise false.
*
* @return true if the connector is started
*/
@@ -39,9 +39,9 @@
/**
* Create and return a connection from this connector.
* <p/>
- * This method must NOT throw an exception if it fails to create the connection
- * (e.g. network is not available), in this case it MUST return null
- *
+ * This method must NOT throw an exception if it fails to create the connection (e.g.
network is
+ * not available), in this case it MUST return {@code null}.
+ *
* @return The connection, or null if unable to create a connection (e.g. network is
unavailable)
*/
Connection createConnection();