public interface IValueVariable extends IStringVariable
Since 3.3, a variable can be specified as a "read only" preventing users from changing the value after it has been initialized. Furthermore, a read only variable that is contributed by an extension will always load the value from the extension.
Example of a value variable contribution with an initial value, the specified variable is created with the initial value "/usr/local/foo".
<extension point="org.eclipse.core.variables.valueVariables"> <variable name="FOO_HOME" initialValue="/usr/local/foo"> </variable> </extension>
Example of a value variable contribution with an initializer class, the class "com.example.FooLocator" will be used to initialize the value the first time it's requested.
<extension point="org.eclipse.core.variables.valueVariables"> <variable name="FOO_HOME" initializerClass="com.example.FooLocator"> </variable> </extension>
Modifier and Type | Method and Description |
---|---|
String |
getValue()
Returns the value of this variable, or
null if none. |
boolean |
isContributed()
Returns whether this variable was contributed by an extension.
|
boolean |
isReadOnly()
Returns whether this variable is read only.
|
void |
setDescription(String description)
Sets the description of this variable to the given value.
|
void |
setValue(String value)
Sets the value of this variable to the given value.
|
getDescription, getName
void setValue(String value)
value
- variable valueString getValue()
null
if none.null
if noneboolean isContributed()
boolean isReadOnly()
void setDescription(String description)
description
- variable description, possibly null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.