File Doc Category Size Date Package
WriterChain.java API Doc Java SE 6 API 3371 Tue Jun 10 00:23:08 BST 2008 com.sun.org.apache.xml.internal.serializer

WriterChain

public interface WriterChain

It is unfortunate that java.io.Writer is a class rather than an interface. The serializer has a number of classes that extend java.io.Writer and which send their ouput to a yet another wrapped Writer or OutputStream. The purpose of this interface is to force such classes to over-ride all of the important methods defined on the java.io.Writer class, namely these:


write(int val)
write(char[] chars)
write(char[] chars, int start, int count)
write(String chars)
write(String chars, int start, int count)
flush()
close()

In this manner nothing will accidentally go directly to the base class rather than to the wrapped Writer or OutputStream. The purpose of this class is to have a uniform way of chaining the output of one writer to the next writer in the chain. In addition there are methods to obtain the Writer or OutputStream that this object sends its output to. This interface is only for internal use withing the serializer.

xsl.usage: internal

Fields Summary
Constructors Summary
Methods Summary
public void close()
This method forces us to over-ride the method defined in java.io.Writer
public void flush()
This method forces us to over-ride the method defined in java.io.Writer
public java.io.OutputStream getOutputStream()
If this method returns null, getWriter() must return non-null. Get the OutputStream that this writer sends its output to.
public java.io.Writer getWriter()
If this method returns null, getOutputStream() must return non-null. Get the writer that this writer sends its output to. It is possible that the Writer returned by this method does not implement the WriterChain interface.
public void write(int val)
This method forces us to over-ride the method defined in java.io.Writer
public void write(char[] chars)
This method forces us to over-ride the method defined in java.io.Writer
public void write(char[] chars, int start, int count)
This method forces us to over-ride the method defined in java.io.Writer
public void write(java.lang.String chars)
This method forces us to over-ride the method defined in java.io.Writer
public void write(java.lang.String chars, int start, int count)
This method forces us to over-ride the method defined in java.io.Writer