[hornetq-commits] JBoss hornetq SVN: r11754 - in trunk/hornetq-core/src/main/java/org/hornetq: core/config and 2 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Thu Nov 24 07:24:54 EST 2011
Author: borges
Date: 2011-11-24 07:24:54 -0500 (Thu, 24 Nov 2011)
New Revision: 11754
Modified:
trunk/hornetq-core/src/main/java/org/hornetq/api/core/TransportConfiguration.java
trunk/hornetq-core/src/main/java/org/hornetq/core/config/ClusterConnectionConfiguration.java
trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Channel.java
trunk/hornetq-core/src/main/java/org/hornetq/core/server/HornetQServer.java
Log:
Improve Javadocs
Modified: trunk/hornetq-core/src/main/java/org/hornetq/api/core/TransportConfiguration.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/api/core/TransportConfiguration.java 2011-11-24 12:24:34 UTC (rev 11753)
+++ trunk/hornetq-core/src/main/java/org/hornetq/api/core/TransportConfiguration.java 2011-11-24 12:24:54 UTC (rev 11754)
@@ -19,19 +19,21 @@
import org.hornetq.utils.UUIDGenerator;
/**
- * A TransportConfiguration is used by a client to specify a connections to a server and its backup if one exists.<br><br>
+ * A TransportConfiguration is used by a client to specify connections to a server and its backup if
+ * one exists.
+ * <p>
+ * Typically the constructors take the class name and parameters for needed to create the
+ * connection. These will be different dependent on which connector is being used, i.e. Netty or
+ * InVM etc. For example:
* <p/>
- * Typically the constructors take the class name and parameters for needed to create the connection. These will be
- * different dependent on which connector is being used, i.e. Netty or InVM etc. For example:<br><br>
- * <p/>
- * <code>
- * HashMap<String, Object> map = new HashMap<String, Object>();<br>
- * map.put("host", "localhost");<br>
- * map.put("port", 5445);<br>
- * TransportConfiguration config = new TransportConfiguration(InVMConnectorFactory.class.getName(), map); <br>
- * ClientSessionFactory sf = new ClientSessionFactoryImpl(config); <br>
- * </code><br><br>
- *
+ *
+ * <pre>
+ * HashMap<String, Object> map = new HashMap<String, Object>();
+ * map.put("host", "localhost");
+ * map.put("port", 5445);
+ * TransportConfiguration config = new TransportConfiguration(InVMConnectorFactory.class.getName(), map);
+ * ClientSessionFactory sf = new ClientSessionFactoryImpl(config);
+ * </pre>
* @author <a href="mailto:tim.fox at jboss.com">Tim Fox</a>
*/
public class TransportConfiguration implements Serializable
Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/config/ClusterConnectionConfiguration.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/config/ClusterConnectionConfiguration.java 2011-11-24 12:24:34 UTC (rev 11753)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/config/ClusterConnectionConfiguration.java 2011-11-24 12:24:54 UTC (rev 11754)
@@ -23,10 +23,6 @@
* A ClusterConnectionConfiguration
*
* @author <a href="mailto:tim.fox at jboss.com">Tim Fox</a>
- *
- * Created 13 Jan 2009 09:42:17
- *
- *
*/
public class ClusterConnectionConfiguration implements Serializable
{
Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Channel.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Channel.java 2011-11-24 12:24:34 UTC (rev 11753)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/protocol/core/Channel.java 2011-11-24 12:24:54 UTC (rev 11754)
@@ -36,7 +36,7 @@
* @return the id
*/
long getID();
-
+
/** For protocol check */
boolean supports(byte packetID);
@@ -46,7 +46,7 @@
* @param packet the packet to send
*/
void send(Packet packet);
-
+
/**
* sends a packet on this channel using batching algorithm if appropriate
*
@@ -71,8 +71,8 @@
Packet sendBlocking(Packet packet) throws HornetQException;
/**
- * sets the {@link org.hornetq.core.protocol.core.ChannelHandler} that this channel should forward received packets to.
- *
+ * Sets the {@link org.hornetq.core.protocol.core.ChannelHandler} that this channel should
+ * forward received packets to.
* @param handler the handler
*/
void setHandler(ChannelHandler handler);
@@ -134,7 +134,7 @@
Lock getLock();
/**
- * returns the Remoting Connection being used by the channel
+ * returns the {@link CoreRemotingConnection} being used by the channel
*/
CoreRemotingConnection getConnection();
Modified: trunk/hornetq-core/src/main/java/org/hornetq/core/server/HornetQServer.java
===================================================================
--- trunk/hornetq-core/src/main/java/org/hornetq/core/server/HornetQServer.java 2011-11-24 12:24:34 UTC (rev 11753)
+++ trunk/hornetq-core/src/main/java/org/hornetq/core/server/HornetQServer.java 2011-11-24 12:24:54 UTC (rev 11754)
@@ -48,19 +48,28 @@
import org.hornetq.utils.ExecutorFactory;
/**
- * This interface defines the internal interface of the HornetQ Server exposed to other components of the server. The
- * external management interface of the HornetQ Server is defined by the HornetQServerManagement interface This
- * interface is never exposed outside the HornetQ server, e.g. by JMX or other means
- *
+ * This interface defines the internal interface of the HornetQ Server exposed to other components
+ * of the server.
+ * <p>
+ * The external management interface of the HornetQ Server is defined by the HornetQServerManagement
+ * interface.
+ * <p>
+ * This interface is never exposed outside the HornetQ server, e.g. by JMX or other means
* @author <a href="tim.fox at jboss.com">Tim Fox</a>
* @author <a href="ataylor at redhat.com">Andy Taylor</a>
*/
public interface HornetQServer extends HornetQComponent
{
- /** This method was created mainly for testing but it may be used in scenarios where
- * you need to have more than one Server inside the same VM.
- * This identity will be exposed on logs what may help you to debug issues on the log traces and debugs.*/
+ /**
+ * Sets the server identity.
+ * <p>
+ * The identity will be exposed on logs. It may help to debug issues on the log traces and
+ * debugs.
+ * <p>
+ * This method was created mainly for testing but it may be used in scenarios where you need to
+ * have more than one Server inside the same VM.
+ */
void setIdentity(String identity);
String getIdentity();
@@ -85,9 +94,7 @@
/**
* Returns the resource to manage this HornetQ server.
- *
- * Using this control will throw IllegalStateException if the
- * server is not properly started.
+ * @throws IllegalStateException if the server is not properly started.
*/
HornetQServerControlImpl getHornetQServerControl();
More information about the hornetq-commits
mailing list