Package org.apache.ivy.plugins.parser.m2

Class PomReader

java.lang.Object

org.apache.ivy.plugins.parser.m2.PomReader

public class PomReader
extends java.lang.Object

Provides the method to read some data out of the DOM tree of a pom file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PomReader.AddDTDFilterInputStream
class	PomReader.PomDependencyData
class	PomReader.PomDependencyMgtElement
class	PomReader.PomPluginElement
class	PomReader.PomProfileElement

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	ARTIFACT_ID
private static java.lang.String	CLASSIFIER
private static java.lang.String	DEPENDENCIES
private static java.lang.String	DEPENDENCY
private static java.lang.String	DEPENDENCY_MGT
private static java.lang.String	DESCRIPTION
private static java.lang.String	DISTRIBUTION_MGT
private static java.lang.String	EXCLUSION
private static java.lang.String	EXCLUSIONS
private static java.lang.String	GROUP_ID
private static java.lang.String	HOMEPAGE
private static java.lang.String	LICENSE
private static java.lang.String	LICENSE_NAME
private static java.lang.String	LICENSE_URL
private static java.lang.String	LICENSES
private static java.lang.String	MODEL
private static java.lang.String	OPTIONAL
private static java.lang.String	PACKAGING
private static java.lang.String	PARENT
private org.w3c.dom.Element	parentElement
private static java.lang.String	PLUGIN
private static java.lang.String	PLUGINS
private static java.lang.String	PROFILE
private static java.lang.String	PROFILES_ELEMENT
private static java.lang.String	PROJECT
private org.w3c.dom.Element	projectElement
private java.util.Map<java.lang.String,java.lang.String>	properties
private static java.lang.String	PROPERTIES
private static java.lang.String	RELOCATION
private static java.lang.String	SCOPE
private static java.lang.String	TYPE
private static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor	Description
PomReader(java.net.URL descriptorURL, Resource res)

Method Summary

Modifier and Type	Method	Description
private static java.util.List<org.w3c.dom.Element>	getAllChilds(org.w3c.dom.Element parent)
java.lang.String	getArtifactId()
java.util.List<PomReader.PomDependencyData>	getDependencies()
private java.util.List<PomReader.PomDependencyData>	getDependencies(org.w3c.dom.Element parent)
java.util.List<PomDependencyMgt>	getDependencyMgt()
private java.util.List<PomDependencyMgt>	getDependencyMgt(org.w3c.dom.Element parent)
java.lang.String	getDescription()
private static org.w3c.dom.Element	getFirstChildElement(org.w3c.dom.Element parentElem, java.lang.String name)
private static java.lang.String	getFirstChildText(org.w3c.dom.Element parentElem, java.lang.String name)
java.lang.String	getGroupId()
java.lang.String	getHomePage()
License[]	getLicenses()
java.lang.String	getPackaging()
java.lang.String	getParentArtifactId()
java.lang.String	getParentGroupId()
java.lang.String	getParentVersion()
java.util.List<PomReader.PomPluginElement>	getPlugins()
private java.util.List<PomReader.PomPluginElement>	getPlugins(org.w3c.dom.Element parent)
java.util.Map<java.lang.String,java.lang.String>	getPomProperties()
java.util.List<PomReader.PomProfileElement>	getProfiles()
private static java.util.Map<java.lang.String,java.lang.String>	getProperties(org.w3c.dom.Element parent)
ModuleRevisionId	getRelocation()
private static java.lang.String	getTextContent(org.w3c.dom.Element element)
java.lang.String	getVersion()
boolean	hasParent()
private java.lang.String	replaceProps(java.lang.String val)
void	setProperty(java.lang.String prop, java.lang.String val)	Add a property if not yet set and value is not null.

Methods inherited from class java.lang.Object

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

Field Detail

PROFILES_ELEMENT

private static final java.lang.String PROFILES_ELEMENT

See Also:

Constant Field Values

PACKAGING

private static final java.lang.String PACKAGING

See Also:

Constant Field Values

DEPENDENCY

private static final java.lang.String DEPENDENCY

See Also:

Constant Field Values

DEPENDENCIES

private static final java.lang.String DEPENDENCIES

See Also:

Constant Field Values

DEPENDENCY_MGT

private static final java.lang.String DEPENDENCY_MGT

See Also:

Constant Field Values

PROJECT

private static final java.lang.String PROJECT

See Also:

Constant Field Values

MODEL

private static final java.lang.String MODEL

See Also:

Constant Field Values

GROUP_ID

private static final java.lang.String GROUP_ID

See Also:

Constant Field Values

ARTIFACT_ID

private static final java.lang.String ARTIFACT_ID

See Also:

Constant Field Values

VERSION

private static final java.lang.String VERSION

See Also:

Constant Field Values

DESCRIPTION

private static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

HOMEPAGE

private static final java.lang.String HOMEPAGE

See Also:

Constant Field Values

LICENSES

private static final java.lang.String LICENSES

See Also:

Constant Field Values

LICENSE

private static final java.lang.String LICENSE

See Also:

Constant Field Values

LICENSE_NAME

private static final java.lang.String LICENSE_NAME

See Also:

Constant Field Values

LICENSE_URL

private static final java.lang.String LICENSE_URL

See Also:

Constant Field Values

PARENT

private static final java.lang.String PARENT

See Also:

Constant Field Values

SCOPE

private static final java.lang.String SCOPE

See Also:

Constant Field Values

CLASSIFIER

private static final java.lang.String CLASSIFIER

See Also:

Constant Field Values

OPTIONAL

private static final java.lang.String OPTIONAL

See Also:

Constant Field Values

EXCLUSIONS

private static final java.lang.String EXCLUSIONS

See Also:

Constant Field Values

EXCLUSION

private static final java.lang.String EXCLUSION

See Also:

Constant Field Values

DISTRIBUTION_MGT

private static final java.lang.String DISTRIBUTION_MGT

See Also:

Constant Field Values

RELOCATION

private static final java.lang.String RELOCATION

See Also:

Constant Field Values

PROPERTIES

private static final java.lang.String PROPERTIES

See Also:

Constant Field Values

PLUGINS

private static final java.lang.String PLUGINS

See Also:

Constant Field Values

PLUGIN

private static final java.lang.String PLUGIN

See Also:

Constant Field Values

TYPE

private static final java.lang.String TYPE

See Also:

Constant Field Values

PROFILE

private static final java.lang.String PROFILE

See Also:

Constant Field Values

properties

private final java.util.Map<java.lang.String,java.lang.String> properties

projectElement

private final org.w3c.dom.Element projectElement

parentElement

private final org.w3c.dom.Element parentElement

Constructor Detail

PomReader

public PomReader(java.net.URL descriptorURL,
                 Resource res)
          throws java.io.IOException,
                 org.xml.sax.SAXException

Throws:

java.io.IOException

org.xml.sax.SAXException

Method Detail

hasParent

public boolean hasParent()

setProperty

public void setProperty(java.lang.String prop,
                        java.lang.String val)

Add a property if not yet set and value is not null. This guarantees that property keeps the first value that is put on it and that the properties are never null.

Parameters:

prop - String

val - String

getGroupId

public java.lang.String getGroupId()

getParentGroupId

public java.lang.String getParentGroupId()

getArtifactId

public java.lang.String getArtifactId()

getParentArtifactId

public java.lang.String getParentArtifactId()

getVersion

public java.lang.String getVersion()

getParentVersion

public java.lang.String getParentVersion()

getPackaging

public java.lang.String getPackaging()

getHomePage

public java.lang.String getHomePage()

getDescription

public java.lang.String getDescription()

getLicenses

public License[] getLicenses()

getRelocation

public ModuleRevisionId getRelocation()

getDependencies

public java.util.List<PomReader.PomDependencyData> getDependencies()

getDependencies

private java.util.List<PomReader.PomDependencyData> getDependencies(org.w3c.dom.Element parent)

getDependencyMgt

public java.util.List<PomDependencyMgt> getDependencyMgt()

getDependencyMgt

private java.util.List<PomDependencyMgt> getDependencyMgt(org.w3c.dom.Element parent)

getProfiles

public java.util.List<PomReader.PomProfileElement> getProfiles()

getPlugins

public java.util.List<PomReader.PomPluginElement> getPlugins()

getPlugins

private java.util.List<PomReader.PomPluginElement> getPlugins(org.w3c.dom.Element parent)

getProperties

private static java.util.Map<java.lang.String,java.lang.String> getProperties(org.w3c.dom.Element parent)

getPomProperties

public java.util.Map<java.lang.String,java.lang.String> getPomProperties()

Returns:

the content of the properties tag into the pom.

replaceProps

private java.lang.String replaceProps(java.lang.String val)

getTextContent

private static java.lang.String getTextContent(org.w3c.dom.Element element)

getFirstChildText

private static java.lang.String getFirstChildText(org.w3c.dom.Element parentElem,
                                                  java.lang.String name)

getFirstChildElement

private static org.w3c.dom.Element getFirstChildElement(org.w3c.dom.Element parentElem,
                                                        java.lang.String name)

getAllChilds

private static java.util.List<org.w3c.dom.Element> getAllChilds(org.w3c.dom.Element parent)