[05/13] incubator-tinkerpop git commit: Update javadoc for PartitionStrategy Builder.

[sp...@apache.org]

Update javadoc for PartitionStrategy Builder.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/92eeafcb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/92eeafcb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/92eeafcb

Branch: refs/heads/master
Commit: 92eeafcb12005abb2289ac3393f3a6284e550705
Parents: c765591
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Aug 28 13:54:57 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Aug 28 13:54:57 2015 -0400

----------------------------------------------------------------------
 .../strategy/decoration/PartitionStrategy.java      | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/92eeafcb/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/decoration/PartitionStrategy.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/decoration/PartitionStrategy.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/decoration/PartitionStrategy.java
index f5b2492..6c5139b 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/decoration/PartitionStrategy.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/strategy/decoration/PartitionStrategy.java
@@ -223,21 +223,37 @@ public final class PartitionStrategy extends AbstractTraversalStrategy<Traversal
             return this;
         }
 
+        /**
+         * Specifies the name of the partition to write when adding vertices, edges and vertex properties.  This
+         * name can be any user defined value.  It is only possible to write to a single partition at a time.
+         */
         public Builder writePartition(final String writePartition) {
             this.writePartition = writePartition;
             return this;
         }
 
+        /**
+         * Specifies the partition key name.  This is the property key that contains the partition value. It
+         * may a good choice to index on this key in certain cases (in graphs that support such things). This
+         * value must be specified for the {@code PartitionStrategy} to be constructed properly.
+         */
         public Builder partitionKey(final String partitionKey) {
             this.partitionKey = partitionKey;
             return this;
         }
 
+        /**
+         * Specifies the partition of the graph to read from.  It is possible to assign multiple partition keys so
+         * as to read from multiple partitions at the same time.
+         */
         public Builder addReadPartition(final String readPartition) {
             this.readPartitions.add(readPartition);
             return this;
         }
 
+        /**
+         * Creates the {@code PartitionStrategy}.
+         */
         public PartitionStrategy create() {
             if (partitionKey == null || partitionKey.isEmpty())
                 throw new IllegalStateException("The partitionKey cannot be null or empty");