You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@twill.apache.org by ch...@apache.org on 2015/07/24 20:29:44 UTC
[10/25] incubator-twill git commit: Simple change to add missing
Javadoc to class header and public method.
Simple change to add missing Javadoc to class header and public method.
This closes #44 on GitHub
Signed-off-by: Terence Yim <ch...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/incubator-twill/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-twill/commit/7350f285
Tree: http://git-wip-us.apache.org/repos/asf/incubator-twill/tree/7350f285
Diff: http://git-wip-us.apache.org/repos/asf/incubator-twill/diff/7350f285
Branch: refs/heads/site
Commit: 7350f2856dd2a45119bc6449d3ae0630acf72bdf
Parents: feee57a
Author: hsaputra <hs...@apache.org>
Authored: Thu Jun 18 11:45:05 2015 -0700
Committer: Terence Yim <ch...@apache.org>
Committed: Mon Jun 22 16:02:25 2015 -0700
----------------------------------------------------------------------
.../main/java/org/apache/twill/zookeeper/ZKClients.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/7350f285/twill-zookeeper/src/main/java/org/apache/twill/zookeeper/ZKClients.java
----------------------------------------------------------------------
diff --git a/twill-zookeeper/src/main/java/org/apache/twill/zookeeper/ZKClients.java b/twill-zookeeper/src/main/java/org/apache/twill/zookeeper/ZKClients.java
index f67c1bd..13b5827 100644
--- a/twill-zookeeper/src/main/java/org/apache/twill/zookeeper/ZKClients.java
+++ b/twill-zookeeper/src/main/java/org/apache/twill/zookeeper/ZKClients.java
@@ -22,7 +22,7 @@ import org.apache.twill.internal.zookeeper.NamespaceZKClient;
import org.apache.twill.internal.zookeeper.RewatchOnExpireZKClient;
/**
- *
+ * Utility class to create {@link ZKClient} instances.
*/
public final class ZKClients {
@@ -51,7 +51,13 @@ public final class ZKClients {
return new FailureRetryZKClient(client, retryStrategy);
}
-
+ /**
+ * Creates a {@link ZKClient} that will add prefix namespace for every paths.
+ *
+ * @param zkClient The {@link ZKClient} for operations delegation.
+ * @param namespace The prefix namespace to be prepended to paths.
+ * @return A {@link ZKClient} that will add namespace to every path.
+ */
public static ZKClient namespace(ZKClient zkClient, String namespace) {
return new NamespaceZKClient(zkClient, namespace);
}