T
- Class type.public abstract class CLO<T>
extends java.lang.Object
Modifier | Constructor and Description |
---|---|
protected |
CLO(java.lang.String shorOption,
java.lang.String longOption,
java.lang.String description)
Constructor for the inheriting classes.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
getCommandLineInput(CommandLine mCL)
Returns the command line value from a given CommandLine Object.
|
java.lang.String |
getDescription() |
java.lang.String |
getLongOption() |
java.lang.String |
getOptionsHelpOutput()
Returns the command line arguments in a command line help-pattern.
|
java.lang.String |
getShortOption() |
void |
setDescription(java.lang.String description) |
void |
setLongOption(java.lang.String longOption) |
void |
setShortOption(java.lang.String shortOption) |
java.lang.String |
toString() |
abstract T |
validateAndReturn(CommandLine mCL)
Validate and return the command line arguments user input.
|
T |
validateAndReturn(CommandLine mCL,
boolean required)
Validate and return the command line arguments user input.
|
protected CLO(java.lang.String shorOption, java.lang.String longOption, java.lang.String description)
shorOption
- (String) Short command line parameter.longOption
- (String) Long command line parameter.description
- (String) Parameter description that will be shown in the
command line helppublic abstract T validateAndReturn(CommandLine mCL) throws java.lang.Exception
mCL
- (CommandLine) The command line object.java.lang.Exception
- Thrown when the validation fails.public final T validateAndReturn(CommandLine mCL, boolean required) throws java.lang.Exception
mCL
- (CommandLine) The command line object.required
- (boolean) Is this parameter required in the cli or not.java.lang.Exception
- Thrown when the validation fails.protected final java.lang.String getCommandLineInput(CommandLine mCL)
mCL
- (CommandLine) The command line object containing the input value.public final java.lang.String getOptionsHelpOutput()
public final java.lang.String getLongOption()
public final void setLongOption(java.lang.String longOption)
longOption
- (String) Long command line option String.public final java.lang.String getShortOption()
public final void setShortOption(java.lang.String shortOption)
shortOption
- (String) Short command line option String.public final java.lang.String getDescription()
public final void setDescription(java.lang.String description)
description
- (String) The command line options description.public final java.lang.String toString()
toString
in class java.lang.Object