TPTP 4.6.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.agentcontroller.config
Class SetConfigSkeleton

java.lang.Object
  extended by org.eclipse.tptp.platform.agentcontroller.config.SetConfigSkeleton
Direct Known Subclasses:
SetConfig, SetConfig, SetConfig, SetConfig, SetConfig, SetConfig, SetConfig, SetConfig

public abstract class SetConfigSkeleton
extends java.lang.Object


Field Summary
 ConfigFile configFile
           
static boolean isNewAC
           
static boolean overwrite
           
static java.lang.String pr
           
static boolean silent
           
static java.lang.String sr
           
static boolean verify
           
static boolean wantsBC
           
 
Constructor Summary
SetConfigSkeleton()
           
SetConfigSkeleton(java.lang.String pluginName)
           
 
Method Summary
abstract  void askUser()
           
abstract  void generateConfiguration()
           
 java.lang.ClassLoader getLoader()
           
 java.util.Enumeration getNLFiles()
          Bug 93461 Retrieve the list of jar files inside the NL plugin
 java.util.Enumeration getNLFiles(java.io.File pDir, java.lang.String plugin)
           
 java.lang.String getPluginName()
          Retrieve the plugin name (the directory with version)
 java.lang.String getString(java.lang.String tag)
          Return the resource string associated with the class
 void init(java.util.Hashtable hash)
           
abstract  void printExamples()
           
abstract  void printHelp()
           
 void run(java.util.Hashtable hash)
           
 void run(java.util.Hashtable hash, boolean bSilent, boolean bOverwrite)
           
 void setFileName(java.lang.String fileName)
           
 void setLoader(java.lang.ClassLoader _loader)
           
 void setPluginName(java.lang.String name)
          Set the plugin name (the directory with version)
 java.lang.String trim(java.lang.String str)
          Trimming off the leading and trailing white spaces
 void validate(java.lang.Boolean showAll)
          Validate the primary configuration file, outputs findings to standard out, this is experimental and provisional for now but is much needed to minimize time taken for debugging issues
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

configFile

public ConfigFile configFile

sr

public static java.lang.String sr

pr

public static java.lang.String pr

silent

public static boolean silent

overwrite

public static boolean overwrite

isNewAC

public static boolean isNewAC

wantsBC

public static boolean wantsBC

verify

public static boolean verify
Constructor Detail

SetConfigSkeleton

public SetConfigSkeleton()

SetConfigSkeleton

public SetConfigSkeleton(java.lang.String pluginName)
Method Detail

askUser

public abstract void askUser()

generateConfiguration

public abstract void generateConfiguration()

printHelp

public abstract void printHelp()

printExamples

public abstract void printExamples()

validate

public void validate(java.lang.Boolean showAll)
Validate the primary configuration file, outputs findings to standard out, this is experimental and provisional for now but is much needed to minimize time taken for debugging issues

Parameters:
fileName - the file name of the configuration file

init

public void init(java.util.Hashtable hash)

run

public void run(java.util.Hashtable hash)

run

public void run(java.util.Hashtable hash,
                boolean bSilent,
                boolean bOverwrite)

setLoader

public void setLoader(java.lang.ClassLoader _loader)

getLoader

public java.lang.ClassLoader getLoader()

getString

public java.lang.String getString(java.lang.String tag)
Return the resource string associated with the class

Parameters:
tag - The tag of the string
Returns:
The resolved string

trim

public java.lang.String trim(java.lang.String str)
Trimming off the leading and trailing white spaces

Parameters:
str - String to be trimmed
Returns:
The resulting string

setFileName

public void setFileName(java.lang.String fileName)
Parameters:
fileName - The fileName to set.

setPluginName

public void setPluginName(java.lang.String name)
Set the plugin name (the directory with version)

Parameters:
name -

getPluginName

public java.lang.String getPluginName()
Retrieve the plugin name (the directory with version)

Returns:

getNLFiles

public java.util.Enumeration getNLFiles()
Bug 93461 Retrieve the list of jar files inside the NL plugin


getNLFiles

public java.util.Enumeration getNLFiles(java.io.File pDir,
                                        java.lang.String plugin)

TPTP 4.6.0 Platform Project
Public API Specification