Repository: incubator-commonsrdf Updated Branches: refs/heads/rdf4j b7bdebc81 -> e40a56a6b
Javadoc links in RDF4J* interfaces Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/cbb5ca57 Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/cbb5ca57 Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/cbb5ca57 Branch: refs/heads/rdf4j Commit: cbb5ca577d810ecfaf271f2d07e76f539ff81a8b Parents: b7bdebc Author: Stian Soiland-Reyes <[email protected]> Authored: Mon Oct 3 18:49:28 2016 +0100 Committer: Stian Soiland-Reyes <[email protected]> Committed: Mon Oct 3 18:49:28 2016 +0100 ---------------------------------------------------------------------- .../org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java | 1 + .../commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java | 10 ++++++---- .../org/apache/commons/rdf/rdf4j/RDF4JDataset.java | 6 ++++-- .../org/apache/commons/rdf/rdf4j/RDF4JGraph.java | 15 ++++++++++----- .../org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java | 9 ++++++++- .../java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java | 1 + .../org/apache/commons/rdf/rdf4j/RDF4JLiteral.java | 13 +++++++------ .../java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java | 1 + .../org/apache/commons/rdf/rdf4j/RDF4JTriple.java | 1 + 9 files changed, 39 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java index a383831..7053cd7 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNode.java @@ -27,6 +27,7 @@ import org.eclipse.rdf4j.model.BNode; * The underlying RDF4J {@link BNode} instance can * be retrieved with {@link #asValue()}. * + * @see RDF4JTermFactory#createBlankNode() */ public interface RDF4JBlankNode extends RDF4JBlankNodeOrIRI<BNode>, BlankNode { } http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java index 5c83b55..ffecf0e 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JBlankNodeOrIRI.java @@ -18,14 +18,16 @@ package org.apache.commons.rdf.rdf4j; import org.apache.commons.rdf.api.BlankNodeOrIRI; +import org.apache.commons.rdf.api.Triple; import org.eclipse.rdf4j.model.Resource; /** - * Marker interface for RDF4J implementations of - * Commons RDF {@link BlankNodeOrIRI} + * Marker interface for RDF4J implementations of Commons RDF + * {@link BlankNodeOrIRI} (e.g. the subject of a {@link Triple}). * <p> - * The underlying RDF4J {@link org.eclipse.rdf4j.model.Resource} - * instance can be retrieved with {@link #asValue()}. + * The underlying RDF4J {@link org.eclipse.rdf4j.model.Resource} instance can be + * retrieved with {@link #asValue()}. + * */ public interface RDF4JBlankNodeOrIRI<T extends Resource> extends RDF4JTerm<T>, BlankNodeOrIRI { http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JDataset.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JDataset.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JDataset.java index 98a90cf..d1aea4c 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JDataset.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JDataset.java @@ -31,6 +31,8 @@ import org.eclipse.rdf4j.repository.RepositoryConnection; /** * Marker interface for RDF4J implementations of Dataset. * + * @see RDF4JTermFactory#createDataset() + * @see RDF4JTermFactory#asRDFTermDataset(org.eclipse.rdf4j.repository.Repository) */ public interface RDF4JDataset extends Dataset, RDF4JGraphLike<Quad> { @@ -54,8 +56,8 @@ public interface RDF4JDataset extends Dataset, RDF4JGraphLike<Quad> { /** * {@inheritDoc} * <p> - * Note that the stream must be closed with {@link Stream#close()} to ensure - * the underlying {@link RepositoryConnection} is closed. + * Note that the stream <strong>must be closed</strong> with + * {@link Stream#close()}. * <p> * This can generally achieved using a try-with-resources block, e.g.: * <pre> http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java index e0e1e4a..e0b7a29 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraph.java @@ -30,12 +30,17 @@ import org.apache.commons.rdf.rdf4j.impl.RepositoryGraphImpl; import org.eclipse.rdf4j.model.Model; import org.eclipse.rdf4j.model.Resource; import org.eclipse.rdf4j.repository.Repository; -import org.eclipse.rdf4j.repository.RepositoryConnection; /** * Marker interface for RDF4J implementations of Graph. * + * @see RDF4JTermFactory#createGraph() + * @see RDF4JTermFactory#asRDFTermGraph(Model) + * @see RDF4JTermFactory#asRDFTermGraph(Repository) + * @see RDF4JTermFactory#asRDFTermGraphUnion(Repository) + * @see RDF4JDataset#getGraph() + * @see RDF4JDataset#getGraph(BlankNodeOrIRI) * @see ModelGraphImpl * @see RepositoryGraphImpl */ @@ -73,8 +78,8 @@ public interface RDF4JGraph extends Graph, RDF4JGraphLike<Triple> { /** * {@inheritDoc} * <p> - * Note that the stream must be closed with {@link Stream#close()} to ensure - * the underlying {@link RepositoryConnection} is closed. + * Note that the stream <strong>must be closed</strong> with + * {@link Stream#close()}. * <p> * This can generally achieved using a try-with-resources block, e.g.: * <pre> @@ -90,8 +95,8 @@ public interface RDF4JGraph extends Graph, RDF4JGraphLike<Triple> { /** * {@inheritDoc} * <p> - * Note that the stream must be closed with {@link Stream#close()} to ensure - * the underlying {@link RepositoryConnection} is closed. + * Note that the stream <strong>must be closed</strong> with + * {@link Stream#close()}. * <p> * This can generally achieved using a try-with-resources block, e.g.: * <pre> http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java index 1750bd8..3b781e0 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JGraphLike.java @@ -29,9 +29,16 @@ import org.eclipse.rdf4j.repository.Repository; /** * Marker interface for RDF4J implementations of GraphLike. + * <p> + * This is a common interface for {@link RDF4JGraph} and {@link RDF4JDataset} + * which provides access to the underlying RDF4J {@link Model} and/or + * {@link Repository}. + * <p> + * At least one of {@link #asModel()} or {@link #asRepository()} will always be + * {@link Optional#isPresent()}. * + * @see RDF4JDataset * @see RDF4JGraph - * */ public interface RDF4JGraphLike<T extends TripleLike<BlankNodeOrIRI, IRI, RDFTerm>> extends GraphLike<T, BlankNodeOrIRI, IRI, RDFTerm>, AutoCloseable { http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java index 95b5359..2fef0c4 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JIRI.java @@ -24,6 +24,7 @@ package org.apache.commons.rdf.rdf4j; * The underlying RDF4J {@link org.eclipse.rdf4j.model.IRI} * instance can be retrieved with {@link #asValue()}. * + * @see RDF4JTermFactory#createIRI(String) */ public interface RDF4JIRI extends RDF4JBlankNodeOrIRI<org.eclipse.rdf4j.model.IRI>, org.apache.commons.rdf.api.IRI { http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JLiteral.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JLiteral.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JLiteral.java index 445a892..0166c67 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JLiteral.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JLiteral.java @@ -18,12 +18,13 @@ package org.apache.commons.rdf.rdf4j; /** - * Marker interface for RDF4J implementations of - * Commons RDF {@link org.apache.commons.rdf.api.Literal}. + * Marker interface for RDF4J implementations of Commons RDF + * {@link org.apache.commons.rdf.api.Literal}. * <p> - * The underlying RDF4J {@link org.eclipse.rdf4j.model.Literal} - * instance can be retrieved with {@link #asValue()}. + * The underlying RDF4J {@link org.eclipse.rdf4j.model.Literal} instance can be + * retrieved with {@link #asValue()}. + * + * @see RDF4JTermFactory#createLiteral(String) */ -public interface RDF4JLiteral - extends RDF4JTerm<org.eclipse.rdf4j.model.Literal>, org.apache.commons.rdf.api.Literal { +public interface RDF4JLiteral extends RDF4JTerm<org.eclipse.rdf4j.model.Literal>, org.apache.commons.rdf.api.Literal { } http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java index 621d34f..2d5b68f 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JQuad.java @@ -22,6 +22,7 @@ import org.apache.commons.rdf.api.Quad; /** * Marker interface for RDF4J implementations of Quad. * + * @see RDF4JTermFactory#createQuad(org.apache.commons.rdf.api.BlankNodeOrIRI, org.apache.commons.rdf.api.BlankNodeOrIRI, org.apache.commons.rdf.api.IRI, org.apache.commons.rdf.api.RDFTerm) */ public interface RDF4JQuad extends Quad, RDF4JTripleLike { http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/cbb5ca57/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTriple.java ---------------------------------------------------------------------- diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTriple.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTriple.java index 4e09f19..7308f8f 100644 --- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTriple.java +++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTriple.java @@ -22,6 +22,7 @@ import org.apache.commons.rdf.api.Triple; /** * Marker interface for RDF4J implementations of Triple. * + * @see RDF4JTermFactory#createTriple(org.apache.commons.rdf.api.BlankNodeOrIRI, org.apache.commons.rdf.api.IRI, org.apache.commons.rdf.api.RDFTerm) */ public interface RDF4JTriple extends Triple, RDF4JTripleLike {
