Package org.eclipse.core.commands

Class Parameterization

  • public final class Parameterization
extends java.lang.Object

    A parameter with a specific value. This is usually a part of a ParameterizedCommand, which is used to refer to a command with a collection of parameterizations.

    Since:
    3.1

    • Constructor Summary

      Constructors 
      Constructor Description
      Parameterization​(IParameter parameter, java.lang.String value)
      Constructs a new instance of Parameterization.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object object)  
      IParameter getParameter()
      Returns the parameter that is being parameterized.
      java.lang.String getValue()
      Returns the value for the parameter in this parameterization.
      java.lang.String getValueName()
      Returns the human-readable name for the current value, if any.
      int hashCode()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Parameterization

        public Parameterization​(IParameter parameter,
                        java.lang.String value)
        Constructs a new instance of Parameterization.
        Parameters:
        parameter - The parameter that is being parameterized; must not be null.
        value - The value for the parameter; may be null.

    • Method Detail

      • equals

        public final boolean equals​(java.lang.Object object)
        Overrides:
        equals in class java.lang.Object

      • getParameter

        public final IParameter getParameter()
        Returns the parameter that is being parameterized.
        Returns:
        The parameter; never null.

      • getValue

        public final java.lang.String getValue()
        Returns the value for the parameter in this parameterization.
        Returns:
        The value; may be null.

      • getValueName

        public final java.lang.String getValueName()
                                    throws ParameterValuesException
        Returns the human-readable name for the current value, if any. If the name cannot be found, then it simply returns the value. It also ensures that any null values are converted into an empty string.
        Returns:
        The human-readable name of the value; never null.
        Throws:
        ParameterValuesException - If the parameter needed to be initialized, but couldn't be.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class java.lang.Object