|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.tools.model.Parameter
public class Parameter
A parameter used by a mojo, and configurable from the command line or POM configuration sections.
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 |
---|
private java.lang.String name
private java.lang.String alias
private java.lang.String property
private boolean required
private boolean readonly
private java.lang.String expression
private java.lang.String defaultValue
private java.lang.String type
private java.lang.String description
private java.lang.String deprecation
private java.lang.String modelEncoding
Constructor Detail |
---|
public Parameter()
Method Detail |
---|
public java.lang.String getAlias()
public java.lang.String getDefaultValue()
public java.lang.String getDeprecation()
public java.lang.String getDescription()
public java.lang.String getExpression()
public java.lang.String getName()
public java.lang.String getProperty()
public java.lang.String getType()
public boolean isReadonly()
public boolean isRequired()
public void setAlias(java.lang.String alias)
alias
- public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- public void setDeprecation(java.lang.String deprecation)
deprecation
- public void setDescription(java.lang.String description)
description
- public void setExpression(java.lang.String expression)
expression
- public void setName(java.lang.String name)
name
- public void setProperty(java.lang.String property)
property
- public void setReadonly(boolean readonly)
readonly
- public void setRequired(boolean required)
required
- public void setType(java.lang.String type)
type
- public void setModelEncoding(java.lang.String modelEncoding)
public java.lang.String getModelEncoding()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |