| java.lang.Object
 org.eclipse.ui.internal.commands.Parameter
| Parameter | | final public class Parameter implements IParameter,ITypedParameter(Code) | |
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.
Parameters are mutable, and can change as the command changes. Notifications
will not be sent if the parameter itself changes. Listeners can be attached
to the command.
since:
3.1 |
| Field Summary | |
| final protected String | id
The identifier for this object. | | protected transient String | string
The string representation of this object. |
| Constructor Summary | |
| public | Parameter(String id, String name, IConfigurationElement values, ParameterType parameterType, boolean optional)
Constructs a new instance of Parameter with all of its
values pre-defined. |
| id | | final protected String id(Code) | | The identifier for this object. This identifier should be unique across
all objects of the same type and should never change. This value will
never be null.
|
| string | | protected transient String string(Code) | | The string representation of this object. This string is for debugging
purposes only, and is not meant to be displayed to the user. This value
is computed lazily, and is cleared if one of its dependent values
changes.
|
| Parameter | | public Parameter(String id, String name, IConfigurationElement values, ParameterType parameterType, boolean optional)(Code) | | Constructs a new instance of Parameter with all of its
values pre-defined.
Parameters:
id - The identifier for this parameter; must not benull.
Parameters:
name - The name for this parameter; must not be null.
Parameters:
values - The values for this parameter; must not be null.
Parameters:
parameterType - the type for this parameter; may be null if theparmeter doesn't declare type.
Parameters:
optional - Whether this parameter is optional (as opposed to required).
Parameters:
commandService - The command service from which parameter types can beretrieved; must not be null. |
| equals | | final public boolean equals(Object object)(Code) | | Tests whether this object is equal to another object. A parameter is only
equal to another parameter with the same properties.
Parameters:
object - The object with which to compare; may be null. true if the objects are equal; falseotherwise. |
| getParameterType | | final public ParameterType getParameterType()(Code) | | |
| getValues | | final public IParameterValues getValues() throws ParameterValuesException(Code) | | |
| hashCode | | final public int hashCode()(Code) | | |
| isOptional | | final public boolean isOptional()(Code) | | |
|
|