- java.lang.Object
-
- org.xml.sax.helpers.XMLFilterImpl
-
- com.sun.xml.txw2.output.IndentingXMLFilter
-
- All Implemented Interfaces:
ContentHandler,DTDHandler,EntityResolver,ErrorHandler,LexicalHandler,XMLFilter,XMLReader
public class IndentingXMLFilter extends XMLFilterImpl implements LexicalHandler
XMLFilterImplthat does indentation to SAX events.- Author:
- Kohsuke Kawaguchi
-
-
Constructor Summary
Constructors Constructor Description IndentingXMLFilter()IndentingXMLFilter(ContentHandler handler)IndentingXMLFilter(ContentHandler handler, LexicalHandler lexical)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidcharacters(char[] ch, int start, int length)Write a sequence of characters.voidcomment(char[] ch, int start, int length)voidendCDATA()voidendDTD()voidendElement(String uri, String localName, String qName)Write an end tag.voidendEntity(String name)intgetIndentStep()Deprecated.Only return the length of the indent string.LexicalHandlergetLexicalHandler()voidsetIndentStep(int indentStep)Deprecated.Should use the version that takes string.voidsetIndentStep(String s)voidsetLexicalHandler(LexicalHandler lexical)voidstartCDATA()voidstartDTD(String name, String publicId, String systemId)voidstartElement(String uri, String localName, String qName, Attributes atts)Write a start tag.voidstartEntity(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
-
-
-
-
Constructor Detail
-
IndentingXMLFilter
public IndentingXMLFilter()
-
IndentingXMLFilter
public IndentingXMLFilter(ContentHandler handler)
-
IndentingXMLFilter
public IndentingXMLFilter(ContentHandler handler, LexicalHandler lexical)
-
-
Method Detail
-
getLexicalHandler
public LexicalHandler getLexicalHandler()
-
setLexicalHandler
public void setLexicalHandler(LexicalHandler lexical)
-
getIndentStep
@Deprecated 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(int)
-
setIndentStep
@Deprecated 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:
getIndentStep()
-
setIndentStep
public void setIndentStep(String s)
-
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:
startElementin interfaceContentHandler- Overrides:
startElementin 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:
XMLWriter.startElement(String, String, String,Attributes)
-
endElement
public void endElement(String uri, String localName, String qName) throws SAXException
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:
endElementin interfaceContentHandler- Overrides:
endElementin 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:
XMLWriter.endElement(String, String, String)
-
characters
public void characters(char[] ch, int start, int length) throws SAXExceptionWrite a sequence of characters.- Specified by:
charactersin interfaceContentHandler- Overrides:
charactersin 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:
XMLWriter.characters(char[], int, int)
-
comment
public void comment(char[] ch, int start, int length) throws SAXException- Specified by:
commentin interfaceLexicalHandler- Throws:
SAXException
-
startDTD
public void startDTD(String name, String publicId, String systemId) throws SAXException
- Specified by:
startDTDin interfaceLexicalHandler- Throws:
SAXException
-
endDTD
public void endDTD() throws SAXException- Specified by:
endDTDin interfaceLexicalHandler- Throws:
SAXException
-
startEntity
public void startEntity(String name) throws SAXException
- Specified by:
startEntityin interfaceLexicalHandler- Throws:
SAXException
-
endEntity
public void endEntity(String name) throws SAXException
- Specified by:
endEntityin interfaceLexicalHandler- Throws:
SAXException
-
startCDATA
public void startCDATA() throws SAXException- Specified by:
startCDATAin interfaceLexicalHandler- Throws:
SAXException
-
endCDATA
public void endCDATA() throws SAXException- Specified by:
endCDATAin interfaceLexicalHandler- Throws:
SAXException
-
-