You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/08/25 15:05:59 UTC
[02/17] incubator-tinkerpop git commit: Update javadoc.
Update javadoc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/25063bb6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/25063bb6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/25063bb6
Branch: refs/heads/master
Commit: 25063bb61ef2849749d0a8be287687ce7b3794be
Parents: b9293bb
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Aug 25 08:32:17 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Aug 25 08:32:17 2015 -0400
----------------------------------------------------------------------
.../java/org/apache/tinkerpop/gremlin/driver/Result.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/25063bb6/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Result.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Result.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Result.java
index 0ea13f0..58793e8 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Result.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Result.java
@@ -29,8 +29,9 @@ import org.apache.tinkerpop.gremlin.structure.VertexProperty;
import java.util.Iterator;
/**
- * A {@code Result} represents an result value from the server (i.e. one item from the server-side {@link Iterator}
- * of results.
+ * A {@code Result} represents a result value from the server-side {@link Iterator} of results. This would be
+ * one item from that result set. This class provides methods for coercing the result {@link Object} to an
+ * expected type.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
@@ -96,6 +97,11 @@ public final class Result {
return Float.parseFloat(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code double}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code double}.
+ */
public double getDouble() {
return Double.parseDouble(resultObject.toString());
}