org.x4o.xml.io.sax.ext

Class AbstractContentWriterHandler

java.lang.Object

org.x4o.xml.io.sax.ext.AbstractContentWriterHandler

All Implemented Interfaces:

ContentHandler

Direct Known Subclasses:

AbstractContentWriterLexical

public class AbstractContentWriterHandler
extends Object
implements ContentHandler

AbstractContentWriterHandler writes SAX content handler events as XML.

Version:

1.0 May 3, 2013

Author:

Willem Cazander

Field Summary

Fields

Modifier and Type	Field and Description
protected Attributes	EMPTY_ATTRIBUTES
protected String	encoding

Constructor Summary

Constructors

Constructor and Description
AbstractContentWriterHandler(Writer out, String encoding, String charNewLine, String charTab) Creates XmlWriter which prints to the Writer interface.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	autoCloseStartElement() Auto close the start element if working in printing event.
void	characters(char c)
void	characters(char[] ch, int start, int length) Prints xml characters and uses characters(java.lang.String) method.
void	characters(String text) Escape and prints xml characters.
void	charactersRaw(String text)
void	closeWriter()
void	closeWriterSafe()
void	comment(char[] ch, int start, int length) Prints xml comment.
void	comment(String text) Prints xml comment.
void	endDocument()
void	endElement(String uri, String localName, String name)
void	endPrefixMapping(String prefix)
void	ignorableWhitespace(char c) Prints xml ignorable whitespace character.
void	ignorableWhitespace(char[] ch, int start, int length) Prints xml ignorable whitespace.
void	ignorableWhitespace(String text) Prints xml ignorable whitespace.
void	processingInstruction(String target, String data) Prints xml instructions.
void	setDocumentLocator(Locator locator) Not implemented.
void	skippedEntity(String name) Not implemented.
void	startDocument()
void	startElement(String uri, String localName, String name, Attributes atts)
void	startElementNamespace(String uri)
void	startElementNamespaceAll(String uri)
void	startElementTag(String uri, String localName)
void	startPrefixMapping(String prefix, String uri) Starts the prefix mapping of an xml namespace uri.
protected void	writeFlush()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_ATTRIBUTES

protected final Attributes EMPTY_ATTRIBUTES

encoding

protected String encoding

Constructor Detail

AbstractContentWriterHandler

public AbstractContentWriterHandler(Writer out,
                            String encoding,
                            String charNewLine,
                            String charTab)

Creates XmlWriter which prints to the Writer interface.

Parameters:

out - The writer to print the xml to.

Method Detail

closeWriter

public void closeWriter()
                 throws IOException

Throws:

IOException

closeWriterSafe

public void closeWriterSafe()

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

See Also:

ContentHandler.endDocument()

startElement

public void startElement(String uri,
                String localName,
                String name,
                Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Parameters:

uri - The xml namespace uri.

localName - The local name of the xml tag.

name - The (full) name of the xml tag.

atts - The attributes of the xml tag.

Throws:

SAXException

See Also:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

startElementTag

public void startElementTag(String uri,
                   String localName)
                     throws SAXException

Throws:

SAXException

startElementNamespace

public void startElementNamespace(String uri)
                           throws SAXException

Throws:

SAXException

startElementNamespaceAll

public void startElementNamespaceAll(String uri)
                              throws SAXException

Throws:

SAXException

endElement

public void endElement(String uri,
              String localName,
              String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Parameters:

uri - The xml namespace uri.

localName - The local name of the xml tag.

name - The (full) name of the xml tag.

Throws:

SAXException

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

startPrefixMapping

public void startPrefixMapping(String prefix,
                      String uri)
                        throws SAXException

Starts the prefix mapping of an xml namespace uri.

Specified by:

startPrefixMapping in interface ContentHandler

Parameters:

prefix - The xml prefix of this xml namespace uri.

uri - The xml namespace uri to add the prefix for.

Throws:

SAXException

See Also:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Parameters:

prefix - The xml prefix of this xml namespace uri to be ended.

Throws:

SAXException

See Also:

ContentHandler.endPrefixMapping(java.lang.String)

characters

public void characters(char[] ch,
              int start,
              int length)
                throws SAXException

Prints xml characters and uses characters(java.lang.String) method.

Specified by:

characters in interface ContentHandler

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

ContentHandler.characters(char[], int, int)

characters

public void characters(String text)
                throws SAXException

Escape and prints xml characters.

Throws:

SAXException

See Also:

ContentWriter.characters(java.lang.String)

characters

public void characters(char c)
                throws SAXException

Throws:

SAXException

charactersRaw

public void charactersRaw(String text)
                   throws SAXException

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)
                         throws SAXException

Prints xml ignorable whitespace.

Specified by:

ignorableWhitespace in interface ContentHandler

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

ContentHandler.ignorableWhitespace(char[], int, int)

ignorableWhitespace

public void ignorableWhitespace(String text)
                         throws SAXException

Prints xml ignorable whitespace.

Parameters:

text - The text to print.

Throws:

SAXException - When IOException has happend while printing.

See Also:

ContentWriter.ignorableWhitespace(java.lang.String)

ignorableWhitespace

public void ignorableWhitespace(char c)
                         throws SAXException

Prints xml ignorable whitespace character.

Parameters:

c - The character to print.

Throws:

SAXException - When IOException has happend while printing.

processingInstruction

public void processingInstruction(String target,
                         String data)
                           throws SAXException

Prints xml instructions.

Specified by:

processingInstruction in interface ContentHandler

Parameters:

target - The target.

data - The data.

Throws:

SAXException

See Also:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

Not implemented.

Specified by:

setDocumentLocator in interface ContentHandler

Parameters:

locator - The DocumentLocator to set.

See Also:

ContentHandler.setDocumentLocator(org.xml.sax.Locator)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Not implemented.

Specified by:

skippedEntity in interface ContentHandler

Parameters:

name - The name of the skipped entity.

Throws:

SAXException

See Also:

ContentHandler.skippedEntity(java.lang.String)

comment

public void comment(char[] ch,
           int start,
           int length)
             throws SAXException

Prints xml comment.

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

DefaultHandler2.comment(char[], int, int)

comment

public void comment(String text)
             throws SAXException

Prints xml comment.

Throws:

SAXException

See Also:

ContentWriter.comment(java.lang.String)

autoCloseStartElement

protected void autoCloseStartElement()
                              throws SAXException

Auto close the start element if working in printing event.

Throws:

IOException - When prints gives exception.

SAXException

writeFlush

protected void writeFlush()
                   throws SAXException

Throws:

SAXException