You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2017/04/06 10:45:07 UTC
jena git commit: Improve javadoc for RDFParser. Provide fromString()
shortcut
Repository: jena
Updated Branches:
refs/heads/master 0174c619e -> f95300130
Improve javadoc for RDFParser. Provide fromString() shortcut
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/f9530013
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/f9530013
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/f9530013
Branch: refs/heads/master
Commit: f953001301a54519a27cd3ea20fab6bdcac801ec
Parents: 0174c61
Author: Andy Seaborne <an...@apache.org>
Authored: Thu Apr 6 11:44:57 2017 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Thu Apr 6 11:44:57 2017 +0100
----------------------------------------------------------------------
.../java/org/apache/jena/riot/RDFParser.java | 45 +++++++++++++++++---
.../org/apache/jena/riot/RDFParserBuilder.java | 21 ++++-----
.../org/apache/jena/riot/TestRDFParser.java | 5 +--
.../jena/riot/lang/ParserTestBaseLib.java | 7 +--
4 files changed, 52 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/jena/blob/f9530013/jena-arq/src/main/java/org/apache/jena/riot/RDFParser.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/RDFParser.java b/jena-arq/src/main/java/org/apache/jena/riot/RDFParser.java
index 7341598..26af001 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/RDFParser.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/RDFParser.java
@@ -105,22 +105,55 @@ public class RDFParser {
return RDFParserBuilder.create();
}
- /** Shortcut for {@code RDFParser.create.source(path)}. */
+ /**
+ * Create an {@link RDFParserBuilder} and set the source to the
+ * {@link Path}.
+ * <p>
+ * This is a shortcut for {@code RDFParser.create.source(path)}.
+ *
+ * @param path
+ * @return this
+ */
public static RDFParserBuilder source(Path path) {
return RDFParserBuilder.create().source(path);
}
- /** Shortcut for {@code RDFParser.create.source(uriOrFile)}. */
+ /**
+ * Create an {@link RDFParserBuilder} and set the source to the URI, which
+ * can be a filename.
+ * <p>
+ * Thsi is a shortcut for {@code RDFParser.create.source(uriOrFile)}.
+ *
+ * @param uriOrFile
+ * @return this
+ */
+
public static RDFParserBuilder source(String uriOrFile) {
return RDFParserBuilder.create().source(uriOrFile);
}
- /** Shortcut for {@code RDFParser.create.source(reader)}. */
- public static RDFParserBuilder source(StringReader reader) {
- return RDFParserBuilder.create().source(reader);
+ /**
+ * Create an {@link RDFParserBuilder} and set content to parse to be the
+ * given string. The syntax must be set with {@code .lang(...)}.
+ * <p>
+ * Shortcut for {@code RDFParser.create.fromString(string)}.
+ * @param string
+ * @return this
+ */
+ public static RDFParserBuilder fromString(String string) {
+ return RDFParserBuilder.create().fromString(string);
}
- /** Shortcut for {@code RDFParser.create.source(input)}. */
+ /**
+ * Create an {@link RDFParserBuilder} and set the source to {@link InputStream}.
+ * The {@link InputStream} will be closed when the
+ * parser is called and the parser can not be reused.
+ * The syntax must be set with {@code .lang(...)}.
+ * <p>
+ * This is a shortcut for {@code RDFParser.create.source(input)}.
+ * @param input
+ * @return this
+ */
public static RDFParserBuilder source(InputStream input) {
return RDFParserBuilder.create().source(input);
}
http://git-wip-us.apache.org/repos/asf/jena/blob/f9530013/jena-arq/src/main/java/org/apache/jena/riot/RDFParserBuilder.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/riot/RDFParserBuilder.java b/jena-arq/src/main/java/org/apache/jena/riot/RDFParserBuilder.java
index 9acea5d..7e0e538 100644
--- a/jena-arq/src/main/java/org/apache/jena/riot/RDFParserBuilder.java
+++ b/jena-arq/src/main/java/org/apache/jena/riot/RDFParserBuilder.java
@@ -113,14 +113,14 @@ public class RDFParserBuilder {
/**
* Set the source to a URI; this includes OS file names.
- * File URL shoudl be of the form {@code file:///...}.
+ * File URL should be of the form {@code file:///...}.
* This clears any other source setting.
- * @param uri
+ * @param uriOrFile
* @return this
*/
- public RDFParserBuilder source(String uri) {
+ public RDFParserBuilder source(String uriOrFile) {
clearSource();
- this.uri = uri;
+ this.uri = uriOrFile;
return this;
}
@@ -139,17 +139,14 @@ public class RDFParserBuilder {
}
/**
- * Set the source to {@link StringReader}.
+ * Use the given string as the content to parse.
* This clears any other source setting.
- * The {@link StringReader} will be closed when the
- * parser is called and the parser can not be reused.
- * @param reader
+ * The parser can not be reused.
+ * @param string
* @return this
*/
- public RDFParserBuilder source(StringReader reader) {
- clearSource();
- this.javaReader = reader;
- return this;
+ public RDFParserBuilder fromString(String string) {
+ return source(new StringReader(string));
}
/**
http://git-wip-us.apache.org/repos/asf/jena/blob/f9530013/jena-arq/src/test/java/org/apache/jena/riot/TestRDFParser.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/test/java/org/apache/jena/riot/TestRDFParser.java b/jena-arq/src/test/java/org/apache/jena/riot/TestRDFParser.java
index 5d00438..84832dd 100644
--- a/jena-arq/src/test/java/org/apache/jena/riot/TestRDFParser.java
+++ b/jena-arq/src/test/java/org/apache/jena/riot/TestRDFParser.java
@@ -24,7 +24,6 @@ import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
-import java.io.StringReader;
import java.io.StringWriter;
import java.nio.charset.StandardCharsets;
import java.nio.file.Paths;
@@ -45,7 +44,7 @@ public class TestRDFParser {
@Test public void source_not_uri_01() {
Graph graph = GraphFactory.createGraphMem();
- RDFParserBuilder.create().lang(Lang.TTL).source(new StringReader(testdata)).parse(graph);
+ RDFParserBuilder.create().lang(Lang.TTL).fromString(testdata).parse(graph);
assertEquals(1, graph.size());
}
@@ -98,7 +97,7 @@ public class TestRDFParser {
// Shortcut source
@Test public void source_shortcut_01() {
Graph graph = GraphFactory.createGraphMem();
- RDFParser.source(new StringReader(testdata)).lang(Lang.TTL).parse(graph);
+ RDFParser.fromString(testdata).lang(Lang.TTL).parse(graph);
assertEquals(1, graph.size());
}
http://git-wip-us.apache.org/repos/asf/jena/blob/f9530013/jena-arq/src/test/java/org/apache/jena/riot/lang/ParserTestBaseLib.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/test/java/org/apache/jena/riot/lang/ParserTestBaseLib.java b/jena-arq/src/test/java/org/apache/jena/riot/lang/ParserTestBaseLib.java
index af31a03..fbe32ed 100644
--- a/jena-arq/src/test/java/org/apache/jena/riot/lang/ParserTestBaseLib.java
+++ b/jena-arq/src/test/java/org/apache/jena/riot/lang/ParserTestBaseLib.java
@@ -18,8 +18,6 @@
package org.apache.jena.riot.lang;
-import java.io.StringReader ;
-
import org.apache.jena.graph.Graph ;
import org.apache.jena.riot.ErrorHandlerTestLib.ErrorHandlerEx ;
import org.apache.jena.riot.Lang ;
@@ -30,7 +28,7 @@ import org.apache.jena.sparql.core.DatasetGraph ;
import org.apache.jena.sparql.core.DatasetGraphFactory ;
import org.apache.jena.sparql.graph.GraphFactory ;
-/** Helper code for RIOT language parsing tests */
+/** Helper code for RIOT language parsing tests. */
class ParserTestBaseLib {
/** Parse for a language - convert errors.wranigns to ErrorHandlerEx */
@@ -52,10 +50,9 @@ class ParserTestBaseLib {
/** Parse strings to destination (checking on, URI resolution off) - convert errors and warning to ErrorHandlerEx */
static void parse(Lang lang, StreamRDF dest, String... strings) {
String string = String.join("\n", strings) ;
- StringReader reader = new StringReader(string) ;
String baseIRI = "http://base/" ;
RDFParser.create()
- .source(reader)
+ .fromString(string)
.base(baseIRI)
.errorHandler(new ErrorHandlerEx())
.lang(lang)