Class Parameter
- java.lang.Object
-
- org.apache.maven.tools.plugin.extractor.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
Fields Modifier and Type Field Description private java.lang.String
alias
An alternate name for the parameter.private java.lang.String
defaultValue
An expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.private java.lang.String
deprecation
A deprecation message for this mojo parameter.private java.lang.String
description
The description for this parameter.private java.lang.String
expression
The command-line reference to this parameter.private java.lang.String
name
The parameter name.private java.lang.String
property
The JavaBeans property name to use to configure the mojo with this parameter.private boolean
readonly
Whether this parameter can be directly edited.private boolean
required
Whether this parameter is required.private java.lang.String
since
Version when the parameter was added.private java.lang.String
type
The java type for this parameter.
-
Constructor Summary
Constructors Constructor Description Parameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
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
getSince()
Get version when the parameter was added.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
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
setSince(java.lang.String since)
Set version when the parameter was added.void
setType(java.lang.String type)
Set the java type for this parameter.
-
-
-
Field Detail
-
name
private java.lang.String name
The parameter name.
-
alias
private java.lang.String alias
An alternate name for the parameter.
-
property
private java.lang.String property
The JavaBeans property name to use to configure the mojo with this parameter.
-
required
private boolean required
Whether this parameter is required.
-
readonly
private boolean readonly
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.
-
expression
private java.lang.String expression
The command-line reference to this parameter.
-
defaultValue
private java.lang.String defaultValue
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()) .
-
type
private java.lang.String type
The java type for this parameter.
-
description
private java.lang.String description
The description for this parameter.
-
deprecation
private java.lang.String deprecation
A deprecation message for this mojo parameter.
-
since
private java.lang.String since
Version when the parameter was added.
-
-
Method Detail
-
getAlias
public java.lang.String getAlias()
Get an alternate name for the parameter.- Returns:
- String
-
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()).- Returns:
- String
-
getDeprecation
public java.lang.String getDeprecation()
Get a deprecation message for this mojo parameter.- Returns:
- String
-
getDescription
public java.lang.String getDescription()
Get the description for this parameter.- Returns:
- String
-
getExpression
public java.lang.String getExpression()
Get the command-line reference to this parameter.- Returns:
- String
-
getName
public java.lang.String getName()
Get the parameter name.- Returns:
- String
-
getProperty
public java.lang.String getProperty()
Get the JavaBeans property name to use to configure the mojo with this parameter.- Returns:
- String
-
getSince
public java.lang.String getSince()
Get version when the parameter was added.- Returns:
- String
-
getType
public java.lang.String getType()
Get the java type for this parameter.- Returns:
- String
-
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.- Returns:
- boolean
-
isRequired
public boolean isRequired()
Get whether this parameter is required.- Returns:
- boolean
-
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
-
-
setSince
public void setSince(java.lang.String since)
Set version when the parameter was added.- Parameters:
since
-
-
setType
public void setType(java.lang.String type)
Set the java type for this parameter.- Parameters:
type
-
-
-