Package org.codehaus.mojo.flatten

Class PomProperty<V>

java.lang.Object

org.codehaus.mojo.flatten.PomProperty<V>

Type Parameters:

V - is the generic type of the property value.

public abstract class PomProperty<V>
extends Object

This class reflects a property of a POM. It contains all available properties as constants and allows generic access to read and write the property via a Model.

Since:

1.0.0-beta-4

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final PomProperty<String>	ARTIFACT_ID
static final PomProperty<Build>	BUILD
static final PomProperty<CiManagement>	CI_MANAGEMENT
static final PomProperty<List<Contributor>>	CONTRIBUTORS
static final PomProperty<List<Dependency>>	DEPENDENCIES
static final PomProperty<DependencyManagement>	DEPENDENCY_MANAGEMENT
static final PomProperty<String>	DESCRIPTION
static final PomProperty<List<Developer>>	DEVELOPERS
static final PomProperty<DistributionManagement>	DISTRIBUTION_MANAGEMENT
static final PomProperty<String>	GROUP_ID
static final PomProperty<String>	INCEPTION_YEAR
static final PomProperty<IssueManagement>	ISSUE_MANAGEMENT
static final PomProperty<List<License>>	LICENSES
static final PomProperty<List<MailingList>>	MAILING_LISTS
static final PomProperty<String>	MODEL_ENCODING
static final PomProperty<String>	MODEL_VERSION
static final PomProperty<List<String>>	MODULES
static final PomProperty<String>	NAME
static final PomProperty<Organization>	ORGANIZATION
static final PomProperty<String>	PACKAGING
static final PomProperty<Parent>	PARENT
static final PomProperty<PluginManagement>	PLUGIN_MANAGEMENT
static final PomProperty<List<Repository>>	PLUGIN_REPOSITORIES
static final PomProperty<File>	POM_FILE
static final PomProperty<Prerequisites>	PREREQUISITES
static final PomProperty<List<Profile>>	PROFILES
static final PomProperty<Properties>	PROPERTIES
static final PomProperty<Reporting>	REPORTING
static final PomProperty<List<Repository>>	REPOSITORIES
static final PomProperty<Scm>	SCM
static final PomProperty<String>	URL
static final PomProperty<String>	VERSION

Constructor Summary

Constructors

Constructor	Description
PomProperty(String name, Class<V> valueType)	The constructor.

Method Summary

Modifier and Type	Method	Description
void	copy(Model source, Model target)	Copies the value identified by this PomProperty from the given source Model to the given target Model.
abstract V	get(Model model)	Generic getter for reading a PomProperty from a Model.
String	getName()
static List<PomProperty<?>>	getPomProperties()
Class<V>	getValueType()
boolean	isElement()
boolean	isRequired()
abstract void	set(Model model, V value)	Generic setter for writing a PomProperty in a Model.

Methods inherited from class java.lang.Object

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

Field Details

ARTIFACT_ID

public static final PomProperty<String> ARTIFACT_ID

See Also:

• Model.getArtifactId()

BUILD

public static final PomProperty<Build> BUILD

See Also:

• Model.getBuild()

CI_MANAGEMENT

public static final PomProperty<CiManagement> CI_MANAGEMENT

See Also:

• Model.getCiManagement()

CONTRIBUTORS

public static final PomProperty<List<Contributor>> CONTRIBUTORS

See Also:

• Model.getContributors()

DEPENDENCIES

public static final PomProperty<List<Dependency>> DEPENDENCIES

See Also:

• ModelBase.getDependencies()

DEPENDENCY_MANAGEMENT

public static final PomProperty<DependencyManagement> DEPENDENCY_MANAGEMENT

See Also:

• ModelBase.getDependencyManagement()

DESCRIPTION

public static final PomProperty<String> DESCRIPTION

See Also:

• Model.getDescription()

DEVELOPERS

public static final PomProperty<List<Developer>> DEVELOPERS

See Also:

• Model.getDevelopers()

DISTRIBUTION_MANAGEMENT

public static final PomProperty<DistributionManagement> DISTRIBUTION_MANAGEMENT

See Also:

• ModelBase.getDistributionManagement()

GROUP_ID

public static final PomProperty<String> GROUP_ID

See Also:

• Model.getGroupId()

INCEPTION_YEAR

public static final PomProperty<String> INCEPTION_YEAR

See Also:

• Model.getInceptionYear()

ISSUE_MANAGEMENT

public static final PomProperty<IssueManagement> ISSUE_MANAGEMENT

See Also:

• Model.getIssueManagement()

LICENSES

public static final PomProperty<List<License>> LICENSES

See Also:

• Model.getLicenses()

MAILING_LISTS

public static final PomProperty<List<MailingList>> MAILING_LISTS

See Also:

• Model.getMailingLists()

MODEL_ENCODING

public static final PomProperty<String> MODEL_ENCODING

See Also:

• Model.getModelEncoding()

MODEL_VERSION

public static final PomProperty<String> MODEL_VERSION

See Also:

• Model.getModelVersion()

MODULES

public static final PomProperty<List<String>> MODULES

See Also:

• ModelBase.getModules()

NAME

public static final PomProperty<String> NAME

See Also:

• Model.getName()

ORGANIZATION

public static final PomProperty<Organization> ORGANIZATION

See Also:

• Model.getOrganization()

PACKAGING

public static final PomProperty<String> PACKAGING

See Also:

• Model.getPackaging()

PARENT

public static final PomProperty<Parent> PARENT

See Also:

• Model.getParent()

PLUGIN_MANAGEMENT

public static final PomProperty<PluginManagement> PLUGIN_MANAGEMENT

See Also:

• PluginConfiguration.getPluginManagement()

PLUGIN_REPOSITORIES

public static final PomProperty<List<Repository>> PLUGIN_REPOSITORIES

See Also:

• ModelBase.getPluginRepositories()

POM_FILE

public static final PomProperty<File> POM_FILE

See Also:

• Model.getPomFile()

PREREQUISITES

public static final PomProperty<Prerequisites> PREREQUISITES

See Also:

• Model.getPrerequisites()

PROFILES

public static final PomProperty<List<Profile>> PROFILES

See Also:

• Model.getProfiles()

PROPERTIES

public static final PomProperty<Properties> PROPERTIES

See Also:

• ModelBase.getProperties()

REPORTING

public static final PomProperty<Reporting> REPORTING

See Also:

• ModelBase.getReporting()

REPOSITORIES

public static final PomProperty<List<Repository>> REPOSITORIES

See Also:

• ModelBase.getPluginRepositories()

SCM

public static final PomProperty<Scm> SCM

See Also:

• Model.getScm()

URL

public static final PomProperty<String> URL

See Also:

• Model.getUrl()

VERSION

public static final PomProperty<String> VERSION

See Also:

• Model.getVersion()

Constructor Details

PomProperty

public PomProperty(String name,
 Class<V> valueType)

The constructor.

Parameters:

name - - see getName().

valueType - - see getValueType().

Method Details

getName

public String getName()

Returns:

name

getValueType

public Class<V> getValueType()

Returns:

Class reflecting the type of the property value.

isRequired

public boolean isRequired()

Returns:

true if required for flattened POM, false otherwise.

isElement

public boolean isElement()

Returns:

true if this property represents an XML element of the POM representation, false otherwise (if an internal property such as Model.getPomFile()).

get

public abstract V get(Model model)

Generic getter for reading a PomProperty from a Model.

Parameters:

model - is the Model to read from.

Returns:

the value of the property to read identified by this PomProperty.

set

public abstract void set(Model model,
 V value)

Generic setter for writing a PomProperty in a Model.

Parameters:

model - is the Model to write to.

value - is the value of the property to write identified by this PomProperty.

copy

public void copy(Model source,
 Model target)

Copies the value identified by this PomProperty from the given source Model to the given target Model.

Parameters:

source - is the Model to copy from (read).

target - is the Model to copy to (write).

getPomProperties

public static List<PomProperty<?>> getPomProperties()

Returns:

an unmodifiable List with all properties.