org.apache.maven.usability.plugin
Class Expression

java.lang.Object
  org.apache.maven.usability.plugin.Expression

All Implemented Interfaces:

Serializable

public class Expression
extends Object
implements Serializable

A plugin parameter expression supported by Maven.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Expression

public Expression()

addApiMethod

public void addApiMethod(String key,
                         String value)

Method addApiMethod.

Parameters:

key -

value -

addCliOption

public void addCliOption(String key,
                         String value)

Method addCliOption.

Parameters:

key -

value -

getApiMethods

public Properties getApiMethods()

Method getApiMethods.

Returns:

Properties

getBan

public String getBan()

Get a preferred alternative to this expression, in the case where it's banned from use.

Returns:

String

getCliOptions

public Properties getCliOptions()

Method getCliOptions.

Returns:

Properties

getConfiguration

public String getConfiguration()

Get the place and syntax used to change the value of this expression.

Returns:

String

getDeprecation

public String getDeprecation()

Get a preferred alternative to this expression, in the case where it's deprecated.

Returns:

String

getDescription

public String getDescription()

Get the description of what this expression references, and what it's generally used for.

Returns:

String

getSyntax

public 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

public void setApiMethods(Properties apiMethods)

Set the programmatic methods used to change the value of this expression.

Parameters:

apiMethods -

setBan

public void setBan(String ban)

Set a preferred alternative to this expression, in the case where it's banned from use.

Parameters:

ban -

setCliOptions

public void setCliOptions(Properties cliOptions)

Set the command-line switches used to change the value of this expression.

Parameters:

cliOptions -

setConfiguration

public void setConfiguration(String configuration)

Set the place and syntax used to change the value of this expression.

Parameters:

configuration -

setDeprecation

public void setDeprecation(String deprecation)

Set a preferred alternative to this expression, in the case where it's deprecated.

Parameters:

deprecation -

setDescription

public void setDescription(String description)

Set the description of what this expression references, and what it's generally used for.

Parameters:

description -

setEditable

public void setEditable(boolean editable)

Set whether the value of this expression can be changed.

Parameters:

editable -

setSyntax

public void setSyntax(String syntax)

Set the syntax of the expression.

Parameters:

syntax -