OpenJDK 27 · com.sun.org.apache.xml.internal.serializer.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.

Method Summary

Modifier and Type	Method and Description
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 OutputStream	getOutputStream() If this method returns null, getWriter() must return non-null.
public Writer	getWriter() If this method returns null, getOutputStream() must return non-null.
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(String chars) This method forces us to over-ride the method defined in java.io.Writer
public void	write(String chars, int start, int count) This method forces us to over-ride the method defined in java.io.Writer

Method Detail

close	back to summary
public void close() throws IOException This method forces us to over-ride the method defined in java.io.Writer

flush	back to summary
public void flush() throws IOException This method forces us to over-ride the method defined in java.io.Writer

getOutputStream	back to summary
public OutputStream getOutputStream() If this method returns null, getWriter() must return non-null. Get the OutputStream that this writer sends its output to.

getWriter	back to summary
public 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.

write	back to summary
public void write(int val) throws IOException This method forces us to over-ride the method defined in java.io.Writer

write	back to summary
public void write(char[] chars) throws IOException This method forces us to over-ride the method defined in java.io.Writer

write	back to summary
public void write(char[] chars, int start, int count) throws IOException This method forces us to over-ride the method defined in java.io.Writer

write	back to summary
public void write(String chars) throws IOException This method forces us to over-ride the method defined in java.io.Writer

write	back to summary
public void write(String chars, int start, int count) throws IOException This method forces us to over-ride the method defined in java.io.Writer

pack-priv Interface WriterChain

Method Summary

Method Detail