public class Parameter extends Object implements Serializable
Constructor and Description |
---|
Parameter() |
Modifier and Type | Method and Description |
---|---|
String |
getAlias()
Get an alternate name for the parameter.
|
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.
|
String |
getDeprecation()
Get a deprecation message for this mojo parameter.
|
String |
getDescription()
Get the description for this parameter.
|
String |
getExpression()
Get the command-line reference to this parameter.
|
String |
getName()
Get the parameter name.
|
String |
getProperty()
Get the JavaBeans property name to use to configure the mojo
with this parameter.
|
String |
getSince()
Get version when the parameter was added.
|
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(String alias)
Set an alternate name for the parameter.
|
void |
setDefaultValue(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(String deprecation)
Set a deprecation message for this mojo parameter.
|
void |
setDescription(String description)
Set the description for this parameter.
|
void |
setExpression(String expression)
Set the command-line reference to this parameter.
|
void |
setName(String name)
Set the parameter name.
|
void |
setProperty(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 |
setSince(String since)
Set version when the parameter was added.
|
void |
setType(String type)
Set the java type for this parameter.
|
public String getAlias()
public String getDefaultValue()
public String getDeprecation()
public String getDescription()
public String getExpression()
public String getName()
public String getProperty()
public String getSince()
public String getType()
public boolean isReadonly()
public boolean isRequired()
public void setAlias(String alias)
alias
- a alias object.public void setDefaultValue(String defaultValue)
defaultValue
- a defaultValue object.public void setDeprecation(String deprecation)
deprecation
- a deprecation object.public void setDescription(String description)
description
- a description object.public void setExpression(String expression)
expression
- a expression object.public void setName(String name)
name
- a name object.public void setProperty(String property)
property
- a property object.public void setReadonly(boolean readonly)
readonly
- a readonly object.public void setRequired(boolean required)
required
- a required object.public void setSince(String since)
since
- a since object.public void setType(String type)
type
- a type object.Copyright © 2004–2024 The Apache Software Foundation. All rights reserved.