Package org.codehaus.mojo.xml.format

Class IndentCheckSaxHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.codehaus.mojo.xml.format.IndentCheckSaxHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class IndentCheckSaxHandler
extends DefaultHandler

A DefaultHandler implementation that detects formatting violations and reports them to the supplied XmlFormatViolationHandler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	IndentCheckSaxHandler.ElementEntry	An entry that can be stored on a stack
private static class	IndentCheckSaxHandler.Indent	An indent occurrence within a file characterized by IndentCheckSaxHandler.Indent.lineNumber and IndentCheckSaxHandler.Indent.size.

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	charBuffer
private int	charLineNumber
private final File	file	The file being checked
private final int	indentSize	The number of spaces for indentation
private IndentCheckSaxHandler.Indent	lastIndent
private Locator	locator	The locator set by SAXParser
private Deque<IndentCheckSaxHandler.ElementEntry>	stack	The element stack
private final XmlFormatViolationHandler	violationHandler	The XmlFormatViolationHandler for reporting found violations

Constructor Summary

Constructors

Constructor	Description
IndentCheckSaxHandler(File file, int indentSize, XmlFormatViolationHandler violationHandler)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Stores the passed characters into a character buffer.
void	endElement(String uri, String localName, String qName)	Checks indentation for an end element.
private void	flushCharacters()	Sets lastIndent based on charBuffer and resets charBuffer.
void	ignorableWhitespace(char[] chars, int start, int length)	Just delegates to characters(char[], int, int), since this method is not called in all situations where it could be naively expected.
InputSource	resolveEntity(String publicId, String systemId)	Always returns an empty InputSource to avoid loading of any DTDs.
void	setDocumentLocator(Locator locator)
void	startElement(String uri, String localName, String qName, Attributes attributes)	Checks indentation for a start element.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, error, fatalError, notationDecl, processingInstruction, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Field Details

charBuffer

private final StringBuilder charBuffer

charLineNumber

private int charLineNumber

file

private final File file

The file being checked

indentSize

private final int indentSize

The number of spaces for indentation

lastIndent

private IndentCheckSaxHandler.Indent lastIndent

locator

private Locator locator

The locator set by SAXParser

stack

private Deque<IndentCheckSaxHandler.ElementEntry> stack

The element stack

violationHandler

private final XmlFormatViolationHandler violationHandler

The XmlFormatViolationHandler for reporting found violations

Constructor Details

IndentCheckSaxHandler

public IndentCheckSaxHandler(File file,
 int indentSize,
 XmlFormatViolationHandler violationHandler)

Method Details

characters

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

Stores the passed characters into a character buffer.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.characters(char[], int, int)

endElement

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

Checks indentation for an end element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

See Also:

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

flushCharacters

private void flushCharacters()

Sets lastIndent based on charBuffer and resets charBuffer.

ignorableWhitespace

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

Just delegates to characters(char[], int, int), since this method is not called in all situations where it could be naively expected.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.ignorableWhitespace(char[], int, int)

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException,
IOException

Always returns an empty InputSource to avoid loading of any DTDs.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Throws:

SAXException

IOException

See Also:

• DefaultHandler.resolveEntity(java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

See Also:

• DefaultHandler.setDocumentLocator(org.xml.sax.Locator)

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Checks indentation for a start element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

See Also:

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