[jboss-cvs] JBossAS SVN: r60799 - trunk/cluster/src/main/org/jboss/ha/framework/interfaces.

[jboss-cvs-commits at lists.jboss.org]

Author: jerrygauth
Date: 2007-02-22 14:07:15 -0500 (Thu, 22 Feb 2007)
New Revision: 60799

Modified:
   trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java
Log:
Fixed typos in javadoc

Modified: trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java	2007-02-22 18:39:53 UTC (rev 60798)
+++ trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java	2007-02-22 19:07:15 UTC (rev 60799)
@@ -64,12 +64,12 @@
    public String getPartitionName();
 
    /**
-    * Accessor to the DRM that is linked to this partition.
-    * @return the DRM linked to this partition
+    * Accessor to the DistributedReplicantManager (DRM) that is linked to this partition.
+    * @return the DistributedReplicantManager
     */   
    public DistributedReplicantManager getDistributedReplicantManager();
    /**
-    * Accessor the the DistributedState (DS) that is linked to this partition.
+    * Accessor to the DistributedState (DS) that is linked to this partition.
     * @return the DistributedState service
     */   
    public DistributedState getDistributedStateService ();
@@ -81,7 +81,7 @@
    // ***************************
    //
    /**
-    * The partition receives RPC calls from other nodes in the cluster and demultiplex
+    * The partition receives RPC calls from other nodes in the cluster and demultiplexes
     * them, according to a service name, to a particular service. Consequently, each
     * service must first subscribe with a particular service name in the partition. The subscriber
     * does not need to implement any specific interface: the call is handled
@@ -130,7 +130,7 @@
 
    /**
     * Invoke a asynchronous RPC call on all nodes of the partition/cluster. The
-    * call will return immediately and will not wait that the nodes answer. Thus
+    * call will return immediately and will not wait for the nodes to answer. Thus
     * no answer is available.
     * @param serviceName Name of the target service name on which calls are de-multiplexed
     * @param methodName name of the Java method to be called on remote services
@@ -152,7 +152,6 @@
     * @param args array of Java Object representing the set of parameters to be
     * given to the remote method
     * @param types The types of the parameters
-    * node of the partition or only on remote nodes
     * @param excludeSelf indicates if the RPC will be made on the current node even if the current node
     * is the coordinator
     * @throws Exception Throws if a communication exception occurs
@@ -183,19 +182,19 @@
    //
    
    /**
-    * State management is higly important for clustered services. Consequently, services that wish to manage their state
-    * need to subscribe to state transfer events. When their node start, a state is pushed from another node to them.
-    * When another node starts, they may be asked to provide such a state to initialise the newly started node.
+    * State management is highly important for clustered services. Consequently, services that wish to manage their state
+    * need to subscribe to state transfer events. When a service is started on a cluster node, state is pushed from another node to the  
+    * new node.  When another node starts, the node may be asked to provide its state to initialise the newly started node.
     */   
    public interface HAPartitionStateTransfer
    {
       /**
-       * Called when a new node need to be initialized. This is called on any existing node to determine a current state for this service.
+       * Called when a new node needs to be initialized. This is called on any existing node to determine a current state for this service.
        * @return A serializable representation of the state
        */      
       public Serializable getCurrentState ();
       /**
-       * This callback method is called when a new service starts on a new node: the state that it should hold is transfered to it through this callback
+       * This callback method is called when a new service starts on a new node; the state that it should hold is transfered to it through this callback.
        * @param newState The serialized representation of the state of the new service.
        */      
       public void setCurrentState(Serializable newState);
@@ -203,7 +202,7 @@
    
    /**
     * Register a service that will participate in state transfer protocol and receive callbacks
-    * @param serviceName Name of the service that subscribes for state stransfer events. This name must be identical for all identical services in the cluster.
+    * @param serviceName Name of the service that subscribes for state transfer events. This name must be identical for all identical services in the cluster.
     * @param subscriber Object implementing {@link HAPartitionStateTransfer} and providing or receiving state transfer callbacks
     */   
    public void subscribeToStateTransferEvents (String serviceName, HAPartition.HAPartitionStateTransfer subscriber);
@@ -230,7 +229,7 @@
       /** Called when a new partition topology occurs. This callback is made
        * using the JG protocol handler thread and so you cannot execute new
        * cluster calls that need this thread. If you need to do that implement
-       * the aynchronous version of the listener interface.
+       * the asynchronous version of the listener interface.
        *
        * @param deadMembers A list of nodes that have died since the previous view
        * @param newMembers A list of nodes that have joined the partition since the previous view
@@ -240,7 +239,7 @@
    }
 
    /** A tagging interface for HAMembershipListener callbacks that will
-    * be performed in a thread seperate from the JG protocl handler thread.
+    * be performed in a thread separate from the JG protocol handler thread.
     * The ordering of view changes is preserved, but listeners are free to
     * execute cluster calls.
     */
@@ -258,14 +257,14 @@
        * @param deadMembers A list of nodes that have died since the previous view
        * @param newMembers A list of nodes that have joined the partition since the previous view
        * @param allMembers A list of nodes that built the current view
-       * @param originatingGroups A list of list of nodes that were previously partionned and that are now merged
+       * @param originatingGroups A list of nodes that were previously partioned and that are now merged
        */      
       public void membershipChangedDuringMerge(Vector deadMembers, Vector newMembers,
             Vector allMembers, Vector originatingGroups);
    }
 
    /** A tagging interface for HAMembershipExtendedListener callbacks that will
-    * be performed in a thread seperate from the JG protocl handler thread.
+    * be performed in a thread separate from the JG protocol handler thread.
     * The ordering of view changes is preserved, but listeners are free to
     * execute cluster calls.
     */
@@ -318,14 +317,14 @@
     */   
    public long getCurrentViewId();
    /**
-    * Return the list of member nodes that built the current view i.e. the current partition.
+    * Return the list of member nodes that built the current view i.e., the current partition.
     * @return An array of Strings containing the node names
     */   
    public Vector getCurrentView ();
 
    /**
-    * Return the member nodes that built the current view i.e. the current partition.
-    * @return   An array of ClusterNode listing the current members of the partitionn.
+    * Return the member nodes that built the current view i.e., the current partition.
+    * @return   An array of ClusterNode listing the current members of the partition.
     *           This array will be in the same order in all nodes in the cluster that
     *           have received the current view.
     */