org.apache.maven.plugin.descriptor.model
Class Parameter

java.lang.Object
  org.apache.maven.plugin.descriptor.model.Parameter

All Implemented Interfaces:

Serializable

public class Parameter
extends Object
implements Serializable

A phase mapping definition.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Parameter()

Method Summary

String	getAlias() Get specifies an alias which can be used to configure this parameter from the POM.
String	getDeprecated() Get specify the version when the parameter was deprecated to the API.
String	getDescription() Get the description of this parameter's use inside the Mojo.
String	getImplementation() Get the implementation field.
String	getName() Get the name of the parameter, to be used in configuring this parameter from the Mojo's declared defaults or from the POM.
String	getSince() Get specify the version when the parameter was added to the API.
String	getType() Get the Java type for this parameter.
boolean	isEditable() Get specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
boolean	isRequired() Get whether this parameter is required for the Mojo to function.
void	setAlias(String alias) Set specifies an alias which can be used to configure this parameter from the POM.
void	setDeprecated(String deprecated) Set specify the version when the parameter was deprecated to the API.
void	setDescription(String description) Set the description of this parameter's use inside the Mojo.
void	setEditable(boolean editable) Set specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
void	setImplementation(String implementation) Set the implementation field.
void	setName(String name) Set the name of the parameter, to be used in configuring this parameter from the Mojo's declared defaults or from the POM.
void	setRequired(boolean required) Set whether this parameter is required for the Mojo to function.
void	setSince(String since) Set specify the version when the parameter was added to the API.
void	setType(String type) Set the Java type for this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter()

Method Detail

getAlias

public String getAlias()

Get specifies an alias which can be used to configure this parameter from the POM. This is primarily useful to improve user-friendliness, where Mojo field names are not intuitive to the user or are otherwise not conducive to configuration via the POM.

Returns:

String

getDeprecated

public String getDeprecated()

Get specify the version when the parameter was deprecated to the API. Similar to Javadoc deprecated. This will trigger a warning when a user tries to configure a parameter marked as deprecated.

Returns:

String

getDescription

public String getDescription()

Get the description of this parameter's use inside the Mojo.

Returns:

String

getImplementation

public String getImplementation()

Get the implementation field.

Returns:

String

getName

public String getName()

Get the name of the parameter, to be used in configuring this parameter from the Mojo's declared defaults or from the POM.

Returns:

String

getSince

public String getSince()

Get specify the version when the parameter was added to the API. Similar to Javadoc since.

Returns:

String

getType

public String getType()

Get the Java type for this parameter. This is used to validate the result of any expressions used to calculate the value which should be injected into the Mojo for this parameter.

Returns:

String

isEditable

public boolean isEditable()

Get specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration). This is useful when you want to force the user to use common POM elements rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify <build><finalName/></build> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.

Returns:

boolean

isRequired

public boolean isRequired()

Get whether this parameter is required for the Mojo to function. This is used to validate the configuration for a Mojo before it is injected, and before the Mojo is executed from some half-state.

Returns:

boolean

setAlias

public void setAlias(String alias)

Set specifies an alias which can be used to configure this parameter from the POM. This is primarily useful to improve user-friendliness, where Mojo field names are not intuitive to the user or are otherwise not conducive to configuration via the POM.

Parameters:

alias -

setDeprecated

public void setDeprecated(String deprecated)

Set specify the version when the parameter was deprecated to the API. Similar to Javadoc deprecated. This will trigger a warning when a user tries to configure a parameter marked as deprecated.

Parameters:

deprecated -

setDescription

public void setDescription(String description)

Set the description of this parameter's use inside the Mojo.

Parameters:

description -

setEditable

public void setEditable(boolean editable)

Set specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration). This is useful when you want to force the user to use common POM elements rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify <build><finalName/></build> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.

Parameters:

editable -

setImplementation

public void setImplementation(String implementation)

Set the implementation field.

Parameters:

implementation -

setName

public void setName(String name)

Set the name of the parameter, to be used in configuring this parameter from the Mojo's declared defaults or from the POM.

Parameters:

name -

setRequired

public void setRequired(boolean required)

Set whether this parameter is required for the Mojo to function. This is used to validate the configuration for a Mojo before it is injected, and before the Mojo is executed from some half-state.

Parameters:

required -

setSince

public void setSince(String since)

Set specify the version when the parameter was added to the API. Similar to Javadoc since.

Parameters:

since -

setType

public void setType(String type)

Set the Java type for this parameter. This is used to validate the result of any expressions used to calculate the value which should be injected into the Mojo for this parameter.

Parameters:

type -