Package org.apache.maven.usability.plugin

Class Expression

  • All Implemented Interfaces:
    java.io.Serializable
    public class Expression
extends java.lang.Object
implements java.io.Serializable
    A plugin parameter expression supported by Maven.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      Expression()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addApiMethod​(java.lang.String key, java.lang.String value)
      Method addApiMethod.
      void addCliOption​(java.lang.String key, java.lang.String value)
      Method addCliOption.
      java.util.Properties getApiMethods()
      Method getApiMethods.
      java.lang.String getBan()
      Get a preferred alternative to this expression, in the case where it's banned from use.
      java.util.Properties getCliOptions()
      Method getCliOptions.
      java.lang.String getConfiguration()
      Get the place and syntax used to change the value of this expression.
      java.lang.String getDeprecation()
      Get a preferred alternative to this expression, in the case where it's deprecated.
      java.lang.String getDescription()
      Get the description of what this expression references, and what it's generally used for.
      java.lang.String getSyntax()
      Get the syntax of the expression.
      boolean isEditable()
      Get whether the value of this expression can be changed.
      void setApiMethods​(java.util.Properties apiMethods)
      Set the programmatic methods used to change the value of this expression.
      void setBan​(java.lang.String ban)
      Set a preferred alternative to this expression, in the case where it's banned from use.
      void setCliOptions​(java.util.Properties cliOptions)
      Set the command-line switches used to change the value of this expression.
      void setConfiguration​(java.lang.String configuration)
      Set the place and syntax used to change the value of this expression.
      void setDeprecation​(java.lang.String deprecation)
      Set a preferred alternative to this expression, in the case where it's deprecated.
      void setDescription​(java.lang.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 setSyntax​(java.lang.String syntax)
      Set the syntax of the expression.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Expression

        public Expression()

    • Method Detail

      • addApiMethod

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

      • addCliOption

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

      • getApiMethods

        public java.util.Properties getApiMethods()
        Method getApiMethods.
        Returns:
        Properties

      • getBan

        public java.lang.String getBan()
        Get a preferred alternative to this expression, in the case where it's banned from use.
        Returns:
        String

      • getCliOptions

        public java.util.Properties getCliOptions()
        Method getCliOptions.
        Returns:
        Properties

      • getConfiguration

        public java.lang.String getConfiguration()
        Get the place and syntax used to change the value of this expression.
        Returns:
        String

      • getDeprecation

        public java.lang.String getDeprecation()
        Get a preferred alternative to this expression, in the case where it's deprecated.
        Returns:
        String

      • getDescription

        public java.lang.String getDescription()
        Get the description of what this expression references, and what it's generally used for.
        Returns:
        String

      • getSyntax

        public java.lang.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​(java.util.Properties apiMethods)
        Set the programmatic methods used to change the value of this expression.
        Parameters:
        apiMethods - a apiMethods object.

      • setBan

        public void setBan​(java.lang.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​(java.util.Properties cliOptions)
        Set the command-line switches used to change the value of this expression.
        Parameters:
        cliOptions - a cliOptions object.

      • setConfiguration

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

      • setDeprecation

        public void setDeprecation​(java.lang.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​(java.lang.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​(java.lang.String syntax)
        Set the syntax of the expression.
        Parameters:
        syntax - a syntax object.