org.eclipse.e4.ui.internal.workbench

Class Parameter

java.lang.Object

org.eclipse.e4.ui.internal.workbench.Parameter

public final class Parameter
extends java.lang.Object

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

Fields

Modifier and Type	Field and Description
protected java.lang.String	id The identifier for this object.
protected java.lang.String	string The string representation of this object.

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String id, java.lang.String name, IConfigurationElement values, ParameterType parameterType, boolean optional) Constructs a new instance of Parameter with all of its values pre-defined.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Tests whether this object is equal to another object.
java.lang.String	getId()
java.lang.String	getName()
ParameterType	getParameterType()
IParameterValues	getValues()
int	hashCode()
boolean	isOptional()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final java.lang.String id

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 java.lang.String string

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.

Constructor Detail

Parameter

public Parameter(java.lang.String id,
                 java.lang.String name,
                 IConfigurationElement values,
                 ParameterType parameterType,
                 boolean optional)

Constructs a new instance of Parameter with all of its values pre-defined.

Parameters:

id - The identifier for this parameter; must not be null.

name - The name for this parameter; must not be null.

values - The values for this parameter; must not be null.

parameterType - the type for this parameter; may be null if the parmeter doesn't declare type.

optional - Whether this parameter is optional (as opposed to required).

Method Detail

equals

public final boolean equals(java.lang.Object object)

Tests whether this object is equal to another object. A parameter is only equal to another parameter with the same properties.

Overrides:

equals in class java.lang.Object

Parameters:

object - The object with which to compare; may be null.

Returns:

true if the objects are equal; false otherwise.

getId

public final java.lang.String getId()

getName

public final java.lang.String getName()

getParameterType

public final ParameterType getParameterType()

getValues

public final IParameterValues getValues()
                                 throws ParameterValuesException

Throws:

ParameterValuesException

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

isOptional

public final boolean isOptional()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object