|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.plugin.descriptor.model.Parameter
public class Parameter
A phase mapping definition.
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 |
---|
public Parameter()
Method Detail |
---|
public String getAlias()
public String getDeprecated()
public String getDescription()
public String getImplementation()
public String getName()
public String getSince()
public String getType()
public boolean isEditable()
<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.
public boolean isRequired()
public void setAlias(String alias)
alias
- public void setDeprecated(String deprecated)
deprecated
- public void setDescription(String description)
description
- public void setEditable(boolean editable)
<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.
editable
- public void setImplementation(String implementation)
implementation
- public void setName(String name)
name
- public void setRequired(boolean required)
required
- public void setSince(String since)
since
- public void setType(String type)
type
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |