| <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: WriterChain.java 468654 2006-10-28 07:09:23Z 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> /**<a name="line.25"></a> |
| <FONT color="green">026</FONT> * It is unfortunate that java.io.Writer is a class rather than an interface.<a name="line.26"></a> |
| <FONT color="green">027</FONT> * The serializer has a number of classes that extend java.io.Writer<a name="line.27"></a> |
| <FONT color="green">028</FONT> * and which send their ouput to a yet another wrapped Writer or OutputStream.<a name="line.28"></a> |
| <FONT color="green">029</FONT> * <a name="line.29"></a> |
| <FONT color="green">030</FONT> * The purpose of this interface is to force such classes to over-ride all of<a name="line.30"></a> |
| <FONT color="green">031</FONT> * the important methods defined on the java.io.Writer class, namely these:<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <code><a name="line.32"></a> |
| <FONT color="green">033</FONT> * write(int val)<a name="line.33"></a> |
| <FONT color="green">034</FONT> * write(char[] chars)<a name="line.34"></a> |
| <FONT color="green">035</FONT> * write(char[] chars, int start, int count)<a name="line.35"></a> |
| <FONT color="green">036</FONT> * write(String chars)<a name="line.36"></a> |
| <FONT color="green">037</FONT> * write(String chars, int start, int count)<a name="line.37"></a> |
| <FONT color="green">038</FONT> * flush()<a name="line.38"></a> |
| <FONT color="green">039</FONT> * close()<a name="line.39"></a> |
| <FONT color="green">040</FONT> * </code><a name="line.40"></a> |
| <FONT color="green">041</FONT> * In this manner nothing will accidentally go directly to <a name="line.41"></a> |
| <FONT color="green">042</FONT> * the base class rather than to the wrapped Writer or OutputStream. <a name="line.42"></a> |
| <FONT color="green">043</FONT> * <a name="line.43"></a> |
| <FONT color="green">044</FONT> * The purpose of this class is to have a uniform way of chaining the output of one writer to<a name="line.44"></a> |
| <FONT color="green">045</FONT> * the next writer in the chain. In addition there are methods to obtain the Writer or <a name="line.45"></a> |
| <FONT color="green">046</FONT> * OutputStream that this object sends its output to.<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <a name="line.47"></a> |
| <FONT color="green">048</FONT> * This interface is only for internal use withing the serializer. <a name="line.48"></a> |
| <FONT color="green">049</FONT> * @xsl.usage internal<a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> interface WriterChain<a name="line.51"></a> |
| <FONT color="green">052</FONT> {<a name="line.52"></a> |
| <FONT color="green">053</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.53"></a> |
| <FONT color="green">054</FONT> public void write(int val) throws IOException;<a name="line.54"></a> |
| <FONT color="green">055</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.55"></a> |
| <FONT color="green">056</FONT> public void write(char[] chars) throws IOException;<a name="line.56"></a> |
| <FONT color="green">057</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.57"></a> |
| <FONT color="green">058</FONT> public void write(char[] chars, int start, int count) throws IOException;<a name="line.58"></a> |
| <FONT color="green">059</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.59"></a> |
| <FONT color="green">060</FONT> public void write(String chars) throws IOException;<a name="line.60"></a> |
| <FONT color="green">061</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.61"></a> |
| <FONT color="green">062</FONT> public void write(String chars, int start, int count) throws IOException;<a name="line.62"></a> |
| <FONT color="green">063</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.63"></a> |
| <FONT color="green">064</FONT> public void flush() throws IOException;<a name="line.64"></a> |
| <FONT color="green">065</FONT> /** This method forces us to over-ride the method defined in java.io.Writer */<a name="line.65"></a> |
| <FONT color="green">066</FONT> public void close() throws IOException;<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> * If this method returns null, getOutputStream() must return non-null.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * Get the writer that this writer sends its output to.<a name="line.70"></a> |
| <FONT color="green">071</FONT> * <a name="line.71"></a> |
| <FONT color="green">072</FONT> * It is possible that the Writer returned by this method does not<a name="line.72"></a> |
| <FONT color="green">073</FONT> * implement the WriterChain interface.<a name="line.73"></a> |
| <FONT color="green">074</FONT> */<a name="line.74"></a> |
| <FONT color="green">075</FONT> public java.io.Writer getWriter();<a name="line.75"></a> |
| <FONT color="green">076</FONT> <a name="line.76"></a> |
| <FONT color="green">077</FONT> /**<a name="line.77"></a> |
| <FONT color="green">078</FONT> * If this method returns null, getWriter() must return non-null.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * Get the OutputStream that this writer sends its output to.<a name="line.79"></a> |
| <FONT color="green">080</FONT> */<a name="line.80"></a> |
| <FONT color="green">081</FONT> public java.io.OutputStream getOutputStream();<a name="line.81"></a> |
| <FONT color="green">082</FONT> }<a name="line.82"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
