org.apache.ws.commons.serialize
Interface XMLWriter

All Superinterfaces:

org.xml.sax.ContentHandler

All Known Implementing Classes:

CharSetXMLWriter, OrderedAttributeXMLWriter, PassThroughXMLWriter, XMLWriterImpl

public interface XMLWriter
extends org.xml.sax.ContentHandler

A simple serializer for XML documents, which is writing to an instance of Writer.

Method Summary

boolean	canEncode(char pChar) Returns whether the XMLWriter can encode the character c without an escape sequence like &#ddd;.
java.lang.String	getEncoding() Returns the writers encoding.
java.lang.String	getIndentString() Returns the string being used to indent an XML element by one level.
java.lang.String	getLineFeed() Returns the line terminator.
java.io.Writer	getWriter() Returns the target Writer.
boolean	isDeclarating() Returns, whether an XML declaration is being generated.
boolean	isFlushing() Returns, whether the method ContentHandler.endDocument() should do a flush on the target stream.
boolean	isIndenting() Returns, whether the XMLWriter is indenting (pretty printing).
void	setDeclarating(boolean pDeclarating) Sets, whether an XML declaration is being generated.
void	setEncoding(java.lang.String pEncoding) Sets the writers encoding.
void	setFlushing(boolean pFlushing) Sets, whether the method ContentHandler.endDocument() should do a flush on the target stream.
void	setIndenting(boolean pIndenting) Returns, whether the XMLWriter is indenting (pretty printing).
void	setIndentString(java.lang.String pIndentString) Sets the string being used to indent an XML element by one level.
void	setLineFeed(java.lang.String pLineFeed) Sets the line terminator.
void	setWriter(java.io.Writer pWriter) Sets the target Writer.

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

setEncoding

void setEncoding(java.lang.String pEncoding)

Sets the writers encoding.

Parameters:

pEncoding - Writers encoding, by default null, in which case UTF-8 is being used.

getEncoding

java.lang.String getEncoding()

Returns the writers encoding.

Returns:

Writers encoding, by default null, in which case UTF-8 is being used.

setDeclarating

void setDeclarating(boolean pDeclarating)

Sets, whether an XML declaration is being generated.

Parameters:

pDeclarating - Whether an XML declaration is generated. Defaults to false.

isDeclarating

boolean isDeclarating()

Returns, whether an XML declaration is being generated.

Returns:

Whether an XML declaration is generated. Defaults to false.

setWriter

void setWriter(java.io.Writer pWriter)

Sets the target Writer. This is typically an instance of BufferedWriter, which is connected to an instance of OutputStreamWriter with an encoding matching the XML documents encoding.

Parameters:

pWriter - The target writer.

getWriter

java.io.Writer getWriter()

Returns the target Writer. This is typically an instance of BufferedWriter, which is connected to an instance of OutputStreamWriter with an encoding matching the XML documents encoding.

Returns:

The target writer.

canEncode

boolean canEncode(char pChar)

Returns whether the XMLWriter can encode the character c without an escape sequence like &#ddd;.

Parameters:

pChar - The character being checked for escaping.

Returns:

Whether to encode the character.

setIndenting

void setIndenting(boolean pIndenting)

Returns, whether the XMLWriter is indenting (pretty printing). If you want indenting, you should consider to invoke the methods setIndentString(java.lang.String) and setLineFeed(java.lang.String) as well.

Parameters:

pIndenting - Whether indentation is enabled. Defaults to false.

isIndenting

boolean isIndenting()

Returns, whether the XMLWriter is indenting (pretty printing). If you want indenting, you should consider to invoke the methods setIndentString(java.lang.String) and setLineFeed(java.lang.String) as well.

Returns:

Whether indentation is enabled. Defaults to false.

setIndentString

void setIndentString(java.lang.String pIndentString)

Sets the string being used to indent an XML element by one level. Ignored, if indentation is disabled.

Parameters:

pIndentString - The indentation string, by default " " (two blanks).

getIndentString

java.lang.String getIndentString()

Returns the string being used to indent an XML element by one level. Ignored, if indentation is disabled.

Returns:

The indentation string, by default " " (two blanks).

setLineFeed

void setLineFeed(java.lang.String pLineFeed)

Sets the line terminator. Ignored, if indentation is disabled.

Parameters:

pLineFeed - The line terminator, by default "\n" (Line Feed). You might prefer "\r\n" (Carriage Return, Line Feed), which is the default on Windows and related operating systems.

getLineFeed

java.lang.String getLineFeed()

Returns the line terminator. Ignored, if indentation is disabled.

Returns:

The line terminator, by default "\n" (Line Feed). You might prefer "\r\n" (Carriage Return, Line Feed), which is the default on Windows and related operating systems.

setFlushing

void setFlushing(boolean pFlushing)

Sets, whether the method ContentHandler.endDocument() should do a flush on the target stream.

Parameters:

pFlushing - True, if a flush should be done. Defaults to false.

isFlushing

boolean isFlushing()

Returns, whether the method ContentHandler.endDocument() should do a flush on the target stream.

Returns:

True, if a flush should be done. Defaults to false.