Package org.refcodes.console
Class AbstractOption<T>
- java.lang.Object
-
- org.refcodes.console.AbstractOperand<T>
-
- org.refcodes.console.AbstractOption<T>
-
- Type Parameters:
T
- the generic type
- All Implemented Interfaces:
java.lang.Comparable<Operand<?>>
,org.refcodes.component.Resetable
,ArgsAccessor
,Operand<T>
,Option<T>
,Syntaxable
,SyntaxUsage
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<T>
,org.refcodes.mixin.ValueAccessor<T>
- Direct Known Subclasses:
EnumOptionImpl
,IntegerOptionImpl
,StringOptionImpl
,SwitchImpl
public abstract class AbstractOption<T> extends AbstractOperand<T> implements Option<T>
TheAbstractOption
is an abstract implementation of anOption
providing the boiler plate when implementing theOption
interface.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
-
Nested classes/interfaces inherited from interface org.refcodes.console.ArgsAccessor
ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor
org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>
-
Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends java.lang.Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends java.lang.Object>
-
-
Field Summary
-
Fields inherited from class org.refcodes.console.AbstractOperand
_value
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aDescription)
Constructs aOption
with the given arguments.AbstractOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)
Constructs aOption
with the given arguments.AbstractOption(org.refcodes.structure.Relation<java.lang.String,T> aProperty, java.lang.Class<T> aType)
Instantiates a new option.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getLongOption()
TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing anOption
instance.java.lang.String
getShortOption()
Returns the short-option representing anOption
instance.java.util.List<Operand<T>>
parseArgs(java.lang.String[] aArgs)
Parses the provided command line arguments and determines the according values by evaluating thisSyntaxable
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[])
methods.protected void
setArgs(java.lang.String[] aArgs)
Sets the command line argument(s) representing theOperand
and its value as parsed by theAbstractOperand.parseArgs(String[])
method.protected void
setValue(T aValue)
Sets the value for theOperand
as parsed by theAbstractOperand.parseArgs(String[])
method.java.lang.String
toState()
TheSyntaxable.toState()
method might be used by theObject.toString()
method and prints out the state of the syntaxable and (if any) its children.java.lang.String
toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSyntaxUsage.toUsage(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
.java.lang.String
toUsage(SyntaxNotation aSyntaxNotation)
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation)
is called from inside aSyntaxable
hierarchy.-
Methods inherited from class org.refcodes.console.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, reset, toString, toValue
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.console.Operand
get, getAlias, getArgs, getValue, hasValue
-
Methods inherited from interface org.refcodes.console.SyntaxUsage
toUsage, toUsage
-
-
-
-
Constructor Detail
-
AbstractOption
public AbstractOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)
Constructs aOption
with the given arguments.- Parameters:
aShortOption
- The short-option being a single character with the additional single hyphen-minus "-" prefix.aLongOption
- The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.aType
- The type of the value returned by theAbstractOperand.getValue()
method.aAlias
- The option argument's name to be used when constructing the syntax.aDescription
- A description without any line breaks.
-
AbstractOption
protected AbstractOption(java.lang.String aShortOption, java.lang.String aLongOption, java.lang.Class<T> aType, java.lang.String aDescription)
Constructs aOption
with the given arguments.- Parameters:
aShortOption
- The short-option being a single character with the additional single hyphen-minus "-" prefix.aLongOption
- The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.aType
- The type of the value returned by theAbstractOperand.getValue()
method.aDescription
- A description without any line breaks.
-
-
Method Detail
-
parseArgs
public java.util.List<Operand<T>> parseArgs(java.lang.String[] aArgs) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException
Parses the provided command line arguments and determines the according values by evaluating thisSyntaxable
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[])
methods. In case of successfully parsing thisSyntaxable
and / or the childSyntaxable
instances, the evaluated command line arguments are returned: Depending on theSyntaxable
subclasses representing the evaluated command line arguments, instances ofSwitch
classes,Option
classes orOperand
classes may be found in the result. In case of parsing failure, an according exception is thrown. ATTENTION: This method does not test for superfluous command line arguments being passed; e.g. command line arguments not being evaluated by any of theSyntaxable
instance being traversed. This method is commonly used by a rootSyntaxable
'sArgsParser.evalArgs(String[])
method, which delegates to theSyntaxable.parseArgs(String[])
method and after which it determines whether there are superfluous arguments to be taken care of (by throwing an according exception). Business logic therefore should invoke the root node'sSyntaxable.parseArgs(String[])
method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.- Specified by:
parseArgs
in interfaceSyntaxable
- Overrides:
parseArgs
in classAbstractOperand<T>
- Parameters:
aArgs
- The command line arguments to be parsed.- Returns:
- The list of evaluated command line arguments being instances of
the
Operand
interfaces or its sub-types. - Throws:
UnknownArgsException
- Thrown in case not one command line argument matched regarding the provided args vs. the expected args.AmbiguousArgsException
- Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type
-
getShortOption
public java.lang.String getShortOption()
Returns the short-option representing anOption
instance. A short option usually is being prefixed with a single hyphen-minus "-" as defined inCommandArgPrefix.POSIX_SHORT_OPTION
.- Specified by:
getShortOption
in interfaceOption<T>
- Returns:
- The short-option
String
.
-
getLongOption
public java.lang.String getLongOption()
TODO: Make the option to be required without the hyphen-minuses "--" Returns the long-option representing anOption
instance. A long option usually is being prefixed with a double hyphen-minus "--" as defined inCommandArgPrefix.POSIX_LONGT_OPTION
.- Specified by:
getLongOption
in interfaceOption<T>
- Returns:
- The long-option
String
.
-
toSyntax
public java.lang.String toSyntax(SyntaxNotation aSyntaxNotation)
This method is to be called from inside theSyntaxable
hierarchy; use the methodSyntaxUsage.toUsage(SyntaxNotation)
in case you invoke syntax retrieval from the rootSyntaxable
. Returns the human readable (verbose) syntax of thisSyntaxable
instance including, in case of being a node in the syntax tree (such as aCondition
, the syntax of the childSyntaxable
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation)
is called from inside theSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
, then the applicable method to be called isSyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSyntax
in interfaceSyntaxable
- Overrides:
toSyntax
in classAbstractOperand<T>
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
toState
public java.lang.String toState()
TheSyntaxable.toState()
method might be used by theObject.toString()
method and prints out the state of the syntaxable and (if any) its children. Even in case parsing command line arguments failed, the state till failure can be inspected with this method.- Specified by:
toState
in interfaceSyntaxable
- Overrides:
toState
in classAbstractOperand<T>
- Returns:
- The state of this
Syntaxable
instance and (if any) its children.
-
setValue
protected void setValue(T aValue)
Sets the value for theOperand
as parsed by theAbstractOperand.parseArgs(String[])
method.- Overrides:
setValue
in classAbstractOperand<T>
- Parameters:
aValue
- The value to be set for thisOperand
.
-
setArgs
protected void setArgs(java.lang.String[] aArgs)
Sets the command line argument(s) representing theOperand
and its value as parsed by theAbstractOperand.parseArgs(String[])
method.- Overrides:
setArgs
in classAbstractOperand<T>
- Parameters:
aArgs
- The command line arguments representing thisOperand
with its value.
-
toUsage
public java.lang.String toUsage(SyntaxNotation aSyntaxNotation)
Description copied from interface:SyntaxUsage
Returns the human readable (verbose) syntax of implementing class ATTENTION: As of different parenthesis settings for some notations regarding the rootSyntaxable
and the childSyntaxable
s, the methodSyntaxable.toSyntax(SyntaxNotation)
is called from inside aSyntaxable
hierarchy. In case the syntax is to be retrieved from the rootSyntaxable
or an encapsulating and different type, then the applicable method to be called isSyntaxUsage.toUsage(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toUsage
in interfaceSyntaxUsage
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-