org.kepler

Class CommandLineArgument

java.lang.Object

org.kepler.CommandLineArgument

public class CommandLineArgument
extends java.lang.Object

A class to hold command line argument information used when parsing the Kepler command like arguments.

Author:

Daniel Crawl

Method Summary

Modifier and Type	Method and Description
static CommandLineArgument	add(java.lang.String flag, int numArgs, java.lang.String description, java.lang.Object... defaultStr) Add a new CommandLineArgument for a flag with following values.
static CommandLineArgument	add(java.lang.String flag, java.lang.String description) Add a new CommandLineArgument for a flag with a description.
static CommandLineArgument	get(java.lang.String flag) Get the CommandLineArgument for a specific flag.
java.lang.String	getActionClass() Get the action class.
java.lang.String	getActionMethod() Get the action method.
static java.util.Collection<CommandLineArgument>	getAll() Get all the CommandLineArguments registered.
java.lang.String	getFlag() Get the flag.
java.lang.String	getUsage() Get a string for the command line usage.
java.lang.String	getValue() Get the value of the first argument.
java.lang.String	getValue(int index) Get the value of the argument at a specific index.
static java.lang.String	getValue(java.lang.String flag) Get the value of the first argument for a flag.
boolean	isAction() Returns true if this CommandLineArgument is an action to run Kepler.
int	parseRemainingArgs(java.lang.String[] args, int i) Parse one or more of the remaining command line arguments.
void	setAction(java.lang.String actionClass, java.lang.String actionMethod) Set the class and method to invoke if this argument is seen on the command line.
java.lang.String	toString() Get a string representation of the command line argument.
boolean	wasParsed() Returns true if the last call to parseRemainingArgs() succeeded.
static boolean	wasParsed(java.lang.String flag) Returns true if the last call to parseRemainingArgs() succeeded.

Methods inherited from class java.lang.Object

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

Method Detail

add

public static CommandLineArgument add(java.lang.String flag,
                                      java.lang.String description)

Add a new CommandLineArgument for a flag with a description.

add

public static CommandLineArgument add(java.lang.String flag,
                                      int numArgs,
                                      java.lang.String description,
                                      java.lang.Object... defaultStr)

Add a new CommandLineArgument for a flag with following values.

get

public static CommandLineArgument get(java.lang.String flag)

Get the CommandLineArgument for a specific flag.

getAll

public static java.util.Collection<CommandLineArgument> getAll()

Get all the CommandLineArguments registered.

getFlag

public java.lang.String getFlag()

Get the flag.

getActionClass

public java.lang.String getActionClass()

Get the action class.

getActionMethod

public java.lang.String getActionMethod()

Get the action method.

getUsage

public java.lang.String getUsage()

Get a string for the command line usage.

getValue

public java.lang.String getValue()

Get the value of the first argument.

getValue

public java.lang.String getValue(int index)

Get the value of the argument at a specific index.

getValue

public static java.lang.String getValue(java.lang.String flag)

Get the value of the first argument for a flag.

isAction

public boolean isAction()

Returns true if this CommandLineArgument is an action to run Kepler. If true, then run() will be called instead of launching the Kepler UI or running a workflow from the command line.

parseRemainingArgs

public int parseRemainingArgs(java.lang.String[] args,
                              int i)
                       throws java.lang.IllegalArgumentException

Parse one or more of the remaining command line arguments.

Parameters:

The - command line arguments.

The - index to the current command line argument yet to be parsed.

Returns:

If one or more of the current command line arguments can be parsed, the index to the next unparsed argument. Otherwise (no arguments can be parsed), returns -1.

Throws:

java.lang.IllegalArgumentException

setAction

public void setAction(java.lang.String actionClass,
                      java.lang.String actionMethod)

Set the class and method to invoke if this argument is seen on the command line.

toString

public java.lang.String toString()

Get a string representation of the command line argument.

Overrides:

toString in class java.lang.Object

wasParsed

public boolean wasParsed()

Returns true if the last call to parseRemainingArgs() succeeded.

wasParsed

public static boolean wasParsed(java.lang.String flag)

Returns true if the last call to parseRemainingArgs() succeeded.