Package org.eclipse.core.commands
Interface IParameter
-
public interface IParameterA 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetId()Returns the identifier for this parameter.StringgetName()Returns the human-readable name for this parameter.IParameterValuesgetValues()Returns the values associated with this parameter.booleanisOptional()Returns whether parameter is optional.
-
-
-
Method Detail
-
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:
trueif the parameter is optional;falseif it is required.
-
-