Class TExportPackageICM.Options

java.lang.Object
  |
  +--TExportPackageICM.Options
Direct Known Subclasses:
TExportPackageICM.ExportOptions, TExportPackageICM.ImportOptions
Enclosing class:
TExportPackageICM

public static class TExportPackageICM.Options
extends java.lang.Object

This class specifies the core set of options that may be used by both import and export. ImportOptions and ExportOptions extend this class.


Constructor Summary
TExportPackageICM.Options()
           Create a base options object, initializing with defaults.
TExportPackageICM.Options(java.lang.String iniFileName)
          Create an Options object with the settings specified in the given configuration file.
 
Method Summary
 boolean getPrintDebugEnable()
          Determines if debug commandline printing is enabled.
 boolean getPrintTraceEnable()
          Determines if trace entry/exit commandline printing is enabled.
 void read(java.lang.String iniFileName)
          Read in settings in configuration file.
 void setPrintDebugEnable(boolean setting)
          Turn debug commandline printing on or off.
 void setPrintTraceEnable(boolean setting)
          Turn trace entry/exit commandline printing on or off.
 java.lang.String toString()
          Returns a string representation of this object.
 void write(java.lang.String iniFileName)
          Write current settings to configuration file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TExportPackageICM.Options

public TExportPackageICM.Options()
 Create a base options object, initializing with defaults.                 

 Defaults:
       Trace Enable = TExportPackageICM.OPTION_PRINT_TRACE_DEFAULT
       Debug Enable = TExportPackageICM.OPTION_PRINT_DEBUG_DEFAULT
 



TExportPackageICM.Options

public TExportPackageICM.Options(java.lang.String iniFileName)
                          throws java.lang.Exception
Create an Options object with the settings specified in the given configuration file. For any settings not specified, defaults will be used. For information on configuration file format, please refer to the TExportPackageICM.Options.read() documention. For information on default settings, please refer to the primary constructor.

Parameters:
iniFileName - - Name of configuration file.
Method Detail

getPrintTraceEnable

public boolean getPrintTraceEnable()
Determines if trace entry/exit commandline printing is enabled.

Returns:
Returns true if trace entry/exit printing is enabled, false otherwise.

getPrintDebugEnable

public boolean getPrintDebugEnable()
Determines if debug commandline printing is enabled.

Returns:
Returns true if debug printing is enabled, false otherwise.

setPrintTraceEnable

public void setPrintTraceEnable(boolean setting)
Turn trace entry/exit commandline printing on or off.

Parameters:
setting - - Turn on by setting to true, turn off by setting to false.

setPrintDebugEnable

public void setPrintDebugEnable(boolean setting)
Turn debug commandline printing on or off.

Parameters:
setting - - Turn on by setting to true, turn off by setting to false.

read

public void read(java.lang.String iniFileName)
          throws java.lang.Exception
Read in settings in configuration file. File may be created by the write() function, modified externally, or created from stracth. File will be scanned for line entries the conform to the following syntax.

File Syntax:
Setting entries are scanned from the top down, one setting entry per line. A setting entry is specified as "=". Properties are case insensitive versions of the exact settings & policies provided through "set" methods. For example, function setPrintDebugEnable() is specified through property "PrintDebugEnable". Values are the exact constant names or if boolean values are requried, the words "TRUE" or "FALSE". For example, "OPTION_CONFLICTS_ALWAYS_NEW" is an example of a value. Any invalid entries or irrelevant data will be ignored. Comments may be entered with a "#". Consider using the write() function to create a template if writing the propeties file from scratch. Review the javadoc for the interface for properties & values associated with each.

Parameters:
iniFileName - - Name of configuration file.

toString

public java.lang.String toString()
Returns a string representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
Returns a string representation of this object.

write

public void write(java.lang.String iniFileName)
           throws java.lang.Exception
Write current settings to configuration file.

File Syntax
Please refer to the read() method.

Parameters:
iniFileName - - Name of configuration file.