org.jostraca
Class Jostraca

java.lang.Object
  org.jostraca.Jostraca

public class Jostraca

extends java.lang.Object

Command line user interface to the Jostraca system.

Field Summary

static char	ARG_ADD_CONFIG
static char	ARG_ALL_TEMPLATES
static char	ARG_ARGUMENT
static char	ARG_BACKUP_FOLDER
static char	ARG_COMPILE
static char	ARG_CONFIG
static char	ARG_DEFINE
static char	ARG_DUMP
static char	ARG_GENERATE
static char	ARG_HIGH_VERBOSE
static char	ARG_LOW_VERBOSE
static char	ARG_META_FOLDER
static char	ARG_NO_BACKUP
static char	ARG_NO_COMPILE
static char	ARG_NO_GENERATE
static char	ARG_NO_META
static char	ARG_NON_STANDARD
static char	ARG_OUTPUT_FOLDER
static char	ARG_TEMPLATE_DOC
static char	ARG_TEMPLATE_LIST
static char	ARG_WORK_FOLDER
static char	ARG_WRITER_FORMAT
static java.lang.String	CN
static java.lang.String	DEFAULT_ConfigPath
static java.lang.String	NSA_noexit
static java.lang.String	NSA_old
static java.lang.String	NSA_track
static java.lang.String	SPECIAL_ARG_CHECK
static java.lang.String	SPECIAL_ARG_HELP
static java.lang.String	SPECIAL_ARG_VERSION

Constructor Summary

Jostraca()

Method Summary

static void	addTemplatePaths(java.util.List pTemplates, java.util.List pTemplatePathsToAdd) Add paths to template files using a List of Strings or TemplatePath objects.
static void	displayErr(java.lang.Exception pException) Send exception description to user.
static void	displayErr(java.lang.String pMessage) Send error text message to user.
void	displayInfo(java.lang.String pMessage) Send informational text message to user.
static void	displayInstallationOKMessage(java.lang.String pHomeFolder) Display installation ok message.
static void	displayVersion() Display version information.
static void	execute(java.lang.String[] pArgs) Main execution point.
boolean	getCheckInstallation() Get CheckInstallation mode.
UserMessageHandler	getUserMessageHandler() Get UserMessageHandler that recieves a series of plain text messages for the user.
static void	main(java.lang.String[] pArgs) Main entry point to command line Jostraca application.
static PropertySet	parseCommandLine(java.lang.String[] pArgs, java.util.ArrayList pTemplates, java.util.ArrayList pAdditionalConfig) Parse cmd line used to invoke Jostraca.
static PropertySet	parseCommandLine(java.lang.String pArgString, java.util.ArrayList pTemplates, java.util.ArrayList pAdditionalConfig)
void	setCheckInstallation(boolean pCheckInstallation) Set CheckInstallation mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CN

public static final java.lang.String CN

ARG_CONFIG

public static final char ARG_CONFIG

See Also:

Constant Field Values

ARG_ADD_CONFIG

public static final char ARG_ADD_CONFIG

See Also:

Constant Field Values

ARG_WRITER_FORMAT

public static final char ARG_WRITER_FORMAT

See Also:

Constant Field Values

ARG_TEMPLATE_LIST

public static final char ARG_TEMPLATE_LIST

See Also:

Constant Field Values

ARG_OUTPUT_FOLDER

public static final char ARG_OUTPUT_FOLDER

See Also:

Constant Field Values

ARG_WORK_FOLDER

public static final char ARG_WORK_FOLDER

See Also:

Constant Field Values

ARG_ARGUMENT

public static final char ARG_ARGUMENT

See Also:

Constant Field Values

ARG_DUMP

public static final char ARG_DUMP

See Also:

Constant Field Values

ARG_DEFINE

public static final char ARG_DEFINE

See Also:

Constant Field Values

ARG_BACKUP_FOLDER

public static final char ARG_BACKUP_FOLDER

See Also:

Constant Field Values

ARG_ALL_TEMPLATES

public static final char ARG_ALL_TEMPLATES

See Also:

Constant Field Values

ARG_NO_BACKUP

public static final char ARG_NO_BACKUP

See Also:

Constant Field Values

ARG_LOW_VERBOSE

public static final char ARG_LOW_VERBOSE

See Also:

Constant Field Values

ARG_HIGH_VERBOSE

public static final char ARG_HIGH_VERBOSE

See Also:

Constant Field Values

ARG_COMPILE

public static final char ARG_COMPILE

See Also:

Constant Field Values

ARG_NO_COMPILE

public static final char ARG_NO_COMPILE

See Also:

Constant Field Values

ARG_GENERATE

public static final char ARG_GENERATE

See Also:

Constant Field Values

ARG_NO_GENERATE

public static final char ARG_NO_GENERATE

See Also:

Constant Field Values

ARG_TEMPLATE_DOC

public static final char ARG_TEMPLATE_DOC

See Also:

Constant Field Values

ARG_NON_STANDARD

public static final char ARG_NON_STANDARD

See Also:

Constant Field Values

ARG_META_FOLDER

public static final char ARG_META_FOLDER

See Also:

Constant Field Values

ARG_NO_META

public static final char ARG_NO_META

See Also:

Constant Field Values

SPECIAL_ARG_CHECK

public static final java.lang.String SPECIAL_ARG_CHECK

See Also:

Constant Field Values

SPECIAL_ARG_VERSION

public static final java.lang.String SPECIAL_ARG_VERSION

See Also:

Constant Field Values

SPECIAL_ARG_HELP

public static final java.lang.String SPECIAL_ARG_HELP

See Also:

Constant Field Values

NSA_old

public static final java.lang.String NSA_old

See Also:

Constant Field Values

NSA_noexit

public static final java.lang.String NSA_noexit

See Also:

Constant Field Values

NSA_track

public static final java.lang.String NSA_track

See Also:

Constant Field Values

DEFAULT_ConfigPath

public static final java.lang.String DEFAULT_ConfigPath

See Also:

Constant Field Values

Constructor Detail

Jostraca

public Jostraca()

Method Detail

getUserMessageHandler

public UserMessageHandler getUserMessageHandler()

Get UserMessageHandler that recieves a series of plain text messages for the user.

setCheckInstallation

public void setCheckInstallation(boolean pCheckInstallation)

Set CheckInstallation mode. true => just check install and don't try to generate anything

Parameters:

pCheckInstallation - boolean

getCheckInstallation

public boolean getCheckInstallation()

Get CheckInstallation mode.

addTemplatePaths

public static void addTemplatePaths(java.util.List pTemplates,
                                    java.util.List pTemplatePathsToAdd)
                             throws TemplateException

Add paths to template files using a List of Strings or TemplatePath objects.

Parameters:

pTemplates - list of templates to modify

pTemplatePathsToAdd - paths to template files

Throws:

TemplateException

displayInfo

public void displayInfo(java.lang.String pMessage)

Send informational text message to user.

Parameters:

pMessage - text

displayErr

public static void displayErr(java.lang.String pMessage)

Send error text message to user.

Parameters:

pMessage - text

displayErr

public static void displayErr(java.lang.Exception pException)

Send exception description to user.

Parameters:

pException - exception

displayInstallationOKMessage

public static final void displayInstallationOKMessage(java.lang.String pHomeFolder)

Display installation ok message.

displayVersion

public static final void displayVersion()

Display version information.

parseCommandLine

public static PropertySet parseCommandLine(java.lang.String pArgString,
                                           java.util.ArrayList pTemplates,
                                           java.util.ArrayList pAdditionalConfig)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

parseCommandLine

public static PropertySet parseCommandLine(java.lang.String[] pArgs,
                                           java.util.ArrayList pTemplates,
                                           java.util.ArrayList pAdditionalConfig)
                                    throws java.lang.Exception

Parse cmd line used to invoke Jostraca.

Parameters:

pArgs - array of command line arguments

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] pArgs)

Main entry point to command line Jostraca application.

Parameters:

pArgs - command line arguments

execute

public static void execute(java.lang.String[] pArgs)
                    throws java.lang.Exception

Main execution point.

Parameters:

pArgs - command line arguments

Throws:

java.lang.Exception