Added: websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/experimental/RDFParser.ParseResult.html ============================================================================== --- websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/experimental/RDFParser.ParseResult.html (added) +++ websites/production/commonsrdf/content/commons-rdf-parent/apidocs/src-html/org/apache/commons/rdf/experimental/RDFParser.ParseResult.html Thu Nov 17 14:45:34 2016 @@ -0,0 +1,557 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> +<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> +<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> +<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> +<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> +<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> +<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> +<span class="sourceLineNo">009</span> *<a name="line.9"></a> +<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> +<span class="sourceLineNo">011</span> *<a name="line.11"></a> +<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> +<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> +<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> +<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> +<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> +<span class="sourceLineNo">017</span> */<a name="line.17"></a> +<span class="sourceLineNo">018</span>package org.apache.commons.rdf.experimental;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.io.InputStream;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.nio.charset.StandardCharsets;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.nio.file.Path;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.Optional;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.concurrent.Future;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.function.Consumer;<a name="line.26"></a> +<span class="sourceLineNo">027</span><a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.commons.rdf.api.BlankNode;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.commons.rdf.api.Dataset;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.commons.rdf.api.Graph;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.commons.rdf.api.IRI;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.commons.rdf.api.Quad;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.commons.rdf.api.RDFSyntax;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.commons.rdf.api.RDFTerm;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.commons.rdf.api.RDF;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.rdf.api.Triple;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>/**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Parse an RDF source into a target (e.g. a Graph/Dataset).<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <h2>Experimental</h2> This interface (and its implementations) should be<a name="line.40"></a> +<span class="sourceLineNo">041</span> * considered <strong>at risk</strong>; they might change or be removed in the<a name="line.41"></a> +<span class="sourceLineNo">042</span> * next minor update of Commons RDF. It may move to the the<a name="line.42"></a> +<span class="sourceLineNo">043</span> * {@link org.apache.commons.rdf.api} package when it has stabilized.<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <h2>Description</h2><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <p><a name="line.45"></a> +<span class="sourceLineNo">046</span> * This interface follows the<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <a href="https://en.wikipedia.org/wiki/Builder_pattern">Builder pattern</a>,<a name="line.47"></a> +<span class="sourceLineNo">048</span> * allowing to set parser settings like {@link #contentType(RDFSyntax)} and<a name="line.48"></a> +<span class="sourceLineNo">049</span> * {@link #base(IRI)}. A caller MUST call one of the <code>source</code> methods<a name="line.49"></a> +<span class="sourceLineNo">050</span> * (e.g. {@link #source(IRI)}, {@link #source(Path)},<a name="line.50"></a> +<span class="sourceLineNo">051</span> * {@link #source(InputStream)}), and MUST call one of the <code>target</code><a name="line.51"></a> +<span class="sourceLineNo">052</span> * methods (e.g. {@link #target(Consumer)}, {@link #target(Dataset)},<a name="line.52"></a> +<span class="sourceLineNo">053</span> * {@link #target(Graph)}) before calling {@link #parse()} on the returned<a name="line.53"></a> +<span class="sourceLineNo">054</span> * RDFParser - however methods can be called in any order.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * <p><a name="line.55"></a> +<span class="sourceLineNo">056</span> * The call to {@link #parse()} returns a {@link Future}, allowing asynchronous<a name="line.56"></a> +<span class="sourceLineNo">057</span> * parse operations. Callers are recommended to check {@link Future#get()} to<a name="line.57"></a> +<span class="sourceLineNo">058</span> * ensure parsing completed successfully, or catch exceptions thrown during<a name="line.58"></a> +<span class="sourceLineNo">059</span> * parsing.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> +<span class="sourceLineNo">061</span> * Setting a method that has already been set will override any existing value<a name="line.61"></a> +<span class="sourceLineNo">062</span> * in the returned builder - regardless of the parameter type (e.g.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * {@link #source(IRI)} will override a previous {@link #source(Path)}. Settings<a name="line.63"></a> +<span class="sourceLineNo">064</span> * can be unset by passing <code>null</code> - note that this may require<a name="line.64"></a> +<span class="sourceLineNo">065</span> * casting, e.g. <code>contentType( (RDFSyntax) null )</code> to undo a previous<a name="line.65"></a> +<span class="sourceLineNo">066</span> * call to {@link #contentType(RDFSyntax)}.<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <p><a name="line.67"></a> +<span class="sourceLineNo">068</span> * It is undefined if a RDFParser is mutable or thread-safe, so callers should<a name="line.68"></a> +<span class="sourceLineNo">069</span> * always use the returned modified RDFParser from the builder methods. The<a name="line.69"></a> +<span class="sourceLineNo">070</span> * builder may return itself after modification, or a cloned builder with the<a name="line.70"></a> +<span class="sourceLineNo">071</span> * modified settings applied. Implementations are however encouraged to be<a name="line.71"></a> +<span class="sourceLineNo">072</span> * immutable, thread-safe and document this. As an example starting point, see<a name="line.72"></a> +<span class="sourceLineNo">073</span> * <code>org.apache.commons.rdf.simple.AbstractRDFParser</code>.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p><a name="line.74"></a> +<span class="sourceLineNo">075</span> * Example usage:<a name="line.75"></a> +<span class="sourceLineNo">076</span> * </p><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <a name="line.77"></a> +<span class="sourceLineNo">078</span> * <pre><a name="line.78"></a> +<span class="sourceLineNo">079</span> * Graph g1 = rDFTermFactory.createGraph();<a name="line.79"></a> +<span class="sourceLineNo">080</span> * new ExampleRDFParserBuilder().source(Paths.get("/tmp/graph.ttl")).contentType(RDFSyntax.TURTLE).target(g1).parse()<a name="line.80"></a> +<span class="sourceLineNo">081</span> * .get(30, TimeUnit.Seconds);<a name="line.81"></a> +<span class="sourceLineNo">082</span> * </pre><a name="line.82"></a> +<span class="sourceLineNo">083</span> *<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span>public interface RDFParser {<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * The result of {@link RDFParser#parse()} indicating parsing completed.<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <p><a name="line.89"></a> +<span class="sourceLineNo">090</span> * This is a marker interface that may be subclassed to include parser<a name="line.90"></a> +<span class="sourceLineNo">091</span> * details, e.g. warning messages or triple counts.<a name="line.91"></a> +<span class="sourceLineNo">092</span> */<a name="line.92"></a> +<span class="sourceLineNo">093</span> public interface ParseResult {<a name="line.93"></a> +<span class="sourceLineNo">094</span> }<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> /**<a name="line.96"></a> +<span class="sourceLineNo">097</span> * Specify which {@link RDF} to use for generating {@link RDFTerm}s.<a name="line.97"></a> +<span class="sourceLineNo">098</span> * <p><a name="line.98"></a> +<span class="sourceLineNo">099</span> * This option may be used together with {@link #target(Graph)} to override<a name="line.99"></a> +<span class="sourceLineNo">100</span> * the implementation's default factory and graph.<a name="line.100"></a> +<span class="sourceLineNo">101</span> * <p><a name="line.101"></a> +<span class="sourceLineNo">102</span> * <strong>Warning:</strong> Using the same {@link RDF} for multiple<a name="line.102"></a> +<span class="sourceLineNo">103</span> * {@link #parse()} calls may accidentally merge {@link BlankNode}s having<a name="line.103"></a> +<span class="sourceLineNo">104</span> * the same label, as the parser may use the<a name="line.104"></a> +<span class="sourceLineNo">105</span> * {@link RDF#createBlankNode(String)} method from the parsed blank node<a name="line.105"></a> +<span class="sourceLineNo">106</span> * labels.<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <a name="line.107"></a> +<span class="sourceLineNo">108</span> * @see #target(Graph)<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param rdfTermFactory<a name="line.109"></a> +<span class="sourceLineNo">110</span> * {@link RDF} to use for generating RDFTerms.<a name="line.110"></a> +<span class="sourceLineNo">111</span> * @return An {@link RDFParser} that will use the specified rdfTermFactory<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> RDFParser rdfTermFactory(RDF rdfTermFactory);<a name="line.113"></a> +<span class="sourceLineNo">114</span><a name="line.114"></a> +<span class="sourceLineNo">115</span> /**<a name="line.115"></a> +<span class="sourceLineNo">116</span> * Specify the content type of the RDF syntax to parse.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * <p><a name="line.117"></a> +<span class="sourceLineNo">118</span> * This option can be used to select the RDFSyntax of the source, overriding<a name="line.118"></a> +<span class="sourceLineNo">119</span> * any <code>Content-Type</code> headers or equivalent.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * <p><a name="line.120"></a> +<span class="sourceLineNo">121</span> * The character set of the RDFSyntax is assumed to be<a name="line.121"></a> +<span class="sourceLineNo">122</span> * {@link StandardCharsets#UTF_8} unless overridden within the document<a name="line.122"></a> +<span class="sourceLineNo">123</span> * (e.g. {@code <?xml version="1.0" encoding="iso-8859-1"?>} in<a name="line.123"></a> +<span class="sourceLineNo">124</span> * {@link RDFSyntax#RDFXML}).<a name="line.124"></a> +<span class="sourceLineNo">125</span> * <p><a name="line.125"></a> +<span class="sourceLineNo">126</span> * This method will override any contentType set with<a name="line.126"></a> +<span class="sourceLineNo">127</span> * {@link #contentType(String)}.<a name="line.127"></a> +<span class="sourceLineNo">128</span> * <a name="line.128"></a> +<span class="sourceLineNo">129</span> * @see #contentType(String)<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @param rdfSyntax<a name="line.130"></a> +<span class="sourceLineNo">131</span> * An {@link RDFSyntax} to parse the source according to, e.g.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * {@link RDFSyntax#TURTLE}.<a name="line.132"></a> +<span class="sourceLineNo">133</span> * @throws IllegalArgumentException<a name="line.133"></a> +<span class="sourceLineNo">134</span> * If this RDFParser does not support the specified RDFSyntax.<a name="line.134"></a> +<span class="sourceLineNo">135</span> * @return An {@link RDFParser} that will use the specified content type.<a name="line.135"></a> +<span class="sourceLineNo">136</span> */<a name="line.136"></a> +<span class="sourceLineNo">137</span> RDFParser contentType(RDFSyntax rdfSyntax) throws IllegalArgumentException;<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * Specify the content type of the RDF syntax to parse.<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <p><a name="line.141"></a> +<span class="sourceLineNo">142</span> * This option can be used to select the RDFSyntax of the source, overriding<a name="line.142"></a> +<span class="sourceLineNo">143</span> * any <code>Content-Type</code> headers or equivalent.<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <p><a name="line.144"></a> +<span class="sourceLineNo">145</span> * The content type MAY include a <code>charset</code> parameter if the RDF<a name="line.145"></a> +<span class="sourceLineNo">146</span> * media types permit it; the default charset is<a name="line.146"></a> +<span class="sourceLineNo">147</span> * {@link StandardCharsets#UTF_8} unless overridden within the document.<a name="line.147"></a> +<span class="sourceLineNo">148</span> * <p><a name="line.148"></a> +<span class="sourceLineNo">149</span> * This method will override any contentType set with<a name="line.149"></a> +<span class="sourceLineNo">150</span> * {@link #contentType(RDFSyntax)}.<a name="line.150"></a> +<span class="sourceLineNo">151</span> * <a name="line.151"></a> +<span class="sourceLineNo">152</span> * @see #contentType(RDFSyntax)<a name="line.152"></a> +<span class="sourceLineNo">153</span> * @param contentType<a name="line.153"></a> +<span class="sourceLineNo">154</span> * A content-type string, e.g. <code>application/ld+json</code><a name="line.154"></a> +<span class="sourceLineNo">155</span> * or <code>text/turtle;charset="UTF-8"</code> as specified by<a name="line.155"></a> +<span class="sourceLineNo">156</span> * <a href="https://tools.ietf.org/html/rfc7231#section-3.1.1.1"><a name="line.156"></a> +<span class="sourceLineNo">157</span> * RFC7231</a>.<a name="line.157"></a> +<span class="sourceLineNo">158</span> * @return An {@link RDFParser} that will use the specified content type.<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @throws IllegalArgumentException<a name="line.159"></a> +<span class="sourceLineNo">160</span> * If the contentType has an invalid syntax, or this RDFParser<a name="line.160"></a> +<span class="sourceLineNo">161</span> * does not support the specified contentType.<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> RDFParser contentType(String contentType) throws IllegalArgumentException;<a name="line.163"></a> +<span class="sourceLineNo">164</span><a name="line.164"></a> +<span class="sourceLineNo">165</span> /**<a name="line.165"></a> +<span class="sourceLineNo">166</span> * Specify a {@link Graph} to add parsed triples to.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * <p><a name="line.167"></a> +<span class="sourceLineNo">168</span> * If the source supports datasets (e.g. the {@link #contentType(RDFSyntax)}<a name="line.168"></a> +<span class="sourceLineNo">169</span> * set has {@link RDFSyntax#supportsDataset} is true)), then only quads in<a name="line.169"></a> +<span class="sourceLineNo">170</span> * the <em>default graph</em> will be added to the Graph as {@link Triple}s.<a name="line.170"></a> +<span class="sourceLineNo">171</span> * <p><a name="line.171"></a> +<span class="sourceLineNo">172</span> * It is undefined if any triples are added to the specified {@link Graph}<a name="line.172"></a> +<span class="sourceLineNo">173</span> * if {@link #parse()} throws any exceptions. (However implementations are<a name="line.173"></a> +<span class="sourceLineNo">174</span> * free to prevent this using transaction mechanisms or similar). If<a name="line.174"></a> +<span class="sourceLineNo">175</span> * {@link Future#get()} does not indicate an exception, the parser<a name="line.175"></a> +<span class="sourceLineNo">176</span> * implementation SHOULD have inserted all parsed triples to the specified<a name="line.176"></a> +<span class="sourceLineNo">177</span> * graph.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * Calling this method will override any earlier targets set with<a name="line.179"></a> +<span class="sourceLineNo">180</span> * {@link #target(Graph)}, {@link #target(Consumer)} or<a name="line.180"></a> +<span class="sourceLineNo">181</span> * {@link #target(Dataset)}.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * <p><a name="line.182"></a> +<span class="sourceLineNo">183</span> * The default implementation of this method calls {@link #target(Consumer)}<a name="line.183"></a> +<span class="sourceLineNo">184</span> * with a {@link Consumer} that does {@link Graph#add(Triple)} with<a name="line.184"></a> +<span class="sourceLineNo">185</span> * {@link Quad#asTriple()} if the quad is in the default graph.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * <a name="line.186"></a> +<span class="sourceLineNo">187</span> * @param graph<a name="line.187"></a> +<span class="sourceLineNo">188</span> * The {@link Graph} to add triples to.<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @return An {@link RDFParser} that will insert triples into the specified<a name="line.189"></a> +<span class="sourceLineNo">190</span> * graph.<a name="line.190"></a> +<span class="sourceLineNo">191</span> */<a name="line.191"></a> +<span class="sourceLineNo">192</span> default RDFParser target(final Graph graph) {<a name="line.192"></a> +<span class="sourceLineNo">193</span> return target(q -> {<a name="line.193"></a> +<span class="sourceLineNo">194</span> if (!q.getGraphName().isPresent()) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> graph.add(q.asTriple());<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span> });<a name="line.197"></a> +<span class="sourceLineNo">198</span> }<a name="line.198"></a> +<span class="sourceLineNo">199</span><a name="line.199"></a> +<span class="sourceLineNo">200</span> /**<a name="line.200"></a> +<span class="sourceLineNo">201</span> * Specify a {@link Dataset} to add parsed quads to.<a name="line.201"></a> +<span class="sourceLineNo">202</span> * <p><a name="line.202"></a> +<span class="sourceLineNo">203</span> * It is undefined if any quads are added to the specified {@link Dataset}<a name="line.203"></a> +<span class="sourceLineNo">204</span> * if {@link #parse()} throws any exceptions. (However implementations are<a name="line.204"></a> +<span class="sourceLineNo">205</span> * free to prevent this using transaction mechanisms or similar). On the<a name="line.205"></a> +<span class="sourceLineNo">206</span> * other hand, if {@link #parse()} does not indicate an exception, the<a name="line.206"></a> +<span class="sourceLineNo">207</span> * implementation SHOULD have inserted all parsed quads to the specified<a name="line.207"></a> +<span class="sourceLineNo">208</span> * dataset.<a name="line.208"></a> +<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> +<span class="sourceLineNo">210</span> * Calling this method will override any earlier targets set with<a name="line.210"></a> +<span class="sourceLineNo">211</span> * {@link #target(Graph)}, {@link #target(Consumer)} or<a name="line.211"></a> +<span class="sourceLineNo">212</span> * {@link #target(Dataset)}.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * <p><a name="line.213"></a> +<span class="sourceLineNo">214</span> * The default implementation of this method calls {@link #target(Consumer)}<a name="line.214"></a> +<span class="sourceLineNo">215</span> * with a {@link Consumer} that does {@link Dataset#add(Quad)}.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * <a name="line.216"></a> +<span class="sourceLineNo">217</span> * @param dataset<a name="line.217"></a> +<span class="sourceLineNo">218</span> * The {@link Dataset} to add quads to.<a name="line.218"></a> +<span class="sourceLineNo">219</span> * @return An {@link RDFParser} that will insert triples into the specified<a name="line.219"></a> +<span class="sourceLineNo">220</span> * dataset.<a name="line.220"></a> +<span class="sourceLineNo">221</span> */<a name="line.221"></a> +<span class="sourceLineNo">222</span> default RDFParser target(final Dataset dataset) {<a name="line.222"></a> +<span class="sourceLineNo">223</span> return target(dataset::add);<a name="line.223"></a> +<span class="sourceLineNo">224</span> }<a name="line.224"></a> +<span class="sourceLineNo">225</span><a name="line.225"></a> +<span class="sourceLineNo">226</span> /**<a name="line.226"></a> +<span class="sourceLineNo">227</span> * Specify a consumer for parsed quads.<a name="line.227"></a> +<span class="sourceLineNo">228</span> * <p><a name="line.228"></a> +<span class="sourceLineNo">229</span> * The quads will include triples in all named graphs of the parsed source,<a name="line.229"></a> +<span class="sourceLineNo">230</span> * including any triples in the default graph. When parsing a source format<a name="line.230"></a> +<span class="sourceLineNo">231</span> * which do not support datasets, all quads delivered to the consumer will<a name="line.231"></a> +<span class="sourceLineNo">232</span> * be in the default graph (e.g. their {@link Quad#getGraphName()} will be<a name="line.232"></a> +<span class="sourceLineNo">233</span> * as {@link Optional#empty()}), while for a source<a name="line.233"></a> +<span class="sourceLineNo">234</span> * <p><a name="line.234"></a> +<span class="sourceLineNo">235</span> * It is undefined if any quads are consumed if {@link #parse()} throws any<a name="line.235"></a> +<span class="sourceLineNo">236</span> * exceptions. On the other hand, if {@link #parse()} does not indicate an<a name="line.236"></a> +<span class="sourceLineNo">237</span> * exception, the implementation SHOULD have produced all parsed quads to<a name="line.237"></a> +<span class="sourceLineNo">238</span> * the specified consumer.<a name="line.238"></a> +<span class="sourceLineNo">239</span> * <p><a name="line.239"></a> +<span class="sourceLineNo">240</span> * Calling this method will override any earlier targets set with<a name="line.240"></a> +<span class="sourceLineNo">241</span> * {@link #target(Graph)}, {@link #target(Consumer)} or<a name="line.241"></a> +<span class="sourceLineNo">242</span> * {@link #target(Dataset)}.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> +<span class="sourceLineNo">244</span> * The consumer is not assumed to be thread safe - only one<a name="line.244"></a> +<span class="sourceLineNo">245</span> * {@link Consumer#accept(Object)} is delivered at a time for a given<a name="line.245"></a> +<span class="sourceLineNo">246</span> * {@link RDFParser#parse()} call.<a name="line.246"></a> +<span class="sourceLineNo">247</span> * <p><a name="line.247"></a> +<span class="sourceLineNo">248</span> * This method is typically called with a functional consumer, for example:<a name="line.248"></a> +<span class="sourceLineNo">249</span> * <a name="line.249"></a> +<span class="sourceLineNo">250</span> * <pre><a name="line.250"></a> +<span class="sourceLineNo">251</span> * {@code<a name="line.251"></a> +<span class="sourceLineNo">252</span> * List<Quad> quads = new ArrayList<Quad>;<a name="line.252"></a> +<span class="sourceLineNo">253</span> * parserBuilder.target(quads::add).parse();<a name="line.253"></a> +<span class="sourceLineNo">254</span> * }<a name="line.254"></a> +<span class="sourceLineNo">255</span> * </pre><a name="line.255"></a> +<span class="sourceLineNo">256</span> * <a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param consumer<a name="line.257"></a> +<span class="sourceLineNo">258</span> * A {@link Consumer} of {@link Quad}s<a name="line.258"></a> +<span class="sourceLineNo">259</span> * @return An {@link RDFParser} that will call the consumer for into the<a name="line.259"></a> +<span class="sourceLineNo">260</span> * specified dataset.<a name="line.260"></a> +<span class="sourceLineNo">261</span> */<a name="line.261"></a> +<span class="sourceLineNo">262</span> RDFParser target(Consumer<Quad> consumer);<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> /**<a name="line.264"></a> +<span class="sourceLineNo">265</span> * Specify a base IRI to use for parsing any relative IRI references.<a name="line.265"></a> +<span class="sourceLineNo">266</span> * <p><a name="line.266"></a> +<span class="sourceLineNo">267</span> * Setting this option will override any protocol-specific base IRI (e.g.<a name="line.267"></a> +<span class="sourceLineNo">268</span> * <code>Content-Location</code> header) or the {@link #source(IRI)} IRI,<a name="line.268"></a> +<span class="sourceLineNo">269</span> * but does not override any base IRIs set within the source document (e.g.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * <code>@base</code> in Turtle documents).<a name="line.270"></a> +<span class="sourceLineNo">271</span> * <p><a name="line.271"></a> +<span class="sourceLineNo">272</span> * If the source is in a syntax that does not support relative IRI<a name="line.272"></a> +<span class="sourceLineNo">273</span> * references (e.g. {@link RDFSyntax#NTRIPLES}), setting the<a name="line.273"></a> +<span class="sourceLineNo">274</span> * <code>base</code> has no effect.<a name="line.274"></a> +<span class="sourceLineNo">275</span> * <p><a name="line.275"></a> +<span class="sourceLineNo">276</span> * This method will override any base IRI set with {@link #base(String)}.<a name="line.276"></a> +<span class="sourceLineNo">277</span> *<a name="line.277"></a> +<span class="sourceLineNo">278</span> * @see #base(String)<a name="line.278"></a> +<span class="sourceLineNo">279</span> * @param base<a name="line.279"></a> +<span class="sourceLineNo">280</span> * An absolute IRI to use as a base.<a name="line.280"></a> +<span class="sourceLineNo">281</span> * @return An {@link RDFParser} that will use the specified base IRI.<a name="line.281"></a> +<span class="sourceLineNo">282</span> */<a name="line.282"></a> +<span class="sourceLineNo">283</span> RDFParser base(IRI base);<a name="line.283"></a> +<span class="sourceLineNo">284</span><a name="line.284"></a> +<span class="sourceLineNo">285</span> /**<a name="line.285"></a> +<span class="sourceLineNo">286</span> * Specify a base IRI to use for parsing any relative IRI references.<a name="line.286"></a> +<span class="sourceLineNo">287</span> * <p><a name="line.287"></a> +<span class="sourceLineNo">288</span> * Setting this option will override any protocol-specific base IRI (e.g.<a name="line.288"></a> +<span class="sourceLineNo">289</span> * <code>Content-Location</code> header) or the {@link #source(IRI)} IRI,<a name="line.289"></a> +<span class="sourceLineNo">290</span> * but does not override any base IRIs set within the source document (e.g.<a name="line.290"></a> +<span class="sourceLineNo">291</span> * <code>@base</code> in Turtle documents).<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <p><a name="line.292"></a> +<span class="sourceLineNo">293</span> * If the source is in a syntax that does not support relative IRI<a name="line.293"></a> +<span class="sourceLineNo">294</span> * references (e.g. {@link RDFSyntax#NTRIPLES}), setting the<a name="line.294"></a> +<span class="sourceLineNo">295</span> * <code>base</code> has no effect.<a name="line.295"></a> +<span class="sourceLineNo">296</span> * <p><a name="line.296"></a> +<span class="sourceLineNo">297</span> * This method will override any base IRI set with {@link #base(IRI)}.<a name="line.297"></a> +<span class="sourceLineNo">298</span> *<a name="line.298"></a> +<span class="sourceLineNo">299</span> * @see #base(IRI)<a name="line.299"></a> +<span class="sourceLineNo">300</span> * @param base<a name="line.300"></a> +<span class="sourceLineNo">301</span> * An absolute IRI to use as a base.<a name="line.301"></a> +<span class="sourceLineNo">302</span> * @return An {@link RDFParser} that will use the specified base IRI.<a name="line.302"></a> +<span class="sourceLineNo">303</span> * @throws IllegalArgumentException<a name="line.303"></a> +<span class="sourceLineNo">304</span> * If the base is not a valid absolute IRI string<a name="line.304"></a> +<span class="sourceLineNo">305</span> */<a name="line.305"></a> +<span class="sourceLineNo">306</span> RDFParser base(String base) throws IllegalArgumentException;<a name="line.306"></a> +<span class="sourceLineNo">307</span><a name="line.307"></a> +<span class="sourceLineNo">308</span> /**<a name="line.308"></a> +<span class="sourceLineNo">309</span> * Specify a source {@link InputStream} to parse.<a name="line.309"></a> +<span class="sourceLineNo">310</span> * <p><a name="line.310"></a> +<span class="sourceLineNo">311</span> * The source set will not be read before the call to {@link #parse()}.<a name="line.311"></a> +<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> +<span class="sourceLineNo">313</span> * The InputStream will not be closed after parsing. The InputStream does<a name="line.313"></a> +<span class="sourceLineNo">314</span> * not need to support {@link InputStream#markSupported()}.<a name="line.314"></a> +<span class="sourceLineNo">315</span> * <p><a name="line.315"></a> +<span class="sourceLineNo">316</span> * The parser might not consume the complete stream (e.g. an RDF/XML parser<a name="line.316"></a> +<span class="sourceLineNo">317</span> * may not read beyond the closing tag of<a name="line.317"></a> +<span class="sourceLineNo">318</span> * <code>&lt;/rdf:Description&gt;</code>).<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <p><a name="line.319"></a> +<span class="sourceLineNo">320</span> * The {@link #contentType(RDFSyntax)} or {@link #contentType(String)}<a name="line.320"></a> +<span class="sourceLineNo">321</span> * SHOULD be set before calling {@link #parse()}.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <p><a name="line.322"></a> +<span class="sourceLineNo">323</span> * The character set is assumed to be {@link StandardCharsets#UTF_8} unless<a name="line.323"></a> +<span class="sourceLineNo">324</span> * the {@link #contentType(String)} specifies otherwise or the document<a name="line.324"></a> +<span class="sourceLineNo">325</span> * declares its own charset (e.g. RDF/XML with a<a name="line.325"></a> +<span class="sourceLineNo">326</span> * <code>&lt;?xml encoding="iso-8859-1"&gt;</code> header).<a name="line.326"></a> +<span class="sourceLineNo">327</span> * <p><a name="line.327"></a> +<span class="sourceLineNo">328</span> * The {@link #base(IRI)} or {@link #base(String)} MUST be set before<a name="line.328"></a> +<span class="sourceLineNo">329</span> * calling {@link #parse()}, unless the RDF syntax does not permit relative<a name="line.329"></a> +<span class="sourceLineNo">330</span> * IRIs (e.g. {@link RDFSyntax#NTRIPLES}).<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> * This method will override any source set with {@link #source(IRI)},<a name="line.332"></a> +<span class="sourceLineNo">333</span> * {@link #source(Path)} or {@link #source(String)}.<a name="line.333"></a> +<span class="sourceLineNo">334</span> * <a name="line.334"></a> +<span class="sourceLineNo">335</span> * @param inputStream<a name="line.335"></a> +<span class="sourceLineNo">336</span> * An InputStream to consume<a name="line.336"></a> +<span class="sourceLineNo">337</span> * @return An {@link RDFParser} that will use the specified source.<a name="line.337"></a> +<span class="sourceLineNo">338</span> */<a name="line.338"></a> +<span class="sourceLineNo">339</span> RDFParser source(InputStream inputStream);<a name="line.339"></a> +<span class="sourceLineNo">340</span><a name="line.340"></a> +<span class="sourceLineNo">341</span> /**<a name="line.341"></a> +<span class="sourceLineNo">342</span> * Specify a source file {@link Path} to parse.<a name="line.342"></a> +<span class="sourceLineNo">343</span> * <p><a name="line.343"></a> +<span class="sourceLineNo">344</span> * The source set will not be read before the call to {@link #parse()}.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * <p><a name="line.345"></a> +<span class="sourceLineNo">346</span> * The {@link #contentType(RDFSyntax)} or {@link #contentType(String)}<a name="line.346"></a> +<span class="sourceLineNo">347</span> * SHOULD be set before calling {@link #parse()}.<a name="line.347"></a> +<span class="sourceLineNo">348</span> * <p><a name="line.348"></a> +<span class="sourceLineNo">349</span> * The character set is assumed to be {@link StandardCharsets#UTF_8} unless<a name="line.349"></a> +<span class="sourceLineNo">350</span> * the {@link #contentType(String)} specifies otherwise or the document<a name="line.350"></a> +<span class="sourceLineNo">351</span> * declares its own charset (e.g. RDF/XML with a<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <code>&lt;?xml encoding="iso-8859-1"&gt;</code> header).<a name="line.352"></a> +<span class="sourceLineNo">353</span> * <p><a name="line.353"></a> +<span class="sourceLineNo">354</span> * The {@link #base(IRI)} or {@link #base(String)} MAY be set before calling<a name="line.354"></a> +<span class="sourceLineNo">355</span> * {@link #parse()}, otherwise {@link Path#toUri()} will be used as the base<a name="line.355"></a> +<span class="sourceLineNo">356</span> * IRI.<a name="line.356"></a> +<span class="sourceLineNo">357</span> * <p><a name="line.357"></a> +<span class="sourceLineNo">358</span> * This method will override any source set with {@link #source(IRI)},<a name="line.358"></a> +<span class="sourceLineNo">359</span> * {@link #source(InputStream)} or {@link #source(String)}.<a name="line.359"></a> +<span class="sourceLineNo">360</span> * <a name="line.360"></a> +<span class="sourceLineNo">361</span> * @param file<a name="line.361"></a> +<span class="sourceLineNo">362</span> * A Path for a file to parse<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @return An {@link RDFParser} that will use the specified source.<a name="line.363"></a> +<span class="sourceLineNo">364</span> */<a name="line.364"></a> +<span class="sourceLineNo">365</span> RDFParser source(Path file);<a name="line.365"></a> +<span class="sourceLineNo">366</span><a name="line.366"></a> +<span class="sourceLineNo">367</span> /**<a name="line.367"></a> +<span class="sourceLineNo">368</span> * Specify an absolute source {@link IRI} to retrieve and parse.<a name="line.368"></a> +<span class="sourceLineNo">369</span> * <p><a name="line.369"></a> +<span class="sourceLineNo">370</span> * The source set will not be read before the call to {@link #parse()}.<a name="line.370"></a> +<span class="sourceLineNo">371</span> * <p><a name="line.371"></a> +<span class="sourceLineNo">372</span> * If this builder does not support the given IRI protocol (e.g.<a name="line.372"></a> +<span class="sourceLineNo">373</span> * <code>urn:uuid:ce667463-c5ab-4c23-9b64-701d055c4890</code>), this method<a name="line.373"></a> +<span class="sourceLineNo">374</span> * should succeed, while the {@link #parse()} should throw an<a name="line.374"></a> +<span class="sourceLineNo">375</span> * {@link IOException}.<a name="line.375"></a> +<span class="sourceLineNo">376</span> * <p><a name="line.376"></a> +<span class="sourceLineNo">377</span> * The {@link #contentType(RDFSyntax)} or {@link #contentType(String)} MAY<a name="line.377"></a> +<span class="sourceLineNo">378</span> * be set before calling {@link #parse()}, in which case that type MAY be<a name="line.378"></a> +<span class="sourceLineNo">379</span> * used for content negotiation (e.g. <code>Accept</code> header in HTTP),<a name="line.379"></a> +<span class="sourceLineNo">380</span> * and SHOULD be used for selecting the RDFSyntax.<a name="line.380"></a> +<span class="sourceLineNo">381</span> * <p><a name="line.381"></a> +<span class="sourceLineNo">382</span> * The character set is assumed to be {@link StandardCharsets#UTF_8} unless<a name="line.382"></a> +<span class="sourceLineNo">383</span> * the protocol's equivalent of <code>Content-Type</code> specifies<a name="line.383"></a> +<span class="sourceLineNo">384</span> * otherwise or the document declares its own charset (e.g. RDF/XML with a<a name="line.384"></a> +<span class="sourceLineNo">385</span> * <code>&lt;?xml encoding="iso-8859-1"&gt;</code> header).<a name="line.385"></a> +<span class="sourceLineNo">386</span> * <p><a name="line.386"></a> +<span class="sourceLineNo">387</span> * The {@link #base(IRI)} or {@link #base(String)} MAY be set before calling<a name="line.387"></a> +<span class="sourceLineNo">388</span> * {@link #parse()}, otherwise the source IRI will be used as the base IRI.<a name="line.388"></a> +<span class="sourceLineNo">389</span> * <p><a name="line.389"></a> +<span class="sourceLineNo">390</span> * This method will override any source set with {@link #source(Path)},<a name="line.390"></a> +<span class="sourceLineNo">391</span> * {@link #source(InputStream)} or {@link #source(String)}.<a name="line.391"></a> +<span class="sourceLineNo">392</span> * <a name="line.392"></a> +<span class="sourceLineNo">393</span> * @param iri<a name="line.393"></a> +<span class="sourceLineNo">394</span> * An IRI to retrieve and parse<a name="line.394"></a> +<span class="sourceLineNo">395</span> * @return An {@link RDFParser} that will use the specified source.<a name="line.395"></a> +<span class="sourceLineNo">396</span> */<a name="line.396"></a> +<span class="sourceLineNo">397</span> RDFParser source(IRI iri);<a name="line.397"></a> +<span class="sourceLineNo">398</span><a name="line.398"></a> +<span class="sourceLineNo">399</span> /**<a name="line.399"></a> +<span class="sourceLineNo">400</span> * Specify an absolute source IRI to retrieve and parse.<a name="line.400"></a> +<span class="sourceLineNo">401</span> * <p><a name="line.401"></a> +<span class="sourceLineNo">402</span> * The source set will not be read before the call to {@link #parse()}.<a name="line.402"></a> +<span class="sourceLineNo">403</span> * <p><a name="line.403"></a> +<span class="sourceLineNo">404</span> * If this builder does not support the given IRI (e.g.<a name="line.404"></a> +<span class="sourceLineNo">405</span> * <code>urn:uuid:ce667463-c5ab-4c23-9b64-701d055c4890</code>), this method<a name="line.405"></a> +<span class="sourceLineNo">406</span> * should succeed, while the {@link #parse()} should throw an<a name="line.406"></a> +<span class="sourceLineNo">407</span> * {@link IOException}.<a name="line.407"></a> +<span class="sourceLineNo">408</span> * <p><a name="line.408"></a> +<span class="sourceLineNo">409</span> * The {@link #contentType(RDFSyntax)} or {@link #contentType(String)} MAY<a name="line.409"></a> +<span class="sourceLineNo">410</span> * be set before calling {@link #parse()}, in which case that type MAY be<a name="line.410"></a> +<span class="sourceLineNo">411</span> * used for content negotiation (e.g. <code>Accept</code> header in HTTP),<a name="line.411"></a> +<span class="sourceLineNo">412</span> * and SHOULD be used for selecting the RDFSyntax.<a name="line.412"></a> +<span class="sourceLineNo">413</span> * <p><a name="line.413"></a> +<span class="sourceLineNo">414</span> * The character set is assumed to be {@link StandardCharsets#UTF_8} unless<a name="line.414"></a> +<span class="sourceLineNo">415</span> * the protocol's equivalent of <code>Content-Type</code> specifies<a name="line.415"></a> +<span class="sourceLineNo">416</span> * otherwise or the document declares its own charset (e.g. RDF/XML with a<a name="line.416"></a> +<span class="sourceLineNo">417</span> * <code>&lt;?xml encoding="iso-8859-1"&gt;</code> header).<a name="line.417"></a> +<span class="sourceLineNo">418</span> * <p><a name="line.418"></a> +<span class="sourceLineNo">419</span> * The {@link #base(IRI)} or {@link #base(String)} MAY be set before calling<a name="line.419"></a> +<span class="sourceLineNo">420</span> * {@link #parse()}, otherwise the source IRI will be used as the base IRI.<a name="line.420"></a> +<span class="sourceLineNo">421</span> * <p><a name="line.421"></a> +<span class="sourceLineNo">422</span> * This method will override any source set with {@link #source(Path)},<a name="line.422"></a> +<span class="sourceLineNo">423</span> * {@link #source(InputStream)} or {@link #source(IRI)}.<a name="line.423"></a> +<span class="sourceLineNo">424</span> * <a name="line.424"></a> +<span class="sourceLineNo">425</span> * @param iri<a name="line.425"></a> +<span class="sourceLineNo">426</span> * An IRI to retrieve and parse<a name="line.426"></a> +<span class="sourceLineNo">427</span> * @return An {@link RDFParser} that will use the specified source.<a name="line.427"></a> +<span class="sourceLineNo">428</span> * @throws IllegalArgumentException<a name="line.428"></a> +<span class="sourceLineNo">429</span> * If the base is not a valid absolute IRI string<a name="line.429"></a> +<span class="sourceLineNo">430</span> * <a name="line.430"></a> +<span class="sourceLineNo">431</span> */<a name="line.431"></a> +<span class="sourceLineNo">432</span> RDFParser source(String iri) throws IllegalArgumentException;<a name="line.432"></a> +<span class="sourceLineNo">433</span><a name="line.433"></a> +<span class="sourceLineNo">434</span> /**<a name="line.434"></a> +<span class="sourceLineNo">435</span> * Parse the specified source.<a name="line.435"></a> +<span class="sourceLineNo">436</span> * <p><a name="line.436"></a> +<span class="sourceLineNo">437</span> * A source method (e.g. {@link #source(InputStream)}, {@link #source(IRI)},<a name="line.437"></a> +<span class="sourceLineNo">438</span> * {@link #source(Path)}, {@link #source(String)} or an equivalent subclass<a name="line.438"></a> +<span class="sourceLineNo">439</span> * method) MUST have been called before calling this method, otherwise an<a name="line.439"></a> +<span class="sourceLineNo">440</span> * {@link IllegalStateException} will be thrown.<a name="line.440"></a> +<span class="sourceLineNo">441</span> * <p><a name="line.441"></a> +<span class="sourceLineNo">442</span> * A target method (e.g. {@link #target(Consumer)},<a name="line.442"></a> +<span class="sourceLineNo">443</span> * {@link #target(Dataset)}, {@link #target(Graph)} or an equivalent<a name="line.443"></a> +<span class="sourceLineNo">444</span> * subclass method) MUST have been called before calling parse(), otherwise<a name="line.444"></a> +<span class="sourceLineNo">445</span> * an {@link IllegalStateException} will be thrown.<a name="line.445"></a> +<span class="sourceLineNo">446</span> * <p><a name="line.446"></a> +<span class="sourceLineNo">447</span> * It is undefined if this method is thread-safe, however the<a name="line.447"></a> +<span class="sourceLineNo">448</span> * {@link RDFParser} may be reused (e.g. setting a different source) as soon<a name="line.448"></a> +<span class="sourceLineNo">449</span> * as the {@link Future} has been returned from this method.<a name="line.449"></a> +<span class="sourceLineNo">450</span> * <p><a name="line.450"></a> +<span class="sourceLineNo">451</span> * The RDFParser SHOULD perform the parsing as an asynchronous operation,<a name="line.451"></a> +<span class="sourceLineNo">452</span> * and return the {@link Future} as soon as preliminary checks (such as<a name="line.452"></a> +<span class="sourceLineNo">453</span> * validity of the {@link #source(IRI)} and {@link #contentType(RDFSyntax)}<a name="line.453"></a> +<span class="sourceLineNo">454</span> * settings) have finished. The future SHOULD not mark<a name="line.454"></a> +<span class="sourceLineNo">455</span> * {@link Future#isDone()} before parsing is complete. A synchronous<a name="line.455"></a> +<span class="sourceLineNo">456</span> * implementation MAY be blocking on the <code>parse()</code> call and<a name="line.456"></a> +<span class="sourceLineNo">457</span> * return a Future that is already {@link Future#isDone()}.<a name="line.457"></a> +<span class="sourceLineNo">458</span> * <p><a name="line.458"></a> +<span class="sourceLineNo">459</span> * The returned {@link Future} contains a {@link ParseResult}.<a name="line.459"></a> +<span class="sourceLineNo">460</span> * Implementations may subclass this interface to provide any parser<a name="line.460"></a> +<span class="sourceLineNo">461</span> * details, e.g. list of warnings. <code>null</code> is a possible return<a name="line.461"></a> +<span class="sourceLineNo">462</span> * value if no details are available, but parsing succeeded.<a name="line.462"></a> +<span class="sourceLineNo">463</span> * <p><a name="line.463"></a> +<span class="sourceLineNo">464</span> * If an exception occurs during parsing, (e.g. {@link IOException} or<a name="line.464"></a> +<span class="sourceLineNo">465</span> * <code>org.apache.commons.rdf.simple.experimental.RDFParseException</code>),<a name="line.465"></a> +<span class="sourceLineNo">466</span> * it should be indicated as the<a name="line.466"></a> +<span class="sourceLineNo">467</span> * {@link java.util.concurrent.ExecutionException#getCause()} in the<a name="line.467"></a> +<span class="sourceLineNo">468</span> * {@link java.util.concurrent.ExecutionException} thrown on<a name="line.468"></a> +<span class="sourceLineNo">469</span> * {@link Future#get()}.<a name="line.469"></a> +<span class="sourceLineNo">470</span> * <a name="line.470"></a> +<span class="sourceLineNo">471</span> * @return A Future that will return the populated {@link Graph} when the<a name="line.471"></a> +<span class="sourceLineNo">472</span> * parsing has finished.<a name="line.472"></a> +<span class="sourceLineNo">473</span> * @throws IOException<a name="line.473"></a> +<span class="sourceLineNo">474</span> * If an error occurred while starting to read the source (e.g.<a name="line.474"></a> +<span class="sourceLineNo">475</span> * file not found, unsupported IRI protocol). Note that IO<a name="line.475"></a> +<span class="sourceLineNo">476</span> * errors during parsing would instead be the<a name="line.476"></a> +<span class="sourceLineNo">477</span> * {@link java.util.concurrent.ExecutionException#getCause()} of<a name="line.477"></a> +<span class="sourceLineNo">478</span> * the {@link java.util.concurrent.ExecutionException} thrown on<a name="line.478"></a> +<span class="sourceLineNo">479</span> * {@link Future#get()}.<a name="line.479"></a> +<span class="sourceLineNo">480</span> * @throws IllegalStateException<a name="line.480"></a> +<span class="sourceLineNo">481</span> * If the builder is in an invalid state, e.g. a<a name="line.481"></a> +<span class="sourceLineNo">482</span> * <code>source</code> has not been set.<a name="line.482"></a> +<span class="sourceLineNo">483</span> */<a name="line.483"></a> +<span class="sourceLineNo">484</span> Future<? extends ParseResult> parse() throws IOException, IllegalStateException;<a name="line.484"></a> +<span class="sourceLineNo">485</span>}<a name="line.485"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> \ No newline at end of file
