Class FlattenMojo.SaxHeaderCommentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.xml.sax.ext.DefaultHandler2

org.codehaus.mojo.flatten.FlattenMojo.SaxHeaderCommentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

Enclosing class:

FlattenMojo

private class FlattenMojo.SaxHeaderCommentHandler
extends DefaultHandler2

This class is a simple SAX handler that extracts the first comment located before the root tag in an XML document.

Field Summary

Fields

Modifier and Type	Field	Description
private String	headerComment
private boolean	rootTagSeen	true if root tag has already been visited, false otherwise.

Constructor Summary

Constructors

Constructor	Description
SaxHeaderCommentHandler()	The constructor.

Method Summary

Modifier and Type	Method	Description
void	comment(char[] ch, int start, int length)
String	getHeaderComment()
void	startElement(String uri, String localName, String qName, Attributes attrs)

Methods inherited from class DefaultHandler2

attributeDecl, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, getExternalSubset, internalEntityDecl, resolveEntity, resolveEntity, startCDATA, startDTD, startEntity

Methods inherited from class DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Field Details

rootTagSeen

private boolean rootTagSeen

true if root tag has already been visited, false otherwise.

headerComment

private String headerComment

See Also:

• getHeaderComment()

Constructor Details

SaxHeaderCommentHandler

SaxHeaderCommentHandler()

The constructor.

Method Details

getHeaderComment

public String getHeaderComment()

Returns:

the XML comment from the header of the document or null if not present.

comment

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

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class DefaultHandler2

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attrs)

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler