blob: a6a88a75ca57dfd5d800dbd21b19d1b3f7c96eef [file] [log] [blame]
<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: DOMSerializer.java 475350 2006-11-15 18:39:15Z 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> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.io.IOException;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import org.w3c.dom.Node;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Interface for a DOM serializer implementation.<a name="line.28"></a>
<FONT color="green">029</FONT> * &lt;p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT> * The DOMSerializer is a facet of a serializer and is obtained from the<a name="line.30"></a>
<FONT color="green">031</FONT> * asDOMSerializer() method of the ({@link Serializer}) interface. <a name="line.31"></a>
<FONT color="green">032</FONT> * A serializer may or may not support a DOM serializer, if it does not then the <a name="line.32"></a>
<FONT color="green">033</FONT> * return value from asDOMSerializer() is null.<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * Example:<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;pre&gt;<a name="line.36"></a>
<FONT color="green">037</FONT> * // Create a document to be serialized<a name="line.37"></a>
<FONT color="green">038</FONT> * org.w3c.dom.Document doc = ...;<a name="line.38"></a>
<FONT color="green">039</FONT> * <a name="line.39"></a>
<FONT color="green">040</FONT> * // Create a Serializer that will be used<a name="line.40"></a>
<FONT color="green">041</FONT> * // to serialize the document <a name="line.41"></a>
<FONT color="green">042</FONT> * org.apache.xml.serializer.Serializer ser = ...;<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * // Set the Writer to write output to, and <a name="line.44"></a>
<FONT color="green">045</FONT> * // serialize the DOM using that Serializer<a name="line.45"></a>
<FONT color="green">046</FONT> * java.io.StringWriter sw = new java.io.StringWriter();<a name="line.46"></a>
<FONT color="green">047</FONT> * ser.setWriter(sw);<a name="line.47"></a>
<FONT color="green">048</FONT> * DOMSerialzier dser = ser.asDOMSerializer();<a name="line.48"></a>
<FONT color="green">049</FONT> * dser.serialize(doc);<a name="line.49"></a>
<FONT color="green">050</FONT> * <a name="line.50"></a>
<FONT color="green">051</FONT> * // Write out the serialized XML in the String.<a name="line.51"></a>
<FONT color="green">052</FONT> * System.out.println(sw.toString());<a name="line.52"></a>
<FONT color="green">053</FONT> * &lt;/pre&gt;<a name="line.53"></a>
<FONT color="green">054</FONT> * <a name="line.54"></a>
<FONT color="green">055</FONT> * @see OutputPropertiesFactory<a name="line.55"></a>
<FONT color="green">056</FONT> * @see SerializerFactory<a name="line.56"></a>
<FONT color="green">057</FONT> * @see Serializer<a name="line.57"></a>
<FONT color="green">058</FONT> * <a name="line.58"></a>
<FONT color="green">059</FONT> * @xsl.usage general<a name="line.59"></a>
<FONT color="green">060</FONT> *<a name="line.60"></a>
<FONT color="green">061</FONT> */<a name="line.61"></a>
<FONT color="green">062</FONT> public interface DOMSerializer<a name="line.62"></a>
<FONT color="green">063</FONT> {<a name="line.63"></a>
<FONT color="green">064</FONT> /**<a name="line.64"></a>
<FONT color="green">065</FONT> * Serializes the DOM node. Throws an exception only if an I/O<a name="line.65"></a>
<FONT color="green">066</FONT> * exception occured while serializing.<a name="line.66"></a>
<FONT color="green">067</FONT> * <a name="line.67"></a>
<FONT color="green">068</FONT> * This interface is a public API.<a name="line.68"></a>
<FONT color="green">069</FONT> *<a name="line.69"></a>
<FONT color="green">070</FONT> * @param node the DOM node to serialize<a name="line.70"></a>
<FONT color="green">071</FONT> * @throws IOException if an I/O exception occured while serializing<a name="line.71"></a>
<FONT color="green">072</FONT> */<a name="line.72"></a>
<FONT color="green">073</FONT> public void serialize(Node node) throws IOException;<a name="line.73"></a>
<FONT color="green">074</FONT> }<a name="line.74"></a>
</PRE>
</BODY>
</HTML>