Class Parameter
- java.lang.Object
-
- org.apache.maven.tools.plugin.extractor.model.Parameter
-
- All Implemented Interfaces:
Serializable
public class Parameter extends Object implements Serializable
A parameter used by a mojo, and configurable from the command line or POM configuration sections.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Parameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Constructor Detail
-
Parameter
public Parameter()
-
-
Method Detail
-
getDefaultValue
public 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 String getDeprecation()
Get a deprecation message for this mojo parameter.- Returns:
- String
-
getDescription
public String getDescription()
Get the description for this parameter.- Returns:
- String
-
getExpression
public String getExpression()
Get the command-line reference to this parameter.- Returns:
- String
-
getProperty
public String getProperty()
Get the JavaBeans property name to use to configure the mojo with 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(String alias)
Set an alternate name for the parameter.- Parameters:
alias
- a alias object.
-
setDefaultValue
public 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. (eg. ${project.build.directory} references project.getBuild().getDirectory()).- Parameters:
defaultValue
- a defaultValue object.
-
setDeprecation
public void setDeprecation(String deprecation)
Set a deprecation message for this mojo parameter.- Parameters:
deprecation
- a deprecation object.
-
setDescription
public void setDescription(String description)
Set the description for this parameter.- Parameters:
description
- a description object.
-
setExpression
public void setExpression(String expression)
Set the command-line reference to this parameter.- Parameters:
expression
- a expression object.
-
setProperty
public void setProperty(String property)
Set the JavaBeans property name to use to configure the mojo with this parameter.- Parameters:
property
- a property object.
-
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
- a readonly object.
-
setRequired
public void setRequired(boolean required)
Set whether this parameter is required.- Parameters:
required
- a required object.
-
setSince
public void setSince(String since)
Set version when the parameter was added.- Parameters:
since
- a since object.
-
-