Eclipse Platform
Release 3.1

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

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

Clients are not intended to implement this interface.

Since:
3.0

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

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

Returns:
variable name

getDescription

public 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.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.