| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a> |
| <FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a> |
| <FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a> |
| <FONT color="green">017</FONT> */<a name="line.17"></a> |
| <FONT color="green">018</FONT> /*<a name="line.18"></a> |
| <FONT color="green">019</FONT> * $Id: Serializer.java 471981 2006-11-07 04:28:00Z minchau $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xml.serializer;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.io.IOException;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.io.OutputStream;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.io.Writer;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.util.Properties;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.xml.sax.ContentHandler;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> /**<a name="line.29"></a> |
| <FONT color="green">030</FONT> * The Serializer interface is implemented by a serializer to enable users to:<a name="line.30"></a> |
| <FONT color="green">031</FONT> * <ul><a name="line.31"></a> |
| <FONT color="green">032</FONT> * <li>get and set streams or writers<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <li>configure the serializer with key/value properties<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <li>get an org.xml.sax.ContentHandler or a DOMSerializer to provide input to<a name="line.34"></a> |
| <FONT color="green">035</FONT> * </ul><a name="line.35"></a> |
| <FONT color="green">036</FONT> *<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p><a name="line.37"></a> |
| <FONT color="green">038</FONT> * Here is an example using the asContentHandler() method:<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <pre><a name="line.39"></a> |
| <FONT color="green">040</FONT> * java.util.Properties props = <a name="line.40"></a> |
| <FONT color="green">041</FONT> * OutputPropertiesFactory.getDefaultMethodProperties(Method.TEXT);<a name="line.41"></a> |
| <FONT color="green">042</FONT> * Serializer ser = SerializerFactory.getSerializer(props);<a name="line.42"></a> |
| <FONT color="green">043</FONT> * java.io.PrintStream ostream = System.out; <a name="line.43"></a> |
| <FONT color="green">044</FONT> * ser.setOutputStream(ostream);<a name="line.44"></a> |
| <FONT color="green">045</FONT> * <a name="line.45"></a> |
| <FONT color="green">046</FONT> * // Provide the SAX input events<a name="line.46"></a> |
| <FONT color="green">047</FONT> * ContentHandler handler = ser.asContentHandler();<a name="line.47"></a> |
| <FONT color="green">048</FONT> * handler.startDocument();<a name="line.48"></a> |
| <FONT color="green">049</FONT> * char[] chars = { 'a', 'b', 'c' };<a name="line.49"></a> |
| <FONT color="green">050</FONT> * handler.characters(chars, 0, chars.length);<a name="line.50"></a> |
| <FONT color="green">051</FONT> * handler.endDocument();<a name="line.51"></a> |
| <FONT color="green">052</FONT> * <a name="line.52"></a> |
| <FONT color="green">053</FONT> * ser.reset(); // get ready to use the serializer for another document<a name="line.53"></a> |
| <FONT color="green">054</FONT> * // of the same output method (TEXT).<a name="line.54"></a> |
| <FONT color="green">055</FONT> * </pre><a name="line.55"></a> |
| <FONT color="green">056</FONT> * <a name="line.56"></a> |
| <FONT color="green">057</FONT> * <p><a name="line.57"></a> |
| <FONT color="green">058</FONT> * As an alternate to supplying a series of SAX events as input through the <a name="line.58"></a> |
| <FONT color="green">059</FONT> * ContentHandler interface, the input to serialize may be given as a DOM. <a name="line.59"></a> |
| <FONT color="green">060</FONT> * <p><a name="line.60"></a> |
| <FONT color="green">061</FONT> * For example:<a name="line.61"></a> |
| <FONT color="green">062</FONT> * <pre><a name="line.62"></a> |
| <FONT color="green">063</FONT> * org.w3c.dom.Document inputDoc;<a name="line.63"></a> |
| <FONT color="green">064</FONT> * org.apache.xml.serializer.Serializer ser;<a name="line.64"></a> |
| <FONT color="green">065</FONT> * java.io.Writer owriter;<a name="line.65"></a> |
| <FONT color="green">066</FONT> * <a name="line.66"></a> |
| <FONT color="green">067</FONT> * java.util.Properties props = <a name="line.67"></a> |
| <FONT color="green">068</FONT> * OutputPropertiesFactory.getDefaultMethodProperties(Method.XML);<a name="line.68"></a> |
| <FONT color="green">069</FONT> * Serializer ser = SerializerFactory.getSerializer(props);<a name="line.69"></a> |
| <FONT color="green">070</FONT> * owriter = ...; // create a writer to serialize the document to<a name="line.70"></a> |
| <FONT color="green">071</FONT> * ser.setWriter( owriter );<a name="line.71"></a> |
| <FONT color="green">072</FONT> * <a name="line.72"></a> |
| <FONT color="green">073</FONT> * inputDoc = ...; // create the DOM document to be serialized<a name="line.73"></a> |
| <FONT color="green">074</FONT> * DOMSerializer dser = ser.asDOMSerializer(); // a DOM will be serialized<a name="line.74"></a> |
| <FONT color="green">075</FONT> * dser.serialize(inputDoc); // serialize the DOM, sending output to owriter<a name="line.75"></a> |
| <FONT color="green">076</FONT> * <a name="line.76"></a> |
| <FONT color="green">077</FONT> * ser.reset(); // get ready to use the serializer for another document<a name="line.77"></a> |
| <FONT color="green">078</FONT> * // of the same output method.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * </pre><a name="line.79"></a> |
| <FONT color="green">080</FONT> * <a name="line.80"></a> |
| <FONT color="green">081</FONT> * This interface is a public API.<a name="line.81"></a> |
| <FONT color="green">082</FONT> * <a name="line.82"></a> |
| <FONT color="green">083</FONT> * @see Method<a name="line.83"></a> |
| <FONT color="green">084</FONT> * @see OutputPropertiesFactory<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @see SerializerFactory<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @see DOMSerializer<a name="line.86"></a> |
| <FONT color="green">087</FONT> * @see ContentHandler<a name="line.87"></a> |
| <FONT color="green">088</FONT> * <a name="line.88"></a> |
| <FONT color="green">089</FONT> * @xsl.usage general<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> public interface Serializer {<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> /**<a name="line.93"></a> |
| <FONT color="green">094</FONT> * Specifies an output stream to which the document should be<a name="line.94"></a> |
| <FONT color="green">095</FONT> * serialized. This method should not be called while the<a name="line.95"></a> |
| <FONT color="green">096</FONT> * serializer is in the process of serializing a document.<a name="line.96"></a> |
| <FONT color="green">097</FONT> * <p><a name="line.97"></a> |
| <FONT color="green">098</FONT> * The encoding specified in the output {@link Properties} is used, or<a name="line.98"></a> |
| <FONT color="green">099</FONT> * if no encoding was specified, the default for the selected<a name="line.99"></a> |
| <FONT color="green">100</FONT> * output method.<a name="line.100"></a> |
| <FONT color="green">101</FONT> * <p><a name="line.101"></a> |
| <FONT color="green">102</FONT> * Only one of setWriter() or setOutputStream() should be called.<a name="line.102"></a> |
| <FONT color="green">103</FONT> *<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @param output The output stream<a name="line.104"></a> |
| <FONT color="green">105</FONT> */<a name="line.105"></a> |
| <FONT color="green">106</FONT> public void setOutputStream(OutputStream output);<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> /**<a name="line.108"></a> |
| <FONT color="green">109</FONT> * Get the output stream where the events will be serialized to.<a name="line.109"></a> |
| <FONT color="green">110</FONT> *<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @return reference to the result stream, or null if only a writer was<a name="line.111"></a> |
| <FONT color="green">112</FONT> * set.<a name="line.112"></a> |
| <FONT color="green">113</FONT> */<a name="line.113"></a> |
| <FONT color="green">114</FONT> public OutputStream getOutputStream();<a name="line.114"></a> |
| <FONT color="green">115</FONT> <a name="line.115"></a> |
| <FONT color="green">116</FONT> /**<a name="line.116"></a> |
| <FONT color="green">117</FONT> * Specifies a writer to which the document should be serialized.<a name="line.117"></a> |
| <FONT color="green">118</FONT> * This method should not be called while the serializer is in<a name="line.118"></a> |
| <FONT color="green">119</FONT> * the process of serializing a document.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <p><a name="line.120"></a> |
| <FONT color="green">121</FONT> * The encoding specified for the output {@link Properties} must be<a name="line.121"></a> |
| <FONT color="green">122</FONT> * identical to the output format used with the writer.<a name="line.122"></a> |
| <FONT color="green">123</FONT> * <a name="line.123"></a> |
| <FONT color="green">124</FONT> * <p><a name="line.124"></a> |
| <FONT color="green">125</FONT> * Only one of setWriter() or setOutputStream() should be called.<a name="line.125"></a> |
| <FONT color="green">126</FONT> *<a name="line.126"></a> |
| <FONT color="green">127</FONT> * @param writer The output writer stream<a name="line.127"></a> |
| <FONT color="green">128</FONT> */<a name="line.128"></a> |
| <FONT color="green">129</FONT> public void setWriter(Writer writer);<a name="line.129"></a> |
| <FONT color="green">130</FONT> <a name="line.130"></a> |
| <FONT color="green">131</FONT> /**<a name="line.131"></a> |
| <FONT color="green">132</FONT> * Get the character stream where the events will be serialized to.<a name="line.132"></a> |
| <FONT color="green">133</FONT> *<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @return Reference to the result Writer, or null.<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> public Writer getWriter();<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> /**<a name="line.138"></a> |
| <FONT color="green">139</FONT> * Specifies an output format for this serializer. It the<a name="line.139"></a> |
| <FONT color="green">140</FONT> * serializer has already been associated with an output format,<a name="line.140"></a> |
| <FONT color="green">141</FONT> * it will switch to the new format. This method should not be<a name="line.141"></a> |
| <FONT color="green">142</FONT> * called while the serializer is in the process of serializing<a name="line.142"></a> |
| <FONT color="green">143</FONT> * a document.<a name="line.143"></a> |
| <FONT color="green">144</FONT> * <p><a name="line.144"></a> |
| <FONT color="green">145</FONT> * The standard property keys supported are: "method", "version", "encoding",<a name="line.145"></a> |
| <FONT color="green">146</FONT> * "omit-xml-declaration", "standalone", doctype-public",<a name="line.146"></a> |
| <FONT color="green">147</FONT> * "doctype-system", "cdata-section-elements", "indent", "media-type". <a name="line.147"></a> |
| <FONT color="green">148</FONT> * These property keys and their values are described in the XSLT recommendation,<a name="line.148"></a> |
| <FONT color="green">149</FONT> * see {@link <a href="http://www.w3.org/TR/1999/REC-xslt-19991116"> XSLT 1.0 recommendation</a>}<a name="line.149"></a> |
| <FONT color="green">150</FONT> * <p><a name="line.150"></a> |
| <FONT color="green">151</FONT> * The non-standard property keys supported are defined in {@link OutputPropertiesFactory}.<a name="line.151"></a> |
| <FONT color="green">152</FONT> *<a name="line.152"></a> |
| <FONT color="green">153</FONT> * <p><a name="line.153"></a> |
| <FONT color="green">154</FONT> * This method can be called multiple times before a document is serialized. Each <a name="line.154"></a> |
| <FONT color="green">155</FONT> * time it is called more, or over-riding property values, can be specified. One <a name="line.155"></a> |
| <FONT color="green">156</FONT> * property value that can not be changed is that of the "method" property key.<a name="line.156"></a> |
| <FONT color="green">157</FONT> * <p><a name="line.157"></a> |
| <FONT color="green">158</FONT> * The value of the "cdata-section-elements" property key is a whitespace<a name="line.158"></a> |
| <FONT color="green">159</FONT> * separated list of elements. If the element is in a namespace then <a name="line.159"></a> |
| <FONT color="green">160</FONT> * value is passed in this format: {uri}localName <a name="line.160"></a> |
| <FONT color="green">161</FONT> * <p><a name="line.161"></a> |
| <FONT color="green">162</FONT> * If the "cdata-section-elements" key is specified on multiple calls<a name="line.162"></a> |
| <FONT color="green">163</FONT> * to this method the set of elements specified in the value<a name="line.163"></a> |
| <FONT color="green">164</FONT> * is not replaced from one call to the<a name="line.164"></a> |
| <FONT color="green">165</FONT> * next, but it is cumulative across the calls.<a name="line.165"></a> |
| <FONT color="green">166</FONT> *<a name="line.166"></a> |
| <FONT color="green">167</FONT> * @param format The output format to use, as a set of key/value pairs.<a name="line.167"></a> |
| <FONT color="green">168</FONT> */<a name="line.168"></a> |
| <FONT color="green">169</FONT> public void setOutputFormat(Properties format);<a name="line.169"></a> |
| <FONT color="green">170</FONT> <a name="line.170"></a> |
| <FONT color="green">171</FONT> /**<a name="line.171"></a> |
| <FONT color="green">172</FONT> * Returns the output format properties for this serializer.<a name="line.172"></a> |
| <FONT color="green">173</FONT> *<a name="line.173"></a> |
| <FONT color="green">174</FONT> * @return The output format key/value pairs in use.<a name="line.174"></a> |
| <FONT color="green">175</FONT> */<a name="line.175"></a> |
| <FONT color="green">176</FONT> public Properties getOutputFormat();<a name="line.176"></a> |
| <FONT color="green">177</FONT> <a name="line.177"></a> |
| <FONT color="green">178</FONT> /**<a name="line.178"></a> |
| <FONT color="green">179</FONT> * Return a {@link ContentHandler} interface to provide SAX input to.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * Through the returned object the document to be serailized,<a name="line.180"></a> |
| <FONT color="green">181</FONT> * as a series of SAX events, can be provided to the serialzier.<a name="line.181"></a> |
| <FONT color="green">182</FONT> * If the serializer does not support the {@link ContentHandler}<a name="line.182"></a> |
| <FONT color="green">183</FONT> * interface, it will return null.<a name="line.183"></a> |
| <FONT color="green">184</FONT> * <p><a name="line.184"></a> |
| <FONT color="green">185</FONT> * In principle only one of asDOMSerializer() or asContentHander() <a name="line.185"></a> |
| <FONT color="green">186</FONT> * should be called.<a name="line.186"></a> |
| <FONT color="green">187</FONT> *<a name="line.187"></a> |
| <FONT color="green">188</FONT> * @return A {@link ContentHandler} interface into this serializer,<a name="line.188"></a> |
| <FONT color="green">189</FONT> * or null if the serializer is not SAX 2 capable<a name="line.189"></a> |
| <FONT color="green">190</FONT> * @throws IOException An I/O exception occured<a name="line.190"></a> |
| <FONT color="green">191</FONT> */<a name="line.191"></a> |
| <FONT color="green">192</FONT> public ContentHandler asContentHandler() throws IOException;<a name="line.192"></a> |
| <FONT color="green">193</FONT> <a name="line.193"></a> |
| <FONT color="green">194</FONT> /**<a name="line.194"></a> |
| <FONT color="green">195</FONT> * Return a {@link DOMSerializer} interface into this serializer.<a name="line.195"></a> |
| <FONT color="green">196</FONT> * Through the returned object the document to be serialized,<a name="line.196"></a> |
| <FONT color="green">197</FONT> * a DOM, can be provided to the serializer.<a name="line.197"></a> |
| <FONT color="green">198</FONT> * If the serializer does not support the {@link DOMSerializer}<a name="line.198"></a> |
| <FONT color="green">199</FONT> * interface, it should return null.<a name="line.199"></a> |
| <FONT color="green">200</FONT> * <p><a name="line.200"></a> |
| <FONT color="green">201</FONT> * In principle only one of asDOMSerializer() or asContentHander() <a name="line.201"></a> |
| <FONT color="green">202</FONT> * should be called.<a name="line.202"></a> |
| <FONT color="green">203</FONT> *<a name="line.203"></a> |
| <FONT color="green">204</FONT> * @return A {@link DOMSerializer} interface into this serializer,<a name="line.204"></a> |
| <FONT color="green">205</FONT> * or null if the serializer is not DOM capable<a name="line.205"></a> |
| <FONT color="green">206</FONT> * @throws IOException An I/O exception occured<a name="line.206"></a> |
| <FONT color="green">207</FONT> */<a name="line.207"></a> |
| <FONT color="green">208</FONT> public DOMSerializer asDOMSerializer() throws IOException;<a name="line.208"></a> |
| <FONT color="green">209</FONT> <a name="line.209"></a> |
| <FONT color="green">210</FONT> /**<a name="line.210"></a> |
| <FONT color="green">211</FONT> * This method resets the serializer. <a name="line.211"></a> |
| <FONT color="green">212</FONT> * If this method returns true, the<a name="line.212"></a> |
| <FONT color="green">213</FONT> * serializer may be used for subsequent serialization of new<a name="line.213"></a> |
| <FONT color="green">214</FONT> * documents. It is possible to change the output format and<a name="line.214"></a> |
| <FONT color="green">215</FONT> * output stream prior to serializing, or to reuse the existing<a name="line.215"></a> |
| <FONT color="green">216</FONT> * output format and output stream or writer.<a name="line.216"></a> |
| <FONT color="green">217</FONT> *<a name="line.217"></a> |
| <FONT color="green">218</FONT> * @return True if serializer has been reset and can be reused<a name="line.218"></a> |
| <FONT color="green">219</FONT> */<a name="line.219"></a> |
| <FONT color="green">220</FONT> public boolean reset();<a name="line.220"></a> |
| <FONT color="green">221</FONT> <a name="line.221"></a> |
| <FONT color="green">222</FONT> /**<a name="line.222"></a> |
| <FONT color="green">223</FONT> * Return an Object into this serializer to be cast to a DOM3Serializer.<a name="line.223"></a> |
| <FONT color="green">224</FONT> * Through the returned object the document to be serialized,<a name="line.224"></a> |
| <FONT color="green">225</FONT> * a DOM (Level 3), can be provided to the serializer.<a name="line.225"></a> |
| <FONT color="green">226</FONT> * If the serializer does not support casting to a {@link DOM3Serializer}<a name="line.226"></a> |
| <FONT color="green">227</FONT> * interface, it should return null.<a name="line.227"></a> |
| <FONT color="green">228</FONT> * <p><a name="line.228"></a> |
| <FONT color="green">229</FONT> * In principle only one of asDOM3Serializer() or asContentHander() <a name="line.229"></a> |
| <FONT color="green">230</FONT> * should be called.<a name="line.230"></a> |
| <FONT color="green">231</FONT> *<a name="line.231"></a> |
| <FONT color="green">232</FONT> * @return An Object to be cast to a DOM3Serializer interface into this serializer,<a name="line.232"></a> |
| <FONT color="green">233</FONT> * or null if the serializer is not DOM capable<a name="line.233"></a> |
| <FONT color="green">234</FONT> * @throws IOException An I/O exception occured<a name="line.234"></a> |
| <FONT color="green">235</FONT> */<a name="line.235"></a> |
| <FONT color="green">236</FONT> public Object asDOM3Serializer() throws IOException;<a name="line.236"></a> |
| <FONT color="green">237</FONT> }<a name="line.237"></a> |
| <FONT color="green">238</FONT> <a name="line.238"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
