Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.compile
Class IBMiCompileUtilities

java.lang.Object
  extended by com.ibm.etools.iseries.rse.ui.compile.IBMiCompileUtilities
All Implemented Interfaces:
IIBMiCompileConstants

public class IBMiCompileUtilities
extends Object
implements IIBMiCompileConstants

A singleton utility class that provides useful methods related to the entire compilation infrastructure.


Field Summary
static String Copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.rse.ui.compile.IIBMiCompileConstants
DBGVIEW_NONE, DBGVIEW_SRC, EVF, LST, NO_EVF, NO_LST, NO_SRC, OPTION, SRC
 
Method Summary
 String addEVFOption(String compileString)
          Given a command without the option to produce an events file, add it to ensure that an events file is produced.
 String fillWithRequiredIFSParams(String commandString)
          Fill a command string with required parameters and substitution variables, when the input is from the IFS
 String fillWithRequiredParams(String commandString)
          Fill a command string with required parameters and substitution variables
 String[] getAllCompileTypes()
          Get all compile types from all profiles for the iSeries Objects sub system factory.
 String[] getAllCompileTypesInOrder()
          Returns all compile types in the order in which compile commands would be executed.
 QSYSCompileCommands getAllIBMSuppliedCmds()
          Get all IBM supplied commands.
 String[] getAllIBMSuppliedCmdStrings()
          Get all IBM supplied command strings.
 String[] getAllIBMSuppliedCompileNames()
          Get all IBM supplied compile names.
 IFSCompileCommands getAllIBMSuppliedIFSCmds()
          Get all IBM supplied IFS commands.
 String[] getAllIBMSuppliedMbrTypes()
          Get all IBM supplied member types.
 String[] getCommandsToExecute(IBMiConnection connection, String compileString, boolean replace)
          Get the commands to execute given the compile string.
 SystemCompileProfile getCompileProfile(Object selectedObject, IHost connection)
          Return the compile profile object, given a connection
static IBMiCompileUtilities getDefault()
          Get the singleton instance.
 String getIBMSuppliedCmdStringFromCompileName(String compileName)
          Get the IBM supplied command string associated with the compile name if it exists.
 QSYSCompileCommand getIBMSuppliedCommand(String commandName)
          If the command is an IBM supplied command, returns its ISeriesIBMCompileCommand object.
 String[] getIBMSuppliedCommandStringsFromType(String sourceType)
          Get the IBM supplied command strings that are associated with the given source type by default.
 SystemDefaultCompileCommand[] getIBMSuppliedCompileCommandsFromType(String sourceType)
          Get the IBM supplied compile commands that are associated with the given source type by default.
 String[] getIBMSuppliedCompileNamesFromType(String sourceType)
          Get the IBM supplied compile names that are associated with the given source type by default.
 String getIBMSuppliedIFSCmdStringFromCompileName(String compileName)
          Get the IBM supplied IFS command string associated with the compile name if it exists.
 IFSCompileCommand getIBMSuppliedIFSCommand(String commandName)
          If the command is an IBM supplied IFS command, returns its ISeriesIBMIFSCompileCommand object.
 SystemCompileCommand getLastUsedCompileCommand(Object selectedObject, String mbrType, IHost connection)
          Return the last used compile command for the given source type
 boolean isIBMSuppliedCommand(String command)
          Is the command an IBM supplied command? These are all the compile commands.
 boolean isIBMSuppliedIFSCommand(String command)
          Is the command an IBM supplied IFS command? These are all the compile commands.
 void printAllIBMSuppliedCmds()
          Print all IBM supplied commands
 void printAllIBMSuppliedIFSCmds()
          Print all IBM supplied IFS commands
 String[] putCompileTypesInDefaultOrder(String[] types)
          Put compile types in default order.
 String[] putTypesInOrder(String[] types)
          Given an array of types, puts those types in order.
 void saveTypesInOrder(String[] types)
          Given a list of types, saves the types according to their order in the list.
 
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
Method Detail

getDefault

public static IBMiCompileUtilities getDefault()
Get the singleton instance.


getAllIBMSuppliedMbrTypes

public String[] getAllIBMSuppliedMbrTypes()
Get all IBM supplied member types.


getAllIBMSuppliedCompileNames

public String[] getAllIBMSuppliedCompileNames()
Get all IBM supplied compile names.


getAllIBMSuppliedCmdStrings

public String[] getAllIBMSuppliedCmdStrings()
Get all IBM supplied command strings.


getAllIBMSuppliedCmds

public QSYSCompileCommands getAllIBMSuppliedCmds()
Get all IBM supplied commands.


getAllIBMSuppliedIFSCmds

public IFSCompileCommands getAllIBMSuppliedIFSCmds()
Get all IBM supplied IFS commands.


printAllIBMSuppliedCmds

public void printAllIBMSuppliedCmds()
Print all IBM supplied commands


printAllIBMSuppliedIFSCmds

public void printAllIBMSuppliedIFSCmds()
Print all IBM supplied IFS commands


getIBMSuppliedCmdStringFromCompileName

public String getIBMSuppliedCmdStringFromCompileName(String compileName)
Get the IBM supplied command string associated with the compile name if it exists. Otherwise, return null.

Parameters:
the - compile name

getIBMSuppliedIFSCmdStringFromCompileName

public String getIBMSuppliedIFSCmdStringFromCompileName(String compileName)
Get the IBM supplied IFS command string associated with the compile name if it exists. Otherwise, return null.

Parameters:
the - compile name

getIBMSuppliedCompileNamesFromType

public String[] getIBMSuppliedCompileNamesFromType(String sourceType)
Get the IBM supplied compile names that are associated with the given source type by default.

Parameters:
the - source type

getIBMSuppliedCommandStringsFromType

public String[] getIBMSuppliedCommandStringsFromType(String sourceType)
Get the IBM supplied command strings that are associated with the given source type by default.

Parameters:
the - source type

getIBMSuppliedCompileCommandsFromType

public SystemDefaultCompileCommand[] getIBMSuppliedCompileCommandsFromType(String sourceType)
Get the IBM supplied compile commands that are associated with the given source type by default.

Parameters:
the - source type

isIBMSuppliedCommand

public boolean isIBMSuppliedCommand(String command)
Is the command an IBM supplied command? These are all the compile commands.


isIBMSuppliedIFSCommand

public boolean isIBMSuppliedIFSCommand(String command)
Is the command an IBM supplied IFS command? These are all the compile commands.


getIBMSuppliedCommand

public QSYSCompileCommand getIBMSuppliedCommand(String commandName)
If the command is an IBM supplied command, returns its ISeriesIBMCompileCommand object. Returns null if not an IBM command.


getIBMSuppliedIFSCommand

public IFSCompileCommand getIBMSuppliedIFSCommand(String commandName)
If the command is an IBM supplied IFS command, returns its ISeriesIBMIFSCompileCommand object. Returns null if not an IBM command.


addEVFOption

public String addEVFOption(String compileString)
Given a command without the option to produce an events file, add it to ensure that an events file is produced.


getCommandsToExecute

public String[] getCommandsToExecute(IBMiConnection connection,
                                     String compileString,
                                     boolean replace)
                              throws Exception
Get the commands to execute given the compile string. Only required because

Throws:
Exception

fillWithRequiredParams

public String fillWithRequiredParams(String commandString)
Fill a command string with required parameters and substitution variables


fillWithRequiredIFSParams

public String fillWithRequiredIFSParams(String commandString)
Fill a command string with required parameters and substitution variables, when the input is from the IFS


getCompileProfile

public SystemCompileProfile getCompileProfile(Object selectedObject,
                                              IHost connection)
Return the compile profile object, given a connection


getLastUsedCompileCommand

public SystemCompileCommand getLastUsedCompileCommand(Object selectedObject,
                                                      String mbrType,
                                                      IHost connection)
Return the last used compile command for the given source type


getAllCompileTypes

public String[] getAllCompileTypes()
Get all compile types from all profiles for the iSeries Objects sub system factory.


getAllCompileTypesInOrder

public String[] getAllCompileTypesInOrder()
Returns all compile types in the order in which compile commands would be executed. The first type in the array should be the first executed, etc.


putCompileTypesInDefaultOrder

public String[] putCompileTypesInDefaultOrder(String[] types)
Put compile types in default order.


saveTypesInOrder

public void saveTypesInOrder(String[] types)
Given a list of types, saves the types according to their order in the list.


putTypesInOrder

public String[] putTypesInOrder(String[] types)
Given an array of types, puts those types in order.


Rational Developer for Power Systems Software
V7.6

Copyright 2011 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.