Eclipse Platform
Release 3.6

org.eclipse.core.resources.variableresolvers
Class PathVariableResolver

java.lang.Object
  extended by org.eclipse.core.resources.variableresolvers.PathVariableResolver

public abstract class PathVariableResolver
extends Object

An interface that variable providers should implement in order to extends the default path variable list used to resolve relative locations of linked resources.

Since:
3.6

Constructor Summary
PathVariableResolver()
           
 
Method Summary
abstract  String getValue(String variable, IResource resource)
          Returns a variable value
 String[] getVariableNames(String variable, IResource resource)
          This method can return a list of possible variables resolved by this resolver.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PathVariableResolver

public PathVariableResolver()
Method Detail

getVariableNames

public String[] getVariableNames(String variable,
                                 IResource resource)
This method can return a list of possible variables resolved by this resolver.

This default implementation always returns null. Subclasses should override to provide custom extensions.

Parameters:
variable - The current variable name.
resource - The resource that the variable is being resolved for.
Returns:
the list of supported variables

getValue

public abstract String getValue(String variable,
                                IResource resource)
Returns a variable value

Parameters:
variable - The current variable name.
resource - The resource that the variable is being resolved for.
Returns:
the variable value.

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

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