Remote Systems
v6.4.1

com.ibm.etools.systems.core.ui.compile
Class SystemDefaultCompileCommand

java.lang.Object
  extended bycom.ibm.etools.systems.core.ui.compile.SystemDefaultCompileCommand
Direct Known Subclasses:
UniversalIBMCompileCommand

public class SystemDefaultCompileCommand
extends Object

This class encapsulates, for a particular compile command, the important information for that command including:


Field Summary
protected  String addlParms
           
static String Copyright
           
protected  String jobEnv
           
protected  String label
           
protected  String name
           
protected  String[] srcTypes
           
 
Constructor Summary
SystemDefaultCompileCommand(String commandName)
          Constructor that just takes a command name and defaults the label to it.
SystemDefaultCompileCommand(String commandLabel, String commandName)
          Constructor that takes a command name and label.
SystemDefaultCompileCommand(String commandLabel, String commandName, String parameters)
          Constructor that takes a command name and label and the parameters.
 
Method Summary
 boolean appliesToSourceType(String type)
          Return true if this command applies to the given source type
 String fillWithRequiredParams(String commandParams)
          Given user-specified command paramaters (minus the cmd name), verify it has all the minimum parameters we defined for this command.
 String getCommandWithParameters()
          Return command fully populated with default parameters and substitution variables
protected  String getCommandWithParameters(String existingParameters)
          Private implementation that supports two modes: - append all required parameters - append only those required parameters that do not already exist Typically not overridden.
 String getJobEnvironment()
          Return the job environment.
 String getLabel()
          Return the command label
 String getName()
          Return the command name, without parameters
 String[] getSourceTypes()
          Get the source types this applies to
protected  void populateWithParameters(StringBuffer bufferSoFar)
          Overridable method that will append required parameters to the command string.
 void printCommand()
          Print the full command string to standard out, for debugging purposes
 void printCommandLabel()
          Print the command lable to standard out, for debugging purposes
 void printCommandName()
          Print the command name to standard out, for debugging purposes
 void setAdditionalParameters(String parms)
          Set additional minimum parameters not specified via the constructor.
 void setJobEnvironment(String jobEnv)
          Set the job environment.
 void setSourceType(String type)
          Set the source type this applies to, when there is only one
 void setSourceTypes(String[] types)
          Set the source types this applies to
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values

name

protected String name

label

protected String label

jobEnv

protected String jobEnv

addlParms

protected String addlParms

srcTypes

protected String[] srcTypes
Constructor Detail

SystemDefaultCompileCommand

public SystemDefaultCompileCommand(String commandLabel,
                                   String commandName)
Constructor that takes a command name and label. You must call setAdditionalCommandParameters after this.


SystemDefaultCompileCommand

public SystemDefaultCompileCommand(String commandName)
Constructor that just takes a command name and defaults the label to it. You must call setAdditionalCommandParameters after this.


SystemDefaultCompileCommand

public SystemDefaultCompileCommand(String commandLabel,
                                   String commandName,
                                   String parameters)
Constructor that takes a command name and label and the parameters. This avoids you having to call setAdditionalCommandParameters.

Method Detail

setAdditionalParameters

public void setAdditionalParameters(String parms)
Set additional minimum parameters not specified via the constructor. Will be appended to the command string in the methods getMinimumCommandWithParameters and getFullCommandWithParameters.

Don't worry about a leading blank.


setSourceType

public void setSourceType(String type)
Set the source type this applies to, when there is only one


setSourceTypes

public void setSourceTypes(String[] types)
Set the source types this applies to


getSourceTypes

public String[] getSourceTypes()
Get the source types this applies to


appliesToSourceType

public boolean appliesToSourceType(String type)
Return true if this command applies to the given source type


getLabel

public String getLabel()
Return the command label


getName

public String getName()
Return the command name, without parameters


getCommandWithParameters

public String getCommandWithParameters()
Return command fully populated with default parameters and substitution variables


setJobEnvironment

public void setJobEnvironment(String jobEnv)
Set the job environment. Some systems support multiple command systems, and this attribute is needed to identify which system this should run in.


getJobEnvironment

public String getJobEnvironment()
Return the job environment. This is not often used, but sometimes needed for systems that support multiple command systems.


fillWithRequiredParams

public String fillWithRequiredParams(String commandParams)
Given user-specified command paramaters (minus the cmd name), verify it has all the minimum parameters we defined for this command. For any that are missing, add them...


printCommandLabel

public void printCommandLabel()
Print the command lable to standard out, for debugging purposes


printCommandName

public void printCommandName()
Print the command name to standard out, for debugging purposes


printCommand

public void printCommand()
Print the full command string to standard out, for debugging purposes


getCommandWithParameters

protected String getCommandWithParameters(String existingParameters)
Private implementation that supports two modes: - append all required parameters - append only those required parameters that do not already exist

Typically not overridden. Rather populateWithParameters is overridden, which this calls.


populateWithParameters

protected void populateWithParameters(StringBuffer bufferSoFar)
Overridable method that will append required parameters to the command string. These are any not already specified via additional parameters


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.