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/09/28 13:52:05 UTC

[13/36] incubator-commonsrdf git commit: javadoc typos

javadoc typos


Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/c3fd214a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/c3fd214a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/c3fd214a

Branch: refs/heads/master
Commit: c3fd214abd8c291635deb4ba9bf7881c166931a0
Parents: b1597ff
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Sun Apr 3 02:47:34 2016 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Sun Apr 3 02:47:34 2016 +0100

----------------------------------------------------------------------
 .../rdf/simple/AbstractRDFParserBuilder.java    | 21 ++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/c3fd214a/simple/src/main/java/org/apache/commons/rdf/simple/AbstractRDFParserBuilder.java
----------------------------------------------------------------------
diff --git a/simple/src/main/java/org/apache/commons/rdf/simple/AbstractRDFParserBuilder.java b/simple/src/main/java/org/apache/commons/rdf/simple/AbstractRDFParserBuilder.java
index b31251d..34aeb5a 100644
--- a/simple/src/main/java/org/apache/commons/rdf/simple/AbstractRDFParserBuilder.java
+++ b/simple/src/main/java/org/apache/commons/rdf/simple/AbstractRDFParserBuilder.java
@@ -317,12 +317,10 @@ public abstract class AbstractRDFParserBuilder implements RDFParserBuilder, Clon
 	 * that is where the parsed triples MUST be inserted into.
 	 * <p>
 	 * 
-	 * @return
-	 * @throws IOException
-	 * @throws IllegalStateException
-	 * @throws ParseException
+	 * @throws IOException If the source could not be read 
+	 * @throws ParseException If the source could not be parsed (e.g. a .ttl file was not valid Turtle)
 	 */
-	protected abstract void parseSynchronusly() throws IOException, IllegalStateException, ParseException;
+	protected abstract void parseSynchronusly() throws IOException, ParseException;
 
 	/**
 	 * Prepare a clone of this RDFParserBuilder which have been checked and
@@ -336,9 +334,9 @@ public abstract class AbstractRDFParserBuilder implements RDFParserBuilder, Clon
 	 * <code>file:///</code> IRI for the Path's real path (e.g. resolving any 
 	 * symbolic links).  
 	 *  
-	 * @return
-	 * @throws IOException
-	 * @throws IllegalStateException
+	 * @return A completed and checked clone of this RDFParserBuilder
+	 * @throws IOException If the source was not accessible (e.g. a file was not found)
+	 * @throws IllegalStateException If the parser was not in a compatible setting (e.g. contentType was an invalid string) 
 	 */
 	protected AbstractRDFParserBuilder prepareForParsing() throws IOException, IllegalStateException {
 		checkSource();
@@ -414,9 +412,12 @@ public abstract class AbstractRDFParserBuilder implements RDFParserBuilder, Clon
 	 * creating a new {@link Graph} if 
 	 * {@link #getIntoGraph()} is {@link Optional#empty()}.
 	 * <p>
+	 * As parsed blank nodes might be made with 
+	 * {@link RDFTermFactory#createBlankNode(String)}, 
+	 * each call to this method should return 
+	 * a new RDFTermFactory instance.
 	 * 
-	 * 
-	 * @return
+	 * @return A new {@link RDFTermFactory}
 	 */
 	protected RDFTermFactory createRDFTermFactory() {
 		return new SimpleRDFTermFactory();