Package com.sun.xml.txw2.output
Class IndentingXMLFilter
java.lang.Object
org.xml.sax.helpers.XMLFilterImpl
com.sun.xml.txw2.output.IndentingXMLFilter
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
,LexicalHandler
,XMLFilter
,XMLReader
XMLFilterImpl
that does indentation to SAX events.- Author:
- Kohsuke Kawaguchi
-
Constructor Summary
ConstructorsConstructorDescriptionIndentingXMLFilter
(ContentHandler handler) IndentingXMLFilter
(ContentHandler handler, LexicalHandler lexical) -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(char[] ch, int start, int length) Write a sequence of characters.void
comment
(char[] ch, int start, int length) void
endCDATA()
void
endDTD()
void
endElement
(String uri, String localName, String qName) Write an end tag.void
int
Deprecated.Only return the length of the indent string.void
setIndentStep
(int indentStep) Deprecated.Should use the version that takes string.void
void
setLexicalHandler
(LexicalHandler lexical) void
void
void
startElement
(String uri, String localName, String qName, Attributes atts) Write a start tag.void
startEntity
(String name) Methods inherited from class org.xml.sax.helpers.XMLFilterImpl
endDocument, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, setProperty, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Constructor Details
-
IndentingXMLFilter
public IndentingXMLFilter() -
IndentingXMLFilter
-
IndentingXMLFilter
-
-
Method Details
-
getLexicalHandler
-
setLexicalHandler
-
getIndentStep
public int getIndentStep()Deprecated.Only return the length of the indent string.Return the current indent step.Return the current indent step: each start tag will be indented by this number of spaces times the number of ancestors that the element has.
- Returns:
- The number of spaces in each indentation step, or 0 or less for no indentation.
- See Also:
-
setIndentStep
public void setIndentStep(int indentStep) Deprecated.Should use the version that takes string.Set the current indent step.- Parameters:
indentStep
- The new indent step (0 or less for no indentation).- See Also:
-
setIndentStep
-
startElement
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException Write a start tag.Each tag will begin on a new line, and will be indented by the current indent step times the number of ancestors that the element has.
The newline and indentation will be passed on down the filter chain through regular characters events.
- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classXMLFilterImpl
- Parameters:
uri
- The element's Namespace URI.localName
- The element's local name.qName
- The element's qualified (prefixed) name.atts
- The element's attribute list.- Throws:
SAXException
- If there is an error writing the start tag, or if a filter further down the chain raises an exception.- See Also:
-
endElement
Write an end tag.If the element has contained other elements, the tag will appear indented on a new line; otherwise, it will appear immediately following whatever came before.
The newline and indentation will be passed on down the filter chain through regular characters events.
- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classXMLFilterImpl
- Parameters:
uri
- The element's Namespace URI.localName
- The element's local name.qName
- The element's qualified (prefixed) name.- Throws:
SAXException
- If there is an error writing the end tag, or if a filter further down the chain raises an exception.- See Also:
-
characters
Write a sequence of characters.- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classXMLFilterImpl
- Parameters:
ch
- The characters to write.start
- The starting position in the array.length
- The number of characters to use.- Throws:
SAXException
- If there is an error writing the characters, or if a filter further down the chain raises an exception.- See Also:
-
comment
- Specified by:
comment
in interfaceLexicalHandler
- Throws:
SAXException
-
startDTD
- Specified by:
startDTD
in interfaceLexicalHandler
- Throws:
SAXException
-
endDTD
- Specified by:
endDTD
in interfaceLexicalHandler
- Throws:
SAXException
-
startEntity
- Specified by:
startEntity
in interfaceLexicalHandler
- Throws:
SAXException
-
endEntity
- Specified by:
endEntity
in interfaceLexicalHandler
- Throws:
SAXException
-
startCDATA
- Specified by:
startCDATA
in interfaceLexicalHandler
- Throws:
SAXException
-
endCDATA
- Specified by:
endCDATA
in interfaceLexicalHandler
- Throws:
SAXException
-