Package org.codehaus.mojo.flatten

Class FlattenDescriptor

java.lang.Object

org.codehaus.mojo.flatten.FlattenDescriptor

public class FlattenDescriptor
extends Object

The descriptor that defines the additional POM elements that should be kept and copied to flattened POM.

Since:

1.0.0-beta-2

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor	Description
FlattenDescriptor()	The constructor.
FlattenDescriptor(org.codehaus.plexus.util.xml.Xpp3Dom descriptor)	The constructor.

Method Summary

Modifier and Type	Method	Description
ElementHandling	getArtifactId()
ElementHandling	getBuild()
ElementHandling	getCiManagement()
ElementHandling	getContributors()
ElementHandling	getDefaultOperation()
ElementHandling	getDependencies()
ElementHandling	getDependencyManagement()
ElementHandling	getDescription()
ElementHandling	getDevelopers()
ElementHandling	getDistributionManagement()
ElementHandling	getGroupId()
ElementHandling	getHandling(PomProperty<?> property)	Generic method to get a ElementHandling.
ElementHandling	getInceptionYear()
ElementHandling	getIssueManagement()
ElementHandling	getMailingLists()
ElementHandling	getModules()
ElementHandling	getName()
ElementHandling	getOrganization()
ElementHandling	getPackaging()
ElementHandling	getParent()
ElementHandling	getPluginManagement()
ElementHandling	getPluginRepositories()
ElementHandling	getPrerequisites()
ElementHandling	getProfiles()
ElementHandling	getProperties()
ElementHandling	getReporting()
ElementHandling	getRepositories()
ElementHandling	getScm()
ElementHandling	getUrl()
ElementHandling	getVersion()
boolean	isEmpty()
FlattenDescriptor	merge(FlattenDescriptor descriptor)	Creates and returns a new FlattenDescriptor with the ElementHandlings merged from this and the given FlattenDescriptor.
void	setArtifactId(ElementHandling artifactId)
void	setBuild(ElementHandling build)
void	setCiManagement(ElementHandling ciManagement)
void	setContributors(ElementHandling contributors)
void	setDefaultOperation(ElementHandling defaultOperation)
void	setDependencies(ElementHandling dependencies)
void	setDependencyManagement(ElementHandling dependencyManagement)
void	setDescription(ElementHandling description)
void	setDevelopers(ElementHandling developers)
void	setDistributionManagement(ElementHandling distributionManagement)
void	setGroupId(ElementHandling groupId)
void	setHandling(PomProperty<?> property, ElementHandling handling)	Generic method to set an ElementHandling.
void	setInceptionYear(ElementHandling inceptionYear)
void	setIssueManagement(ElementHandling issueManagement)
void	setMailingLists(ElementHandling mailingLists)
void	setModules(ElementHandling modules)
void	setName(ElementHandling name)
void	setOrganization(ElementHandling organization)
void	setPackaging(ElementHandling packaging)
void	setParent(ElementHandling parent)
void	setPluginManagement(ElementHandling pluginManagement)
void	setPluginRepositories(ElementHandling pluginRepositories)
void	setPrerequisites(ElementHandling prerequisites)
void	setProfiles(ElementHandling profiles)
void	setProperties(ElementHandling properties)
void	setReporting(ElementHandling reporting)
void	setRepositories(ElementHandling repositories)
void	setScm(ElementHandling scm)
void	setUrl(ElementHandling url)
void	setVersion(ElementHandling version)

Methods inherited from class java.lang.Object

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

Constructor Details

FlattenDescriptor

public FlattenDescriptor()

The constructor.

FlattenDescriptor

public FlattenDescriptor(org.codehaus.plexus.util.xml.Xpp3Dom descriptor)

The constructor.

Parameters:

descriptor - is the raw Xpp3Dom from the MOJOs configuration.

Method Details

getDefaultOperation

public ElementHandling getDefaultOperation()

setDefaultOperation

public void setDefaultOperation(ElementHandling defaultOperation)

getHandling

public ElementHandling getHandling(PomProperty<?> property)

Generic method to get a ElementHandling.

Parameters:

property - is the PomProperty such as PomProperty.NAME.

Returns:

the ElementHandling. Will be flattened as fallback if undefined.

setHandling

public void setHandling(PomProperty<?> property,
 ElementHandling handling)

Generic method to set an ElementHandling.

Parameters:

property - is the PomProperty such as PomProperty.NAME.

handling - the new ElementHandling.

getArtifactId

public ElementHandling getArtifactId()

Returns:

ElementHandling for artifactId.

setArtifactId

public void setArtifactId(ElementHandling artifactId)

Parameters:

artifactId - the artifactId to set.

getGroupId

public ElementHandling getGroupId()

Returns:

ElementHandling for groupId.

setGroupId

public void setGroupId(ElementHandling groupId)

Parameters:

groupId - the groupId to set.

getPackaging

public ElementHandling getPackaging()

Returns:

ElementHandling for packaging.

setPackaging

public void setPackaging(ElementHandling packaging)

Parameters:

packaging - the packaging to set.

getName

public ElementHandling getName()

Returns:

ElementHandling for name.

setName

public void setName(ElementHandling name)

Parameters:

name - the name to set.

getDescription

public ElementHandling getDescription()

Returns:

ElementHandling for description.

setDescription

public void setDescription(ElementHandling description)

Parameters:

description - the description to set.

getUrl

public ElementHandling getUrl()

Returns:

ElementHandling for URL.

setUrl

public void setUrl(ElementHandling url)

Parameters:

url - the URL to set.

getInceptionYear

public ElementHandling getInceptionYear()

Returns:

ElementHandling for inceptionYear.

setInceptionYear

public void setInceptionYear(ElementHandling inceptionYear)

Parameters:

inceptionYear - the inceptionYear to set

getOrganization

public ElementHandling getOrganization()

Returns:

ElementHandling for organization.

setOrganization

public void setOrganization(ElementHandling organization)

Parameters:

organization - the organization to set.

getScm

public ElementHandling getScm()

Returns:

ElementHandling for SCM.

setScm

public void setScm(ElementHandling scm)

Parameters:

scm - the scm to set.

getPrerequisites

public ElementHandling getPrerequisites()

Returns:

ElementHandling for prerequisites.

setPrerequisites

public void setPrerequisites(ElementHandling prerequisites)

Parameters:

prerequisites - the prerequisites to set.

getDevelopers

public ElementHandling getDevelopers()

Returns:

ElementHandling for developers.

setDevelopers

public void setDevelopers(ElementHandling developers)

Parameters:

developers - the developers to set.

getContributors

public ElementHandling getContributors()

Returns:

ElementHandling for contributors.

setContributors

public void setContributors(ElementHandling contributors)

Parameters:

contributors - the contributors to set.

getMailingLists

public ElementHandling getMailingLists()

Returns:

ElementHandling for mailingLists.

setMailingLists

public void setMailingLists(ElementHandling mailingLists)

Parameters:

mailingLists - the mailingLists to set.

getRepositories

public ElementHandling getRepositories()

Returns:

ElementHandling for repositories.

setRepositories

public void setRepositories(ElementHandling repositories)

Parameters:

repositories - the repositories to set.

getPluginManagement

public ElementHandling getPluginManagement()

Returns:

ElementHandling for PluginConfiguration.getPluginManagement() pluginManagement}.

setPluginManagement

public void setPluginManagement(ElementHandling pluginManagement)

Parameters:

pluginManagement - the pluginManagement to set.

getPluginRepositories

public ElementHandling getPluginRepositories()

Returns:

ElementHandling for pluginRepositories.

setPluginRepositories

public void setPluginRepositories(ElementHandling pluginRepositories)

Parameters:

pluginRepositories - the pluginRepositories to set.

getIssueManagement

public ElementHandling getIssueManagement()

Returns:

ElementHandling for issueManagement.

setIssueManagement

public void setIssueManagement(ElementHandling issueManagement)

Parameters:

issueManagement - the issueManagement to set.

getCiManagement

public ElementHandling getCiManagement()

Returns:

ElementHandling for ciManagement.

setCiManagement

public void setCiManagement(ElementHandling ciManagement)

Parameters:

ciManagement - the ciManagement to set.

getDistributionManagement

public ElementHandling getDistributionManagement()

Returns:

ElementHandling for distributionManagement.

setDistributionManagement

public void setDistributionManagement(ElementHandling distributionManagement)

Parameters:

distributionManagement - the distributionManagement to set.

getDependencyManagement

public ElementHandling getDependencyManagement()

Returns:

ElementHandling for dependencyManagement.

setDependencyManagement

public void setDependencyManagement(ElementHandling dependencyManagement)

Parameters:

dependencyManagement - the dependencyManagement to set.

getBuild

public ElementHandling getBuild()

Returns:

ElementHandling for build.

setBuild

public void setBuild(ElementHandling build)

Parameters:

build - the build to set.

getParent

public ElementHandling getParent()

Returns:

ElementHandling for parent.

setParent

public void setParent(ElementHandling parent)

Parameters:

parent - the parent to set.

getModules

public ElementHandling getModules()

Returns:

ElementHandling for modules.

setModules

public void setModules(ElementHandling modules)

Parameters:

modules - the modules to set.

getProperties

public ElementHandling getProperties()

Returns:

ElementHandling for properties.

setProperties

public void setProperties(ElementHandling properties)

Parameters:

properties - the properties to set.

getReporting

public ElementHandling getReporting()

Returns:

ElementHandling for reporting.

setReporting

public void setReporting(ElementHandling reporting)

Parameters:

reporting - the reporting to set.

getDependencies

public ElementHandling getDependencies()

Returns:

ElementHandling for dependencies.

setDependencies

public void setDependencies(ElementHandling dependencies)

Parameters:

dependencies - the dependencies to set.

getProfiles

public ElementHandling getProfiles()

Returns:

ElementHandling for profiles.

setProfiles

public void setProfiles(ElementHandling profiles)

Parameters:

profiles - the profiles to set.

getVersion

public ElementHandling getVersion()

Returns:

ElementHandling for version.

setVersion

public void setVersion(ElementHandling version)

Parameters:

version - the version to set.

merge

public FlattenDescriptor merge(FlattenDescriptor descriptor)

Creates and returns a new FlattenDescriptor with the ElementHandlings merged from this and the given FlattenDescriptor.

Parameters:

descriptor - is the FlattenDescriptor to merge with this one.

Returns:

the merged FlattenDescriptor.

isEmpty

public boolean isEmpty()

Returns:

true if none of the properties has been set explicitly, false otherwise.