Package 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:

  • Field Details

    • syntax

      private String syntax
      The syntax of the expression.

    • description

      private String description
      The description of what this expression references, and what it's generally used for.

    • configuration

      private String configuration
      The place and syntax used to change the value of this expression.

    • cliOptions

      private Properties cliOptions
      Field cliOptions.

    • apiMethods

      private Properties apiMethods
      Field apiMethods.

    • deprecation

      private String deprecation
      A preferred alternative to this expression, in the case where it's deprecated.

    • ban

      private String ban
      A preferred alternative to this expression, in the case where it's banned from use.

    • editable

      private boolean editable
      Whether the value of this expression can be changed.

  • Constructor Details

    • Expression

      public Expression()

  • Method Details

    • addApiMethod

      public void addApiMethod(String key, String value)
      Method addApiMethod.
      Parameters:
      key - a key object.
      value - a value object.

    • addCliOption

      public void addCliOption(String key, String value)
      Method addCliOption.
      Parameters:
      key - a key object.
      value - a value object.

    • 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 - a apiMethods object.

    • setBan

      public void setBan(String ban)
      Set a preferred alternative to this expression, in the case where it's banned from use.
      Parameters:
      ban - a ban object.

    • setCliOptions

      public void setCliOptions(Properties cliOptions)
      Set the command-line switches used to change the value of this expression.
      Parameters:
      cliOptions - a cliOptions object.

    • setConfiguration

      public void setConfiguration(String configuration)
      Set the place and syntax used to change the value of this expression.
      Parameters:
      configuration - a configuration object.

    • setDeprecation

      public void setDeprecation(String deprecation)
      Set a preferred alternative to this expression, in the case where it's deprecated.
      Parameters:
      deprecation - a deprecation object.

    • setDescription

      public void setDescription(String description)
      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

      public void setSyntax(String syntax)
      Set the syntax of the expression.
      Parameters:
      syntax - a syntax object.