commonsrdf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject [11/19] incubator-commonsrdf git commit: Javadoc tweaks
Date Thu, 29 Sep 2016 00:16:47 GMT
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/06711f9c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/06711f9c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/06711f9c

Branch: refs/heads/jena-jsonld-rdf4j-integration
Commit: 06711f9c2832609680b9775de39456b5b2b71ccb
Parents: 13c491e
Author: Stian Soiland-Reyes <stain@apache.org>
Authored: Wed Sep 28 23:55:59 2016 +0100
Committer: Stian Soiland-Reyes <stain@apache.org>
Committed: Wed Sep 28 23:55:59 2016 +0100

----------------------------------------------------------------------
 .../commons/rdf/rdf4j/RDF4JTermFactory.java     | 33 +++++++++++---------
 .../rdf/rdf4j/experimental/package-info.java    |  3 +-
 2 files changed, 19 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/06711f9c/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTermFactory.java
----------------------------------------------------------------------
diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTermFactory.java b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTermFactory.java
index 55a8046..32044f1 100644
--- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTermFactory.java
+++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/RDF4JTermFactory.java
@@ -101,10 +101,8 @@ import org.eclipse.rdf4j.repository.Repository;
 public class RDF4JTermFactory implements RDFTermFactory {
 
 	/**
-	 * 
 	 * Adapt a RDF4J {@link Value} as a Commons RDF {@link RDFTerm}.
 	 * <p>
-	 * <p>
 	 * The value will be of the same kind as the term, e.g. a
 	 * {@link org.eclipse.rdf4j.model.BNode} is converted to a
 	 * {@link org.apache.commons.rdf.api.BlankNode}, a
@@ -113,15 +111,19 @@ public class RDF4JTermFactory implements RDFTermFactory {
 	 * {@link org.eclipse.rdf4j.model.Literal}. is converted to a
 	 * {@link org.apache.commons.rdf.api.Literal}
 	 * 
-	 * @param value The RDF4J {@link Value} to convert.
+	 * @param value
+	 *            The RDF4J {@link Value} to convert.
 	 * @param salt
 	 *            A {@link UUID} salt to use for uniquely mapping any
 	 *            {@link BNode}s. The salt should typically be the same for
 	 *            multiple statements in the same {@link Repository} or
 	 *            {@link Model} to ensure {@link BlankNode#equals(Object)} and
 	 *            {@link BlankNode#uniqueReference()} works as intended.
+	 * @param <T>
+	 *            The subclass of {@link Value}, e.g. {@link BNode}
 	 * @return A {@link RDFTerm} that corresponds to the RDF4J value
-	 * @throws IllegalArgumentException if the value is not a BNode, Literal or IRI 
+	 * @throws IllegalArgumentException
+	 *             if the value is not a BNode, Literal or IRI
 	 */
 	@SuppressWarnings("unchecked")
 	public static <T extends Value> RDF4JTerm<T> asRDFTerm(final T value, UUID salt)
{
@@ -213,7 +215,6 @@ public class RDF4JTermFactory implements RDFTermFactory {
 	 * 
 	 * Adapt a RDF4J {@link Value} as a Commons RDF {@link RDFTerm}.
 	 * <p>
-	 * <p>
 	 * The value will be of the same kind as the term, e.g. a
 	 * {@link org.eclipse.rdf4j.model.BNode} is converted to a
 	 * {@link org.apache.commons.rdf.api.BlankNode}, a
@@ -235,6 +236,8 @@ public class RDF4JTermFactory implements RDFTermFactory {
 	 * instance is used per RDF4J repository/model.  
 	 * 
 	 * @param value The RDF4J {@link Value} to convert.
+	 * @param <T>
+	 *            The subclass of {@link Value}, e.g. {@link BNode}
 	 * @return A {@link RDFTerm} that corresponds to the RDF4J value
 	 * @throws IllegalArgumentException if the value is not a BNode, Literal or IRI 
 	 */
@@ -358,19 +361,19 @@ public class RDF4JTermFactory implements RDFTermFactory {
 	/**
 	 * Adapt a RDF4J {@link Statement} as a Commons RDF {@link Triple}.
 	 * <p>
-	 * For the purpose of {@link BlankNode} equivalence, this 
-	 * method will use an internal salt UUID that is unique per instance of 
-	 * {@link RDF4JTermFactory}. 
+	 * For the purpose of {@link BlankNode} equivalence, this method will use an
+	 * internal salt UUID that is unique per instance of
+	 * {@link RDF4JTermFactory}.
 	 * <p>
-	 * <strong>NOTE:</strong> If combining RDF4J statements from
-	 * multiple repositories or models, then their {@link BNode}s 
-	 * may have the same {@link BNode#getID()}, which with this method 
-	 * would become equivalent according to {@link BlankNode#equals(Object)} and
-	 * {@link BlankNode#uniqueReference()}, 
-	 * unless a separate {@link RDF4JTermFactory}
-	 * instance is used per RDF4J repository/model.
+	 * <strong>NOTE:</strong> If combining RDF4J statements from multiple
+	 * repositories or models, then their {@link BNode}s may have the same
+	 * {@link BNode#getID()}, which with this method would become equivalent
+	 * according to {@link BlankNode#equals(Object)} and
+	 * {@link BlankNode#uniqueReference()}, unless a separate
+	 * {@link RDF4JTermFactory} instance is used per RDF4J repository/model.
 	 * 
 	 * @param statement
+	 *            The RDF4J {@link Statement} to adapt.
 	 * @return A {@link RDF4JTriple} that is equivalent to the statement
 	 */
 	public RDF4JTriple asTriple(final Statement statement) {

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/06711f9c/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/package-info.java
----------------------------------------------------------------------
diff --git a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/package-info.java
b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/package-info.java
index 192a148..217d003 100644
--- a/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/package-info.java
+++ b/rdf4j/src/main/java/org/apache/commons/rdf/rdf4j/experimental/package-info.java
@@ -24,11 +24,10 @@
  * <p>
  * When a class has stabilized, it will move to the
  * {@link org.apache.commons.rdf.rdf4j} package.
- * <p>
  * <ul>
  * <li>{@link RDF4JParser} - an RDF4J-backed
  * implementations of 
- * {@link org.apache.commons.rdf.api.experimental.RDFParser}.</li>
+ * {@link org.apache.commons.rdf.experimental.RDFParser}.</li>
  * </ul>
  */
 package org.apache.commons.rdf.rdf4j.experimental;
\ No newline at end of file


Mime
View raw message