org.eclipse.m2e.core.internal.content

Class PomHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.eclipse.m2e.core.internal.content.PomHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public final class PomHandler
extends org.xml.sax.helpers.DefaultHandler

An xml event handler for detecting the project top-level element in a POM file. Also records whether a default attribute is present for the project and if any typical Maven elements are present.

Since:

0.9.6

See Also:

org.eclipse.ant.internal.core.contentDescriber.AntHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	PomHandler.StopParsingException An exception indicating that the parsing should stop.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ARTIFACTID
private boolean	fArtifactIdFound
private javax.xml.parsers.SAXParserFactory	fFactory
private int	fLevel
private java.lang.String	fTopElementFound This is the name of the top-level element found in the XML file.
private static java.lang.String	PROJECT

Constructor Summary

Constructors

Constructor and Description
PomHandler()

Method Summary

Modifier and Type	Method and Description
private javax.xml.parsers.SAXParser	createParser(javax.xml.parsers.SAXParserFactory parserFactory) Creates a new SAX parser for use within this instance.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
private javax.xml.parsers.SAXParserFactory	getFactory()
protected boolean	hasArtifactIdElement()
protected boolean	hasRootProjectElement()
protected boolean	parseContents(org.xml.sax.InputSource contents)
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId)
void	startElement(java.lang.String uri, java.lang.String elementName, java.lang.String qualifiedName, org.xml.sax.Attributes attributes)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT

private static final java.lang.String PROJECT

See Also:

Constant Field Values

ARTIFACTID

private static final java.lang.String ARTIFACTID

See Also:

Constant Field Values

fTopElementFound

private java.lang.String fTopElementFound

This is the name of the top-level element found in the XML file. This member variable is null unless the file has been parsed successful to the point of finding the top-level element.

fFactory

private javax.xml.parsers.SAXParserFactory fFactory

fArtifactIdFound

private boolean fArtifactIdFound

fLevel

private int fLevel

Constructor Detail

PomHandler

public PomHandler()

Method Detail

createParser

private final javax.xml.parsers.SAXParser createParser(javax.xml.parsers.SAXParserFactory parserFactory)
                                                throws javax.xml.parsers.ParserConfigurationException,
                                                       org.xml.sax.SAXException,
                                                       org.xml.sax.SAXNotRecognizedException,
                                                       org.xml.sax.SAXNotSupportedException

Creates a new SAX parser for use within this instance.

Returns:

The newly created parser.

Throws:

javax.xml.parsers.ParserConfigurationException - If a parser of the given configuration cannot be created.

org.xml.sax.SAXException - If something in general goes wrong when creating the parser.

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getFactory

private javax.xml.parsers.SAXParserFactory getFactory()

parseContents

protected boolean parseContents(org.xml.sax.InputSource contents)
                         throws java.io.IOException,
                                javax.xml.parsers.ParserConfigurationException,
                                org.xml.sax.SAXException

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Overrides:

resolveEntity in class org.xml.sax.helpers.DefaultHandler

startElement

public final void startElement(java.lang.String uri,
                               java.lang.String elementName,
                               java.lang.String qualifiedName,
                               org.xml.sax.Attributes attributes)
                        throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

hasRootProjectElement

protected boolean hasRootProjectElement()

hasArtifactIdElement

protected boolean hasArtifactIdElement()