helix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j...@apache.org
Subject helix git commit: [HELIX-670] Fix typo in Javadoc
Date Wed, 04 Oct 2017 21:11:44 GMT
Repository: helix
Updated Branches:
  refs/heads/master d57882b9b -> d2c3ebb48


[HELIX-670] Fix typo in Javadoc


Project: http://git-wip-us.apache.org/repos/asf/helix/repo
Commit: http://git-wip-us.apache.org/repos/asf/helix/commit/d2c3ebb4
Tree: http://git-wip-us.apache.org/repos/asf/helix/tree/d2c3ebb4
Diff: http://git-wip-us.apache.org/repos/asf/helix/diff/d2c3ebb4

Branch: refs/heads/master
Commit: d2c3ebb486c95a010a0d6c9dcafa2b968e30fce2
Parents: d57882b
Author: Dongqi Xue <dongqixue@gmail.com>
Authored: Mon Oct 2 16:34:49 2017 -0700
Committer: Dongqi Xue <dongqi@hcdatainc.com>
Committed: Wed Oct 4 13:57:23 2017 -0700

----------------------------------------------------------------------
 .../java/org/apache/helix/BaseDataAccessor.java    |  8 ++++----
 .../org/apache/helix/ClusterMessagingService.java  | 17 ++++++++---------
 2 files changed, 12 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/helix/blob/d2c3ebb4/helix-core/src/main/java/org/apache/helix/BaseDataAccessor.java
----------------------------------------------------------------------
diff --git a/helix-core/src/main/java/org/apache/helix/BaseDataAccessor.java b/helix-core/src/main/java/org/apache/helix/BaseDataAccessor.java
index 32510c0..28891b2 100644
--- a/helix-core/src/main/java/org/apache/helix/BaseDataAccessor.java
+++ b/helix-core/src/main/java/org/apache/helix/BaseDataAccessor.java
@@ -88,7 +88,7 @@ public interface BaseDataAccessor<T> {
    * Use it when creating children under a parent node. This will use async api for better
    * performance. If the child already exists it will return false.
    * @param paths the paths to the children ZNodes
-   * @param record List of data to write to each of the path
+   * @param records List of data to write to each of the path
    * @param options Set the type of ZNode see the valid values in {@link AccessOption}
    * @return For each child: true if creation succeeded, false otherwise (e.g. if the child
exists)
    */
@@ -98,7 +98,7 @@ public interface BaseDataAccessor<T> {
    * can set multiple children under a parent node. This will use async api for better
    * performance. If this child does not exist it will create it.
    * @param paths the paths to the children ZNodes
-   * @param record List of data with which to overwrite the corresponding ZNodes
+   * @param records List of data with which to overwrite the corresponding ZNodes
    * @param options Set the type of ZNode see the valid values in {@link AccessOption}
    * @return For each child: true if the data was set, false otherwise
    */
@@ -107,7 +107,7 @@ public interface BaseDataAccessor<T> {
   /**
    * Can update multiple nodes using async api for better performance. If a child does not
    * exist it will create it.
-   * @param the paths to the children ZNodes
+   * @param paths the paths to the children ZNodes
    * @param updaters List of update routines for records to update
    * @param options Set the type of ZNode see the valid values in {@link AccessOption}
    * @return For each child, true if the data is updated successfully, false otherwise
@@ -142,7 +142,7 @@ public interface BaseDataAccessor<T> {
 
   /**
    * Get the children under a parent path using async api
-   * @param path path to the immediate parent ZNode
+   * @param parentPath path to the immediate parent ZNode
    * @param stats Zookeeper Stat objects corresponding to each child
    * @param options Set the type of ZNode see the valid values in {@link AccessOption}
    * @return A list of children of the parent ZNode

http://git-wip-us.apache.org/repos/asf/helix/blob/d2c3ebb4/helix-core/src/main/java/org/apache/helix/ClusterMessagingService.java
----------------------------------------------------------------------
diff --git a/helix-core/src/main/java/org/apache/helix/ClusterMessagingService.java b/helix-core/src/main/java/org/apache/helix/ClusterMessagingService.java
index 96a5957..28188e0 100644
--- a/helix-core/src/main/java/org/apache/helix/ClusterMessagingService.java
+++ b/helix-core/src/main/java/org/apache/helix/ClusterMessagingService.java
@@ -37,7 +37,7 @@ import org.apache.helix.model.Message;
 public interface ClusterMessagingService {
   /**
    * Send message matching the specifications mentioned in recipientCriteria.
-   * @param receipientCriteria criteria to be met, defined as {@link Criteria}
+   * @param recipientCriteria criteria to be met, defined as {@link Criteria}
    * @See Criteria
    * @param message
    *          message to be sent. Some attributes of this message will be
@@ -55,24 +55,24 @@ public interface ClusterMessagingService {
    * This is useful when message need to be sent and current thread need not
    * wait for response since processing will be done in another thread.
    * @see #send(Criteria, Message)
-   * @param receipientCriteria
+   * @param recipientCriteria
    * @param message
    * @param callbackOnReply callback to trigger on completion
    * @param timeOut Time to wait before failing the send
    * @return the number of messages that were successfully sent
    */
-  int send(Criteria receipientCriteria, Message message, AsyncCallback callbackOnReply, int
timeOut);
+  int send(Criteria recipientCriteria, Message message, AsyncCallback callbackOnReply, int
timeOut);
 
   /**
    * @see #send(Criteria, Message, AsyncCallback, int)
-   * @param receipientCriteria
+   * @param recipientCriteria
    * @param message
    * @param callbackOnReply
    * @param timeOut
    * @param retryCount maximum number of times to retry the send
    * @return the number of messages that were successfully sent
    */
-  int send(Criteria receipientCriteria, Message message, AsyncCallback callbackOnReply,
+  int send(Criteria recipientCriteria, Message message, AsyncCallback callbackOnReply,
       int timeOut, int retryCount);
 
   /**
@@ -86,14 +86,13 @@ public interface ClusterMessagingService {
    * The current thread can use callbackOnReply instance to store application
    * specific data.
    * @see #send(Criteria, Message, AsyncCallback, int)
-   * @param receipientCriteria
+   * @param recipientCriteria
    * @param message
    * @param callbackOnReply
    * @param timeOut
-   * @param retryCount
    * @return the number of messages that were successfully sent
    */
-  int sendAndWait(Criteria receipientCriteria, Message message, AsyncCallback callbackOnReply,
+  int sendAndWait(Criteria recipientCriteria, Message message, AsyncCallback callbackOnReply,
       int timeOut);
 
   /**
@@ -144,7 +143,7 @@ public interface ClusterMessagingService {
   /**
    * This will generate all messages to be sent given the recipientCriteria and MessageTemplate,
    * the messages are not sent.
-   * @param receipientCriteria criteria to be met, defined as {@link Criteria}
+   * @param recipientCriteria criteria to be met, defined as {@link Criteria}
    * @param messageTemplate the Message on which to base the messages to send
    * @return messages to be sent, grouped by the type of instance to send the message to
    */


Mime
View raw message