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/14 21:07:59 UTC
[2/4] incubator-tinkerpop git commit: Update javadoc on Result.
Update javadoc on Result.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/35b4b917
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/35b4b917
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/35b4b917
Branch: refs/heads/tp30
Commit: 35b4b9174461e6428edad8a629019b61ee697092
Parents: e17235b
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Aug 14 13:50:04 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Aug 14 13:50:04 2015 -0400
----------------------------------------------------------------------
.../apache/tinkerpop/gremlin/driver/Result.java | 64 +++++++++++++++++++-
1 file changed, 62 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/35b4b917/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 f65f2be..0ea13f0 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
@@ -44,26 +44,54 @@ public final class Result {
this.resultObject = responseData;
}
+ /**
+ * Gets the result item by coercing it to a {@code String} via {@code toString()}.
+ */
public String getString() {
return resultObject.toString();
}
+ /**
+ * Gets the result item by coercing it to an {@code int}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code int}.
+ */
public int getInt() {
return Integer.parseInt(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code byte}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code byte}.
+ */
public byte getByte() {
return Byte.parseByte(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code short}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code short}.
+ */
public short getShort() {
return Short.parseShort(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code long}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code long}.
+ */
public long getLong() {
return Long.parseLong(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code float}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code float}.
+ */
public float getFloat() {
return Float.parseFloat(resultObject.toString());
}
@@ -72,42 +100,74 @@ public final class Result {
return Double.parseDouble(resultObject.toString());
}
+ /**
+ * Gets the result item by coercing it to an {@code boolean}.
+ *
+ * @throws NumberFormatException if the value is not parsable as an {@code boolean}.
+ */
public boolean getBoolean() {
return Boolean.parseBoolean(resultObject.toString());
}
+ /**
+ * Determines if the result item is null or not. This is often a good check prior to calling other methods to
+ * get the object as they could throw an unexpected {@link NullPointerException} if the result item is
+ * {@code null}.
+ */
public boolean isNull() {
return null == resultObject;
}
+ /**
+ * Gets the result item by casting it to a {@link Vertex}.
+ */
public Vertex getVertex() {
return (Vertex) resultObject;
}
-
+ /**
+ * Gets the result item by casting it to an {@link Edge}.
+ */
public Edge getEdge() {
return (Edge) resultObject;
}
-
+ /**
+ * Gets the result item by casting it to an {@link Element}.
+ */
public Element getElement() {
return (Element) resultObject;
}
+ /**
+ * Gets the result item by casting it to a {@link Path}.
+ */
public Path getPath() {
return (Path) resultObject;
}
+ /**
+ * Gets the result item by casting it to a {@link Property}.
+ */
public <V> Property<V> getProperty() {
return (Property<V>) resultObject;
}
+ /**
+ * Gets the result item by casting it to a {@link VertexProperty}.
+ */
public <V> VertexProperty<V> getVertexProperty() {
return (VertexProperty<V>) resultObject;
}
+ /**
+ * Gets the result item by casting it to the specified {@link Class}.
+ */
public <T> T get(final Class<? extends T> clazz) {
return clazz.cast(this.resultObject);
}
+ /**
+ * Gets the result item.
+ */
public Object getObject() {
return this.resultObject;
}