Class Parameter
java.lang.Object
org.apache.maven.tools.plugin.extractor.model.Parameter
- All Implemented Interfaces:
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
-
Method Summary
Modifier and TypeMethodDescriptiongetAlias()
Get an alternate name for the parameter.Get an expression in the form ${instance.property} for extracting a value for this parameter, especially from a runtime instance within the build system.Get a deprecation message for this mojo parameter.Get the description for this parameter.Get the command-line reference to this parameter.getName()
Get the parameter name.Get the JavaBeans property name to use to configure the mojo with this parameter.getSince()
Get version when the parameter was added.getType()
Get the java type for this parameter.boolean
Get whether this parameter can be directly edited.boolean
Get whether this parameter is required.void
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
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
Set version when the parameter was added.void
Set the java type for this parameter.
-
Constructor Details
-
Parameter
public Parameter()
-
-
Method Details
-
getAlias
Get an alternate name for the parameter.- Returns:
- 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
Get a deprecation message for this mojo parameter.- Returns:
- String
-
getDescription
Get the description for this parameter.- Returns:
- String
-
getExpression
Get the command-line reference to this parameter.- Returns:
- String
-
getName
Get the parameter name.- Returns:
- String
-
getProperty
Get the JavaBeans property name to use to configure the mojo with this parameter.- Returns:
- String
-
getSince
Get version when the parameter was added.- Returns:
- String
-
getType
Get the java type for this parameter.- Returns:
- String
-
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
Get whether this parameter is required.- Returns:
- boolean
-
setAlias
Set an alternate name for the parameter.- Parameters:
alias
-
-
setDefaultValue
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
Set a deprecation message for this mojo parameter.- Parameters:
deprecation
-
-
setDescription
Set the description for this parameter.- Parameters:
description
-
-
setExpression
Set the command-line reference to this parameter.- Parameters:
expression
-
-
setName
Set the parameter name.- Parameters:
name
-
-
setProperty
Set the JavaBeans property name to use to configure the mojo with this parameter.- Parameters:
property
-
-
setReadonly
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
Set whether this parameter is required.- Parameters:
required
-
-
setSince
Set version when the parameter was added.- Parameters:
since
-
-
setType
Set the java type for this parameter.- Parameters:
type
-
-