Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.commands
Interface ISystemSubstitutor

All Known Subinterfaces:
ISystemCompileCommandSubstitutor
All Known Implementing Classes:
SystemUDActionSubsystem, UniversalCompileSubstitutor

public interface ISystemSubstitutor

Objects implementing this interface are passed to SystemCmdSubstVarList parse a given command string for variables defined in the substitution list. For each match, this object is called back to retrieve the substition value, given the variable name (including its prefix). It will also pass back the context object given to it. Presumably this is a currently selected object.


Field Summary
static String copyright
           
 
Method Summary
 String getSubstitutionValue(String substitutionVariable, Object context)
          Return the string to substitute for the given substitution variable, given the current context object.
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getSubstitutionValue

public String getSubstitutionValue(String substitutionVariable,
                                   Object context)
Return the string to substitute for the given substitution variable, given the current context object. This object will be passed whatever was passed into the doSubstitution method.

It is VERY IMPORTANT to return null if you can't do the substitution for some reason! This is a clue to the algorithm that no change was made and increases performance.


Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.