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/10/07 14:19:45 UTC
[2/3] incubator-commonsrdf git commit: More Javadoc..
More Javadoc..
Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/1271ae01
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/1271ae01
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/1271ae01
Branch: refs/heads/jena
Commit: 1271ae013f1b983fedc64fa3271454d94b1e2c48
Parents: c718800
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Fri Oct 7 15:14:02 2016 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Fri Oct 7 15:16:16 2016 +0100
----------------------------------------------------------------------
.../commons/rdf/jena/ConversionException.java | 3 +++
.../org/apache/commons/rdf/jena/JenaBlankNode.java | 2 ++
.../org/apache/commons/rdf/jena/JenaDataset.java | 8 +++++++-
.../commons/rdf/jena/JenaGeneralizedQuadLike.java | 5 +++--
.../commons/rdf/jena/JenaGeneralizedTripleLike.java | 7 ++++---
.../java/org/apache/commons/rdf/jena/JenaGraph.java | 16 +++++++++++-----
.../java/org/apache/commons/rdf/jena/JenaIRI.java | 3 ++-
.../org/apache/commons/rdf/jena/JenaLiteral.java | 3 ++-
.../java/org/apache/commons/rdf/jena/JenaQuad.java | 8 ++++++--
.../org/apache/commons/rdf/jena/JenaQuadLike.java | 11 ++++++++++-
.../org/apache/commons/rdf/jena/JenaRDFTerm.java | 10 +++++++++-
.../org/apache/commons/rdf/jena/JenaTriple.java | 8 ++++++--
.../org/apache/commons/rdf/jena/JenaTripleLike.java | 15 ++++++++++++++-
13 files changed, 79 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java b/jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
index 990086f..be75427 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
@@ -22,6 +22,7 @@ import org.apache.jena.shared.JenaException;
/**
* Exception thrown when a problem arises across the Jena-CommonRDF boundary.
+ * <p>
* This should not happen in well-formed RDF data but, for example, Jena triples
* allow
* <a href="http://www.w3.org/TR/rdf11-concepts/#section-generalized-rdf" >
@@ -29,6 +30,8 @@ import org.apache.jena.shared.JenaException;
*/
public class ConversionException extends JenaException {
+ private static final long serialVersionUID = -898179977312382568L;
+
public ConversionException() {
super();
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaBlankNode.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaBlankNode.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaBlankNode.java
index 4777dda..ef12951 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaBlankNode.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaBlankNode.java
@@ -23,6 +23,8 @@ import org.apache.jena.graph.Node;
/**
* A Jena-backed {@link BlankNode}.
+ * <p>
+ * The underlying Jena {@link Node} can be accessed from {@link #asJenaNode()}.
*
* @see Node#isBlank()
*/
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaDataset.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaDataset.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaDataset.java
index ad8c0ca..4a85d34 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaDataset.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaDataset.java
@@ -18,10 +18,16 @@
package org.apache.commons.rdf.jena;
+import org.apache.commons.rdf.api.Dataset;
import org.apache.commons.rdf.api.Graph;
import org.apache.jena.sparql.core.DatasetGraph;
-/** Access the Jena graph backing this object */
+/**
+ * A Jena-backed {@link Dataset}.
+ * <p>
+ * The underlying Jena {@link DatasetGraph} can be accessed with
+ * {@link #asJenaDatasetGraph()}.
+ */
public interface JenaDataset extends org.apache.commons.rdf.api.Dataset {
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
index 272421d..49e1fe9 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
@@ -29,9 +29,10 @@ import org.apache.commons.rdf.api.RDFTerm;
* some serializations like JSON-LD.
* <p>
* Note that unlike {@link Quad}, this type does not have fixed semantics for
- * {@link #equals(Object)} or {@link #hashCode()} beyond object identity.
+ * {@link Object#equals(Object)} or {@link Object#hashCode()} beyond object
+ * identity.
*
+ * @see JenaGeneralizedTripleLike
*/
public interface JenaGeneralizedQuadLike extends JenaQuadLike<RDFTerm, RDFTerm, RDFTerm, RDFTerm> {
-
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedTripleLike.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedTripleLike.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedTripleLike.java
index 68e5264..546089f 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedTripleLike.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedTripleLike.java
@@ -29,10 +29,11 @@ import org.apache.commons.rdf.api.Triple;
* JSON-LD.
* <p>
* Note that unlike {@link Triple}, this type does not have fixed semantics for
- * {@link #equals(Object)} or {@link #hashCode()} beyond object identity.
+ * {@link Object#equals(Object)} or {@link Object#hashCode()} beyond object
+ * identity.
*
+ * @see JenaGeneralizedQuadLike
*/
public interface JenaGeneralizedTripleLike
- extends JenaTripleLike<RDFTerm, RDFTerm, RDFTerm> {
-
+ extends JenaTripleLike<RDFTerm, RDFTerm, RDFTerm> {
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
index 2ce453f..86b9f29 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
@@ -18,20 +18,26 @@
package org.apache.commons.rdf.jena;
-import org.apache.jena.graph.Graph;
+// NOTE: To avoid confusion, don't import Graph as it exists in both APIs
import org.apache.jena.rdf.model.Model;
+//
-/** Access the Jena graph backing this object */
+/**
+ * A Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ * <p>
+ * The underlying Jena {@link org.apache.jena.graph.Graph} can be accessed with
+ * {@link #asJenaGraph()}.
+ */
public interface JenaGraph extends org.apache.commons.rdf.api.Graph {
/**
- * Return the underlying Jena {@link Graph}.
+ * Return the underlying Jena {@link org.apache.jena.graph.Graph}.
* <p>
* Changes to the Jena graph are reflected in the Commons RDF graph and vice versa.
*
- * @return A Jena {@link Graph}
+ * @return A Jena {@link org.apache.jena.graph.Graph}
*/
- public Graph asJenaGraph();
+ public org.apache.jena.graph.Graph asJenaGraph();
/**
* Return the graph as a Jena {@link Model}.
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaIRI.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaIRI.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaIRI.java
index b16acd8..bcc46c8 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaIRI.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaIRI.java
@@ -15,7 +15,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.IRI;
@@ -23,6 +22,8 @@ import org.apache.jena.graph.Node;
/**
* A Jena-backed {@link IRI}.
+ * <p>
+ * The underlying Jena {@link Node} can be accessed from {@link #asJenaNode()}.
*
* @see Node#isURI()
*/
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
index df0c697..96bf530 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
@@ -15,7 +15,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.Literal;
@@ -23,6 +22,8 @@ import org.apache.jena.graph.Node;
/**
* A Jena-backed {@link Literal}
+ *
+ * The underlying Jena {@link Node} can be accessed from {@link #asJenaNode()}.
*
* @see Node#isLiteral()
*/
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
index 45d9d2c..b593263 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
@@ -15,14 +15,18 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.BlankNodeOrIRI;
import org.apache.commons.rdf.api.IRI;
import org.apache.commons.rdf.api.RDFTerm;
-/** Access the Jena quad backing this object */
+/**
+ * A Jena-backed {@link org.apache.commons.rdf.api.Quad}.
+ * <p>
+ * The underlying Jena {@link org.apache.jena.sparql.core.Quad}
+ * can be accessed with {@link #asJenaQuad()}.
+ */
public interface JenaQuad extends org.apache.commons.rdf.api.Quad,
JenaQuadLike<BlankNodeOrIRI,IRI,RDFTerm,BlankNodeOrIRI> {
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuadLike.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuadLike.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuadLike.java
index 015e8c9..e21e670 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuadLike.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaQuadLike.java
@@ -22,7 +22,16 @@ import org.apache.commons.rdf.api.QuadLike;
import org.apache.commons.rdf.api.RDFTerm;
import org.apache.jena.sparql.core.Quad;
-/** Access the Jena quad backing this object */
+/**
+ * A {@link QuadLike} wrapper of a Jena {@link Quad}.
+ * <p>
+ * This is a marker interface common to its specializations {@link JenaQuad} and
+ * {@link JenaGeneralizedQuadLike}.
+ *
+ * @see JenaQuad
+ * @see JenaGeneralizedQuadLike
+ *
+ */
public interface JenaQuadLike<S extends RDFTerm, P extends RDFTerm, O extends RDFTerm, G extends RDFTerm>
extends JenaTripleLike<S,P,O>, QuadLike<S,P,O,G> {
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
index 623f8b4..0bbe26b 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
@@ -21,7 +21,15 @@ package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.RDFTerm;
import org.apache.jena.graph.Node;
-/** Access the Jena node backing this object */
+/**
+ * A Jena-backed {@link RDFTerm}.
+ * <p>
+ * The underlying Jena {@link Node} can be retrieved with {@link #asJenaNode()}.
+ *
+ * @see JenaIRI
+ * @see JenaLiteral
+ * @see JenaBlankNode
+ */
public interface JenaRDFTerm extends RDFTerm {
public Node asJenaNode();
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
index b94cc08..d39bec7 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
@@ -15,13 +15,17 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.BlankNodeOrIRI;
import org.apache.commons.rdf.api.IRI;
import org.apache.commons.rdf.api.RDFTerm;
-/** Access the Jena triple backing this object */
+/**
+ * A Jena-backed {@link org.apache.commons.rdf.api.Triple}.
+ * <p>
+ * The underlying Jena {@link org.apache.jena.graph.Triple}
+ * can be accessed with {@link #asJenaTriple()}.
+ */
public interface JenaTriple extends org.apache.commons.rdf.api.Triple, JenaTripleLike<BlankNodeOrIRI, IRI, RDFTerm> {
}
http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/1271ae01/jena/src/main/java/org/apache/commons/rdf/jena/JenaTripleLike.java
----------------------------------------------------------------------
diff --git a/jena/src/main/java/org/apache/commons/rdf/jena/JenaTripleLike.java b/jena/src/main/java/org/apache/commons/rdf/jena/JenaTripleLike.java
index 4f0deb8..8821c51 100644
--- a/jena/src/main/java/org/apache/commons/rdf/jena/JenaTripleLike.java
+++ b/jena/src/main/java/org/apache/commons/rdf/jena/JenaTripleLike.java
@@ -19,9 +19,22 @@
package org.apache.commons.rdf.jena;
import org.apache.commons.rdf.api.RDFTerm;
+import org.apache.commons.rdf.api.TripleLike;
import org.apache.jena.graph.Triple;
-/** Access the Jena triple backing this object */
+/**
+ * A {@link TripleLike} wrapper of a Jena {@link Triple}.
+ * <p>
+ * This is a marker interface common to its specializations {@link JenaTriple},
+ * {@link JenaGeneralizedTripleLike}, {@link JenaQuad} and
+ * {@link JenaGeneralizedQuadLike}.
+ *
+ * @see JenaTriple
+ * @see JenaGeneralizedTripleLike
+ * @see JenaQuad
+ * @see JenaGeneralizedQuadLike
+ *
+ */
public interface JenaTripleLike<S extends RDFTerm, P extends RDFTerm, O extends RDFTerm>
extends org.apache.commons.rdf.api.TripleLike<S,P,O> {