|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A variable that can be referenced in an expression, which resolves to a string value. Variables are referenced in expressions via their name, in the following format.
${varname} or ${varname:argument}
A variable is identified by its name, and optionally accepts an argument. When an argument is present, a colon seperates the variable name from its argument.
Variables can be contributed by extensions or programmatically. There are two kinds of variables.
IValueVariable
- variables that have a value (with getter and setter), and
accept no arguments. The value of this type of variable is resolved at the time
its value is set via its setter API.IDynamicVariable
- variables whose value is resolved at the time
a string substitution is performed by a contributed resolver. Dynamic variables
may accept an argument.Clients are not intended to implement this interface.
Method Summary | |
---|---|
String |
getDescription()
Returns a human readable description of this variable, possibly null |
String |
getName()
Returns the name of this variable. |
Method Detail |
public String getName()
public String getDescription()
null
null
if none
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.