org.apache.xml.serialize

Class Printer

Known Direct Subclasses:
IndentPrinter

public class Printer
extends java.lang.Object

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.
Version:
$Revision: 1.8 $ $Date: 2004/02/24 23:34:03 $
Author:
Assaf Arkin

Field Summary

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 OutputFormat
_format
The output format associated with this serializer.
protected Writer
_writer
The writer to which the document is written.

Constructor Summary

Printer(Writer writer, OutputFormat format)

Method Summary

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(String text)
void
printText(StringBuffer text)
void
printText(char ch)
void
printText(char[] chars, int start, int length)
void
setNextIndent(int indent)
void
setThisIndent(int indent)
void
unindent()

Field Details

_docWriter

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

_dtdWriter

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.

_exception

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.

_format

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.

_writer

protected Writer _writer
The writer to which the document is written.

Constructor Details

Printer

public Printer(Writer writer,
               OutputFormat format)

Method Details

breakLine

public void breakLine()
            throws IOException

breakLine

public void breakLine(boolean preserveSpace)
            throws IOException

enterDTD

public void enterDTD()
            throws IOException

flush

public void flush()
            throws IOException
Flush the output stream. Must be called when done printing the document, otherwise some text might be buffered.

flushLine

public void flushLine(boolean preserveSpace)
            throws IOException

getException

public IOException getException()

getNextIndent

public int getNextIndent()

indent

public void indent()

leaveDTD

public String leaveDTD()
            throws IOException
Called by the root element to leave DTD mode and if any DTD parts were printer, will return a string with their textual content.

printSpace

public void printSpace()
            throws IOException

printText

public void printText(String text)
            throws IOException

printText

public void printText(StringBuffer text)
            throws IOException

printText

public void printText(char ch)
            throws IOException

printText

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

setNextIndent

public void setNextIndent(int indent)

setThisIndent

public void setThisIndent(int indent)

unindent

public void unindent()

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.