com.psec.util

Class Parm.Opt

java.lang.Object

com.psec.util.Parm.Opt

Enclosing class:

Parm

public static class Parm.Opt
extends java.lang.Object

Base class for option set.

It is intended that this base class be extended with custom fields (and even methods if needed) according to the program requirements.

This also serves to supply the initialization methods to populate the options and afterwards invoke the custom run time routines that process based on these options.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bHelp Trigger dump of options when true.
java.lang.String	sBrief Fully qualified name of Brief file.

Constructor Summary

Constructors

Constructor and Description
Opt()

Method Summary

Modifier and Type	Method and Description
void	addProp(java.lang.String sProp) Parse and add property string.
java.lang.String	getProp(java.lang.String sKey) Return property value for sKey or null;
java.lang.String	getProp(java.lang.String sKey, java.lang.String sDef) Return property value for sKey or sDef;
java.lang.String[]	getProps() Return an array of property value names;
boolean	isTrue(java.lang.String sProp) Return whether a property value represents true.
void	mainStart(Parm[] oParms, java.lang.String[] sArgs, Parm.MainRun oRun) The mainStart method handles the standard startup and termination procedures.
void	selfIntro(java.lang.Object self) Print to System.out standard introductory line.
void	setBrief(Parm.Brief oBrief) Set the internal oBrief value to paramater oBrief value.

Methods inherited from class java.lang.Object

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

Field Detail

bHelp

public boolean bHelp

Trigger dump of options when true. When true the Parm parser will trigger a dump of the possible options and terminate.

sBrief

public java.lang.String sBrief

Fully qualified name of Brief file. Populated by setBrief method.

Constructor Detail

Opt

public Opt()

Method Detail

addProp

public void addProp(java.lang.String sProp)

Parse and add property string. After removing the prefix, by convention -def, the sProp string is split on the first equal sign (=), the left being the name and the right being the value.

Multiple values are permitted. The last silently replaces the former.

Inproperly formatted strings are silently ignored.

Parameters:

sProp - the property string.

selfIntro

public void selfIntro(java.lang.Object self)

Print to System.out standard introductory line. The self parameter is used to determine the class.

Parameters:

self - The class to which this message applies.

getProp

public java.lang.String getProp(java.lang.String sKey)

Return property value for sKey or null;

Parameters:

sKey - The case sensitive property name.

getProp

public java.lang.String getProp(java.lang.String sKey,
                                java.lang.String sDef)

Return property value for sKey or sDef;

Parameters:

sKey - The case sensitive property name.

sDef - The default value to return if sKey does not exist.

getProps

public java.lang.String[] getProps()

Return an array of property value names;

Returns:

the String array of names.

isTrue

public boolean isTrue(java.lang.String sProp)

Return whether a property value represents true. A true value starts with "t", "T", "y" or "Y".

Parameters:

sProp - The case sensitive property name.

Returns:

the result.

mainStart

public void mainStart(Parm[] oParms,
                      java.lang.String[] sArgs,
                      Parm.MainRun oRun)

The mainStart method handles the standard startup and termination procedures.

First the parameters are passed using processArguments.

If the parse fails or the bHelp flag is true, the printHelp method is called and the run terminates.

Otherwise the run method is called.

When the run method returns and the internal oBrief object populated by the setBrief method call is populated, it is transformed to a JSON object using GsonBuilder and written to the file specified by sBrief.

Finally, the run terminates.

Parameters:

oParms - The option table to parse.

sArgs - The arguments to match.

oRun - The MainRun mainline instance on which to invoke the run method.

setBrief

public void setBrief(Parm.Brief oBrief)
              throws java.lang.Exception

Set the internal oBrief value to paramater oBrief value.

The internal sBrief value must be populated or an Exception occurs.

If the physical files exists it is deleted. This means that at the end of the run the external routines can know that the non-existance of the Brief file implies a run failure.

For this protcol to work reliably, this method call should be issued at the beginning of the run invokation.

Parameters:

oBrief - The Brief extended instance.

Throws:

java.lang.Exception