Class Expression
java.lang.Object
org.apache.maven.usability.plugin.Expression
- All Implemented Interfaces:
Serializable
A plugin parameter expression supported by Maven.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Properties
Field apiMethods.private String
A preferred alternative to this expression, in the case where it's banned from use.private Properties
Field cliOptions.private String
The place and syntax used to change the value of this expression.private String
A preferred alternative to this expression, in the case where it's deprecated.private String
The description of what this expression references, and what it's generally used for.private boolean
Whether the value of this expression can be changed.private String
The syntax of the expression. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addApiMethod
(String key, String value) Method addApiMethod.void
addCliOption
(String key, String value) Method addCliOption.Method getApiMethods.getBan()
Get a preferred alternative to this expression, in the case where it's banned from use.Method getCliOptions.Get the place and syntax used to change the value of this expression.Get a preferred alternative to this expression, in the case where it's deprecated.Get the description of what this expression references, and what it's generally used for.Get the syntax of the expression.boolean
Get whether the value of this expression can be changed.void
setApiMethods
(Properties apiMethods) Set the programmatic methods used to change the value of this expression.void
Set a preferred alternative to this expression, in the case where it's banned from use.void
setCliOptions
(Properties cliOptions) Set the command-line switches used to change the value of this expression.void
setConfiguration
(String configuration) Set the place and syntax used to change the value of this expression.void
setDeprecation
(String deprecation) Set a preferred alternative to this expression, in the case where it's deprecated.void
setDescription
(String description) Set the description of what this expression references, and what it's generally used for.void
setEditable
(boolean editable) Set whether the value of this expression can be changed.void
Set the syntax of the expression.
-
Field Details
-
syntax
The syntax of the expression. -
description
The description of what this expression references, and what it's generally used for. -
configuration
The place and syntax used to change the value of this expression. -
cliOptions
Field cliOptions. -
apiMethods
Field apiMethods. -
deprecation
A preferred alternative to this expression, in the case where it's deprecated. -
ban
A preferred alternative to this expression, in the case where it's banned from use. -
editable
private boolean editableWhether the value of this expression can be changed.
-
-
Constructor Details
-
Expression
public Expression()
-
-
Method Details
-
addApiMethod
Method addApiMethod.- Parameters:
key
- a key object.value
- a value object.
-
addCliOption
Method addCliOption.- Parameters:
key
- a key object.value
- a value object.
-
getApiMethods
Method getApiMethods.- Returns:
- Properties
-
getBan
Get a preferred alternative to this expression, in the case where it's banned from use.- Returns:
- String
-
getCliOptions
Method getCliOptions.- Returns:
- Properties
-
getConfiguration
Get the place and syntax used to change the value of this expression.- Returns:
- String
-
getDeprecation
Get a preferred alternative to this expression, in the case where it's deprecated.- Returns:
- String
-
getDescription
Get the description of what this expression references, and what it's generally used for.- Returns:
- String
-
getSyntax
Get the syntax of the expression.- Returns:
- String
-
isEditable
public boolean isEditable()Get whether the value of this expression can be changed.- Returns:
- boolean
-
setApiMethods
Set the programmatic methods used to change the value of this expression.- Parameters:
apiMethods
- a apiMethods object.
-
setBan
Set a preferred alternative to this expression, in the case where it's banned from use.- Parameters:
ban
- a ban object.
-
setCliOptions
Set the command-line switches used to change the value of this expression.- Parameters:
cliOptions
- a cliOptions object.
-
setConfiguration
Set the place and syntax used to change the value of this expression.- Parameters:
configuration
- a configuration object.
-
setDeprecation
Set a preferred alternative to this expression, in the case where it's deprecated.- Parameters:
deprecation
- a deprecation object.
-
setDescription
Set the description of what this expression references, and what it's generally used for.- Parameters:
description
- a description object.
-
setEditable
public void setEditable(boolean editable) Set whether the value of this expression can be changed.- Parameters:
editable
- a editable object.
-
setSyntax
Set the syntax of the expression.- Parameters:
syntax
- a syntax object.
-