Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 01ede9e87 -> d35b70d1f
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/xml/XmlParserSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlParserSession.html b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlParserSession.html index 7b839e6..6532f42 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlParserSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlParserSession.html @@ -116,252 +116,256 @@ <span class="sourceLineNo">108</span> * @throws Exception If problem occurred trying to create reader.<a name="line.108"></a> <span class="sourceLineNo">109</span> */<a name="line.109"></a> <span class="sourceLineNo">110</span> public final XMLStreamReader getXmlStreamReader() throws Exception {<a name="line.110"></a> -<span class="sourceLineNo">111</span> try {<a name="line.111"></a> -<span class="sourceLineNo">112</span> Reader r = getBufferedReader(getReader());<a name="line.112"></a> -<span class="sourceLineNo">113</span> XMLInputFactory factory = XMLInputFactory.newInstance();<a name="line.113"></a> -<span class="sourceLineNo">114</span> factory.setProperty(XMLInputFactory.IS_VALIDATING, validating);<a name="line.114"></a> -<span class="sourceLineNo">115</span> factory.setProperty(XMLInputFactory.IS_COALESCING, true);<a name="line.115"></a> -<span class="sourceLineNo">116</span> factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, true); // This usually has no effect anyway.<a name="line.116"></a> -<span class="sourceLineNo">117</span> if (factory.isPropertySupported(XMLInputFactory.REPORTER) && reporter != null)<a name="line.117"></a> -<span class="sourceLineNo">118</span> factory.setProperty(XMLInputFactory.REPORTER, reporter);<a name="line.118"></a> -<span class="sourceLineNo">119</span> if (factory.isPropertySupported(XMLInputFactory.RESOLVER) && resolver != null)<a name="line.119"></a> -<span class="sourceLineNo">120</span> factory.setProperty(XMLInputFactory.RESOLVER, resolver);<a name="line.120"></a> -<span class="sourceLineNo">121</span> if (factory.isPropertySupported(XMLInputFactory.ALLOCATOR) && eventAllocator != null)<a name="line.121"></a> -<span class="sourceLineNo">122</span> factory.setProperty(XMLInputFactory.ALLOCATOR, eventAllocator);<a name="line.122"></a> -<span class="sourceLineNo">123</span> xmlStreamReader = factory.createXMLStreamReader(r);<a name="line.123"></a> -<span class="sourceLineNo">124</span> xmlStreamReader.nextTag();<a name="line.124"></a> -<span class="sourceLineNo">125</span> } catch (Error e) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> close();<a name="line.126"></a> -<span class="sourceLineNo">127</span> throw new ParseException(e.getLocalizedMessage());<a name="line.127"></a> -<span class="sourceLineNo">128</span> } catch (XMLStreamException e) {<a name="line.128"></a> +<span class="sourceLineNo">111</span> if (xmlStreamReader != null)<a name="line.111"></a> +<span class="sourceLineNo">112</span> return xmlStreamReader;<a name="line.112"></a> +<span class="sourceLineNo">113</span><a name="line.113"></a> +<span class="sourceLineNo">114</span> try {<a name="line.114"></a> +<span class="sourceLineNo">115</span> Reader r = getBufferedReader(getReader());<a name="line.115"></a> +<span class="sourceLineNo">116</span> XMLInputFactory factory = XMLInputFactory.newInstance();<a name="line.116"></a> +<span class="sourceLineNo">117</span> factory.setProperty(XMLInputFactory.IS_VALIDATING, validating);<a name="line.117"></a> +<span class="sourceLineNo">118</span> factory.setProperty(XMLInputFactory.IS_COALESCING, true);<a name="line.118"></a> +<span class="sourceLineNo">119</span> factory.setProperty(XMLInputFactory.IS_REPLACING_ENTITY_REFERENCES, true); // This usually has no effect anyway.<a name="line.119"></a> +<span class="sourceLineNo">120</span> if (factory.isPropertySupported(XMLInputFactory.REPORTER) && reporter != null)<a name="line.120"></a> +<span class="sourceLineNo">121</span> factory.setProperty(XMLInputFactory.REPORTER, reporter);<a name="line.121"></a> +<span class="sourceLineNo">122</span> if (factory.isPropertySupported(XMLInputFactory.RESOLVER) && resolver != null)<a name="line.122"></a> +<span class="sourceLineNo">123</span> factory.setProperty(XMLInputFactory.RESOLVER, resolver);<a name="line.123"></a> +<span class="sourceLineNo">124</span> if (factory.isPropertySupported(XMLInputFactory.ALLOCATOR) && eventAllocator != null)<a name="line.124"></a> +<span class="sourceLineNo">125</span> factory.setProperty(XMLInputFactory.ALLOCATOR, eventAllocator);<a name="line.125"></a> +<span class="sourceLineNo">126</span> xmlStreamReader = factory.createXMLStreamReader(r);<a name="line.126"></a> +<span class="sourceLineNo">127</span> xmlStreamReader.nextTag();<a name="line.127"></a> +<span class="sourceLineNo">128</span> } catch (Error e) {<a name="line.128"></a> <span class="sourceLineNo">129</span> close();<a name="line.129"></a> -<span class="sourceLineNo">130</span> throw new ParseException(e);<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> return xmlStreamReader;<a name="line.133"></a> -<span class="sourceLineNo">134</span> }<a name="line.134"></a> +<span class="sourceLineNo">130</span> throw new ParseException(e.getLocalizedMessage());<a name="line.130"></a> +<span class="sourceLineNo">131</span> } catch (XMLStreamException e) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> close();<a name="line.132"></a> +<span class="sourceLineNo">133</span> throw new ParseException(e);<a name="line.133"></a> +<span class="sourceLineNo">134</span> }<a name="line.134"></a> <span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> /**<a name="line.136"></a> -<span class="sourceLineNo">137</span> * Decodes and trims the specified string.<a name="line.137"></a> -<span class="sourceLineNo">138</span> *<a name="line.138"></a> -<span class="sourceLineNo">139</span> * <p><a name="line.139"></a> -<span class="sourceLineNo">140</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.140"></a> +<span class="sourceLineNo">136</span> return xmlStreamReader;<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<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> * Decodes and trims the specified string.<a name="line.140"></a> <span class="sourceLineNo">141</span> *<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @param s The string to be decoded.<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @return The decoded string.<a name="line.143"></a> -<span class="sourceLineNo">144</span> */<a name="line.144"></a> -<span class="sourceLineNo">145</span> public final String decodeString(String s) {<a name="line.145"></a> -<span class="sourceLineNo">146</span> if (s == null)<a name="line.146"></a> -<span class="sourceLineNo">147</span> return null;<a name="line.147"></a> -<span class="sourceLineNo">148</span> sb.setLength(0);<a name="line.148"></a> -<span class="sourceLineNo">149</span> s = XmlUtils.decode(s, sb);<a name="line.149"></a> -<span class="sourceLineNo">150</span> if (isTrimStrings())<a name="line.150"></a> -<span class="sourceLineNo">151</span> s = s.trim();<a name="line.151"></a> -<span class="sourceLineNo">152</span> return s;<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> * Returns the name of the current XML element.<a name="line.156"></a> -<span class="sourceLineNo">157</span> *<a name="line.157"></a> -<span class="sourceLineNo">158</span> * <p><a name="line.158"></a> -<span class="sourceLineNo">159</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.159"></a> +<span class="sourceLineNo">142</span> * <p><a name="line.142"></a> +<span class="sourceLineNo">143</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.143"></a> +<span class="sourceLineNo">144</span> *<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param s The string to be decoded.<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return The decoded string.<a name="line.146"></a> +<span class="sourceLineNo">147</span> */<a name="line.147"></a> +<span class="sourceLineNo">148</span> public final String decodeString(String s) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (s == null)<a name="line.149"></a> +<span class="sourceLineNo">150</span> return null;<a name="line.150"></a> +<span class="sourceLineNo">151</span> sb.setLength(0);<a name="line.151"></a> +<span class="sourceLineNo">152</span> s = XmlUtils.decode(s, sb);<a name="line.152"></a> +<span class="sourceLineNo">153</span> if (isTrimStrings())<a name="line.153"></a> +<span class="sourceLineNo">154</span> s = s.trim();<a name="line.154"></a> +<span class="sourceLineNo">155</span> return s;<a name="line.155"></a> +<span class="sourceLineNo">156</span> }<a name="line.156"></a> +<span class="sourceLineNo">157</span><a name="line.157"></a> +<span class="sourceLineNo">158</span> /**<a name="line.158"></a> +<span class="sourceLineNo">159</span> * Returns the name of the current XML element.<a name="line.159"></a> <span class="sourceLineNo">160</span> *<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @param r The reader to read from.<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return The decoded element name.<a name="line.162"></a> -<span class="sourceLineNo">163</span> * @throws XMLStreamException<a name="line.163"></a> -<span class="sourceLineNo">164</span> */<a name="line.164"></a> -<span class="sourceLineNo">165</span> public final String getElementName(XMLStreamReader r) throws XMLStreamException {<a name="line.165"></a> -<span class="sourceLineNo">166</span> return decodeString(r.getLocalName());<a name="line.166"></a> -<span class="sourceLineNo">167</span> }<a name="line.167"></a> -<span class="sourceLineNo">168</span><a name="line.168"></a> -<span class="sourceLineNo">169</span> /**<a name="line.169"></a> -<span class="sourceLineNo">170</span> * Returns the name of the specified attribute on the current XML element.<a name="line.170"></a> -<span class="sourceLineNo">171</span> *<a name="line.171"></a> -<span class="sourceLineNo">172</span> * <p><a name="line.172"></a> -<span class="sourceLineNo">173</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.173"></a> +<span class="sourceLineNo">161</span> * <p><a name="line.161"></a> +<span class="sourceLineNo">162</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.162"></a> +<span class="sourceLineNo">163</span> *<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @param r The reader to read from.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @return The decoded element name.<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @throws XMLStreamException<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> public final String getElementName(XMLStreamReader r) throws XMLStreamException {<a name="line.168"></a> +<span class="sourceLineNo">169</span> return decodeString(r.getLocalName());<a name="line.169"></a> +<span class="sourceLineNo">170</span> }<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> /**<a name="line.172"></a> +<span class="sourceLineNo">173</span> * Returns the name of the specified attribute on the current XML element.<a name="line.173"></a> <span class="sourceLineNo">174</span> *<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @param r The reader to read from.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * @param i The attribute index.<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @return The decoded attribute name.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @throws XMLStreamException<a name="line.178"></a> -<span class="sourceLineNo">179</span> */<a name="line.179"></a> -<span class="sourceLineNo">180</span> public final String getAttributeName(XMLStreamReader r, int i) throws XMLStreamException {<a name="line.180"></a> -<span class="sourceLineNo">181</span> return decodeString(r.getAttributeLocalName(i));<a name="line.181"></a> -<span class="sourceLineNo">182</span> }<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> * Returns the value of the specified attribute on the current XML element.<a name="line.185"></a> -<span class="sourceLineNo">186</span> *<a name="line.186"></a> -<span class="sourceLineNo">187</span> * <p><a name="line.187"></a> -<span class="sourceLineNo">188</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.188"></a> +<span class="sourceLineNo">175</span> * <p><a name="line.175"></a> +<span class="sourceLineNo">176</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @param r The reader to read from.<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @param i The attribute index.<a name="line.179"></a> +<span class="sourceLineNo">180</span> * @return The decoded attribute name.<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @throws XMLStreamException<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> public final String getAttributeName(XMLStreamReader r, int i) throws XMLStreamException {<a name="line.183"></a> +<span class="sourceLineNo">184</span> return decodeString(r.getAttributeLocalName(i));<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<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> * Returns the value of the specified attribute on the current XML element.<a name="line.188"></a> <span class="sourceLineNo">189</span> *<a name="line.189"></a> -<span class="sourceLineNo">190</span> * @param r The reader to read from.<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @param i The attribute index.<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @return The decoded attribute value.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @throws XMLStreamException<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> public final String getAttributeValue(XMLStreamReader r, int i) throws XMLStreamException {<a name="line.195"></a> -<span class="sourceLineNo">196</span> return decodeString(r.getAttributeValue(i));<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> * Returns the text content of the current XML element.<a name="line.200"></a> -<span class="sourceLineNo">201</span> *<a name="line.201"></a> -<span class="sourceLineNo">202</span> * <p><a name="line.202"></a> -<span class="sourceLineNo">203</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.203"></a> +<span class="sourceLineNo">190</span> * <p><a name="line.190"></a> +<span class="sourceLineNo">191</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.191"></a> +<span class="sourceLineNo">192</span> *<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @param r The reader to read from.<a name="line.193"></a> +<span class="sourceLineNo">194</span> * @param i The attribute index.<a name="line.194"></a> +<span class="sourceLineNo">195</span> * @return The decoded attribute value.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * @throws XMLStreamException<a name="line.196"></a> +<span class="sourceLineNo">197</span> */<a name="line.197"></a> +<span class="sourceLineNo">198</span> public final String getAttributeValue(XMLStreamReader r, int i) throws XMLStreamException {<a name="line.198"></a> +<span class="sourceLineNo">199</span> return decodeString(r.getAttributeValue(i));<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span><a name="line.201"></a> +<span class="sourceLineNo">202</span> /**<a name="line.202"></a> +<span class="sourceLineNo">203</span> * Returns the text content of the current XML element.<a name="line.203"></a> <span class="sourceLineNo">204</span> *<a name="line.204"></a> <span class="sourceLineNo">205</span> * <p><a name="line.205"></a> -<span class="sourceLineNo">206</span> * Leading and trailing whitespace (unencoded) will be trimmed from the result.<a name="line.206"></a> +<span class="sourceLineNo">206</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.206"></a> <span class="sourceLineNo">207</span> *<a name="line.207"></a> -<span class="sourceLineNo">208</span> * @param r The reader to read the element text from.<a name="line.208"></a> -<span class="sourceLineNo">209</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.209"></a> -<span class="sourceLineNo">210</span> * @throws XMLStreamException<a name="line.210"></a> -<span class="sourceLineNo">211</span> */<a name="line.211"></a> -<span class="sourceLineNo">212</span> public String getElementText(XMLStreamReader r) throws XMLStreamException {<a name="line.212"></a> -<span class="sourceLineNo">213</span> String s = r.getElementText().trim();<a name="line.213"></a> -<span class="sourceLineNo">214</span> return decodeString(s);<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> * Returns the content of the current CHARACTERS node.<a name="line.218"></a> -<span class="sourceLineNo">219</span> *<a name="line.219"></a> -<span class="sourceLineNo">220</span> * <p><a name="line.220"></a> -<span class="sourceLineNo">221</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.221"></a> +<span class="sourceLineNo">208</span> * <p><a name="line.208"></a> +<span class="sourceLineNo">209</span> * Leading and trailing whitespace (unencoded) will be trimmed from the result.<a name="line.209"></a> +<span class="sourceLineNo">210</span> *<a name="line.210"></a> +<span class="sourceLineNo">211</span> * @param r The reader to read the element text from.<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @throws Exception<a name="line.213"></a> +<span class="sourceLineNo">214</span> */<a name="line.214"></a> +<span class="sourceLineNo">215</span> public String getElementText(XMLStreamReader r) throws Exception {<a name="line.215"></a> +<span class="sourceLineNo">216</span> String s = r.getElementText().trim();<a name="line.216"></a> +<span class="sourceLineNo">217</span> return decodeString(s);<a name="line.217"></a> +<span class="sourceLineNo">218</span> }<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Returns the content of the current CHARACTERS node.<a name="line.221"></a> <span class="sourceLineNo">222</span> *<a name="line.222"></a> <span class="sourceLineNo">223</span> * <p><a name="line.223"></a> -<span class="sourceLineNo">224</span> * Leading and trailing whitespace (unencoded) will be trimmed from the result.<a name="line.224"></a> +<span class="sourceLineNo">224</span> * Any <js>'_x####_'</js> sequences in the string will be decoded.<a name="line.224"></a> <span class="sourceLineNo">225</span> *<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @param r The reader to read the element text from.<a name="line.226"></a> -<span class="sourceLineNo">227</span> * @param trim<a name="line.227"></a> -<span class="sourceLineNo">228</span> * If <jk>true</jk>, trim the contents of the text node BEFORE decoding escape sequences.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * Typically <jk>true</jk> for {@link XmlFormat#MIXED_PWS} and {@link XmlFormat#TEXT_PWS}.<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @throws XMLStreamException<a name="line.231"></a> -<span class="sourceLineNo">232</span> */<a name="line.232"></a> -<span class="sourceLineNo">233</span> public String getText(XMLStreamReader r, boolean trim) throws XMLStreamException {<a name="line.233"></a> -<span class="sourceLineNo">234</span> String s = r.getText();<a name="line.234"></a> -<span class="sourceLineNo">235</span> if (trim)<a name="line.235"></a> -<span class="sourceLineNo">236</span> s = s.trim();<a name="line.236"></a> -<span class="sourceLineNo">237</span> if (s.isEmpty())<a name="line.237"></a> -<span class="sourceLineNo">238</span> return null;<a name="line.238"></a> -<span class="sourceLineNo">239</span> return decodeString(s);<a name="line.239"></a> -<span class="sourceLineNo">240</span> }<a name="line.240"></a> -<span class="sourceLineNo">241</span><a name="line.241"></a> -<span class="sourceLineNo">242</span> /**<a name="line.242"></a> -<span class="sourceLineNo">243</span> * Shortcut for calling <code>getText(r, <jk>true</jk>);</code>.<a name="line.243"></a> -<span class="sourceLineNo">244</span> *<a name="line.244"></a> -<span class="sourceLineNo">245</span> * @param r The reader to read the element text from.<a name="line.245"></a> -<span class="sourceLineNo">246</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.246"></a> -<span class="sourceLineNo">247</span> * @throws XMLStreamException<a name="line.247"></a> -<span class="sourceLineNo">248</span> */<a name="line.248"></a> -<span class="sourceLineNo">249</span> public String getText(XMLStreamReader r) throws XMLStreamException {<a name="line.249"></a> -<span class="sourceLineNo">250</span> return getText(r, true);<a name="line.250"></a> -<span class="sourceLineNo">251</span> }<a name="line.251"></a> -<span class="sourceLineNo">252</span><a name="line.252"></a> -<span class="sourceLineNo">253</span> /**<a name="line.253"></a> -<span class="sourceLineNo">254</span> * Takes the element being read from the XML stream reader and reconstructs it as XML.<a name="line.254"></a> -<span class="sourceLineNo">255</span> *<a name="line.255"></a> -<span class="sourceLineNo">256</span> * <p><a name="line.256"></a> -<span class="sourceLineNo">257</span> * Used when reconstructing bean properties of type {@link XmlFormat#XMLTEXT}.<a name="line.257"></a> +<span class="sourceLineNo">226</span> * <p><a name="line.226"></a> +<span class="sourceLineNo">227</span> * Leading and trailing whitespace (unencoded) will be trimmed from the result.<a name="line.227"></a> +<span class="sourceLineNo">228</span> *<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @param r The reader to read the element text from.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @param trim<a name="line.230"></a> +<span class="sourceLineNo">231</span> * If <jk>true</jk>, trim the contents of the text node BEFORE decoding escape sequences.<a name="line.231"></a> +<span class="sourceLineNo">232</span> * Typically <jk>true</jk> for {@link XmlFormat#MIXED_PWS} and {@link XmlFormat#TEXT_PWS}.<a name="line.232"></a> +<span class="sourceLineNo">233</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.233"></a> +<span class="sourceLineNo">234</span> * @throws XMLStreamException<a name="line.234"></a> +<span class="sourceLineNo">235</span> */<a name="line.235"></a> +<span class="sourceLineNo">236</span> public String getText(XMLStreamReader r, boolean trim) throws XMLStreamException {<a name="line.236"></a> +<span class="sourceLineNo">237</span> String s = r.getText();<a name="line.237"></a> +<span class="sourceLineNo">238</span> if (trim)<a name="line.238"></a> +<span class="sourceLineNo">239</span> s = s.trim();<a name="line.239"></a> +<span class="sourceLineNo">240</span> if (s.isEmpty())<a name="line.240"></a> +<span class="sourceLineNo">241</span> return null;<a name="line.241"></a> +<span class="sourceLineNo">242</span> return decodeString(s);<a name="line.242"></a> +<span class="sourceLineNo">243</span> }<a name="line.243"></a> +<span class="sourceLineNo">244</span><a name="line.244"></a> +<span class="sourceLineNo">245</span> /**<a name="line.245"></a> +<span class="sourceLineNo">246</span> * Shortcut for calling <code>getText(r, <jk>true</jk>);</code>.<a name="line.246"></a> +<span class="sourceLineNo">247</span> *<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @param r The reader to read the element text from.<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @return The decoded text. <jk>null</jk> if the text consists of the sequence <js>'_x0000_'</js>.<a name="line.249"></a> +<span class="sourceLineNo">250</span> * @throws XMLStreamException<a name="line.250"></a> +<span class="sourceLineNo">251</span> */<a name="line.251"></a> +<span class="sourceLineNo">252</span> public String getText(XMLStreamReader r) throws XMLStreamException {<a name="line.252"></a> +<span class="sourceLineNo">253</span> return getText(r, true);<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> /**<a name="line.256"></a> +<span class="sourceLineNo">257</span> * Takes the element being read from the XML stream reader and reconstructs it as XML.<a name="line.257"></a> <span class="sourceLineNo">258</span> *<a name="line.258"></a> -<span class="sourceLineNo">259</span> * @param r The XML stream reader to read the current event from.<a name="line.259"></a> -<span class="sourceLineNo">260</span> * @return The event as XML.<a name="line.260"></a> -<span class="sourceLineNo">261</span> * @throws RuntimeException if the event is not a start or end tag.<a name="line.261"></a> -<span class="sourceLineNo">262</span> */<a name="line.262"></a> -<span class="sourceLineNo">263</span> public final String getElementAsString(XMLStreamReader r) {<a name="line.263"></a> -<span class="sourceLineNo">264</span> int t = r.getEventType();<a name="line.264"></a> -<span class="sourceLineNo">265</span> if (t > 2)<a name="line.265"></a> -<span class="sourceLineNo">266</span> throw new RuntimeException("Invalid event type on stream reader for elementToString() method: " + XmlUtils.toReadableEvent(r));<a name="line.266"></a> -<span class="sourceLineNo">267</span> sb.setLength(0);<a name="line.267"></a> -<span class="sourceLineNo">268</span> sb.append("<").append(t == 1 ? "" : "/").append(r.getLocalName());<a name="line.268"></a> -<span class="sourceLineNo">269</span> if (t == 1)<a name="line.269"></a> -<span class="sourceLineNo">270</span> for (int i = 0; i < r.getAttributeCount(); i++)<a name="line.270"></a> -<span class="sourceLineNo">271</span> sb.append(' ').append(r.getAttributeName(i)).append('=').append('\'').append(r.getAttributeValue(i)).append('\'');<a name="line.271"></a> -<span class="sourceLineNo">272</span> sb.append('>');<a name="line.272"></a> -<span class="sourceLineNo">273</span> return sb.toString();<a name="line.273"></a> -<span class="sourceLineNo">274</span> }<a name="line.274"></a> -<span class="sourceLineNo">275</span><a name="line.275"></a> -<span class="sourceLineNo">276</span> /**<a name="line.276"></a> -<span class="sourceLineNo">277</span> * Parses the current element as text.<a name="line.277"></a> -<span class="sourceLineNo">278</span> *<a name="line.278"></a> -<span class="sourceLineNo">279</span> * <p><a name="line.279"></a> -<span class="sourceLineNo">280</span> * Note that this is different than {@link #getText(XMLStreamReader)} since it assumes that we're pointing to a<a name="line.280"></a> -<span class="sourceLineNo">281</span> * whitespace element.<a name="line.281"></a> -<span class="sourceLineNo">282</span> *<a name="line.282"></a> -<span class="sourceLineNo">283</span> * @param r<a name="line.283"></a> -<span class="sourceLineNo">284</span> * @return The parsed text.<a name="line.284"></a> -<span class="sourceLineNo">285</span> * @throws XMLStreamException<a name="line.285"></a> -<span class="sourceLineNo">286</span> */<a name="line.286"></a> -<span class="sourceLineNo">287</span> public String parseText(XMLStreamReader r) throws XMLStreamException {<a name="line.287"></a> -<span class="sourceLineNo">288</span> StringBuilder sb2 = getStringBuilder();<a name="line.288"></a> -<span class="sourceLineNo">289</span><a name="line.289"></a> -<span class="sourceLineNo">290</span> int depth = 0;<a name="line.290"></a> -<span class="sourceLineNo">291</span> while (true) {<a name="line.291"></a> -<span class="sourceLineNo">292</span> int et = r.getEventType();<a name="line.292"></a> -<span class="sourceLineNo">293</span> if (et == START_ELEMENT) {<a name="line.293"></a> -<span class="sourceLineNo">294</span> sb2.append(getElementAsString(r));<a name="line.294"></a> -<span class="sourceLineNo">295</span> depth++;<a name="line.295"></a> -<span class="sourceLineNo">296</span> } else if (et == CHARACTERS) {<a name="line.296"></a> -<span class="sourceLineNo">297</span> sb2.append(getText(r));<a name="line.297"></a> -<span class="sourceLineNo">298</span> } else if (et == END_ELEMENT) {<a name="line.298"></a> -<span class="sourceLineNo">299</span> sb2.append(getElementAsString(r));<a name="line.299"></a> -<span class="sourceLineNo">300</span> depth--;<a name="line.300"></a> -<span class="sourceLineNo">301</span> if (depth <= 0)<a name="line.301"></a> -<span class="sourceLineNo">302</span> break;<a name="line.302"></a> -<span class="sourceLineNo">303</span> }<a name="line.303"></a> -<span class="sourceLineNo">304</span> et = r.next();<a name="line.304"></a> -<span class="sourceLineNo">305</span> }<a name="line.305"></a> -<span class="sourceLineNo">306</span> String s = sb2.toString();<a name="line.306"></a> -<span class="sourceLineNo">307</span> returnStringBuilder(sb2);<a name="line.307"></a> -<span class="sourceLineNo">308</span> return s;<a name="line.308"></a> -<span class="sourceLineNo">309</span> }<a name="line.309"></a> -<span class="sourceLineNo">310</span><a name="line.310"></a> -<span class="sourceLineNo">311</span> /**<a name="line.311"></a> -<span class="sourceLineNo">312</span> * Returns <jk>true</jk> if the current element is a whitespace element.<a name="line.312"></a> -<span class="sourceLineNo">313</span> *<a name="line.313"></a> -<span class="sourceLineNo">314</span> * <p><a name="line.314"></a> -<span class="sourceLineNo">315</span> * For the XML parser, this always returns <jk>false</jk>.<a name="line.315"></a> -<span class="sourceLineNo">316</span> * However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.<a name="line.316"></a> -<span class="sourceLineNo">317</span> *<a name="line.317"></a> -<span class="sourceLineNo">318</span> * @param r The XML stream reader to read the current event from.<a name="line.318"></a> -<span class="sourceLineNo">319</span> * @return <jk>true</jk> if the current element is a whitespace element.<a name="line.319"></a> -<span class="sourceLineNo">320</span> */<a name="line.320"></a> -<span class="sourceLineNo">321</span> public boolean isWhitespaceElement(XMLStreamReader r) {<a name="line.321"></a> -<span class="sourceLineNo">322</span> return false;<a name="line.322"></a> -<span class="sourceLineNo">323</span> }<a name="line.323"></a> -<span class="sourceLineNo">324</span><a name="line.324"></a> -<span class="sourceLineNo">325</span> /**<a name="line.325"></a> -<span class="sourceLineNo">326</span> * Parses the current whitespace element.<a name="line.326"></a> -<span class="sourceLineNo">327</span> *<a name="line.327"></a> -<span class="sourceLineNo">328</span> * <p><a name="line.328"></a> -<span class="sourceLineNo">329</span> * For the XML parser, this always returns <jk>null</jk> since there is no concept of a whitespace element.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.<a name="line.330"></a> -<span class="sourceLineNo">331</span> *<a name="line.331"></a> -<span class="sourceLineNo">332</span> * @param r The XML stream reader to read the current event from.<a name="line.332"></a> -<span class="sourceLineNo">333</span> * @return The whitespace character or characters.<a name="line.333"></a> -<span class="sourceLineNo">334</span> * @throws XMLStreamException<a name="line.334"></a> -<span class="sourceLineNo">335</span> */<a name="line.335"></a> -<span class="sourceLineNo">336</span> public String parseWhitespaceElement(XMLStreamReader r) throws XMLStreamException {<a name="line.336"></a> -<span class="sourceLineNo">337</span> return null;<a name="line.337"></a> -<span class="sourceLineNo">338</span> }<a name="line.338"></a> -<span class="sourceLineNo">339</span><a name="line.339"></a> -<span class="sourceLineNo">340</span> /**<a name="line.340"></a> -<span class="sourceLineNo">341</span> * Silently closes the XML stream.<a name="line.341"></a> -<span class="sourceLineNo">342</span> */<a name="line.342"></a> -<span class="sourceLineNo">343</span> @Override /* ParserContext */<a name="line.343"></a> -<span class="sourceLineNo">344</span> public boolean close() {<a name="line.344"></a> -<span class="sourceLineNo">345</span> if (super.close()) {<a name="line.345"></a> -<span class="sourceLineNo">346</span> try {<a name="line.346"></a> -<span class="sourceLineNo">347</span> if (xmlStreamReader != null)<a name="line.347"></a> -<span class="sourceLineNo">348</span> xmlStreamReader.close();<a name="line.348"></a> -<span class="sourceLineNo">349</span> } catch (XMLStreamException e) {<a name="line.349"></a> -<span class="sourceLineNo">350</span> // Ignore.<a name="line.350"></a> -<span class="sourceLineNo">351</span> }<a name="line.351"></a> -<span class="sourceLineNo">352</span> return true;<a name="line.352"></a> -<span class="sourceLineNo">353</span> }<a name="line.353"></a> -<span class="sourceLineNo">354</span> return false;<a name="line.354"></a> -<span class="sourceLineNo">355</span> }<a name="line.355"></a> -<span class="sourceLineNo">356</span>}<a name="line.356"></a> +<span class="sourceLineNo">259</span> * <p><a name="line.259"></a> +<span class="sourceLineNo">260</span> * Used when reconstructing bean properties of type {@link XmlFormat#XMLTEXT}.<a name="line.260"></a> +<span class="sourceLineNo">261</span> *<a name="line.261"></a> +<span class="sourceLineNo">262</span> * @param r The XML stream reader to read the current event from.<a name="line.262"></a> +<span class="sourceLineNo">263</span> * @return The event as XML.<a name="line.263"></a> +<span class="sourceLineNo">264</span> * @throws RuntimeException if the event is not a start or end tag.<a name="line.264"></a> +<span class="sourceLineNo">265</span> */<a name="line.265"></a> +<span class="sourceLineNo">266</span> public final String getElementAsString(XMLStreamReader r) {<a name="line.266"></a> +<span class="sourceLineNo">267</span> int t = r.getEventType();<a name="line.267"></a> +<span class="sourceLineNo">268</span> if (t > 2)<a name="line.268"></a> +<span class="sourceLineNo">269</span> throw new FormattedRuntimeException("Invalid event type on stream reader for elementToString() method: ''{0}''", XmlUtils.toReadableEvent(r));<a name="line.269"></a> +<span class="sourceLineNo">270</span> sb.setLength(0);<a name="line.270"></a> +<span class="sourceLineNo">271</span> sb.append("<").append(t == 1 ? "" : "/").append(r.getLocalName());<a name="line.271"></a> +<span class="sourceLineNo">272</span> if (t == 1)<a name="line.272"></a> +<span class="sourceLineNo">273</span> for (int i = 0; i < r.getAttributeCount(); i++)<a name="line.273"></a> +<span class="sourceLineNo">274</span> sb.append(' ').append(r.getAttributeName(i)).append('=').append('\'').append(r.getAttributeValue(i)).append('\'');<a name="line.274"></a> +<span class="sourceLineNo">275</span> sb.append('>');<a name="line.275"></a> +<span class="sourceLineNo">276</span> return sb.toString();<a name="line.276"></a> +<span class="sourceLineNo">277</span> }<a name="line.277"></a> +<span class="sourceLineNo">278</span><a name="line.278"></a> +<span class="sourceLineNo">279</span> /**<a name="line.279"></a> +<span class="sourceLineNo">280</span> * Parses the current element as text.<a name="line.280"></a> +<span class="sourceLineNo">281</span> *<a name="line.281"></a> +<span class="sourceLineNo">282</span> * <p><a name="line.282"></a> +<span class="sourceLineNo">283</span> * Note that this is different than {@link #getText(XMLStreamReader)} since it assumes that we're pointing to a<a name="line.283"></a> +<span class="sourceLineNo">284</span> * whitespace element.<a name="line.284"></a> +<span class="sourceLineNo">285</span> *<a name="line.285"></a> +<span class="sourceLineNo">286</span> * @param r<a name="line.286"></a> +<span class="sourceLineNo">287</span> * @return The parsed text.<a name="line.287"></a> +<span class="sourceLineNo">288</span> * @throws Exception<a name="line.288"></a> +<span class="sourceLineNo">289</span> */<a name="line.289"></a> +<span class="sourceLineNo">290</span> public String parseText(XMLStreamReader r) throws Exception {<a name="line.290"></a> +<span class="sourceLineNo">291</span> StringBuilder sb2 = getStringBuilder();<a name="line.291"></a> +<span class="sourceLineNo">292</span><a name="line.292"></a> +<span class="sourceLineNo">293</span> int depth = 0;<a name="line.293"></a> +<span class="sourceLineNo">294</span> while (true) {<a name="line.294"></a> +<span class="sourceLineNo">295</span> int et = r.getEventType();<a name="line.295"></a> +<span class="sourceLineNo">296</span> if (et == START_ELEMENT) {<a name="line.296"></a> +<span class="sourceLineNo">297</span> sb2.append(getElementAsString(r));<a name="line.297"></a> +<span class="sourceLineNo">298</span> depth++;<a name="line.298"></a> +<span class="sourceLineNo">299</span> } else if (et == CHARACTERS) {<a name="line.299"></a> +<span class="sourceLineNo">300</span> sb2.append(getText(r));<a name="line.300"></a> +<span class="sourceLineNo">301</span> } else if (et == END_ELEMENT) {<a name="line.301"></a> +<span class="sourceLineNo">302</span> sb2.append(getElementAsString(r));<a name="line.302"></a> +<span class="sourceLineNo">303</span> depth--;<a name="line.303"></a> +<span class="sourceLineNo">304</span> if (depth <= 0)<a name="line.304"></a> +<span class="sourceLineNo">305</span> break;<a name="line.305"></a> +<span class="sourceLineNo">306</span> }<a name="line.306"></a> +<span class="sourceLineNo">307</span> et = r.next();<a name="line.307"></a> +<span class="sourceLineNo">308</span> }<a name="line.308"></a> +<span class="sourceLineNo">309</span> String s = sb2.toString();<a name="line.309"></a> +<span class="sourceLineNo">310</span> returnStringBuilder(sb2);<a name="line.310"></a> +<span class="sourceLineNo">311</span> return s;<a name="line.311"></a> +<span class="sourceLineNo">312</span> }<a name="line.312"></a> +<span class="sourceLineNo">313</span><a name="line.313"></a> +<span class="sourceLineNo">314</span> /**<a name="line.314"></a> +<span class="sourceLineNo">315</span> * Returns <jk>true</jk> if the current element is a whitespace element.<a name="line.315"></a> +<span class="sourceLineNo">316</span> *<a name="line.316"></a> +<span class="sourceLineNo">317</span> * <p><a name="line.317"></a> +<span class="sourceLineNo">318</span> * For the XML parser, this always returns <jk>false</jk>.<a name="line.318"></a> +<span class="sourceLineNo">319</span> * However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.<a name="line.319"></a> +<span class="sourceLineNo">320</span> *<a name="line.320"></a> +<span class="sourceLineNo">321</span> * @param r The XML stream reader to read the current event from.<a name="line.321"></a> +<span class="sourceLineNo">322</span> * @return <jk>true</jk> if the current element is a whitespace element.<a name="line.322"></a> +<span class="sourceLineNo">323</span> */<a name="line.323"></a> +<span class="sourceLineNo">324</span> public boolean isWhitespaceElement(XMLStreamReader r) {<a name="line.324"></a> +<span class="sourceLineNo">325</span> return false;<a name="line.325"></a> +<span class="sourceLineNo">326</span> }<a name="line.326"></a> +<span class="sourceLineNo">327</span><a name="line.327"></a> +<span class="sourceLineNo">328</span> /**<a name="line.328"></a> +<span class="sourceLineNo">329</span> * Parses the current whitespace element.<a name="line.329"></a> +<span class="sourceLineNo">330</span> *<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> * For the XML parser, this always returns <jk>null</jk> since there is no concept of a whitespace element.<a name="line.332"></a> +<span class="sourceLineNo">333</span> * However, the HTML parser defines various whitespace elements such as <js>"br"</js> and <js>"sp"</js>.<a name="line.333"></a> +<span class="sourceLineNo">334</span> *<a name="line.334"></a> +<span class="sourceLineNo">335</span> * @param r The XML stream reader to read the current event from.<a name="line.335"></a> +<span class="sourceLineNo">336</span> * @return The whitespace character or characters.<a name="line.336"></a> +<span class="sourceLineNo">337</span> * @throws XMLStreamException<a name="line.337"></a> +<span class="sourceLineNo">338</span> * @throws Exception<a name="line.338"></a> +<span class="sourceLineNo">339</span> */<a name="line.339"></a> +<span class="sourceLineNo">340</span> public String parseWhitespaceElement(XMLStreamReader r) throws Exception {<a name="line.340"></a> +<span class="sourceLineNo">341</span> return null;<a name="line.341"></a> +<span class="sourceLineNo">342</span> }<a name="line.342"></a> +<span class="sourceLineNo">343</span><a name="line.343"></a> +<span class="sourceLineNo">344</span> /**<a name="line.344"></a> +<span class="sourceLineNo">345</span> * Silently closes the XML stream.<a name="line.345"></a> +<span class="sourceLineNo">346</span> */<a name="line.346"></a> +<span class="sourceLineNo">347</span> @Override /* ParserContext */<a name="line.347"></a> +<span class="sourceLineNo">348</span> public boolean close() {<a name="line.348"></a> +<span class="sourceLineNo">349</span> if (super.close()) {<a name="line.349"></a> +<span class="sourceLineNo">350</span> try {<a name="line.350"></a> +<span class="sourceLineNo">351</span> if (xmlStreamReader != null)<a name="line.351"></a> +<span class="sourceLineNo">352</span> xmlStreamReader.close();<a name="line.352"></a> +<span class="sourceLineNo">353</span> } catch (XMLStreamException e) {<a name="line.353"></a> +<span class="sourceLineNo">354</span> // Ignore.<a name="line.354"></a> +<span class="sourceLineNo">355</span> }<a name="line.355"></a> +<span class="sourceLineNo">356</span> return true;<a name="line.356"></a> +<span class="sourceLineNo">357</span> }<a name="line.357"></a> +<span class="sourceLineNo">358</span> return false;<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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/d35b70d1/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSchemaSerializer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSchemaSerializer.html b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSchemaSerializer.html index c3e3ad1..f78b903 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSchemaSerializer.html +++ b/content/site/apidocs/src-html/org/apache/juneau/xml/XmlSchemaSerializer.html @@ -199,7 +199,7 @@ <span class="sourceLineNo">191</span> ns = defaultNs;<a name="line.191"></a> <span class="sourceLineNo">192</span> Schema s = get(ns);<a name="line.192"></a> <span class="sourceLineNo">193</span> if (s == null)<a name="line.193"></a> -<span class="sourceLineNo">194</span> throw new RuntimeException("No schema defined for namespace '"+ns+"'");<a name="line.194"></a> +<span class="sourceLineNo">194</span> throw new FormattedRuntimeException("No schema defined for namespace ''{0}''", ns);<a name="line.194"></a> <span class="sourceLineNo">195</span> return s;<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>
