gw.lang.cli

Class CommandLineAccess

java.lang.Object

gw.lang.cli.CommandLineAccess

public class CommandLineAccess
extends Object

Constructor Summary

Constructors

Constructor and Description
CommandLineAccess()

Method Summary

Modifier and Type	Method and Description
protected static String	deriveDescription(IPropertyInfo propertyInfo)
static File	getCurrentProgram()
static String	getHelpMessageFor(Object obj) Returns the help message derived from the given type
static List<String>	getRawArgs()
static void	initialize(IType commandLineShell) Initializes the static properties on the given type based on the command line arguments.
static boolean	initialize(Object obj, boolean exitOnBadArgs) Initializes the properties on the given object based on the command line arguments.
static boolean	isUseTerminalWidth()
static void	setCurrentProgram(File currentProgram)
static void	setExitEnabled(boolean exitEnabled)
static void	setRawArgs(List<String> args)
static void	setUseTerminalWidth(boolean b) Set to true for CommandLineAccess to use the active terminals width when printing it's help message
static void	showHelp(IType obj) Shows a help message for the program arguments derived from the given type, sent to stdout
static void	showHelp(String programName, Object obj) Shows a help message for the program arguments derived from the given type, sent to stdout

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineAccess

public CommandLineAccess()

Method Detail

getRawArgs

public static List<String> getRawArgs()

Returns:

the raw string arguments a Gosu program was started with

setRawArgs

public static void setRawArgs(List<String> args)

Parameters:

args - the args to a Gosu program

getCurrentProgram

public static File getCurrentProgram()

Returns:

the currently executing program as a file object

setCurrentProgram

public static void setCurrentProgram(File currentProgram)

Parameters:

currentProgram - - the currently executing program

isUseTerminalWidth

public static boolean isUseTerminalWidth()

Returns:

true if CommandLineAccess will attempt to use the active terminals width when printing it's help message

setUseTerminalWidth

public static void setUseTerminalWidth(boolean b)

Set to true for CommandLineAccess to use the active terminals width when printing it's help message

initialize

public static void initialize(IType commandLineShell)

Initializes the static properties on the given type based on the command line arguments. If the arguments incorrectly map to the given type, a help message will be printed and the JVM will exit with a -1 return value.

Parameters:

commandLineShell - the class to initialize from the passed in arguments

initialize

public static boolean initialize(Object obj,
                                 boolean exitOnBadArgs)

Initializes the properties on the given object based on the command line arguments. If the object passed in is a type, static properties will be initialized.

Note that you will get -h, -help and --help for free, there is no need to explicitly include a help property on your command line class.

Parameters:

obj - the class to initialize from the passed in arguments

exitOnBadArgs - if true is passed in and the arguments incorrectly map to the given type, a help message will be printed and the JVM will exit with a -1 return value, otherwise a false value will be returned

Returns:

true if initialization was successful

showHelp

public static void showHelp(String programName,
                            Object obj)

Shows a help message for the program arguments derived from the given type, sent to stdout

Parameters:

programName - the name of the program

obj - either the type of the command line shell if static properties are used, or the instance if instance properties are used

showHelp

public static void showHelp(IType obj)

Shows a help message for the program arguments derived from the given type, sent to stdout

Parameters:

obj - either the type of the command line shell if static properties are used, or the instance if instance properties are used

getHelpMessageFor

public static String getHelpMessageFor(Object obj)

Returns the help message derived from the given type

Parameters:

obj - the object or type of the command line shell

Returns:

the help message derived from the given type

deriveDescription

protected static String deriveDescription(IPropertyInfo propertyInfo)

setExitEnabled

public static void setExitEnabled(boolean exitEnabled)