org.helenus.commons.cli

Class RunnableFirstOption

java.lang.Object

org.apache.commons.cli.Option

org.helenus.commons.cli.RunnableFirstOption

All Implemented Interfaces:

Serializable, Cloneable

public abstract class RunnableFirstOption
extends Option

The RunnableFirstOption class extends Apache's {#link Option} class in order to provide the option to embed the running logic inside the option itself when it needs to be ran first before all other options.

Since:

1.0

Version:

1 - Jan 15, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

See Also:

Serialized Form

Copyright:

2015-2015 The Helenus Driver Project Authors

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.cli.Option

Option.Builder

Field Summary

Fields inherited from class org.apache.commons.cli.Option

UNINITIALIZED, UNLIMITED_VALUES

Constructor Summary

Constructors

Constructor and Description
RunnableFirstOption(String opt, boolean hasArg, String description) Instantiates a new RunnableOption object.
RunnableFirstOption(String opt, String description) Instantiates a new RunnableOption object.
RunnableFirstOption(String opt, String longOpt, boolean hasArg, String description) Instantiates a new RunnableOption object.

Method Summary

Modifier and Type	Method and Description
abstract void	run(CommandLine line) Runs this particular option based on the provided command line.

Methods inherited from class org.apache.commons.cli.Option

addValue, builder, builder, clone, equals, getArgName, getArgs, getDescription, getId, getLongOpt, getOpt, getType, getValue, getValue, getValue, getValues, getValueSeparator, getValuesList, hasArg, hasArgName, hasArgs, hashCode, hasLongOpt, hasOptionalArg, hasValueSeparator, isRequired, setArgName, setArgs, setDescription, setLongOpt, setOptionalArg, setRequired, setType, setType, setValueSeparator, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RunnableFirstOption

public RunnableFirstOption(String opt,
                           boolean hasArg,
                           String description)
                    throws IllegalArgumentException

Instantiates a new RunnableOption object.

Parameters:

opt - short representation of the option

hasArg - specifies whether the Option takes an argument or not

description - describes the function of the option

Throws:

IllegalArgumentException - if there are any non valid Option characters in opt.

RunnableFirstOption

public RunnableFirstOption(String opt,
                           String longOpt,
                           boolean hasArg,
                           String description)
                    throws IllegalArgumentException

Instantiates a new RunnableOption object.

Parameters:

opt - short representation of the option

longOpt - the long representation of the option

hasArg - specifies whether the Option takes an argument or not

description - describes the function of the option

Throws:

IllegalArgumentException - if there are any non valid Option characters in opt.

RunnableFirstOption

public RunnableFirstOption(String opt,
                           String description)
                    throws IllegalArgumentException

Instantiates a new RunnableOption object.

Parameters:

opt - short representation of the option

description - describes the function of the option

Throws:

IllegalArgumentException - if there are any non valid Option characters in opt.

Method Detail

run

public abstract void run(CommandLine line)
                  throws Exception

Runs this particular option based on the provided command line.

Parameters:

line - the command line for which to run this option

Throws:

Exception - if an error occurred while running the command option