You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commonsrdf.apache.org by st...@apache.org on 2016/09/08 15:32:06 UTC

[38/50] incubator-commonsrdf git commit: javadoc tweaks

javadoc tweaks


Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/4e7f2617
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/4e7f2617
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/4e7f2617

Branch: refs/heads/jsonld-java
Commit: 4e7f26179615ece7f0a3c38eb33d00309e430a8a
Parents: 7500084
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Tue Sep 6 16:07:19 2016 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Tue Sep 6 16:07:19 2016 +0100

----------------------------------------------------------------------
 api/src/main/java/org/apache/commons/rdf/api/GraphLike.java    | 6 +++---
 api/src/main/java/org/apache/commons/rdf/api/Quad.java         | 2 ++
 api/src/main/java/org/apache/commons/rdf/api/QuadLike.java     | 6 ++++--
 .../main/java/org/apache/commons/rdf/api/RDFTermFactory.java   | 1 +
 api/src/main/java/org/apache/commons/rdf/api/Triple.java       | 2 ++
 api/src/main/java/org/apache/commons/rdf/api/TripleLike.java   | 6 ++++--
 6 files changed, 16 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/GraphLike.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/GraphLike.java b/api/src/main/java/org/apache/commons/rdf/api/GraphLike.java
index bd37510..f8d052f 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/GraphLike.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/GraphLike.java
@@ -26,9 +26,9 @@ import java.util.stream.Stream;
  * Extended by {@link Graph} (for {@link Triple}) and {@link Dataset} (for
  * {@link Quad}).
  * <p>
- * Unlike {@link Graph} and {@link Dataset}, this interface can support with
- * generalised {@link TripleLike} or {@link QuadLike} statements, and does not
- * include semantics like {@link #size()} or the requirement of mapping
+ * Unlike {@link Graph} and {@link Dataset}, this interface can support
+ * generalised {@link TripleLike} or {@link QuadLike} statements, but does not
+ * imply semantics like {@link #size()} or the requirement of mapping
  * {@link RDFTerm} instances from different implementations.
  * <p>
  * As {@link TripleLike} do not have a specific {@link Object#equals(Object)}

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/Quad.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/Quad.java b/api/src/main/java/org/apache/commons/rdf/api/Quad.java
index 679000b..951f593 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/Quad.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/Quad.java
@@ -29,6 +29,8 @@ import java.util.Optional;
  * February 2014.
  * 
  * @since 0.3.0-incubating
+ * @see Dataset
+ * @see RDFTermFactory#createQuad(BlankNodeOrIRI,BlankNodeOrIRI,IRI,RDFTerm)
  * @see <a href="http://www.w3.org/TR/2014/NOTE-rdf11-datasets-20140225/">RDF
  *      1.1: On Semantics of RDF Datasets</a>
  * @see <a href="http://www.w3.org/TR/rdf11-concepts/#section-dataset"> </a>

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/QuadLike.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/QuadLike.java b/api/src/main/java/org/apache/commons/rdf/api/QuadLike.java
index 3f85862..8de180a 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/QuadLike.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/QuadLike.java
@@ -25,8 +25,10 @@ import java.util.Optional;
  * A QuadLike statement has at least a {@link #getSubject()},
  * {@link #getPredicate()}, {@link #getObject()} and {@link #getGraphName()},
  * but unlike a {@link Quad} does not have a formalised
- * {@link Quad#equals(Object)} semantics, and can allow generalised quads (e.g.
- * a {@link BlankNode} as predicate).
+ * {@link Quad#equals(Object)} 
+ * or {@link Quad#hashCode()} 
+ * semantics. This interface can also be used for <em>generalised quads</em>
+ * (e.g. a {@link BlankNode} as predicate).
  * <p>
  * Implementations should specialise which specific {@link RDFTerm} types they
  * return for {@link #getSubject()}, {@link #getPredicate()},

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/RDFTermFactory.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/RDFTermFactory.java b/api/src/main/java/org/apache/commons/rdf/api/RDFTermFactory.java
index 48605e7..17758b6 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/RDFTermFactory.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/RDFTermFactory.java
@@ -36,6 +36,7 @@ import java.util.Locale;
  *
  * @see RDFTerm
  * @see Graph
+ * @see Quad
  */
 public interface RDFTermFactory {
 

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/Triple.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/Triple.java b/api/src/main/java/org/apache/commons/rdf/api/Triple.java
index dcbb509..9375983 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/Triple.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/Triple.java
@@ -25,6 +25,8 @@ import java.util.Objects;
  * >RDF-1.1 Concepts and Abstract Syntax</a>, a W3C Recommendation published on
  * 25 February 2014.<br>
  *
+ * @see Quad 
+ * @see RDFTermFactory#createTriple(BlankNodeOrIRI,IRI,RDFTerm)
  * @see <a href= "http://www.w3.org/TR/rdf11-concepts/#dfn-rdf-triple" >RDF-1.1
  * Triple</a>
  */

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4e7f2617/api/src/main/java/org/apache/commons/rdf/api/TripleLike.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/TripleLike.java b/api/src/main/java/org/apache/commons/rdf/api/TripleLike.java
index 9bead97..55d0380 100644
--- a/api/src/main/java/org/apache/commons/rdf/api/TripleLike.java
+++ b/api/src/main/java/org/apache/commons/rdf/api/TripleLike.java
@@ -23,8 +23,10 @@ package org.apache.commons.rdf.api;
  * <p>
  * A TripleLike statement has at least a {@link #getSubject()},
  * {@link #getPredicate()} and {@link #getObject()}, but unlike a {@link Triple}
- * does not have a formalised {@link Triple#equals(Object)} semantics, and can
- * allow generalised triples (e.g. a {@link BlankNode} as predicate).
+ * does not have a formalised 
+ * {@link Triple#equals(Object)} or 
+ * {@link Triple#hashCode()} semantics. This interfaced can also be 
+ * used for <em>generalised triples</em> (e.g. a {@link BlankNode} as predicate).
  * <p>
  * Implementations should specialise which specific {@link RDFTerm} types they
  * return for {@link #getSubject()}, {@link #getPredicate()} and