Package org.eclipse.core.commands

Interface IParameter

public interface IParameter

A parameter for a command. A parameter identifies a type of information that the command might accept. For example, a "Show View" command might accept the id of a view for display. This parameter also identifies possible values, for display in the user interface.

Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Returns the identifier for this parameter.
    String
    getName()
    Returns the human-readable name for this parameter.
    IParameterValues
    getValues()
    Returns the values associated with this parameter.
    boolean
    isOptional()
    Returns whether parameter is optional.

  • Method Details

    • getId

      String getId()
      Returns the identifier for this parameter.
      Returns:
      The identifier; never null.

    • getName

      String getName()
      Returns the human-readable name for this parameter.
      Returns:
      The parameter name; never null.

    • getValues

      IParameterValues getValues() throws ParameterValuesException
      Returns the values associated with this parameter.
      Returns:
      The values associated with this parameter. This must not be null.
      Throws:
      ParameterValuesException - If the values can't be retrieved for some reason.

    • isOptional

      boolean isOptional()
      Returns whether parameter is optional. Otherwise, it is required.
      Returns:
      true if the parameter is optional; false if it is required.