| <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: DOM3Serializer.java 1225426 2011-12-29 04:13:08Z mrglavas $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> <a name="line.21"></a> |
| <FONT color="green">022</FONT> package org.apache.xml.serializer;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.io.IOException;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.w3c.dom.DOMErrorHandler;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.w3c.dom.Node;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.w3c.dom.ls.LSSerializerFilter;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * This interface is not intended to be used<a name="line.31"></a> |
| <FONT color="green">032</FONT> * by an end user, but rather by an XML parser that is implementing the DOM <a name="line.32"></a> |
| <FONT color="green">033</FONT> * Level 3 Load and Save APIs.<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p><a name="line.34"></a> |
| <FONT color="green">035</FONT> * <a name="line.35"></a> |
| <FONT color="green">036</FONT> * See the DOM Level 3 Load and Save interface at <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407/load-save.html#LS-LSSerializer">LSSeializer</a>.<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <a name="line.37"></a> |
| <FONT color="green">038</FONT> * For a list of configuration parameters for DOM Level 3 see <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#DOMConfiguration">DOMConfiguration</a>.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * For additional configuration parameters available with the DOM Level 3 Load and Save API LSSerializer see<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407/load-save.html#LS-LSSerializer-config">LSerializer config</a>.<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <p><a name="line.41"></a> |
| <FONT color="green">042</FONT> * The following example uses a DOM3Serializer indirectly, through an an XML<a name="line.42"></a> |
| <FONT color="green">043</FONT> * parser that uses this class as part of its implementation of the DOM Level 3<a name="line.43"></a> |
| <FONT color="green">044</FONT> * Load and Save APIs, and is the prefered way to serialize with DOM Level 3 APIs.<a name="line.44"></a> |
| <FONT color="green">045</FONT> * <p><a name="line.45"></a> |
| <FONT color="green">046</FONT> * Example:<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <pre><a name="line.47"></a> |
| <FONT color="green">048</FONT> * public class TestDOM3 {<a name="line.48"></a> |
| <FONT color="green">049</FONT> *<a name="line.49"></a> |
| <FONT color="green">050</FONT> * public static void main(String args[]) throws Exception {<a name="line.50"></a> |
| <FONT color="green">051</FONT> * // Get document to serialize<a name="line.51"></a> |
| <FONT color="green">052</FONT> * TestDOM3 test = new TestDOM3();<a name="line.52"></a> |
| <FONT color="green">053</FONT> * <a name="line.53"></a> |
| <FONT color="green">054</FONT> * // Serialize using standard DOM Level 3 Load/Save APIs <a name="line.54"></a> |
| <FONT color="green">055</FONT> * System.out.println(test.testDOM3LS());<a name="line.55"></a> |
| <FONT color="green">056</FONT> * }<a name="line.56"></a> |
| <FONT color="green">057</FONT> *<a name="line.57"></a> |
| <FONT color="green">058</FONT> * public org.w3c.dom.Document getDocument() throws Exception {<a name="line.58"></a> |
| <FONT color="green">059</FONT> * // Create a simple DOM Document.<a name="line.59"></a> |
| <FONT color="green">060</FONT> * javax.xml.parsers.DocumentBuilderFactory factory = <a name="line.60"></a> |
| <FONT color="green">061</FONT> * javax.xml.parsers.DocumentBuilderFactory.newInstance();<a name="line.61"></a> |
| <FONT color="green">062</FONT> * javax.xml.parsers.DocumentBuilder builder = factory.newDocumentBuilder();<a name="line.62"></a> |
| <FONT color="green">063</FONT> * byte[] bytes = "<parent><child/></parent>".getBytes();<a name="line.63"></a> |
| <FONT color="green">064</FONT> * java.io.InputStream is = new java.io.ByteArrayInputStream(bytes);<a name="line.64"></a> |
| <FONT color="green">065</FONT> * org.w3c.dom.Document doc = builder.parse(is);<a name="line.65"></a> |
| <FONT color="green">066</FONT> * return doc;<a name="line.66"></a> |
| <FONT color="green">067</FONT> * }<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <a name="line.68"></a> |
| <FONT color="green">069</FONT> * //<a name="line.69"></a> |
| <FONT color="green">070</FONT> * // This method uses standard DOM Level 3 Load Save APIs:<a name="line.70"></a> |
| <FONT color="green">071</FONT> * // org.w3c.dom.bootstrap.DOMImplementationRegistry<a name="line.71"></a> |
| <FONT color="green">072</FONT> * // org.w3c.dom.ls.DOMImplementationLS<a name="line.72"></a> |
| <FONT color="green">073</FONT> * // org.w3c.dom.ls.DOMImplementationLS<a name="line.73"></a> |
| <FONT color="green">074</FONT> * // org.w3c.dom.ls.LSSerializer<a name="line.74"></a> |
| <FONT color="green">075</FONT> * // org.w3c.dom.DOMConfiguration<a name="line.75"></a> |
| <FONT color="green">076</FONT> * // <a name="line.76"></a> |
| <FONT color="green">077</FONT> * // The only thing non-standard in this method is the value set for the<a name="line.77"></a> |
| <FONT color="green">078</FONT> * // name of the class implementing the DOM Level 3 Load Save APIs,<a name="line.78"></a> |
| <FONT color="green">079</FONT> * // which in this case is:<a name="line.79"></a> |
| <FONT color="green">080</FONT> * // org.apache.xerces.dom.DOMImplementationSourceImpl<a name="line.80"></a> |
| <FONT color="green">081</FONT> * //<a name="line.81"></a> |
| <FONT color="green">082</FONT> *<a name="line.82"></a> |
| <FONT color="green">083</FONT> * public String testDOM3LS() throws Exception {<a name="line.83"></a> |
| <FONT color="green">084</FONT> * <a name="line.84"></a> |
| <FONT color="green">085</FONT> * // Get a simple DOM Document that will be serialized.<a name="line.85"></a> |
| <FONT color="green">086</FONT> * org.w3c.dom.Document docToSerialize = getDocument();<a name="line.86"></a> |
| <FONT color="green">087</FONT> *<a name="line.87"></a> |
| <FONT color="green">088</FONT> * // Get a factory (DOMImplementationLS) for creating a Load and Save object.<a name="line.88"></a> |
| <FONT color="green">089</FONT> * org.w3c.dom.ls.DOMImplementationLS impl = <a name="line.89"></a> |
| <FONT color="green">090</FONT> * (org.w3c.dom.ls.DOMImplementationLS) <a name="line.90"></a> |
| <FONT color="green">091</FONT> * org.w3c.dom.bootstrap.DOMImplementationRegistry.newInstance().getDOMImplementation("LS");<a name="line.91"></a> |
| <FONT color="green">092</FONT> *<a name="line.92"></a> |
| <FONT color="green">093</FONT> * // Use the factory to create an object (LSSerializer) used to <a name="line.93"></a> |
| <FONT color="green">094</FONT> * // write out or save the document.<a name="line.94"></a> |
| <FONT color="green">095</FONT> * org.w3c.dom.ls.LSSerializer writer = impl.createLSSerializer();<a name="line.95"></a> |
| <FONT color="green">096</FONT> * org.w3c.dom.DOMConfiguration config = writer.getDomConfig();<a name="line.96"></a> |
| <FONT color="green">097</FONT> * config.setParameter("format-pretty-print", Boolean.TRUE);<a name="line.97"></a> |
| <FONT color="green">098</FONT> * <a name="line.98"></a> |
| <FONT color="green">099</FONT> * // Use the LSSerializer to write out or serialize the document to a String.<a name="line.99"></a> |
| <FONT color="green">100</FONT> * String serializedXML = writer.writeToString(docToSerialize);<a name="line.100"></a> |
| <FONT color="green">101</FONT> * return serializedXML;<a name="line.101"></a> |
| <FONT color="green">102</FONT> * }<a name="line.102"></a> |
| <FONT color="green">103</FONT> * <a name="line.103"></a> |
| <FONT color="green">104</FONT> * } // end of class TestDOM3<a name="line.104"></a> |
| <FONT color="green">105</FONT> * </pre><a name="line.105"></a> |
| <FONT color="green">106</FONT> * <a name="line.106"></a> |
| <FONT color="green">107</FONT> * @see <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#DOMConfiguration">DOMConfiguration</a><a name="line.107"></a> |
| <FONT color="green">108</FONT> * @see <a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407/load-save.html#LS-LSSerializer-config">LSSerializer</a><a name="line.108"></a> |
| <FONT color="green">109</FONT> * @see org.apache.xml.serializer.Serializer<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @see org.apache.xml.serializer.DOMSerializer<a name="line.110"></a> |
| <FONT color="green">111</FONT> * <a name="line.111"></a> |
| <FONT color="green">112</FONT> * @xsl.usage advanced<a name="line.112"></a> |
| <FONT color="green">113</FONT> *<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> public interface DOM3Serializer {<a name="line.115"></a> |
| <FONT color="green">116</FONT> /**<a name="line.116"></a> |
| <FONT color="green">117</FONT> * Serializes the Level 3 DOM node. Throws an exception only if an I/O<a name="line.117"></a> |
| <FONT color="green">118</FONT> * exception occured while serializing.<a name="line.118"></a> |
| <FONT color="green">119</FONT> * <a name="line.119"></a> |
| <FONT color="green">120</FONT> * This interface is a public API.<a name="line.120"></a> |
| <FONT color="green">121</FONT> *<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @param node the Level 3 DOM node to serialize<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @throws IOException if an I/O exception occured while serializing<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> public void serializeDOM3(Node node) throws IOException;<a name="line.125"></a> |
| <FONT color="green">126</FONT> <a name="line.126"></a> |
| <FONT color="green">127</FONT> /**<a name="line.127"></a> |
| <FONT color="green">128</FONT> * Sets a DOMErrorHandler on the DOM Level 3 Serializer.<a name="line.128"></a> |
| <FONT color="green">129</FONT> * <a name="line.129"></a> |
| <FONT color="green">130</FONT> * This interface is a public API.<a name="line.130"></a> |
| <FONT color="green">131</FONT> *<a name="line.131"></a> |
| <FONT color="green">132</FONT> * @param handler the Level 3 DOMErrorHandler<a name="line.132"></a> |
| <FONT color="green">133</FONT> */<a name="line.133"></a> |
| <FONT color="green">134</FONT> public void setErrorHandler(DOMErrorHandler handler);<a name="line.134"></a> |
| <FONT color="green">135</FONT> <a name="line.135"></a> |
| <FONT color="green">136</FONT> /**<a name="line.136"></a> |
| <FONT color="green">137</FONT> * Returns a DOMErrorHandler set on the DOM Level 3 Serializer.<a name="line.137"></a> |
| <FONT color="green">138</FONT> * <a name="line.138"></a> |
| <FONT color="green">139</FONT> * This interface is a public API.<a name="line.139"></a> |
| <FONT color="green">140</FONT> *<a name="line.140"></a> |
| <FONT color="green">141</FONT> * @return A Level 3 DOMErrorHandler<a name="line.141"></a> |
| <FONT color="green">142</FONT> */<a name="line.142"></a> |
| <FONT color="green">143</FONT> public DOMErrorHandler getErrorHandler();<a name="line.143"></a> |
| <FONT color="green">144</FONT> <a name="line.144"></a> |
| <FONT color="green">145</FONT> /**<a name="line.145"></a> |
| <FONT color="green">146</FONT> * Sets a LSSerializerFilter on the DOM Level 3 Serializer to filter nodes<a name="line.146"></a> |
| <FONT color="green">147</FONT> * during serialization.<a name="line.147"></a> |
| <FONT color="green">148</FONT> * <a name="line.148"></a> |
| <FONT color="green">149</FONT> * This interface is a public API.<a name="line.149"></a> |
| <FONT color="green">150</FONT> *<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @param filter the Level 3 LSSerializerFilter<a name="line.151"></a> |
| <FONT color="green">152</FONT> */<a name="line.152"></a> |
| <FONT color="green">153</FONT> public void setNodeFilter(LSSerializerFilter filter);<a name="line.153"></a> |
| <FONT color="green">154</FONT> <a name="line.154"></a> |
| <FONT color="green">155</FONT> /**<a name="line.155"></a> |
| <FONT color="green">156</FONT> * Returns a LSSerializerFilter set on the DOM Level 3 Serializer to filter nodes<a name="line.156"></a> |
| <FONT color="green">157</FONT> * during serialization.<a name="line.157"></a> |
| <FONT color="green">158</FONT> * <a name="line.158"></a> |
| <FONT color="green">159</FONT> * This interface is a public API.<a name="line.159"></a> |
| <FONT color="green">160</FONT> *<a name="line.160"></a> |
| <FONT color="green">161</FONT> * @return The Level 3 LSSerializerFilter<a name="line.161"></a> |
| <FONT color="green">162</FONT> */<a name="line.162"></a> |
| <FONT color="green">163</FONT> public LSSerializerFilter getNodeFilter();<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> /**<a name="line.165"></a> |
| <FONT color="green">166</FONT> * Sets the end-of-line sequence of characters to be used during serialization<a name="line.166"></a> |
| <FONT color="green">167</FONT> * @param newLine The end-of-line sequence of characters to be used during serialization<a name="line.167"></a> |
| <FONT color="green">168</FONT> */<a name="line.168"></a> |
| <FONT color="green">169</FONT> public void setNewLine(char[] newLine);<a name="line.169"></a> |
| <FONT color="green">170</FONT> }<a name="line.170"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
