Eclipse Platform
Release 3.6

org.eclipse.core.resources
Interface IPathVariable


public interface IPathVariable

Represents a path variable contained in a IPathVariableManager.

A path variable is a pair of non-null elements (name,value) where name is a case-sensitive string (containing only letters, digits and the underscore character, and not starting with a digit), and value is an absolute IPath object.

Path variables allow for the creation of relative paths whose exact location in the file system depends on the value of a variable. A variable reference may only appear as the first segment of a relative path.

Since:
3.6
See Also:
IPath
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

Method Summary
 Object[] getExtensions(String variable, IResource resource)
          If the variable supports extensions (specified as "${VARNAME-EXTENSIONNAME}"), this method can return the list of possible extensions, or null if none are supported.
 boolean isReadOnly()
          Returns whether a IPathVariable is read only or not.
 

Method Detail

isReadOnly

boolean isReadOnly()
Returns whether a IPathVariable is read only or not. Path variables defined for all projects through the extension point are read only, and cannot be edited nor removed.

Returns:
true if the path variable is read only.
Since:
3.6

getExtensions

Object[] getExtensions(String variable,
                       IResource resource)
If the variable supports extensions (specified as "${VARNAME-EXTENSIONNAME}"), this method can return the list of possible extensions, or null if none are supported.

Parameters:
variable - The current variable name.
resource - The resource that the variable is being resolved for.
Returns:
the possible variable extensions or null if none are supported.

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

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