GraphLike 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/c7e1a5bd Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/c7e1a5bd Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/c7e1a5bd Branch: refs/heads/master Commit: c7e1a5bde5e3b8209cb15099a7ceaef6ced57e7f Parents: b25af13 Author: Stian Soiland-Reyes <st...@apache.org> Authored: Thu Jun 2 12:18:03 2016 +0100 Committer: Stian Soiland-Reyes <st...@apache.org> Committed: Thu Jun 2 12:18:03 2016 +0100 ---------------------------------------------------------------------- .../org/apache/commons/rdf/api/GraphLike.java | 20 +++---- .../java/org/apache/commons/rdf/api/Quad.java | 4 +- .../org/apache/commons/rdf/api/QuadLike.java | 51 +++++++--------- .../org/apache/commons/rdf/api/TripleLike.java | 63 +++++++++----------- 4 files changed, 63 insertions(+), 75 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/c7e1a5bd/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 57b55cb..28c2f10 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,10 +26,10 @@ 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 {@link RDFTerm} instances from different implementations. + * 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 + * {@link RDFTerm} instances from different implementations. * * @see Graph * @see Dataset @@ -83,14 +83,14 @@ public interface GraphLike<T extends TripleLike<S, P, O>, S extends RDFTerm, P e /** * Iterate over contained statements. - * + * * @return An {@link Iterable} of {@link TripleLike} statements. * - * @throws IllegalStateException - * if the {@link Iterable} has been reused - * @throws ConcurrentModificationException - * if a concurrency conflict occurs while the Iterator is - * active. + * @throws IllegalStateException + * if the {@link Iterable} has been reused + * @throws ConcurrentModificationException + * if a concurrency conflict occurs while the Iterator is + * active. */ Iterable<T> iterate() throws ConcurrentModificationException, IllegalStateException; http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/c7e1a5bd/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 fa9298e..348595b 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 @@ -40,8 +40,8 @@ public interface Quad extends QuadLike<BlankNodeOrIRI,IRI,RDFTerm,BlankNodeOrIRI * If {@link Optional#isPresent()}, then the {@link Optional#get()} is * either a {@link BlankNode} or an {@link IRI}, indicating the * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-named-graph">graph - * name of this Quad. If the graph name is not present (e.g. the value is - * {@link Optional#empty()}), it indicates that this Quad is in the + * name of this Quad. If the graph name is not present, e.g. the value is + * {@link Optional#empty()}, it indicates that this Quad is in the * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-default-graph">default * graph. * http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/c7e1a5bd/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 a47e32b..7ed7255 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 @@ -22,42 +22,35 @@ import java.util.Optional; /** * A generalised "quad-like" interface, extended by {@link Quad}. * <p> - * A QuadLike has at least a - * {@link #getSubject()}, {@link #getPredicate()} and - * {@link #getObject()}, and a {@link #getGraphName()}, - * but unlike a {@link Quad} does not have a - * formalised {@link Quad#equals(Object)} semantics, and allow - * generalised quads (e.g. a BlankNode as predicate). + * 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). * <p> - * Implementations should specialise which RDFTerm - * subclasses they return for subject {@link S}, - * predicate {@link P}, object {@link O} and graph name {@link G}. + * Implementations should specialise which {@link RDFTerm} subclasses they + * return for subject {@link S}, predicate {@link P}, object {@link O} and graph + * name {@link G}. * <p> + * * @see Quad */ -public interface QuadLike <S extends RDFTerm, P extends RDFTerm, O extends RDFTerm, G extends RDFTerm> - extends TripleLike<S,P,O> { - +public interface QuadLike<S extends RDFTerm, P extends RDFTerm, O extends RDFTerm, G extends RDFTerm> + extends TripleLike<S, P, O> { /** - * The graph name (graph label) of this quad, if present. - * - * If {@link Optional#isPresent()}, then the {@link Optional#get()} - * indicate the - * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-named-graph">graph - * name of this Quad. If the graph name is not present (e.g. the value is - * {@link Optional#empty()}), it indicates that this Quad is in the - * <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-default-graph">default - * graph. + * The graph name (graph label) of this statement, if present. + * <p> + * If {@link Optional#isPresent()}, then the {@link Optional#get()} indicate + * the graph name of this statement. If the graph name is not present,e.g. + * the value is {@link Optional#empty()}, it indicates that this Quad is in + * the default graph. * - * @return If {@link Optional#isPresent()}, the graph name - * of this quad, otherwise. The graph name is typically an - * {@link IRI} or {@link BlankNode}. - * {@link Optional#empty()}, indicating the default graph. - * - * @see <a href="https://www.w3.org/TR/rdf11-concepts/#dfn-rdf-dataset">RDF- - * 1.1 Dataset</a> + * @return If {@link Optional#isPresent()}, the graph name of this quad, + * otherwise {@link Optional#empty()}, indicating the default + * graph. The graph name is typically an {@link IRI} or + * {@link BlankNode}. */ Optional<G> getGraphName(); - + } http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/c7e1a5bd/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 1ed75d0..c061cc7 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 @@ -18,48 +18,43 @@ package org.apache.commons.rdf.api; /** - * A generalised "triple-like" interface, extended by {@link Triple} and {@link Quad}. + * A generalised "triple-like" interface, extended by {@link Triple} and + * {@link Quad}. * <p> - * A TripleLike 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 allow - * generalised triples (e.g. a BlankNode as predicate). - * <p> - * Implementations should specialise which RDFTerms subclasses - * they return for subject, predicate and object. + * 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). * <p> + * Implementations should specialise which {@link RDFTerm} subclasses they + * return for subject {@link S}, predicate {@link P} and object {@link O}. + * * @see Triple * @see Quad * @see QuadLike * */ -public interface TripleLike <S extends RDFTerm, P extends RDFTerm, O extends RDFTerm> { +public interface TripleLike<S extends RDFTerm, P extends RDFTerm, O extends RDFTerm> { - /** - * The subject of this statement. - * - * @return The subject, typically an {@link IRI} or {@link BlankNode}. - * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-subject">RDF-1.1 - * Triple subject</a> - */ - S getSubject(); + /** + * The subject of this statement. + * + * @return The subject, typically an {@link IRI} or {@link BlankNode}. + */ + S getSubject(); - /** - * The predicate of this statement. - * - * @return The predicate, typically an {@link IRI}. - * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-predicate">RDF-1.1 - * Triple predicate</a> - */ - P getPredicate(); + /** + * The predicate of this statement. + * + * @return The predicate, typically an {@link IRI}. + */ + P getPredicate(); - /** - * The object of this statement. - * - * @return The object, typically an {@link IRI}, {@link BlankNode} or {@link Literal}. - * @see <a href="http://www.w3.org/TR/rdf11-concepts/#dfn-object">RDF-1.1 - * Triple object</a> - */ - O getObject(); + /** + * The object of this statement. + * + * @return The object, typically an {@link IRI}, {@link BlankNode} or + * {@link Literal}. + */ + O getObject(); }