Eclipse Platform
Release 3.6

org.eclipse.core.variables
Interface IStringVariable

All Known Subinterfaces:
IDynamicVariable, IValueVariable

public interface IStringVariable

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 separates the variable name from its argument.

Variables can be contributed by extensions or programmatically. There are two kinds of variables.

Since:
3.0
Restriction:
This interface is not intended to be implemented by clients.

Method Summary
 String getDescription()
          Returns a human readable description of this variable, possibly null
 String getName()
          Returns the name of this variable.
 

Method Detail

getName

String getName()
Returns the name of this variable. A variable is uniquely identified by its name.

Returns:
variable name

getDescription

String getDescription()
Returns a human readable description of this variable, possibly null

Returns:
a description of this variable, or null if none

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.