| <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: SerializationHandler.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> <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 javax.xml.transform.Transformer;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <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.xml.sax.ContentHandler;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.xml.sax.ErrorHandler;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.xml.sax.SAXException;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.xml.sax.ext.DeclHandler;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> /**<a name="line.33"></a> |
| <FONT color="green">034</FONT> * This interface is the one that a serializer implements. It is a group of<a name="line.34"></a> |
| <FONT color="green">035</FONT> * other interfaces, such as ExtendedContentHandler, ExtendedLexicalHandler etc.<a name="line.35"></a> |
| <FONT color="green">036</FONT> * In addition there are other methods, such as reset().<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <a name="line.37"></a> |
| <FONT color="green">038</FONT> * This class is public only because it is used in another package,<a name="line.38"></a> |
| <FONT color="green">039</FONT> * it is not a public API.<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <a name="line.40"></a> |
| <FONT color="green">041</FONT> * @xsl.usage internal<a name="line.41"></a> |
| <FONT color="green">042</FONT> */<a name="line.42"></a> |
| <FONT color="green">043</FONT> public interface SerializationHandler<a name="line.43"></a> |
| <FONT color="green">044</FONT> extends<a name="line.44"></a> |
| <FONT color="green">045</FONT> ExtendedContentHandler,<a name="line.45"></a> |
| <FONT color="green">046</FONT> ExtendedLexicalHandler,<a name="line.46"></a> |
| <FONT color="green">047</FONT> XSLOutputAttributes,<a name="line.47"></a> |
| <FONT color="green">048</FONT> DeclHandler,<a name="line.48"></a> |
| <FONT color="green">049</FONT> org.xml.sax.DTDHandler,<a name="line.49"></a> |
| <FONT color="green">050</FONT> ErrorHandler,<a name="line.50"></a> |
| <FONT color="green">051</FONT> DOMSerializer,<a name="line.51"></a> |
| <FONT color="green">052</FONT> Serializer<a name="line.52"></a> |
| <FONT color="green">053</FONT> {<a name="line.53"></a> |
| <FONT color="green">054</FONT> /**<a name="line.54"></a> |
| <FONT color="green">055</FONT> * Set the SAX Content handler that the serializer sends its output to. This<a name="line.55"></a> |
| <FONT color="green">056</FONT> * method only applies to a ToSAXHandler, not to a ToStream serializer.<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <a name="line.57"></a> |
| <FONT color="green">058</FONT> * @see Serializer#asContentHandler()<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @see ToSAXHandler<a name="line.59"></a> |
| <FONT color="green">060</FONT> */<a name="line.60"></a> |
| <FONT color="green">061</FONT> public void setContentHandler(ContentHandler ch);<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> public void close();<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Notify that the serializer should take this DOM node as input to be<a name="line.66"></a> |
| <FONT color="green">067</FONT> * serialized.<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <a name="line.68"></a> |
| <FONT color="green">069</FONT> * @param node the DOM node to be serialized.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @throws IOException<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> public void serialize(Node node) throws IOException;<a name="line.72"></a> |
| <FONT color="green">073</FONT> /**<a name="line.73"></a> |
| <FONT color="green">074</FONT> * Turns special character escaping on/off. <a name="line.74"></a> |
| <FONT color="green">075</FONT> * <a name="line.75"></a> |
| <FONT color="green">076</FONT> * Note that characters will<a name="line.76"></a> |
| <FONT color="green">077</FONT> * never, even if this option is set to 'true', be escaped within<a name="line.77"></a> |
| <FONT color="green">078</FONT> * CDATA sections in output XML documents.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * <a name="line.79"></a> |
| <FONT color="green">080</FONT> * @param escape true if escaping is to be set on.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> public boolean setEscaping(boolean escape) throws SAXException;<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> /**<a name="line.84"></a> |
| <FONT color="green">085</FONT> * Set the number of spaces to indent for each indentation level.<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @param spaces the number of spaces to indent for each indentation level.<a name="line.86"></a> |
| <FONT color="green">087</FONT> */<a name="line.87"></a> |
| <FONT color="green">088</FONT> public void setIndentAmount(int spaces);<a name="line.88"></a> |
| <FONT color="green">089</FONT> <a name="line.89"></a> |
| <FONT color="green">090</FONT> /**<a name="line.90"></a> |
| <FONT color="green">091</FONT> * Set the transformer associated with the serializer.<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @param transformer the transformer associated with the serializer.<a name="line.92"></a> |
| <FONT color="green">093</FONT> */<a name="line.93"></a> |
| <FONT color="green">094</FONT> public void setTransformer(Transformer transformer);<a name="line.94"></a> |
| <FONT color="green">095</FONT> <a name="line.95"></a> |
| <FONT color="green">096</FONT> /**<a name="line.96"></a> |
| <FONT color="green">097</FONT> * Get the transformer associated with the serializer.<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @return Transformer the transformer associated with the serializer.<a name="line.98"></a> |
| <FONT color="green">099</FONT> */<a name="line.99"></a> |
| <FONT color="green">100</FONT> public Transformer getTransformer();<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> /** <a name="line.102"></a> |
| <FONT color="green">103</FONT> * Used only by TransformerSnapshotImpl to restore the serialization <a name="line.103"></a> |
| <FONT color="green">104</FONT> * to a previous state. <a name="line.104"></a> |
| <FONT color="green">105</FONT> * <a name="line.105"></a> |
| <FONT color="green">106</FONT> * @param mappings NamespaceMappings<a name="line.106"></a> |
| <FONT color="green">107</FONT> */<a name="line.107"></a> |
| <FONT color="green">108</FONT> public void setNamespaceMappings(NamespaceMappings mappings);<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> /**<a name="line.110"></a> |
| <FONT color="green">111</FONT> * A SerializationHandler accepts SAX-like events, so<a name="line.111"></a> |
| <FONT color="green">112</FONT> * it can accumulate attributes or namespace nodes after<a name="line.112"></a> |
| <FONT color="green">113</FONT> * a startElement().<a name="line.113"></a> |
| <FONT color="green">114</FONT> * <p><a name="line.114"></a> |
| <FONT color="green">115</FONT> * If the SerializationHandler has a Writer or OutputStream, <a name="line.115"></a> |
| <FONT color="green">116</FONT> * a call to this method will flush such accumulated <a name="line.116"></a> |
| <FONT color="green">117</FONT> * events as a closed start tag for an element.<a name="line.117"></a> |
| <FONT color="green">118</FONT> * <p><a name="line.118"></a> |
| <FONT color="green">119</FONT> * If the SerializationHandler wraps a ContentHandler,<a name="line.119"></a> |
| <FONT color="green">120</FONT> * a call to this method will flush such accumulated<a name="line.120"></a> |
| <FONT color="green">121</FONT> * events as a SAX (not SAX-like) calls to<a name="line.121"></a> |
| <FONT color="green">122</FONT> * startPrefixMapping() and startElement().<a name="line.122"></a> |
| <FONT color="green">123</FONT> * <p><a name="line.123"></a> |
| <FONT color="green">124</FONT> * If one calls endDocument() then one need not call<a name="line.124"></a> |
| <FONT color="green">125</FONT> * this method since a call to endDocument() will<a name="line.125"></a> |
| <FONT color="green">126</FONT> * do what this method does. However, in some<a name="line.126"></a> |
| <FONT color="green">127</FONT> * circumstances, such as with document fragments,<a name="line.127"></a> |
| <FONT color="green">128</FONT> * endDocument() is not called and it may be<a name="line.128"></a> |
| <FONT color="green">129</FONT> * necessary to call this method to flush<a name="line.129"></a> |
| <FONT color="green">130</FONT> * any pending events.<a name="line.130"></a> |
| <FONT color="green">131</FONT> * <p> <a name="line.131"></a> |
| <FONT color="green">132</FONT> * For performance reasons this method should not be called<a name="line.132"></a> |
| <FONT color="green">133</FONT> * very often. <a name="line.133"></a> |
| <FONT color="green">134</FONT> */<a name="line.134"></a> |
| <FONT color="green">135</FONT> public void flushPending() throws SAXException;<a name="line.135"></a> |
| <FONT color="green">136</FONT> <a name="line.136"></a> |
| <FONT color="green">137</FONT> /**<a name="line.137"></a> |
| <FONT color="green">138</FONT> * Default behavior is to expand DTD entities,<a name="line.138"></a> |
| <FONT color="green">139</FONT> * that is the initall default value is true.<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param expand true if DTD entities are to be expanded,<a name="line.140"></a> |
| <FONT color="green">141</FONT> * false if they are to be left as DTD entity references. <a name="line.141"></a> |
| <FONT color="green">142</FONT> */<a name="line.142"></a> |
| <FONT color="green">143</FONT> public void setDTDEntityExpansion(boolean expand);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
