public class

Printer

extends Object
java.lang.Object
   ↳ org.apache.xml.serialize.Printer
Known Direct Subclasses

This class is deprecated.
This class was deprecated in Xerces 2.9.0. It is recommended that new applications use the DOM Level 3 LSSerializer or JAXP's Transformation API for XML (TrAX) for serializing XML. See the Xerces documentation for more information.

Class Overview

The printer is responsible for sending text to the output stream or writer. This class performs direct writing for efficiency. IndentPrinter supports indentation and line wrapping by extending this class.

Summary

Fields
protected Writer _docWriter Holds a reference to the document writer while we are in DTD mode.
protected StringWriter _dtdWriter The DTD writer.
protected IOException _exception Holds the exception thrown by the serializer.
protected final OutputFormat _format The output format associated with this serializer.
protected Writer _writer The writer to which the document is written.
Public Constructors
Printer(Writer writer, OutputFormat format)
Public Methods
void breakLine()
void breakLine(boolean preserveSpace)
void enterDTD()
Called by any of the DTD handlers to enter DTD mode.
void flush()
Flush the output stream.
void flushLine(boolean preserveSpace)
IOException getException()
int getNextIndent()
void indent()
String leaveDTD()
Called by the root element to leave DTD mode and if any DTD parts were printer, will return a string with their textual content.
void printSpace()
void printText(char ch)
void printText(StringBuffer text)
void printText(char[] chars, int start, int length)
void printText(String text)
void setNextIndent(int indent)
void setThisIndent(int indent)
void unindent()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected Writer _docWriter

Holds a reference to the document writer while we are in DTD mode.

protected StringWriter _dtdWriter

The DTD writer. When we switch to DTD mode, all output is accumulated in this DTD writer. When we switch out of it, the output is obtained as a string. Must not be reset to null until we're done with the document.

protected IOException _exception

Holds the exception thrown by the serializer. Exceptions do not cause the serializer to quit, but are held and one is thrown at the end.

protected final OutputFormat _format

The output format associated with this serializer. This will never be a null reference. If no format was passed to the constructor, the default one for this document type will be used. The format object is never changed by the serializer.

protected Writer _writer

The writer to which the document is written.

Public Constructors

public Printer (Writer writer, OutputFormat format)

Public Methods

public void breakLine ()

Throws
IOException

public void breakLine (boolean preserveSpace)

Throws
IOException

public void enterDTD ()

Called by any of the DTD handlers to enter DTD mode. Once entered, all output will be accumulated in a string that can be printed as part of the document's DTD. This method may be called any number of time but will only have affect the first time it's called. To exist DTD state and get the accumulated DTD, call leaveDTD().

Throws
IOException

public void flush ()

Flush the output stream. Must be called when done printing the document, otherwise some text might be buffered.

Throws
IOException

public void flushLine (boolean preserveSpace)

Throws
IOException

public IOException getException ()

public int getNextIndent ()

public void indent ()

public String leaveDTD ()

Called by the root element to leave DTD mode and if any DTD parts were printer, will return a string with their textual content.

Throws
IOException

public void printSpace ()

Throws
IOException

public void printText (char ch)

Throws
IOException

public void printText (StringBuffer text)

Throws
IOException

public void printText (char[] chars, int start, int length)

Throws
IOException

public void printText (String text)

Throws
IOException

public void setNextIndent (int indent)

public void setThisIndent (int indent)

public void unindent ()