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

java.lang.Object
  extended by org.apache.maven.plugin.tools.model.Parameter
All Implemented Interfaces:
java.io.Serializable

public class Parameter
extends java.lang.Object
implements java.io.Serializable

A parameter used by a mojo, and configurable from the command line or POM configuration sections.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Field Summary
private  java.lang.String alias
          Field alias
private  java.lang.String defaultValue
          Field defaultValue
private  java.lang.String deprecation
          Field deprecation
private  java.lang.String description
          Field description
private  java.lang.String expression
          Field expression
private  java.lang.String modelEncoding
           
private  java.lang.String name
          Field name
private  java.lang.String property
          Field property
private  boolean readonly
          Field readonly
private  boolean required
          Field required
private  java.lang.String type
          Field type
 
Constructor Summary
Parameter()
           
 
Method Summary
 java.lang.String getAlias()
          Get An alternate name for the parameter.
 java.lang.String getDefaultValue()
          Get An expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.
 java.lang.String getDeprecation()
          Get A deprecation message for this mojo parameter.
 java.lang.String getDescription()
          Get The description for this parameter.
 java.lang.String getExpression()
          Get The command-line reference to this parameter.
 java.lang.String getModelEncoding()
           
 java.lang.String getName()
          Get The parameter name
 java.lang.String getProperty()
          Get The JavaBeans property name to use to configure the mojo with this parameter.
 java.lang.String getType()
          Get The java type for this parameter.
 boolean isReadonly()
          Get Whether this parameter can be directly edited.
 boolean isRequired()
          Get Whether this parameter is required.
 void setAlias(java.lang.String alias)
          Set An alternate name for the parameter.
 void setDefaultValue(java.lang.String defaultValue)
          Set An expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.
 void setDeprecation(java.lang.String deprecation)
          Set A deprecation message for this mojo parameter.
 void setDescription(java.lang.String description)
          Set The description for this parameter.
 void setExpression(java.lang.String expression)
          Set The command-line reference to this parameter.
 void setModelEncoding(java.lang.String modelEncoding)
           
 void setName(java.lang.String name)
          Set The parameter name
 void setProperty(java.lang.String property)
          Set The JavaBeans property name to use to configure the mojo with this parameter.
 void setReadonly(boolean readonly)
          Set Whether this parameter can be directly edited.
 void setRequired(boolean required)
          Set Whether this parameter is required.
 void setType(java.lang.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
 

Field Detail

name

private java.lang.String name
Field name


alias

private java.lang.String alias
Field alias


property

private java.lang.String property
Field property


required

private boolean required
Field required


readonly

private boolean readonly
Field readonly


expression

private java.lang.String expression
Field expression


defaultValue

private java.lang.String defaultValue
Field defaultValue


type

private java.lang.String type
Field type


description

private java.lang.String description
Field description


deprecation

private java.lang.String deprecation
Field deprecation


modelEncoding

private java.lang.String modelEncoding
Constructor Detail

Parameter

public Parameter()
Method Detail

getAlias

public java.lang.String getAlias()
Get An alternate name for the parameter.


getDefaultValue

public java.lang.String getDefaultValue()
Get An expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system. (eg. ${project.build.directory} references project.getBuild().getDirectory())


getDeprecation

public java.lang.String getDeprecation()
Get A deprecation message for this mojo parameter.


getDescription

public java.lang.String getDescription()
Get The description for this parameter.


getExpression

public java.lang.String getExpression()
Get The command-line reference to this parameter.


getName

public java.lang.String getName()
Get The parameter name


getProperty

public java.lang.String getProperty()
Get The JavaBeans property name to use to configure the mojo with this parameter.


getType

public java.lang.String getType()
Get The java type for this parameter.


isReadonly

public boolean isReadonly()
Get Whether this parameter can be directly edited. If false, this param is either derived from another POM element, or refers to a runtime instance of the build system.


isRequired

public boolean isRequired()
Get Whether this parameter is required.


setAlias

public void setAlias(java.lang.String alias)
Set An alternate name for the parameter.

Parameters:
alias -

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
Set An expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system. (eg. ${project.build.directory} references project.getBuild().getDirectory())

Parameters:
defaultValue -

setDeprecation

public void setDeprecation(java.lang.String deprecation)
Set A deprecation message for this mojo parameter.

Parameters:
deprecation -

setDescription

public void setDescription(java.lang.String description)
Set The description for this parameter.

Parameters:
description -

setExpression

public void setExpression(java.lang.String expression)
Set The command-line reference to this parameter.

Parameters:
expression -

setName

public void setName(java.lang.String name)
Set The parameter name

Parameters:
name -

setProperty

public void setProperty(java.lang.String property)
Set The JavaBeans property name to use to configure the mojo with this parameter.

Parameters:
property -

setReadonly

public void setReadonly(boolean readonly)
Set Whether this parameter can be directly edited. If false, this param is either derived from another POM element, or refers to a runtime instance of the build system.

Parameters:
readonly -

setRequired

public void setRequired(boolean required)
Set Whether this parameter is required.

Parameters:
required -

setType

public void setType(java.lang.String type)
Set The java type for this parameter.

Parameters:
type -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()