This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rdf.git
commit 9be49776b0a3ec7202e2154ce528aa99baeb58e4
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Apr 24 18:00:10 2025 -0400
Add missing Javadoc
---
.../org/apache/commons/rdf/api/BlankNodeOrIRI.java | 1 +
.../commons/rdf/jena/ConversionException.java | 30 +++-
.../commons/rdf/jena/JenaGeneralizedQuadLike.java | 2 +
.../org/apache/commons/rdf/jena/JenaGraph.java | 20 +--
.../org/apache/commons/rdf/jena/JenaLiteral.java | 5 +-
.../java/org/apache/commons/rdf/jena/JenaQuad.java | 1 +
.../org/apache/commons/rdf/jena/JenaRDFTerm.java | 7 +
.../org/apache/commons/rdf/jena/JenaTriple.java | 1 +
.../rdf/jena/experimental/JenaRDFParser.java | 15 ++
.../commons/rdf/jena/impl/InternalJenaFactory.java | 157 +++++++++++++++++++--
.../commons/rdf/jsonldjava/JsonLdBlankNode.java | 3 +
.../commons/rdf/jsonldjava/JsonLdDataset.java | 3 +
.../apache/commons/rdf/jsonldjava/JsonLdIRI.java | 4 +-
.../commons/rdf/jsonldjava/JsonLdLiteral.java | 3 +
.../apache/commons/rdf/jsonldjava/JsonLdQuad.java | 3 +
.../commons/rdf/jsonldjava/JsonLdQuadLike.java | 3 +
.../apache/commons/rdf/jsonldjava/JsonLdRDF.java | 9 ++
.../apache/commons/rdf/jsonldjava/JsonLdTerm.java | 3 +
.../commons/rdf/jsonldjava/JsonLdTriple.java | 3 +
.../commons/rdf/jsonldjava/JsonLdTripleLike.java | 3 +
.../rdf/jsonldjava/experimental/JsonLdParser.java | 3 +
.../java/org/apache/commons/rdf/rdf4j/RDF4J.java | 8 ++
.../rdf/rdf4j/experimental/RDF4JParser.java | 5 +
.../rdf/simple/experimental/RDFParseException.java | 4 +
24 files changed, 270 insertions(+), 26 deletions(-)
diff --git
a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/BlankNodeOrIRI.java
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/BlankNodeOrIRI.java
index 1c6c4698..0a6ad546 100644
---
a/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/BlankNodeOrIRI.java
+++
b/commons-rdf-api/src/main/java/org/apache/commons/rdf/api/BlankNodeOrIRI.java
@@ -23,6 +23,7 @@ package org.apache.commons.rdf.api;
* position of a {@link Quad}.
* <p>
* Instances of BlankNodeOrIRI SHOULD be a {@link BlankNode} or an {@link IRI}.
+ * </p>
*/
public interface BlankNodeOrIRI extends RDFTerm {
}
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
index 3159f14f..9c32b816 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/ConversionException.java
@@ -21,26 +21,48 @@ package org.apache.commons.rdf.jena;
/**
* 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";>
+ * 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";>
* generalized RDF</a>.
+ * </p>
*/
-
public class ConversionException extends RuntimeException {
+
private static final long serialVersionUID = -898179977312382568L;
+ /**
+ * Constructs a new runtime exception with {@code null} as its detail
message. The cause is not initialized, and may subsequently be initialized by a
call
+ * to {@link #initCause}.
+ */
public ConversionException() {
}
+ /**
+ * Constructs a new instance with the specified detail message.
+ *
+ * @param message the detail message (which you can get using {@link
#getMessage()}).
+ */
public ConversionException(final String message) {
super(message);
}
+ /**
+ * Constructs a new instance with the specified detail message and cause.
+ * <p>
+ * The detail message associated with {@code cause} is <em>not</em>
automatically incorporated in the detail message.
+ * </p>
+ *
+ * @param message the detail message (which you can get using {@link
#getMessage()}).
+ * @param cause the cause (which you can get using {@link
#getMessage()}}. A {@code null} means the cause is nonexistent or unknown.
+ */
public ConversionException(final String message, final Throwable cause) {
super(message, cause);
}
+ /**
+ * Constructs a new instance with the specified detail cause.
+ *
+ * @param cause the cause (which you can get using {@link #getMessage()}}.
A {@code null} means the cause is nonexistent or unknown.
+ */
public ConversionException(final Throwable cause) {
super(cause);
}
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
index 100cbaa9..faa342a6 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGeneralizedQuadLike.java
@@ -27,10 +27,12 @@ import org.apache.commons.rdf.api.RDFTerm;
* {@link RDFTerm} type for its {@link #getSubject()}, {@link #getPredicate()}
* {@link #getObject()} and {@link #getGraphName()}. This might be useful with
* some serializations like JSON-LD.
+ * </p>
* <p>
* Note that unlike {@link Quad}, this type does not have fixed semantics for
* {@link Object#equals(Object)} or {@link Object#hashCode()} beyond object
* identity.
+ * </p>
*
* @see JenaGeneralizedTripleLike
*/
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
index c96705d5..f6f01986 100644
--- a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
+++ b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaGraph.java
@@ -25,17 +25,17 @@ import org.apache.jena.rdf.model.Model;
/**
* 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()}.
+ * The underlying Jena {@link org.apache.jena.graph.Graph} can be accessed
with {@link #asJenaGraph()}.
+ * </p>
*/
public interface JenaGraph extends org.apache.commons.rdf.api.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.
- *
+ * Changes to the Jena graph are reflected in the Commons RDF graph and
vice versa.
+ * </p>
+ *
* @return A Jena {@link org.apache.jena.graph.Graph}
*/
org.apache.jena.graph.Graph asJenaGraph();
@@ -43,12 +43,12 @@ public interface JenaGraph extends
org.apache.commons.rdf.api.Graph {
/**
* Return the graph as a Jena {@link Model}.
* <p>
- * Changes to the Jena model are reflected in the Commons RDF graph and
vice
- * versa.
+ * Changes to the Jena model are reflected in the Commons RDF graph and
vice versa.
+ * </p>
* <p>
- * Note that in some cases there is no underlying Jena {@link Model}, in
- * which case this method will create one. Subsequent calls should return
- * the same model.
+ * Note that in some cases there is no underlying Jena {@link Model}, in
which case this method will create one. Subsequent calls should return the same
+ * model.
+ * </p>
*
* @return A Jena {@link Model}
*/
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
index 2f647449..880810ce 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaLiteral.java
@@ -21,9 +21,10 @@ import org.apache.commons.rdf.api.Literal;
import org.apache.jena.graph.Node;
/**
- * A Jena-backed {@link Literal}
- *
+ * A Jena-backed {@link Literal}.
+ * <p>
* The underlying Jena {@link Node} can be accessed from {@link #asJenaNode()}.
+ * </p>
*
* @see Node#isLiteral()
*/
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
index 00040176..f35a2454 100644
--- a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
+++ b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaQuad.java
@@ -24,6 +24,7 @@ import org.apache.commons.rdf.api.BlankNodeOrIRI;
* <p>
* The underlying Jena {@link org.apache.jena.sparql.core.Quad} can be accessed
* with {@link #asJenaQuad()}.
+ * </p>
*/
public interface JenaQuad extends org.apache.commons.rdf.api.Quad,
JenaQuadLike<BlankNodeOrIRI> {
}
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
index 5fdb916d..9c26ff3e 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaRDFTerm.java
@@ -25,11 +25,18 @@ import org.apache.jena.graph.Node;
* A Jena-backed {@link RDFTerm}.
* <p>
* The underlying Jena {@link Node} can be retrieved with {@link
#asJenaNode()}.
+ * </p>
*
* @see JenaIRI
* @see JenaLiteral
* @see JenaBlankNode
*/
public interface JenaRDFTerm extends RDFTerm {
+
+ /**
+ * Converts this instance to a node.
+ *
+ * @return this instance as a node.
+ */
Node asJenaNode();
}
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
index c73e0185..69e0c48a 100644
--- a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
+++ b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/JenaTriple.java
@@ -22,6 +22,7 @@ package org.apache.commons.rdf.jena;
* <p>
* The underlying Jena {@link org.apache.jena.graph.Triple} can be accessed
with
* {@link #asJenaTriple()}.
+ * </p>
*/
public interface JenaTriple extends org.apache.commons.rdf.api.Triple,
JenaTripleLike {
}
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/experimental/JenaRDFParser.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/experimental/JenaRDFParser.java
index 8154d2fc..94f871e0 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/experimental/JenaRDFParser.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/experimental/JenaRDFParser.java
@@ -37,6 +37,9 @@ import org.apache.jena.riot.RDFParser;
import org.apache.jena.riot.system.StreamRDF;
import org.apache.jena.riot.system.StreamRDFLib;
+/**
+ * Experimental.
+ */
public class JenaRDFParser extends AbstractRDFParser<JenaRDFParser> {
private Consumer<TripleLike> generalizedConsumerTriple;
@@ -89,6 +92,12 @@ public class JenaRDFParser extends
AbstractRDFParser<JenaRDFParser> {
this.generalizedConsumerQuad = null;
}
+ /**
+ * Experimental.
+ *
+ * @param consumer a Consumer.
+ * @return a clone of this instance.
+ */
public JenaRDFParser targetGeneralizedQuad(final
Consumer<QuadLike<RDFTerm>> consumer) {
final JenaRDFParser c = this.clone();
c.resetTarget();
@@ -96,6 +105,12 @@ public class JenaRDFParser extends
AbstractRDFParser<JenaRDFParser> {
return c;
}
+ /**
+ * Experimental.
+ *
+ * @param consumer a Consumer.
+ * @return a clone of this instance.
+ */
public JenaRDFParser targetGeneralizedTriple(final Consumer<TripleLike>
consumer) {
final JenaRDFParser c = this.clone();
c.resetTarget();
diff --git
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/impl/InternalJenaFactory.java
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/impl/InternalJenaFactory.java
index d279b82f..b16338db 100644
---
a/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/impl/InternalJenaFactory.java
+++
b/commons-rdf-jena/src/main/java/org/apache/commons/rdf/jena/impl/InternalJenaFactory.java
@@ -24,6 +24,8 @@ import java.util.UUID;
import org.apache.commons.rdf.api.BlankNode;
import org.apache.commons.rdf.api.BlankNodeOrIRI;
import org.apache.commons.rdf.api.IRI;
+import org.apache.commons.rdf.api.Literal;
+import org.apache.commons.rdf.api.RDF;
import org.apache.commons.rdf.api.RDFTerm;
import org.apache.commons.rdf.jena.ConversionException;
import org.apache.commons.rdf.jena.JenaBlankNode;
@@ -48,13 +50,10 @@ import org.apache.jena.system.JenaSystem;
/**
* Constructs Jena implementations of Commons RDF.
* <p>
- * This class is deliberately an abstract class, as it is an internal helper
- * which <strong>may change</strong> in any minor version update; users should
- * instead use {@link JenaRDF}.
+ * This class is deliberately an abstract class, as it is an internal helper
which <strong>may change</strong> in any minor version update; users should
instead
+ * use {@link JenaRDF}.
* <p>
- * For the purpose of blank node identity, some of these methods require a
- * {@link UUID} to use as a salt. See {@link BlankNode#uniqueReference()} for
- * details.
+ * For the purpose of blank node identity, some of these methods require a
{@link UUID} to use as a salt. See {@link BlankNode#uniqueReference()} for
details.
*/
public abstract class InternalJenaFactory {
@@ -63,77 +62,203 @@ public abstract class InternalJenaFactory {
JenaSystem.init();
}
+ /**
+ * Creates a blank node based on the given ID and name.
+ *
+ * @param id A non-empty, non-null, String that is unique to this blank
node in the context of this {@link RDF}.
+ * @param salt A UUID salt.
+ * @return A blank node based on the given ID and name.
+ */
public JenaBlankNode createBlankNode(final String id, final UUID salt) {
return new JenaBlankNodeImpl(NodeFactory.createBlankNode(id), salt);
}
+ /**
+ * Creates a blank node based on the given ID.
+ *
+ * @param salt A UUID salt.
+ * @return A blank node based on the given ID and name.
+ */
public JenaBlankNode createBlankNode(final UUID salt) {
return new JenaBlankNodeImpl(NodeFactory.createBlankNode(), salt);
}
+ /**
+ * Creates a dataset based on the given graph and salt.
+ *
+ * @param datasetGraph dataset to wrap.
+ * @param salt a UUID salt.
+ * @return A dataset based on the given graph and salt.
+ */
public JenaDataset createDataset(final DatasetGraph datasetGraph, final
UUID salt) {
return new JenaDatasetImpl(datasetGraph, salt);
}
+ /**
+ * Creates a dataset based on the given graph and salt.
+ *
+ * @param salt A UUID salt.
+ * @return A dataset based on the given graph and salt.
+ */
public JenaDataset createDataset(final UUID salt) {
final DatasetGraph dg = DatasetGraphFactory.createGeneral();
// Or which createMethod() -- a bit confusing with lots of choice.
return new JenaDatasetImpl(dg, salt);
}
+ /**
+ * Creates a generalized quad representation for the given quad and salt.
+ *
+ * @param quad The quad to wrap.
+ * @param salt A UUID salt.
+ * @return A generalized quad representation for the given quad and salt.
+ */
public JenaGeneralizedQuadLike createGeneralizedQuad(final
org.apache.jena.sparql.core.Quad quad, final UUID salt) {
return new JenaGeneralizedQuadLikeImpl(quad, salt);
}
- public JenaGeneralizedQuadLike createGeneralizedQuad(final RDFTerm
subject, final RDFTerm predicate, final RDFTerm object,
- final RDFTerm graphName) {
+ /**
+ * Creates a generalized quad representation for the given inputs.
+ *
+ * @param subject An RDF subject.
+ * @param predicate An RDF predicate.
+ * @param object An RDF object.
+ * @param graphName An RDF graph name.
+ * @return A generalized quad representation for the given inputs.
+ */
+ public JenaGeneralizedQuadLike createGeneralizedQuad(final RDFTerm
subject, final RDFTerm predicate, final RDFTerm object, final RDFTerm
graphName) {
return new JenaGeneralizedQuadLikeImpl(subject, predicate, object,
Optional.ofNullable(graphName));
}
+ /**
+ * Creates a generalized triple representation for the given inputs.
+ *
+ * @param triple A triple.
+ * @param salt a UUID salt.
+ * @return A generalized triple representation for the given inputs.
+ */
public JenaGeneralizedTripleLike createGeneralizedTriple(final
org.apache.jena.graph.Triple triple, final UUID salt) {
return new JenaGeneralizedTripleLikeImpl(triple, salt);
}
+ /**
+ * Creates a generalized triple representation for the given inputs.
+ *
+ * @param subject An RDF subject.
+ * @param predicate An RDF predicate.
+ * @param object An RDF object.
+ * @return A generalized triple representation for the given inputs.
+ */
public JenaGeneralizedTripleLike createGeneralizedTriple(final RDFTerm
subject, final RDFTerm predicate, final RDFTerm object) {
return new JenaGeneralizedTripleLikeImpl(subject, predicate, object);
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ *
+ * @param model A model.
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ */
public JenaGraph createGraph(final Model model, final UUID salt) {
return new JenaGraphImpl(model, salt);
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ *
+ * @param graph A graph.
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ */
public JenaGraph createGraph(final org.apache.jena.graph.Graph graph,
final UUID salt) {
return new JenaGraphImpl(graph, salt);
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ *
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Graph}.
+ */
public JenaGraph createGraph(final UUID salt) {
return new JenaGraphImpl(GraphFactory.createDefaultGraph(), salt);
}
+ /**
+ * Creates a Jena-backed {@link IRI}.
+ *
+ * @param iriStr IRI string.
+ * @return A Jena-backed {@link IRI}.
+ */
public JenaIRI createIRI(final String iriStr) {
return new JenaIRIImpl(iriStr);
}
+ /**
+ * Creates a Jena-backed {@link Literal}.
+ *
+ * @param lexStr a literal string.
+ * @return A Jena-backed {@link Literal}.
+ */
public JenaLiteral createLiteral(final String lexStr) {
return new JenaLiteralImpl(NodeFactory.createLiteral(lexStr));
}
+ /**
+ * Creates a Jena-backed {@link Literal}.
+ *
+ * @param lexStr a literal string.
+ * @param datatypeIRI datatype IRI string.
+ * @return A Jena-backed {@link Literal}.
+ */
public JenaLiteral createLiteralDT(final String lexStr, final String
datatypeIRI) {
return new JenaLiteralImpl(NodeFactory.createLiteral(lexStr,
NodeFactory.getType(datatypeIRI)));
}
+ /**
+ * Creates a Jena-backed {@link Literal}.
+ *
+ * @param lexStr a literal string.
+ * @param langTag A language tag.
+ * @return A Jena-backed {@link Literal}.
+ */
public JenaLiteral createLiteralLang(final String lexStr, final String
langTag) {
return new JenaLiteralImpl(NodeFactory.createLiteral(lexStr, langTag));
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Quad}.
+ *
+ * @param subject A subject as a blank node or IRI.
+ * @param predicate A predicate IRI.
+ * @param object An RDF object.
+ * @param graphName A graph name as a blank node or IRI.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Quad}.
+ */
public JenaQuad createQuad(final BlankNodeOrIRI subject, final IRI
predicate, final RDFTerm object, final BlankNodeOrIRI graphName) {
return new JenaQuadImpl(subject, predicate, object,
Optional.ofNullable(graphName));
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Quad}.
+ *
+ * @param quad A quad.
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Quad}.
+ */
public JenaQuad createQuad(final org.apache.jena.sparql.core.Quad quad,
final UUID salt) {
return new JenaQuadImpl(quad, salt);
}
+ /**
+ * Creates a Jena-backed {@link RDFTerm}.
+ *
+ * @param node A node.
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link RDFTerm}.
+ * @throws ConversionException Thrown for an unrecognized node type.
+ */
public JenaRDFTerm createRDFTerm(final Node node, final UUID salt) throws
ConversionException {
if (!node.isConcrete()) {
throw new ConversionException("Node is not a concrete RDF Term: "
+ node);
@@ -158,12 +283,26 @@ public abstract class InternalJenaFactory {
throw new ConversionException("Unrecognized node type: " + node);
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Triple}.
+ *
+ * @param subject A subject as a blank node or IRI.
+ * @param predicate A predicate IRI.
+ * @param object An RDF object.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Triple}.
+ */
public JenaTriple createTriple(final BlankNodeOrIRI subject, final IRI
predicate, final RDFTerm object) {
return new JenaTripleImpl(subject, predicate, object);
}
+ /**
+ * Creates a Jena-backed {@link org.apache.commons.rdf.api.Triple}.
+ *
+ * @param triple A triple.
+ * @param salt A UUID salt.
+ * @return A Jena-backed {@link org.apache.commons.rdf.api.Triple}.
+ */
public JenaTriple createTriple(final org.apache.jena.graph.Triple triple,
final UUID salt) {
return new JenaTripleImpl(triple, salt);
}
-
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdBlankNode.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdBlankNode.java
index 3c4eb937..ea763be5 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdBlankNode.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdBlankNode.java
@@ -21,6 +21,9 @@ import org.apache.commons.rdf.api.BlankNode;
import com.github.jsonldjava.core.RDFDataset.Node;
+/**
+ * An empty extension of {@link JsonLdTerm} and {@link BlankNode}.
+ */
public interface JsonLdBlankNode extends JsonLdTerm, BlankNode {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdDataset.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdDataset.java
index 90df4cbd..bf9525d9 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdDataset.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdDataset.java
@@ -32,6 +32,9 @@ import org.apache.commons.rdf.api.RDFTerm;
import com.github.jsonldjava.core.RDFDataset;
+/**
+ * An empty extension of {@link JsonLdGraphLike} and {@link Dataset}.
+ */
public interface JsonLdDataset extends
JsonLdGraphLike<org.apache.commons.rdf.api.Quad>, Dataset {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdIRI.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdIRI.java
index ac702b08..0bf4129f 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdIRI.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdIRI.java
@@ -16,12 +16,14 @@
* limitations under the License.
*/
package org.apache.commons.rdf.jsonldjava;
-
import org.apache.commons.rdf.api.IRI;
import com.github.jsonldjava.core.RDFDataset;
import com.github.jsonldjava.core.RDFDataset.Node;
+/**
+ * An empty extension of {@link JsonLdTerm} and {@link IRI}.
+ */
public interface JsonLdIRI extends JsonLdTerm, IRI {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdLiteral.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdLiteral.java
index 206dd7b2..7ed6808c 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdLiteral.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdLiteral.java
@@ -27,6 +27,9 @@ import org.apache.commons.rdf.simple.Types;
import com.github.jsonldjava.core.RDFDataset.Node;
+/**
+ * An empty extension of {@link JsonLdTerm} and {@link Literal}.
+ */
public interface JsonLdLiteral extends JsonLdTerm, Literal {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuad.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuad.java
index bf37c6cc..ed0a511c 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuad.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuad.java
@@ -24,6 +24,9 @@ import org.apache.commons.rdf.api.IRI;
import org.apache.commons.rdf.api.RDFTerm;
// Note: To avoid confusion - don't import either Quad
+/**
+ * An empty extension of {@link org.apache.commons.rdf.api.Quad} and {@link
JsonLdTripleLike}.
+ */
public interface JsonLdQuad extends org.apache.commons.rdf.api.Quad,
JsonLdTripleLike {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuadLike.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuadLike.java
index 1cacb0e5..56c73659 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuadLike.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdQuadLike.java
@@ -24,6 +24,9 @@ import org.apache.commons.rdf.api.RDFTerm;
import com.github.jsonldjava.core.RDFDataset.Quad;
+/**
+ * An empty extension of {@link QuadLike} and {@link JsonLdTripleLike}.
+ */
public interface JsonLdQuadLike<G extends RDFTerm> extends QuadLike<G>,
JsonLdTripleLike {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdRDF.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdRDF.java
index 3c9fc2cc..5d67751a 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdRDF.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdRDF.java
@@ -42,6 +42,9 @@ public final class JsonLdRDF implements RDF {
final String bnodePrefix;
+ /**
+ * Constructs a new instance.
+ */
public JsonLdRDF() {
// An "outside Graph" bnodePrefix
this("urn:uuid:" + UUID.randomUUID() + "#b");
@@ -86,6 +89,12 @@ public final class JsonLdRDF implements RDF {
return new JsonLdGraphImpl(rdfDataSet);
}
+ /**
+ * Creates a new node for the given term.
+ *
+ * @param term The RDF term.
+ * @return a new node.
+ */
public Node asJsonLdNode(final RDFTerm term) {
if (term instanceof JsonLdBlankNode) {
final JsonLdBlankNode jsonLdBlankNode = (JsonLdBlankNode) term;
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTerm.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTerm.java
index 27d66158..6c361bfc 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTerm.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTerm.java
@@ -40,6 +40,9 @@ abstract class AbstractJsonLdTermImpl implements JsonLdTerm {
}
+/**
+ * Extends {@link RDFTerm} to provide a conversion service.
+ */
public interface JsonLdTerm extends RDFTerm {
/**
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTriple.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTriple.java
index 4211c8fb..431388fd 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTriple.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTriple.java
@@ -26,6 +26,9 @@ import org.apache.commons.rdf.api.Triple;
import com.github.jsonldjava.core.RDFDataset.Quad;
+/**
+ * An empty extension of {@link Triple} and {@link JsonLdTripleLike}.
+ */
public interface JsonLdTriple extends Triple, JsonLdTripleLike {
}
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTripleLike.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTripleLike.java
index 135cbdb3..9c2e0e52 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTripleLike.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/JsonLdTripleLike.java
@@ -19,6 +19,9 @@ package org.apache.commons.rdf.jsonldjava;
import org.apache.commons.rdf.api.TripleLike;
+/**
+ * Extends {@link TripleLike} to provide a conversion service.
+ */
public interface JsonLdTripleLike extends TripleLike {
/**
diff --git
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/experimental/JsonLdParser.java
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/experimental/JsonLdParser.java
index d4242cae..0f7056ca 100644
---
a/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/experimental/JsonLdParser.java
+++
b/commons-rdf-jsonld-java/src/main/java/org/apache/commons/rdf/jsonldjava/experimental/JsonLdParser.java
@@ -41,6 +41,9 @@ import com.github.jsonldjava.core.JsonLdProcessor;
import com.github.jsonldjava.core.RDFDataset;
import com.github.jsonldjava.utils.JsonUtils;
+/**
+ * Experimental.
+ */
public class JsonLdParser extends AbstractRDFParser<JsonLdParser> {
private static URL asURL(final IRI iri) throws IllegalStateException {
diff --git
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
index e5b29d70..a0f7d92b 100644
--- a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
+++ b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4J.java
@@ -103,6 +103,9 @@ import org.eclipse.rdf4j.sail.memory.MemoryStore;
@SuppressWarnings("PMD.UnnecessaryFullyQualifiedName") // we use
fully-qualified names for clarity
public final class RDF4J implements RDF {
+ /**
+ * Enumerates options.
+ */
public enum Option {
/**
* The Graph/Dataset should include any inferred statements
@@ -643,6 +646,11 @@ public final class RDF4J implements RDF {
return asTriple(statement);
}
+ /**
+ * Gets the value factory.
+ *
+ * @return the value factory.
+ */
public ValueFactory getValueFactory() {
return valueFactory;
}
diff --git
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/RDF4JParser.java
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/RDF4JParser.java
index 37cea4a6..0c88ba33 100644
---
a/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/RDF4JParser.java
+++
b/commons-rdf-rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/RDF4JParser.java
@@ -123,6 +123,11 @@ public class RDF4JParser extends
AbstractRDFParser<RDF4JParser> {
return parserConfig;
}
+ /**
+ * Creates a new instance of an RDFHandler.
+ *
+ * @return a new instance of an RDFHandler.
+ */
protected RDFHandler makeRDFHandler() {
// TODO: Can we join the below DF4JDataset and RDF4JGraph cases
diff --git
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/RDFParseException.java
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/RDFParseException.java
index 16de9738..ed315736 100644
---
a/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/RDFParseException.java
+++
b/commons-rdf-simple/src/main/java/org/apache/commons/rdf/simple/experimental/RDFParseException.java
@@ -25,6 +25,10 @@ import org.apache.commons.rdf.experimental.RDFParser;
*/
public class RDFParseException extends Exception {
private static final long serialVersionUID = 5427752643780702976L;
+
+ /**
+ * RDF builder.
+ */
private final RDFParser builder;
/**
