http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/5f11cb85/content/site/apidocs/src-html/org/apache/juneau/parser/Parser.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/parser/Parser.html b/content/site/apidocs/src-html/org/apache/juneau/parser/Parser.html index a32be7e..5e0d340 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/parser/Parser.html +++ b/content/site/apidocs/src-html/org/apache/juneau/parser/Parser.html @@ -25,589 +25,588 @@ <span class="sourceLineNo">017</span><a name="line.17"></a> <span class="sourceLineNo">018</span>import java.io.*;<a name="line.18"></a> <span class="sourceLineNo">019</span>import java.lang.reflect.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import java.text.*;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import java.util.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.juneau.annotation.*;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.juneau.http.*;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.juneau.transform.*;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.juneau.transforms.*;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.juneau.utils.*;<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span>/**<a name="line.30"></a> -<span class="sourceLineNo">031</span> * Parent class for all Juneau parsers.<a name="line.31"></a> -<span class="sourceLineNo">032</span> *<a name="line.32"></a> -<span class="sourceLineNo">033</span> * <h6 class='topic'>@Consumes annotation</h6><a name="line.33"></a> -<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * The media types that this parser can handle is specified through the {@link Consumes @Consumes} annotation.<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <p><a name="line.36"></a> -<span class="sourceLineNo">037</span> * However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()} method.<a name="line.37"></a> -<span class="sourceLineNo">038</span> *<a name="line.38"></a> -<span class="sourceLineNo">039</span> * <a id='ValidDataConversions'></a><h6 class='topic'>Valid data conversions</h6><a name="line.39"></a> -<span class="sourceLineNo">040</span> * Parsers can parse any parsable POJO types, as specified in the <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>.<a name="line.40"></a> -<span class="sourceLineNo">041</span> * <p><a name="line.41"></a> -<span class="sourceLineNo">042</span> * Some examples of conversions are shown below...<a name="line.42"></a> -<span class="sourceLineNo">043</span> * </p><a name="line.43"></a> -<span class="sourceLineNo">044</span> * <table class='styled'><a name="line.44"></a> -<span class="sourceLineNo">045</span> * <tr><a name="line.45"></a> -<span class="sourceLineNo">046</span> * <th>Data type</th><a name="line.46"></a> -<span class="sourceLineNo">047</span> * <th>Class type</th><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <th>JSON example</th><a name="line.48"></a> -<span class="sourceLineNo">049</span> * <th>XML example</th><a name="line.49"></a> -<span class="sourceLineNo">050</span> * <th>Class examples</th><a name="line.50"></a> -<span class="sourceLineNo">051</span> * </tr><a name="line.51"></a> -<span class="sourceLineNo">052</span> * <tr><a name="line.52"></a> -<span class="sourceLineNo">053</span> * <td>object</td><a name="line.53"></a> -<span class="sourceLineNo">054</span> * <td>Maps, Java beans</td><a name="line.54"></a> -<span class="sourceLineNo">055</span> * <td class='code'>{name:<js>'John Smith'</js>,age:21}</td><a name="line.55"></a> -<span class="sourceLineNo">056</span> * <td class='code'><xt>&lt;object&gt;<a name="line.56"></a> -<span class="sourceLineNo">057</span> * &lt;name</xt> <xa>type</xa>=<xs>'string'</xs><xt>&gt;</xt>John Smith<xt>&lt;/name&gt;<a name="line.57"></a> -<span class="sourceLineNo">058</span> * &lt;age</xt> <xa>type</xa>=<xs>'number'</xs><xt>&gt;</xt>21<xt>&lt;/age&gt;<a name="line.58"></a> -<span class="sourceLineNo">059</span> * &lt;/object&gt;</xt></td><a name="line.59"></a> -<span class="sourceLineNo">060</span> * <td class='code'>HashMap, TreeMap&lt;String,Integer&gt;</td><a name="line.60"></a> -<span class="sourceLineNo">061</span> * </tr><a name="line.61"></a> -<span class="sourceLineNo">062</span> * <tr><a name="line.62"></a> -<span class="sourceLineNo">063</span> * <td>array</td><a name="line.63"></a> -<span class="sourceLineNo">064</span> * <td>Collections, Java arrays</td><a name="line.64"></a> -<span class="sourceLineNo">065</span> * <td class='code'>[1,2,3]</td><a name="line.65"></a> -<span class="sourceLineNo">066</span> * <td class='code'><xt>&lt;array&gt;<a name="line.66"></a> -<span class="sourceLineNo">067</span> * &lt;number&gt;</xt>1<xt>&lt;/number&gt;<a name="line.67"></a> -<span class="sourceLineNo">068</span> * &lt;number&gt;</xt>2<xt>&lt;/number&gt;<a name="line.68"></a> -<span class="sourceLineNo">069</span> * &lt;number&gt;</xt>3<xt>&lt;/number&gt;<a name="line.69"></a> -<span class="sourceLineNo">070</span> * &lt;/array&gt;</xt></td><a name="line.70"></a> -<span class="sourceLineNo">071</span> * <td class='code'>List&lt;Integer&gt;, <jk>int</jk>[], Float[], Set&lt;Person&gt;</td><a name="line.71"></a> -<span class="sourceLineNo">072</span> * </tr><a name="line.72"></a> -<span class="sourceLineNo">073</span> * <tr><a name="line.73"></a> -<span class="sourceLineNo">074</span> * <td>number</td><a name="line.74"></a> -<span class="sourceLineNo">075</span> * <td>Numbers</td><a name="line.75"></a> -<span class="sourceLineNo">076</span> * <td class='code'>123</td><a name="line.76"></a> -<span class="sourceLineNo">077</span> * <td class='code'><xt>&lt;number&gt;</xt>123<xt>&lt;/number&gt;</xt></td><a name="line.77"></a> -<span class="sourceLineNo">078</span> * <td class='code'>Integer, Long, Float, <jk>int</jk></td><a name="line.78"></a> -<span class="sourceLineNo">079</span> * </tr><a name="line.79"></a> -<span class="sourceLineNo">080</span> * <tr><a name="line.80"></a> -<span class="sourceLineNo">081</span> * <td>boolean</td><a name="line.81"></a> -<span class="sourceLineNo">082</span> * <td>Booleans</td><a name="line.82"></a> -<span class="sourceLineNo">083</span> * <td class='code'><jk>true</jk></td><a name="line.83"></a> -<span class="sourceLineNo">084</span> * <td class='code'><xt>&lt;boolean&gt;</xt>true<xt>&lt;/boolean&gt;</xt></td><a name="line.84"></a> -<span class="sourceLineNo">085</span> * <td class='code'>Boolean</td><a name="line.85"></a> -<span class="sourceLineNo">086</span> * </tr><a name="line.86"></a> -<span class="sourceLineNo">087</span> * <tr><a name="line.87"></a> -<span class="sourceLineNo">088</span> * <td>string</td><a name="line.88"></a> -<span class="sourceLineNo">089</span> * <td>CharSequences</td><a name="line.89"></a> -<span class="sourceLineNo">090</span> * <td class='code'><js>'foobar'</js></td><a name="line.90"></a> -<span class="sourceLineNo">091</span> * <td class='code'><xt>&lt;string&gt;</xt>foobar<xt>&lt;/string&gt;</xt></td><a name="line.91"></a> -<span class="sourceLineNo">092</span> * <td class='code'>String, StringBuilder</td><a name="line.92"></a> -<span class="sourceLineNo">093</span> * </tr><a name="line.93"></a> -<span class="sourceLineNo">094</span> * </table><a name="line.94"></a> -<span class="sourceLineNo">095</span> * <p><a name="line.95"></a> -<span class="sourceLineNo">096</span> * In addition, any class types with {@link PojoSwap PojoSwaps} associated with them on the registered<a name="line.96"></a> -<span class="sourceLineNo">097</span> * {@link #getBeanContext() beanContext} can also be passed in.<a name="line.97"></a> -<span class="sourceLineNo">098</span> * <p><a name="line.98"></a> -<span class="sourceLineNo">099</span> * For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String} objects. When registered<a name="line.99"></a> -<span class="sourceLineNo">100</span> * with this parser, you can construct {@code Calendar} objects from {@code Strings} using the following syntax...<a name="line.100"></a> -<span class="sourceLineNo">101</span> * <p class='bcode'><a name="line.101"></a> -<span class="sourceLineNo">102</span> * Calendar c = parser.parse(<js>"'Sun Mar 03 04:05:06 EST 2001'"</js>, GregorianCalendar.<jk>class</jk>);<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <p><a name="line.103"></a> -<span class="sourceLineNo">104</span> * If <code>Object.<jk>class</jk></code> is specified as the target type, then the parser<a name="line.104"></a> -<span class="sourceLineNo">105</span> * automatically determines the data types and generates the following object types...<a name="line.105"></a> -<span class="sourceLineNo">106</span> * </p><a name="line.106"></a> -<span class="sourceLineNo">107</span> * <table class='styled'><a name="line.107"></a> -<span class="sourceLineNo">108</span> * <tr><th>JSON type</th><th>Class type</th></tr><a name="line.108"></a> -<span class="sourceLineNo">109</span> * <tr><td>object</td><td>{@link ObjectMap}</td></tr><a name="line.109"></a> -<span class="sourceLineNo">110</span> * <tr><td>array</td><td>{@link ObjectList}</td></tr><a name="line.110"></a> -<span class="sourceLineNo">111</span> * <tr><td>number</td><td>{@link Number} <br>(depending on length and format, could be {@link Integer}, {@link Double}, {@link Float}, etc...)</td></tr><a name="line.111"></a> -<span class="sourceLineNo">112</span> * <tr><td>boolean</td><td>{@link Boolean}</td></tr><a name="line.112"></a> -<span class="sourceLineNo">113</span> * <tr><td>string</td><td>{@link String}</td></tr><a name="line.113"></a> -<span class="sourceLineNo">114</span> * </table><a name="line.114"></a> -<span class="sourceLineNo">115</span> *<a name="line.115"></a> -<span class="sourceLineNo">116</span> * <a id='SupportedTypes'></a><h6 class='topic'>Supported types</h6><a name="line.116"></a> -<span class="sourceLineNo">117</span> * <p><a name="line.117"></a> -<span class="sourceLineNo">118</span> * Several of the methods below take {@link Type} parameters to identify the type of<a name="line.118"></a> -<span class="sourceLineNo">119</span> * object to create. Any of the following types can be passed in to these methods...<a name="line.119"></a> -<span class="sourceLineNo">120</span> * </p><a name="line.120"></a> -<span class="sourceLineNo">121</span> * <ul><a name="line.121"></a> -<span class="sourceLineNo">122</span> * <li>{@link ClassMeta}<a name="line.122"></a> -<span class="sourceLineNo">123</span> * <li>{@link Class}<a name="line.123"></a> -<span class="sourceLineNo">124</span> * <li>{@link ParameterizedType}<a name="line.124"></a> -<span class="sourceLineNo">125</span> * <li>{@link GenericArrayType}<a name="line.125"></a> -<span class="sourceLineNo">126</span> * </ul><a name="line.126"></a> -<span class="sourceLineNo">127</span> * <p><a name="line.127"></a> -<span class="sourceLineNo">128</span> * However, {@code ParameterizedTypes} and {@code GenericArrayTypes} should not contain<a name="line.128"></a> -<span class="sourceLineNo">129</span> * {@link WildcardType WildcardTypes} or {@link TypeVariable TypeVariables}.<a name="line.129"></a> -<span class="sourceLineNo">130</span> * <p><a name="line.130"></a> -<span class="sourceLineNo">131</span> * Passing in <jk>null</jk> or <code>Object.<jk>class</jk></code> typically signifies that it's up to the parser<a name="line.131"></a> -<span class="sourceLineNo">132</span> * to determine what object type is being parsed parsed based on the rules above.<a name="line.132"></a> -<span class="sourceLineNo">133</span> */<a name="line.133"></a> -<span class="sourceLineNo">134</span>public abstract class Parser extends CoreObject {<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> /** General parser properties currently set on this parser. */<a name="line.136"></a> -<span class="sourceLineNo">137</span> private final MediaType[] mediaTypes;<a name="line.137"></a> -<span class="sourceLineNo">138</span> private final ParserContext ctx;<a name="line.138"></a> -<span class="sourceLineNo">139</span><a name="line.139"></a> -<span class="sourceLineNo">140</span> // Hidden constructor to force subclass from InputStreamParser or ReaderParser.<a name="line.140"></a> -<span class="sourceLineNo">141</span> Parser(PropertyStore propertyStore) {<a name="line.141"></a> -<span class="sourceLineNo">142</span> super(propertyStore);<a name="line.142"></a> -<span class="sourceLineNo">143</span> this.ctx = createContext(ParserContext.class);<a name="line.143"></a> -<span class="sourceLineNo">144</span><a name="line.144"></a> -<span class="sourceLineNo">145</span> Consumes c = getAnnotation(Consumes.class, getClass());<a name="line.145"></a> -<span class="sourceLineNo">146</span> if (c == null)<a name="line.146"></a> -<span class="sourceLineNo">147</span> throw new RuntimeException(MessageFormat.format("Class ''{0}'' is missing the @Consumes annotation", getClass().getName()));<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> String[] mt = split(c.value(), ',');<a name="line.149"></a> -<span class="sourceLineNo">150</span> this.mediaTypes = new MediaType[mt.length];<a name="line.150"></a> -<span class="sourceLineNo">151</span> for (int i = 0; i < mt.length; i++) {<a name="line.151"></a> -<span class="sourceLineNo">152</span> mediaTypes[i] = MediaType.forString(mt[i]);<a name="line.152"></a> -<span class="sourceLineNo">153</span> }<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> -<span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> @Override /* CoreObject */<a name="line.156"></a> -<span class="sourceLineNo">157</span> public ParserBuilder builder() {<a name="line.157"></a> -<span class="sourceLineNo">158</span> return new ParserBuilder(propertyStore);<a name="line.158"></a> -<span class="sourceLineNo">159</span> }<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> //--------------------------------------------------------------------------------<a name="line.161"></a> -<span class="sourceLineNo">162</span> // Abstract methods<a name="line.162"></a> -<span class="sourceLineNo">163</span> //--------------------------------------------------------------------------------<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> * Workhorse method. Subclasses are expected to implement this method.<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.<a name="line.167"></a> -<span class="sourceLineNo">168</span> * If <jk>null</jk>, one will be created using {@link #createSession(Object)}.<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @param type The class type of the object to create.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * If <jk>null</jk> or <code>Object.<jk>class</jk></code>, object type is based on what's being parsed.<a name="line.170"></a> -<span class="sourceLineNo">171</span> * For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>, <code>ObjectMap</code>, etc...<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @param <T> The class type of the object to create.<a name="line.172"></a> -<span class="sourceLineNo">173</span> * @return The parsed object.<a name="line.173"></a> -<span class="sourceLineNo">174</span> * @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.<a name="line.174"></a> -<span class="sourceLineNo">175</span> */<a name="line.175"></a> -<span class="sourceLineNo">176</span> protected abstract <T> T doParse(ParserSession session, ClassMeta<T> type) throws Exception;<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> /**<a name="line.178"></a> -<span class="sourceLineNo">179</span> * Returns <jk>true</jk> if this parser subclasses from {@link ReaderParser}.<a name="line.179"></a> -<span class="sourceLineNo">180</span> *<a name="line.180"></a> -<span class="sourceLineNo">181</span> * @return <jk>true</jk> if this parser subclasses from {@link ReaderParser}.<a name="line.181"></a> -<span class="sourceLineNo">182</span> */<a name="line.182"></a> -<span class="sourceLineNo">183</span> public abstract boolean isReaderParser();<a name="line.183"></a> -<span class="sourceLineNo">184</span><a name="line.184"></a> -<span class="sourceLineNo">185</span> //--------------------------------------------------------------------------------<a name="line.185"></a> -<span class="sourceLineNo">186</span> // Other methods<a name="line.186"></a> -<span class="sourceLineNo">187</span> //--------------------------------------------------------------------------------<a name="line.187"></a> -<span class="sourceLineNo">188</span><a name="line.188"></a> -<span class="sourceLineNo">189</span> /**<a name="line.189"></a> -<span class="sourceLineNo">190</span> * Entry point for all parsing calls.<a name="line.190"></a> -<span class="sourceLineNo">191</span> * <p><a name="line.191"></a> -<span class="sourceLineNo">192</span> * Calls the {@link #doParse(ParserSession, ClassMeta)} implementation class and catches/rewraps any exceptions thrown.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @param session The runtime session returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.<a name="line.193"></a> -<span class="sourceLineNo">194</span> * @param type The class type of the object to create.<a name="line.194"></a> -<span class="sourceLineNo">195</span> * @param <T> The class type of the object to create.<a name="line.195"></a> -<span class="sourceLineNo">196</span> * @return The parsed object.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.197"></a> -<span class="sourceLineNo">198</span> */<a name="line.198"></a> -<span class="sourceLineNo">199</span> public final <T> T parseSession(ParserSession session, ClassMeta<T> type) throws ParseException {<a name="line.199"></a> -<span class="sourceLineNo">200</span> try {<a name="line.200"></a> -<span class="sourceLineNo">201</span> if (type.isVoid())<a name="line.201"></a> -<span class="sourceLineNo">202</span> return null;<a name="line.202"></a> -<span class="sourceLineNo">203</span> return doParse(session, type);<a name="line.203"></a> -<span class="sourceLineNo">204</span> } catch (ParseException e) {<a name="line.204"></a> -<span class="sourceLineNo">205</span> throw e;<a name="line.205"></a> -<span class="sourceLineNo">206</span> } catch (StackOverflowError e) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> throw new ParseException(session, "Depth too deep. Stack overflow occurred.");<a name="line.207"></a> -<span class="sourceLineNo">208</span> } catch (IOException e) {<a name="line.208"></a> -<span class="sourceLineNo">209</span> throw new ParseException(session, "I/O exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);<a name="line.209"></a> -<span class="sourceLineNo">210</span> } catch (Exception e) {<a name="line.210"></a> -<span class="sourceLineNo">211</span> throw new ParseException(session, "Exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);<a name="line.211"></a> -<span class="sourceLineNo">212</span> } finally {<a name="line.212"></a> -<span class="sourceLineNo">213</span> session.close();<a name="line.213"></a> -<span class="sourceLineNo">214</span> }<a name="line.214"></a> -<span class="sourceLineNo">215</span> }<a name="line.215"></a> -<span class="sourceLineNo">216</span><a name="line.216"></a> -<span class="sourceLineNo">217</span> /**<a name="line.217"></a> -<span class="sourceLineNo">218</span> * Parses input into the specified object type.<a name="line.218"></a> -<span class="sourceLineNo">219</span> * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).<a name="line.219"></a> -<span class="sourceLineNo">220</span> *<a name="line.220"></a> -<span class="sourceLineNo">221</span> * <h5 class='section'>Examples:</h5><a name="line.221"></a> -<span class="sourceLineNo">222</span> * <p class='bcode'><a name="line.222"></a> -<span class="sourceLineNo">223</span> * ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;<a name="line.223"></a> -<span class="sourceLineNo">224</span> *<a name="line.224"></a> -<span class="sourceLineNo">225</span> * <jc>// Parse into a linked-list of strings.</jc><a name="line.225"></a> -<span class="sourceLineNo">226</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.226"></a> -<span class="sourceLineNo">227</span> *<a name="line.227"></a> -<span class="sourceLineNo">228</span> * <jc>// Parse into a linked-list of beans.</jc><a name="line.228"></a> -<span class="sourceLineNo">229</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.229"></a> -<span class="sourceLineNo">230</span> *<a name="line.230"></a> -<span class="sourceLineNo">231</span> * <jc>// Parse into a linked-list of linked-lists of strings.</jc><a name="line.231"></a> -<span class="sourceLineNo">232</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.232"></a> -<span class="sourceLineNo">233</span> *<a name="line.233"></a> -<span class="sourceLineNo">234</span> * <jc>// Parse into a map of string keys/values.</jc><a name="line.234"></a> -<span class="sourceLineNo">235</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);<a name="line.235"></a> -<span class="sourceLineNo">236</span> *<a name="line.236"></a> -<span class="sourceLineNo">237</span> * <jc>// Parse into a map containing string keys and values of lists containing beans.</jc><a name="line.237"></a> -<span class="sourceLineNo">238</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.238"></a> -<span class="sourceLineNo">239</span> * </p><a name="line.239"></a> -<span class="sourceLineNo">240</span> * <p><a name="line.240"></a> -<span class="sourceLineNo">241</span> * <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.<a name="line.241"></a> -<span class="sourceLineNo">242</span> * <p><a name="line.242"></a> -<span class="sourceLineNo">243</span> * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types.<a name="line.243"></a> -<span class="sourceLineNo">244</span> * <p><a name="line.244"></a> -<span class="sourceLineNo">245</span> * The array can be arbitrarily long to indicate arbitrarily complex data structures.<a name="line.245"></a> -<span class="sourceLineNo">246</span> * <p><a name="line.246"></a> -<span class="sourceLineNo">247</span> * <h5 class='section'>Notes:</h5><a name="line.247"></a> -<span class="sourceLineNo">248</span> * <ul><a name="line.248"></a> -<span class="sourceLineNo">249</span> * <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection.<a name="line.249"></a> -<span class="sourceLineNo">250</span> * </ul><a name="line.250"></a> -<span class="sourceLineNo">251</span> *<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param <T> The class type of the object to create.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @param input The input.<a name="line.253"></a> -<span class="sourceLineNo">254</span> * <br>Character-based parsers can handle the following input class types:<a name="line.254"></a> -<span class="sourceLineNo">255</span> * <ul><a name="line.255"></a> -<span class="sourceLineNo">256</span> * <li><jk>null</jk><a name="line.256"></a> -<span class="sourceLineNo">257</span> * <li>{@link Reader}<a name="line.257"></a> -<span class="sourceLineNo">258</span> * <li>{@link CharSequence}<a name="line.258"></a> -<span class="sourceLineNo">259</span> * <li>{@link InputStream} containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).<a name="line.259"></a> -<span class="sourceLineNo">260</span> * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).<a name="line.260"></a> -<span class="sourceLineNo">261</span> * <li>{@link File} containing system encoded text (or charset defined by {@link ParserContext#PARSER_fileCharset} property value).<a name="line.261"></a> -<span class="sourceLineNo">262</span> * </ul><a name="line.262"></a> -<span class="sourceLineNo">263</span> * <br>Stream-based parsers can handle the following input class types:<a name="line.263"></a> -<span class="sourceLineNo">264</span> * <ul><a name="line.264"></a> -<span class="sourceLineNo">265</span> * <li><jk>null</jk><a name="line.265"></a> -<span class="sourceLineNo">266</span> * <li>{@link InputStream}<a name="line.266"></a> -<span class="sourceLineNo">267</span> * <li><code><jk>byte</jk>[]</code><a name="line.267"></a> -<span class="sourceLineNo">268</span> * <li>{@link File}<a name="line.268"></a> -<span class="sourceLineNo">269</span> * </ul><a name="line.269"></a> -<span class="sourceLineNo">270</span> * @param type The object type to create.<a name="line.270"></a> -<span class="sourceLineNo">271</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.271"></a> -<span class="sourceLineNo">272</span> * @param args The type arguments of the class if it's a collection or map.<a name="line.272"></a> -<span class="sourceLineNo">273</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.273"></a> -<span class="sourceLineNo">274</span> * <br>Ignored if the main type is not a map or collection.<a name="line.274"></a> -<span class="sourceLineNo">275</span> * @return The parsed object.<a name="line.275"></a> -<span class="sourceLineNo">276</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.276"></a> -<span class="sourceLineNo">277</span> * @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.<a name="line.277"></a> -<span class="sourceLineNo">278</span> */<a name="line.278"></a> -<span class="sourceLineNo">279</span> @SuppressWarnings("unchecked")<a name="line.279"></a> -<span class="sourceLineNo">280</span> public final <T> T parse(Object input, Type type, Type...args) throws ParseException {<a name="line.280"></a> -<span class="sourceLineNo">281</span> ParserSession session = createSession(input);<a name="line.281"></a> -<span class="sourceLineNo">282</span> return (T)parseSession(session, session.getClassMeta(type, args));<a name="line.282"></a> -<span class="sourceLineNo">283</span> }<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> * Same as {@link #parse(Object, Type, Type...)} except optimized for a non-parameterized class.<a name="line.286"></a> -<span class="sourceLineNo">287</span> * <p><a name="line.287"></a> -<span class="sourceLineNo">288</span> * This is the preferred parse method for simple types since you don't need to cast the results.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <h5 class='section'>Examples:</h5><a name="line.289"></a> -<span class="sourceLineNo">290</span> * <p class='bcode'><a name="line.290"></a> -<span class="sourceLineNo">291</span> * ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;<a name="line.291"></a> -<span class="sourceLineNo">292</span> *<a name="line.292"></a> -<span class="sourceLineNo">293</span> * <jc>// Parse into a string.</jc><a name="line.293"></a> -<span class="sourceLineNo">294</span> * String s = p.parse(json, String.<jk>class</jk>);<a name="line.294"></a> -<span class="sourceLineNo">295</span> *<a name="line.295"></a> -<span class="sourceLineNo">296</span> * <jc>// Parse into a bean.</jc><a name="line.296"></a> -<span class="sourceLineNo">297</span> * MyBean b = p.parse(json, MyBean.<jk>class</jk>);<a name="line.297"></a> -<span class="sourceLineNo">298</span> *<a name="line.298"></a> -<span class="sourceLineNo">299</span> * <jc>// Parse into a bean array.</jc><a name="line.299"></a> -<span class="sourceLineNo">300</span> * MyBean[] ba = p.parse(json, MyBean[].<jk>class</jk>);<a name="line.300"></a> -<span class="sourceLineNo">301</span> *<a name="line.301"></a> -<span class="sourceLineNo">302</span> * <jc>// Parse into a linked-list of objects.</jc><a name="line.302"></a> -<span class="sourceLineNo">303</span> * List l = p.parse(json, LinkedList.<jk>class</jk>);<a name="line.303"></a> -<span class="sourceLineNo">304</span> *<a name="line.304"></a> -<span class="sourceLineNo">305</span> * <jc>// Parse into a map of object keys/values.</jc><a name="line.305"></a> -<span class="sourceLineNo">306</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>);<a name="line.306"></a> -<span class="sourceLineNo">307</span> * </p><a name="line.307"></a> -<span class="sourceLineNo">308</span> *<a name="line.308"></a> -<span class="sourceLineNo">309</span> * @param <T> The class type of the object being created.<a name="line.309"></a> -<span class="sourceLineNo">310</span> * @param input The input.<a name="line.310"></a> -<span class="sourceLineNo">311</span> * See {@link #parse(Object, Type, Type...)} for details.<a name="line.311"></a> -<span class="sourceLineNo">312</span> * @param type The object type to create.<a name="line.312"></a> -<span class="sourceLineNo">313</span> * @return The parsed object.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.314"></a> -<span class="sourceLineNo">315</span> */<a name="line.315"></a> -<span class="sourceLineNo">316</span> public final <T> T parse(Object input, Class<T> type) throws ParseException {<a name="line.316"></a> -<span class="sourceLineNo">317</span> ParserSession session = createSession(input);<a name="line.317"></a> -<span class="sourceLineNo">318</span> return parseSession(session, session.getClassMeta(type));<a name="line.318"></a> -<span class="sourceLineNo">319</span> }<a name="line.319"></a> -<span class="sourceLineNo">320</span><a name="line.320"></a> -<span class="sourceLineNo">321</span> /**<a name="line.321"></a> -<span class="sourceLineNo">322</span> * Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta} object.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * <p><a name="line.323"></a> -<span class="sourceLineNo">324</span> * This is mostly an internal method used by the framework.<a name="line.324"></a> -<span class="sourceLineNo">325</span> *<a name="line.325"></a> -<span class="sourceLineNo">326</span> * @param <T> The class type of the object being created.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * @param input The input.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * See {@link #parse(Object, Type, Type...)} for details.<a name="line.328"></a> -<span class="sourceLineNo">329</span> * @param type The object type to create.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @return The parsed object.<a name="line.330"></a> -<span class="sourceLineNo">331</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.331"></a> -<span class="sourceLineNo">332</span> */<a name="line.332"></a> -<span class="sourceLineNo">333</span> public final <T> T parse(Object input, ClassMeta<T> type) throws ParseException {<a name="line.333"></a> -<span class="sourceLineNo">334</span> return parseSession(createSession(input), type);<a name="line.334"></a> -<span class="sourceLineNo">335</span> }<a name="line.335"></a> -<span class="sourceLineNo">336</span><a name="line.336"></a> -<span class="sourceLineNo">337</span> /**<a name="line.337"></a> -<span class="sourceLineNo">338</span> * Create the session object that will be passed in to the parse method.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * <p><a name="line.339"></a> -<span class="sourceLineNo">340</span> * It's up to implementers to decide what the session object looks like, although typically<a name="line.340"></a> -<span class="sourceLineNo">341</span> * it's going to be a subclass of {@link ParserSession}.<a name="line.341"></a> -<span class="sourceLineNo">342</span> *<a name="line.342"></a> -<span class="sourceLineNo">343</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.343"></a> -<span class="sourceLineNo">344</span> * @param op Optional additional properties.<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @param javaMethod Java method that invoked this parser.<a name="line.345"></a> -<span class="sourceLineNo">346</span> * When using the REST API, this is the Java method invoked by the REST call.<a name="line.346"></a> -<span class="sourceLineNo">347</span> * Can be used to access annotations defined on the method or class.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * @param outer The outer object for instantiating top-level non-static inner classes.<a name="line.348"></a> -<span class="sourceLineNo">349</span> * @param locale The session locale.<a name="line.349"></a> -<span class="sourceLineNo">350</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.350"></a> -<span class="sourceLineNo">351</span> * @param timeZone The session timezone.<a name="line.351"></a> -<span class="sourceLineNo">352</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.352"></a> -<span class="sourceLineNo">353</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @return The new session.<a name="line.354"></a> -<span class="sourceLineNo">355</span> */<a name="line.355"></a> -<span class="sourceLineNo">356</span> public ParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.356"></a> -<span class="sourceLineNo">357</span> return new ParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);<a name="line.357"></a> -<span class="sourceLineNo">358</span> }<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> /**<a name="line.360"></a> -<span class="sourceLineNo">361</span> * Create a basic session object without overriding properties or specifying <code>javaMethod</code>.<a name="line.361"></a> -<span class="sourceLineNo">362</span> * <p><a name="line.362"></a> -<span class="sourceLineNo">363</span> * Equivalent to calling <code>createSession(<jk>null</jk>, <jk>null</jk>)</code>.<a name="line.363"></a> -<span class="sourceLineNo">364</span> *<a name="line.364"></a> -<span class="sourceLineNo">365</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.365"></a> -<span class="sourceLineNo">366</span> * @return The new context.<a name="line.366"></a> -<span class="sourceLineNo">367</span> */<a name="line.367"></a> -<span class="sourceLineNo">368</span> protected final ParserSession createSession(Object input) {<a name="line.368"></a> -<span class="sourceLineNo">369</span> return createSession(input, null, null, null, null, null, getPrimaryMediaType());<a name="line.369"></a> -<span class="sourceLineNo">370</span> }<a name="line.370"></a> +<span class="sourceLineNo">020</span>import java.util.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.annotation.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.http.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.transform.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.juneau.transforms.*;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.juneau.utils.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>/**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Parent class for all Juneau parsers.<a name="line.30"></a> +<span class="sourceLineNo">031</span> *<a name="line.31"></a> +<span class="sourceLineNo">032</span> * <h6 class='topic'>@Consumes annotation</h6><a name="line.32"></a> +<span class="sourceLineNo">033</span> * <p><a name="line.33"></a> +<span class="sourceLineNo">034</span> * The media types that this parser can handle is specified through the {@link Consumes @Consumes} annotation.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * However, the media types can also be specified programmatically by overriding the {@link #getMediaTypes()} method.<a name="line.36"></a> +<span class="sourceLineNo">037</span> *<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <a id='ValidDataConversions'></a><h6 class='topic'>Valid data conversions</h6><a name="line.38"></a> +<span class="sourceLineNo">039</span> * Parsers can parse any parsable POJO types, as specified in the <a class="doclink" href="../../../../overview-summary.html#Core.PojoCategories">POJO Categories</a>.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p><a name="line.40"></a> +<span class="sourceLineNo">041</span> * Some examples of conversions are shown below...<a name="line.41"></a> +<span class="sourceLineNo">042</span> * </p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * <table class='styled'><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <tr><a name="line.44"></a> +<span class="sourceLineNo">045</span> * <th>Data type</th><a name="line.45"></a> +<span class="sourceLineNo">046</span> * <th>Class type</th><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <th>JSON example</th><a name="line.47"></a> +<span class="sourceLineNo">048</span> * <th>XML example</th><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <th>Class examples</th><a name="line.49"></a> +<span class="sourceLineNo">050</span> * </tr><a name="line.50"></a> +<span class="sourceLineNo">051</span> * <tr><a name="line.51"></a> +<span class="sourceLineNo">052</span> * <td>object</td><a name="line.52"></a> +<span class="sourceLineNo">053</span> * <td>Maps, Java beans</td><a name="line.53"></a> +<span class="sourceLineNo">054</span> * <td class='code'>{name:<js>'John Smith'</js>,age:21}</td><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <td class='code'><xt>&lt;object&gt;<a name="line.55"></a> +<span class="sourceLineNo">056</span> * &lt;name</xt> <xa>type</xa>=<xs>'string'</xs><xt>&gt;</xt>John Smith<xt>&lt;/name&gt;<a name="line.56"></a> +<span class="sourceLineNo">057</span> * &lt;age</xt> <xa>type</xa>=<xs>'number'</xs><xt>&gt;</xt>21<xt>&lt;/age&gt;<a name="line.57"></a> +<span class="sourceLineNo">058</span> * &lt;/object&gt;</xt></td><a name="line.58"></a> +<span class="sourceLineNo">059</span> * <td class='code'>HashMap, TreeMap&lt;String,Integer&gt;</td><a name="line.59"></a> +<span class="sourceLineNo">060</span> * </tr><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <tr><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <td>array</td><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <td>Collections, Java arrays</td><a name="line.63"></a> +<span class="sourceLineNo">064</span> * <td class='code'>[1,2,3]</td><a name="line.64"></a> +<span class="sourceLineNo">065</span> * <td class='code'><xt>&lt;array&gt;<a name="line.65"></a> +<span class="sourceLineNo">066</span> * &lt;number&gt;</xt>1<xt>&lt;/number&gt;<a name="line.66"></a> +<span class="sourceLineNo">067</span> * &lt;number&gt;</xt>2<xt>&lt;/number&gt;<a name="line.67"></a> +<span class="sourceLineNo">068</span> * &lt;number&gt;</xt>3<xt>&lt;/number&gt;<a name="line.68"></a> +<span class="sourceLineNo">069</span> * &lt;/array&gt;</xt></td><a name="line.69"></a> +<span class="sourceLineNo">070</span> * <td class='code'>List&lt;Integer&gt;, <jk>int</jk>[], Float[], Set&lt;Person&gt;</td><a name="line.70"></a> +<span class="sourceLineNo">071</span> * </tr><a name="line.71"></a> +<span class="sourceLineNo">072</span> * <tr><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <td>number</td><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <td>Numbers</td><a name="line.74"></a> +<span class="sourceLineNo">075</span> * <td class='code'>123</td><a name="line.75"></a> +<span class="sourceLineNo">076</span> * <td class='code'><xt>&lt;number&gt;</xt>123<xt>&lt;/number&gt;</xt></td><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <td class='code'>Integer, Long, Float, <jk>int</jk></td><a name="line.77"></a> +<span class="sourceLineNo">078</span> * </tr><a name="line.78"></a> +<span class="sourceLineNo">079</span> * <tr><a name="line.79"></a> +<span class="sourceLineNo">080</span> * <td>boolean</td><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <td>Booleans</td><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <td class='code'><jk>true</jk></td><a name="line.82"></a> +<span class="sourceLineNo">083</span> * <td class='code'><xt>&lt;boolean&gt;</xt>true<xt>&lt;/boolean&gt;</xt></td><a name="line.83"></a> +<span class="sourceLineNo">084</span> * <td class='code'>Boolean</td><a name="line.84"></a> +<span class="sourceLineNo">085</span> * </tr><a name="line.85"></a> +<span class="sourceLineNo">086</span> * <tr><a name="line.86"></a> +<span class="sourceLineNo">087</span> * <td>string</td><a name="line.87"></a> +<span class="sourceLineNo">088</span> * <td>CharSequences</td><a name="line.88"></a> +<span class="sourceLineNo">089</span> * <td class='code'><js>'foobar'</js></td><a name="line.89"></a> +<span class="sourceLineNo">090</span> * <td class='code'><xt>&lt;string&gt;</xt>foobar<xt>&lt;/string&gt;</xt></td><a name="line.90"></a> +<span class="sourceLineNo">091</span> * <td class='code'>String, StringBuilder</td><a name="line.91"></a> +<span class="sourceLineNo">092</span> * </tr><a name="line.92"></a> +<span class="sourceLineNo">093</span> * </table><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <p><a name="line.94"></a> +<span class="sourceLineNo">095</span> * In addition, any class types with {@link PojoSwap PojoSwaps} associated with them on the registered<a name="line.95"></a> +<span class="sourceLineNo">096</span> * {@link #getBeanContext() beanContext} can also be passed in.<a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> +<span class="sourceLineNo">098</span> * For example, if the {@link CalendarSwap} transform is used to generalize {@code Calendar} objects to {@code String} objects. When registered<a name="line.98"></a> +<span class="sourceLineNo">099</span> * with this parser, you can construct {@code Calendar} objects from {@code Strings} using the following syntax...<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <p class='bcode'><a name="line.100"></a> +<span class="sourceLineNo">101</span> * Calendar c = parser.parse(<js>"'Sun Mar 03 04:05:06 EST 2001'"</js>, GregorianCalendar.<jk>class</jk>);<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <p><a name="line.102"></a> +<span class="sourceLineNo">103</span> * If <code>Object.<jk>class</jk></code> is specified as the target type, then the parser<a name="line.103"></a> +<span class="sourceLineNo">104</span> * automatically determines the data types and generates the following object types...<a name="line.104"></a> +<span class="sourceLineNo">105</span> * </p><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <table class='styled'><a name="line.106"></a> +<span class="sourceLineNo">107</span> * <tr><th>JSON type</th><th>Class type</th></tr><a name="line.107"></a> +<span class="sourceLineNo">108</span> * <tr><td>object</td><td>{@link ObjectMap}</td></tr><a name="line.108"></a> +<span class="sourceLineNo">109</span> * <tr><td>array</td><td>{@link ObjectList}</td></tr><a name="line.109"></a> +<span class="sourceLineNo">110</span> * <tr><td>number</td><td>{@link Number} <br>(depending on length and format, could be {@link Integer}, {@link Double}, {@link Float}, etc...)</td></tr><a name="line.110"></a> +<span class="sourceLineNo">111</span> * <tr><td>boolean</td><td>{@link Boolean}</td></tr><a name="line.111"></a> +<span class="sourceLineNo">112</span> * <tr><td>string</td><td>{@link String}</td></tr><a name="line.112"></a> +<span class="sourceLineNo">113</span> * </table><a name="line.113"></a> +<span class="sourceLineNo">114</span> *<a name="line.114"></a> +<span class="sourceLineNo">115</span> * <a id='SupportedTypes'></a><h6 class='topic'>Supported types</h6><a name="line.115"></a> +<span class="sourceLineNo">116</span> * <p><a name="line.116"></a> +<span class="sourceLineNo">117</span> * Several of the methods below take {@link Type} parameters to identify the type of<a name="line.117"></a> +<span class="sourceLineNo">118</span> * object to create. Any of the following types can be passed in to these methods...<a name="line.118"></a> +<span class="sourceLineNo">119</span> * </p><a name="line.119"></a> +<span class="sourceLineNo">120</span> * <ul><a name="line.120"></a> +<span class="sourceLineNo">121</span> * <li>{@link ClassMeta}<a name="line.121"></a> +<span class="sourceLineNo">122</span> * <li>{@link Class}<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <li>{@link ParameterizedType}<a name="line.123"></a> +<span class="sourceLineNo">124</span> * <li>{@link GenericArrayType}<a name="line.124"></a> +<span class="sourceLineNo">125</span> * </ul><a name="line.125"></a> +<span class="sourceLineNo">126</span> * <p><a name="line.126"></a> +<span class="sourceLineNo">127</span> * However, {@code ParameterizedTypes} and {@code GenericArrayTypes} should not contain<a name="line.127"></a> +<span class="sourceLineNo">128</span> * {@link WildcardType WildcardTypes} or {@link TypeVariable TypeVariables}.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * <p><a name="line.129"></a> +<span class="sourceLineNo">130</span> * Passing in <jk>null</jk> or <code>Object.<jk>class</jk></code> typically signifies that it's up to the parser<a name="line.130"></a> +<span class="sourceLineNo">131</span> * to determine what object type is being parsed parsed based on the rules above.<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span>public abstract class Parser extends CoreObject {<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /** General parser properties currently set on this parser. */<a name="line.135"></a> +<span class="sourceLineNo">136</span> private final MediaType[] mediaTypes;<a name="line.136"></a> +<span class="sourceLineNo">137</span> private final ParserContext ctx;<a name="line.137"></a> +<span class="sourceLineNo">138</span><a name="line.138"></a> +<span class="sourceLineNo">139</span> // Hidden constructor to force subclass from InputStreamParser or ReaderParser.<a name="line.139"></a> +<span class="sourceLineNo">140</span> Parser(PropertyStore propertyStore) {<a name="line.140"></a> +<span class="sourceLineNo">141</span> super(propertyStore);<a name="line.141"></a> +<span class="sourceLineNo">142</span> this.ctx = createContext(ParserContext.class);<a name="line.142"></a> +<span class="sourceLineNo">143</span><a name="line.143"></a> +<span class="sourceLineNo">144</span> Consumes c = getAnnotation(Consumes.class, getClass());<a name="line.144"></a> +<span class="sourceLineNo">145</span> if (c == null)<a name="line.145"></a> +<span class="sourceLineNo">146</span> throw new FormattedRuntimeException("Class ''{0}'' is missing the @Consumes annotation", c);<a name="line.146"></a> +<span class="sourceLineNo">147</span><a name="line.147"></a> +<span class="sourceLineNo">148</span> String[] mt = split(c.value());<a name="line.148"></a> +<span class="sourceLineNo">149</span> this.mediaTypes = new MediaType[mt.length];<a name="line.149"></a> +<span class="sourceLineNo">150</span> for (int i = 0; i < mt.length; i++) {<a name="line.150"></a> +<span class="sourceLineNo">151</span> mediaTypes[i] = MediaType.forString(mt[i]);<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span> }<a name="line.153"></a> +<span class="sourceLineNo">154</span><a name="line.154"></a> +<span class="sourceLineNo">155</span> @Override /* CoreObject */<a name="line.155"></a> +<span class="sourceLineNo">156</span> public ParserBuilder builder() {<a name="line.156"></a> +<span class="sourceLineNo">157</span> return new ParserBuilder(propertyStore);<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span><a name="line.159"></a> +<span class="sourceLineNo">160</span> //--------------------------------------------------------------------------------<a name="line.160"></a> +<span class="sourceLineNo">161</span> // Abstract methods<a name="line.161"></a> +<span class="sourceLineNo">162</span> //--------------------------------------------------------------------------------<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * Workhorse method. Subclasses are expected to implement this method.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * If <jk>null</jk>, one will be created using {@link #createSession(Object)}.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @param type The class type of the object to create.<a name="line.168"></a> +<span class="sourceLineNo">169</span> * If <jk>null</jk> or <code>Object.<jk>class</jk></code>, object type is based on what's being parsed.<a name="line.169"></a> +<span class="sourceLineNo">170</span> * For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>, <code>ObjectMap</code>, etc...<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @param <T> The class type of the object to create.<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @return The parsed object.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.<a name="line.173"></a> +<span class="sourceLineNo">174</span> */<a name="line.174"></a> +<span class="sourceLineNo">175</span> protected abstract <T> T doParse(ParserSession session, ClassMeta<T> type) throws Exception;<a name="line.175"></a> +<span class="sourceLineNo">176</span><a name="line.176"></a> +<span class="sourceLineNo">177</span> /**<a name="line.177"></a> +<span class="sourceLineNo">178</span> * Returns <jk>true</jk> if this parser subclasses from {@link ReaderParser}.<a name="line.178"></a> +<span class="sourceLineNo">179</span> *<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @return <jk>true</jk> if this parser subclasses from {@link ReaderParser}.<a name="line.180"></a> +<span class="sourceLineNo">181</span> */<a name="line.181"></a> +<span class="sourceLineNo">182</span> public abstract boolean isReaderParser();<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> //--------------------------------------------------------------------------------<a name="line.184"></a> +<span class="sourceLineNo">185</span> // Other methods<a name="line.185"></a> +<span class="sourceLineNo">186</span> //--------------------------------------------------------------------------------<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Entry point for all parsing calls.<a name="line.189"></a> +<span class="sourceLineNo">190</span> * <p><a name="line.190"></a> +<span class="sourceLineNo">191</span> * Calls the {@link #doParse(ParserSession, ClassMeta)} implementation class and catches/rewraps any exceptions thrown.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param session The runtime session returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param type The class type of the object to create.<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param <T> The class type of the object to create.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @return The parsed object.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public final <T> T parseSession(ParserSession session, ClassMeta<T> type) throws ParseException {<a name="line.198"></a> +<span class="sourceLineNo">199</span> try {<a name="line.199"></a> +<span class="sourceLineNo">200</span> if (type.isVoid())<a name="line.200"></a> +<span class="sourceLineNo">201</span> return null;<a name="line.201"></a> +<span class="sourceLineNo">202</span> return doParse(session, type);<a name="line.202"></a> +<span class="sourceLineNo">203</span> } catch (ParseException e) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> throw e;<a name="line.204"></a> +<span class="sourceLineNo">205</span> } catch (StackOverflowError e) {<a name="line.205"></a> +<span class="sourceLineNo">206</span> throw new ParseException(session, "Depth too deep. Stack overflow occurred.");<a name="line.206"></a> +<span class="sourceLineNo">207</span> } catch (IOException e) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> throw new ParseException(session, "I/O exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);<a name="line.208"></a> +<span class="sourceLineNo">209</span> } catch (Exception e) {<a name="line.209"></a> +<span class="sourceLineNo">210</span> throw new ParseException(session, "Exception occurred. exception={0}, message={1}.", e.getClass().getSimpleName(), e.getLocalizedMessage()).initCause(e);<a name="line.210"></a> +<span class="sourceLineNo">211</span> } finally {<a name="line.211"></a> +<span class="sourceLineNo">212</span> session.close();<a name="line.212"></a> +<span class="sourceLineNo">213</span> }<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * Parses input into the specified object type.<a name="line.217"></a> +<span class="sourceLineNo">218</span> * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).<a name="line.218"></a> +<span class="sourceLineNo">219</span> *<a name="line.219"></a> +<span class="sourceLineNo">220</span> * <h5 class='section'>Examples:</h5><a name="line.220"></a> +<span class="sourceLineNo">221</span> * <p class='bcode'><a name="line.221"></a> +<span class="sourceLineNo">222</span> * ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;<a name="line.222"></a> +<span class="sourceLineNo">223</span> *<a name="line.223"></a> +<span class="sourceLineNo">224</span> * <jc>// Parse into a linked-list of strings.</jc><a name="line.224"></a> +<span class="sourceLineNo">225</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.225"></a> +<span class="sourceLineNo">226</span> *<a name="line.226"></a> +<span class="sourceLineNo">227</span> * <jc>// Parse into a linked-list of beans.</jc><a name="line.227"></a> +<span class="sourceLineNo">228</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.228"></a> +<span class="sourceLineNo">229</span> *<a name="line.229"></a> +<span class="sourceLineNo">230</span> * <jc>// Parse into a linked-list of linked-lists of strings.</jc><a name="line.230"></a> +<span class="sourceLineNo">231</span> * List l = p.parse(json, LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.231"></a> +<span class="sourceLineNo">232</span> *<a name="line.232"></a> +<span class="sourceLineNo">233</span> * <jc>// Parse into a map of string keys/values.</jc><a name="line.233"></a> +<span class="sourceLineNo">234</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);<a name="line.234"></a> +<span class="sourceLineNo">235</span> *<a name="line.235"></a> +<span class="sourceLineNo">236</span> * <jc>// Parse into a map containing string keys and values of lists containing beans.</jc><a name="line.236"></a> +<span class="sourceLineNo">237</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.237"></a> +<span class="sourceLineNo">238</span> * </p><a name="line.238"></a> +<span class="sourceLineNo">239</span> * <p><a name="line.239"></a> +<span class="sourceLineNo">240</span> * <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.<a name="line.240"></a> +<span class="sourceLineNo">241</span> * <p><a name="line.241"></a> +<span class="sourceLineNo">242</span> * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value types.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * <p><a name="line.243"></a> +<span class="sourceLineNo">244</span> * The array can be arbitrarily long to indicate arbitrarily complex data structures.<a name="line.244"></a> +<span class="sourceLineNo">245</span> * <p><a name="line.245"></a> +<span class="sourceLineNo">246</span> * <h5 class='section'>Notes:</h5><a name="line.246"></a> +<span class="sourceLineNo">247</span> * <ul><a name="line.247"></a> +<span class="sourceLineNo">248</span> * <li>Use the {@link #parse(Object, Class)} method instead if you don't need a parameterized map/collection.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * </ul><a name="line.249"></a> +<span class="sourceLineNo">250</span> *<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @param <T> The class type of the object to create.<a name="line.251"></a> +<span class="sourceLineNo">252</span> * @param input The input.<a name="line.252"></a> +<span class="sourceLineNo">253</span> * <br>Character-based parsers can handle the following input class types:<a name="line.253"></a> +<span class="sourceLineNo">254</span> * <ul><a name="line.254"></a> +<span class="sourceLineNo">255</span> * <li><jk>null</jk><a name="line.255"></a> +<span class="sourceLineNo">256</span> * <li>{@link Reader}<a name="line.256"></a> +<span class="sourceLineNo">257</span> * <li>{@link CharSequence}<a name="line.257"></a> +<span class="sourceLineNo">258</span> * <li>{@link InputStream} containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).<a name="line.258"></a> +<span class="sourceLineNo">259</span> * <li><code><jk>byte</jk>[]</code> containing UTF-8 encoded text (or charset defined by {@link ParserContext#PARSER_inputStreamCharset} property value).<a name="line.259"></a> +<span class="sourceLineNo">260</span> * <li>{@link File} containing system encoded text (or charset defined by {@link ParserContext#PARSER_fileCharset} property value).<a name="line.260"></a> +<span class="sourceLineNo">261</span> * </ul><a name="line.261"></a> +<span class="sourceLineNo">262</span> * <br>Stream-based parsers can handle the following input class types:<a name="line.262"></a> +<span class="sourceLineNo">263</span> * <ul><a name="line.263"></a> +<span class="sourceLineNo">264</span> * <li><jk>null</jk><a name="line.264"></a> +<span class="sourceLineNo">265</span> * <li>{@link InputStream}<a name="line.265"></a> +<span class="sourceLineNo">266</span> * <li><code><jk>byte</jk>[]</code><a name="line.266"></a> +<span class="sourceLineNo">267</span> * <li>{@link File}<a name="line.267"></a> +<span class="sourceLineNo">268</span> * </ul><a name="line.268"></a> +<span class="sourceLineNo">269</span> * @param type The object type to create.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.270"></a> +<span class="sourceLineNo">271</span> * @param args The type arguments of the class if it's a collection or map.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.272"></a> +<span class="sourceLineNo">273</span> * <br>Ignored if the main type is not a map or collection.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * @return The parsed object.<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.275"></a> +<span class="sourceLineNo">276</span> * @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.<a name="line.276"></a> +<span class="sourceLineNo">277</span> */<a name="line.277"></a> +<span class="sourceLineNo">278</span> @SuppressWarnings("unchecked")<a name="line.278"></a> +<span class="sourceLineNo">279</span> public final <T> T parse(Object input, Type type, Type...args) throws ParseException {<a name="line.279"></a> +<span class="sourceLineNo">280</span> ParserSession session = createSession(input);<a name="line.280"></a> +<span class="sourceLineNo">281</span> return (T)parseSession(session, session.getClassMeta(type, args));<a name="line.281"></a> +<span class="sourceLineNo">282</span> }<a name="line.282"></a> +<span class="sourceLineNo">283</span><a name="line.283"></a> +<span class="sourceLineNo">284</span> /**<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Same as {@link #parse(Object, Type, Type...)} except optimized for a non-parameterized class.<a name="line.285"></a> +<span class="sourceLineNo">286</span> * <p><a name="line.286"></a> +<span class="sourceLineNo">287</span> * This is the preferred parse method for simple types since you don't need to cast the results.<a name="line.287"></a> +<span class="sourceLineNo">288</span> * <h5 class='section'>Examples:</h5><a name="line.288"></a> +<span class="sourceLineNo">289</span> * <p class='bcode'><a name="line.289"></a> +<span class="sourceLineNo">290</span> * ReaderParser p = JsonParser.<jsf>DEFAULT</jsf>;<a name="line.290"></a> +<span class="sourceLineNo">291</span> *<a name="line.291"></a> +<span class="sourceLineNo">292</span> * <jc>// Parse into a string.</jc><a name="line.292"></a> +<span class="sourceLineNo">293</span> * String s = p.parse(json, String.<jk>class</jk>);<a name="line.293"></a> +<span class="sourceLineNo">294</span> *<a name="line.294"></a> +<span class="sourceLineNo">295</span> * <jc>// Parse into a bean.</jc><a name="line.295"></a> +<span class="sourceLineNo">296</span> * MyBean b = p.parse(json, MyBean.<jk>class</jk>);<a name="line.296"></a> +<span class="sourceLineNo">297</span> *<a name="line.297"></a> +<span class="sourceLineNo">298</span> * <jc>// Parse into a bean array.</jc><a name="line.298"></a> +<span class="sourceLineNo">299</span> * MyBean[] ba = p.parse(json, MyBean[].<jk>class</jk>);<a name="line.299"></a> +<span class="sourceLineNo">300</span> *<a name="line.300"></a> +<span class="sourceLineNo">301</span> * <jc>// Parse into a linked-list of objects.</jc><a name="line.301"></a> +<span class="sourceLineNo">302</span> * List l = p.parse(json, LinkedList.<jk>class</jk>);<a name="line.302"></a> +<span class="sourceLineNo">303</span> *<a name="line.303"></a> +<span class="sourceLineNo">304</span> * <jc>// Parse into a map of object keys/values.</jc><a name="line.304"></a> +<span class="sourceLineNo">305</span> * Map m = p.parse(json, TreeMap.<jk>class</jk>);<a name="line.305"></a> +<span class="sourceLineNo">306</span> * </p><a name="line.306"></a> +<span class="sourceLineNo">307</span> *<a name="line.307"></a> +<span class="sourceLineNo">308</span> * @param <T> The class type of the object being created.<a name="line.308"></a> +<span class="sourceLineNo">309</span> * @param input The input.<a name="line.309"></a> +<span class="sourceLineNo">310</span> * See {@link #parse(Object, Type, Type...)} for details.<a name="line.310"></a> +<span class="sourceLineNo">311</span> * @param type The object type to create.<a name="line.311"></a> +<span class="sourceLineNo">312</span> * @return The parsed object.<a name="line.312"></a> +<span class="sourceLineNo">313</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.313"></a> +<span class="sourceLineNo">314</span> */<a name="line.314"></a> +<span class="sourceLineNo">315</span> public final <T> T parse(Object input, Class<T> type) throws ParseException {<a name="line.315"></a> +<span class="sourceLineNo">316</span> ParserSession session = createSession(input);<a name="line.316"></a> +<span class="sourceLineNo">317</span> return parseSession(session, session.getClassMeta(type));<a name="line.317"></a> +<span class="sourceLineNo">318</span> }<a name="line.318"></a> +<span class="sourceLineNo">319</span><a name="line.319"></a> +<span class="sourceLineNo">320</span> /**<a name="line.320"></a> +<span class="sourceLineNo">321</span> * Same as {@link #parse(Object, Type, Type...)} except the type has already been converted into a {@link ClassMeta} object.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * <p><a name="line.322"></a> +<span class="sourceLineNo">323</span> * This is mostly an internal method used by the framework.<a name="line.323"></a> +<span class="sourceLineNo">324</span> *<a name="line.324"></a> +<span class="sourceLineNo">325</span> * @param <T> The class type of the object being created.<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @param input The input.<a name="line.326"></a> +<span class="sourceLineNo">327</span> * See {@link #parse(Object, Type, Type...)} for details.<a name="line.327"></a> +<span class="sourceLineNo">328</span> * @param type The object type to create.<a name="line.328"></a> +<span class="sourceLineNo">329</span> * @return The parsed object.<a name="line.329"></a> +<span class="sourceLineNo">330</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.330"></a> +<span class="sourceLineNo">331</span> */<a name="line.331"></a> +<span class="sourceLineNo">332</span> public final <T> T parse(Object input, ClassMeta<T> type) throws ParseException {<a name="line.332"></a> +<span class="sourceLineNo">333</span> return parseSession(createSession(input), type);<a name="line.333"></a> +<span class="sourceLineNo">334</span> }<a name="line.334"></a> +<span class="sourceLineNo">335</span><a name="line.335"></a> +<span class="sourceLineNo">336</span> /**<a name="line.336"></a> +<span class="sourceLineNo">337</span> * Create the session object that will be passed in to the parse method.<a name="line.337"></a> +<span class="sourceLineNo">338</span> * <p><a name="line.338"></a> +<span class="sourceLineNo">339</span> * It's up to implementers to decide what the session object looks like, although typically<a name="line.339"></a> +<span class="sourceLineNo">340</span> * it's going to be a subclass of {@link ParserSession}.<a name="line.340"></a> +<span class="sourceLineNo">341</span> *<a name="line.341"></a> +<span class="sourceLineNo">342</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @param op Optional additional properties.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param javaMethod Java method that invoked this parser.<a name="line.344"></a> +<span class="sourceLineNo">345</span> * When using the REST API, this is the Java method invoked by the REST call.<a name="line.345"></a> +<span class="sourceLineNo">346</span> * Can be used to access annotations defined on the method or class.<a name="line.346"></a> +<span class="sourceLineNo">347</span> * @param outer The outer object for instantiating top-level non-static inner classes.<a name="line.347"></a> +<span class="sourceLineNo">348</span> * @param locale The session locale.<a name="line.348"></a> +<span class="sourceLineNo">349</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.349"></a> +<span class="sourceLineNo">350</span> * @param timeZone The session timezone.<a name="line.350"></a> +<span class="sourceLineNo">351</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.351"></a> +<span class="sourceLineNo">352</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.352"></a> +<span class="sourceLineNo">353</span> * @return The new session.<a name="line.353"></a> +<span class="sourceLineNo">354</span> */<a name="line.354"></a> +<span class="sourceLineNo">355</span> public ParserSession createSession(Object input, ObjectMap op, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.355"></a> +<span class="sourceLineNo">356</span> return new ParserSession(ctx, op, input, javaMethod, outer, locale, timeZone, mediaType);<a name="line.356"></a> +<span class="sourceLineNo">357</span> }<a name="line.357"></a> +<span class="sourceLineNo">358</span><a name="line.358"></a> +<span class="sourceLineNo">359</span> /**<a name="line.359"></a> +<span class="sourceLineNo">360</span> * Create a basic session object without overriding properties or specifying <code>javaMethod</code>.<a name="line.360"></a> +<span class="sourceLineNo">361</span> * <p><a name="line.361"></a> +<span class="sourceLineNo">362</span> * Equivalent to calling <code>createSession(<jk>null</jk>, <jk>null</jk>)</code>.<a name="line.362"></a> +<span class="sourceLineNo">363</span> *<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.364"></a> +<span class="sourceLineNo">365</span> * @return The new context.<a name="line.365"></a> +<span class="sourceLineNo">366</span> */<a name="line.366"></a> +<span class="sourceLineNo">367</span> protected final ParserSession createSession(Object input) {<a name="line.367"></a> +<span class="sourceLineNo">368</span> return createSession(input, null, null, null, null, null, getPrimaryMediaType());<a name="line.368"></a> +<span class="sourceLineNo">369</span> }<a name="line.369"></a> +<span class="sourceLineNo">370</span><a name="line.370"></a> <span class="sourceLineNo">371</span><a name="line.371"></a> -<span class="sourceLineNo">372</span><a name="line.372"></a> -<span class="sourceLineNo">373</span> //--------------------------------------------------------------------------------<a name="line.373"></a> -<span class="sourceLineNo">374</span> // Optional methods<a name="line.374"></a> -<span class="sourceLineNo">375</span> //--------------------------------------------------------------------------------<a name="line.375"></a> -<span class="sourceLineNo">376</span><a name="line.376"></a> -<span class="sourceLineNo">377</span> /**<a name="line.377"></a> -<span class="sourceLineNo">378</span> * Parses the contents of the specified reader and loads the results into the specified map.<a name="line.378"></a> -<span class="sourceLineNo">379</span> * <p><a name="line.379"></a> -<span class="sourceLineNo">380</span> * Reader must contain something that serializes to a map (such as text containing a JSON object).<a name="line.380"></a> -<span class="sourceLineNo">381</span> * <p><a name="line.381"></a> -<span class="sourceLineNo">382</span> * Used in the following locations:<a name="line.382"></a> -<span class="sourceLineNo">383</span> * <ul class='spaced-list'><a name="line.383"></a> -<span class="sourceLineNo">384</span> * <li>The various character-based constructors in {@link ObjectMap} (e.g. {@link ObjectMap#ObjectMap(CharSequence,Parser)}).<a name="line.384"></a> -<span class="sourceLineNo">385</span> * </ul><a name="line.385"></a> -<span class="sourceLineNo">386</span> *<a name="line.386"></a> -<span class="sourceLineNo">387</span> * @param <K> The key class type.<a name="line.387"></a> -<span class="sourceLineNo">388</span> * @param <V> The value class type.<a name="line.388"></a> -<span class="sourceLineNo">389</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.389"></a> -<span class="sourceLineNo">390</span> * @param m The map being loaded.<a name="line.390"></a> -<span class="sourceLineNo">391</span> * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.<br><a name="line.391"></a> -<span class="sourceLineNo">392</span> * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.<br><a name="line.392"></a> -<span class="sourceLineNo">393</span> * @return The same map that was passed in to allow this method to be chained.<a name="line.393"></a> -<span class="sourceLineNo">394</span> * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.394"></a> -<span class="sourceLineNo">395</span> * @throws UnsupportedOperationException If not implemented.<a name="line.395"></a> -<span class="sourceLineNo">396</span> */<a name="line.396"></a> -<span class="sourceLineNo">397</span> public final <K,V> Map<K,V> parseIntoMap(Object input, Map<K,V> m, Type keyType, Type valueType) throws ParseException {<a name="line.397"></a> -<span class="sourceLineNo">398</span> ParserSession session = createSession(input);<a name="line.398"></a> -<span class="sourceLineNo">399</span> try {<a name="line.399"></a> -<span class="sourceLineNo">400</span> return doParseIntoMap(session, m, keyType, valueType);<a name="line.400"></a> -<span class="sourceLineNo">401</span> } catch (ParseException e) {<a name="line.401"></a> -<span class="sourceLineNo">402</span> throw e;<a name="line.402"></a> -<span class="sourceLineNo">403</span> } catch (Exception e) {<a name="line.403"></a> -<span class="sourceLineNo">404</span> throw new ParseException(session, e);<a name="line.404"></a> -<span class="sourceLineNo">405</span> } finally {<a name="line.405"></a> -<span class="sourceLineNo">406</span> session.close();<a name="line.406"></a> -<span class="sourceLineNo">407</span> }<a name="line.407"></a> -<span class="sourceLineNo">408</span> }<a name="line.408"></a> -<span class="sourceLineNo">409</span><a name="line.409"></a> -<span class="sourceLineNo">410</span> /**<a name="line.410"></a> -<span class="sourceLineNo">411</span> * Implementation method.<a name="line.411"></a> -<span class="sourceLineNo">412</span> * Default implementation throws an {@link UnsupportedOperationException}.<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param session The runtime session object returned by {@link #createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)}.<a name="line.413"></a> -<span class="sourceLineNo">414</span> * If <jk>null</jk>, one will be created using {@link #createSession(Object)}.<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @param m The map being loaded.<a name="line.415"></a> -<span class="sourceLineNo">416</span> * @param keyType The class type of the keys, or <jk>null</jk> to default to <code>String.<jk>class</jk></code>.<br><a name="line.416"></a> -<span class="sourceLineNo">417</span> * @param valueType The class type of the values, or <jk>null</jk> to default to whatever is being parsed.<br><a name="line.417"></a> -<span class="sourceLineNo">418</span> *<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @return The same map that was passed in to allow this method to be chained.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @throws Exception If thrown from underlying stream, or if the input contains a syntax error or is malformed.<a name="line.420"></a> -<span class="sourceLineNo">421</span> */<a name="line.421"></a> -<span class="sourceLineNo">422</span> protected <K,V> Map<K,V> doParseIntoMap(ParserSession session, Map<K,V> m, Type keyType, Type valueType) throws Exception {<a name="line.422"></a> -<span class="sourceLineNo">423</span> throw new UnsupportedOperationException("Parser '"+getClass().getName()+"' does not support this method.");<a name="line.423"></a> -<span class="sourceLineNo">424</span> }<a name="line.424"></a> -<span class="sourceLineNo">425</span><a name="line.425"></a> -<span class="sourceLineNo">426</span> /**<a name="line.426"></a> -<span class="sourceLineNo">427</span> * Parses the contents of the specified reader and loads the results into the specified collection.<a name="line.427"></a> -<span class="sourceLineNo">428</span> * <p><a name="line.428"></a> -<span class="sourceLineNo">429</span> * Used in the following locations:<a name="line.429"></a> -<span class="sourceLineNo">430</span> * <ul class='spaced-list'><a name="line.430"></a> -<span class="sourceLineNo">431</span> * <li>The various character-based constructors in {@link ObjectList} (e.g. {@link ObjectList#ObjectList(CharSequence,Parser)}.<a name="line.431"></a> -<span class="sourceLineNo">432</span> * </ul><a name="line.432"></a> -<span class="sourceLineNo">433</span> *<a name="line.433"></a> -<span class="sourceLineNo">434</span> * @param <E> The element class type.<a name="line.434"></a> -<span class="sourceLineNo">435</span> * @param input The input. See {@link #parse(Object, ClassMeta)} for supported input types.<a name="line.435"></a> -<span class="sourceLineNo">436</span> * @param c The collection being loaded.<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @param elementType The class type of the elements, or <jk>null</jk> to default to whatever is being parsed.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * @return The same collection that was passed in to allow this method to be chained.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @throws ParseException If the input
<TRUNCATED>
