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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Properties apiMethods
      Field apiMethods.
      private java.lang.String ban
      A preferred alternative to this expression, in the case where it's banned from use.
      private java.util.Properties cliOptions
      Field cliOptions.
      private java.lang.String configuration
      The place and syntax used to change the value of this expression.
      private java.lang.String deprecation
      A preferred alternative to this expression, in the case where it's deprecated.
      private java.lang.String description
      The description of what this expression references, and what it's generally used for.
      private boolean editable
      Whether the value of this expression can be changed.
      private java.lang.String syntax
      The syntax of the expression.

    • 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

    • Field Detail

      • syntax

        private java.lang.String syntax
        The syntax of the expression.

      • description

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

      • configuration

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

      • cliOptions

        private java.util.Properties cliOptions
        Field cliOptions.

      • apiMethods

        private java.util.Properties apiMethods
        Field apiMethods.

      • deprecation

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

      • ban

        private java.lang.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 Detail

      • Expression

        public Expression()

    • Method Detail

      • addApiMethod

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

      • addCliOption

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

      • 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 -

      • 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 -

      • setCliOptions

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

      • setConfiguration

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

      • setDeprecation

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

      • 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 -

      • setEditable

        public void setEditable​(boolean editable)
        Set whether the value of this expression can be changed.
        Parameters:
        editable -

      • setSyntax

        public void setSyntax​(java.lang.String syntax)
        Set the syntax of the expression.
        Parameters:
        syntax -