java.lang.Object
org.refcodes.cli.AbstractOperand<T>
org.refcodes.cli.AbstractOption<T>
org.refcodes.cli.EnumOption<T>
- Type Parameters:
T
- The generic type of the enumeration.
- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,MatchCountAccessor
,Operand<T>
,Option<T>
,Synopsisable
,Term
,org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable
,org.refcodes.mixin.TypeAccessor<T>
,org.refcodes.mixin.ValueAccessor<T>
The
EnumOption
represents an Option
of enumeration types.-
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.cli.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.exception.ExceptionAccessor
org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC extends Throwable,
B extends org.refcodes.exception.ExceptionAccessor.ExceptionBuilder<EXC, B>>, org.refcodes.exception.ExceptionAccessor.ExceptionMutator<EXC extends Throwable>, org.refcodes.exception.ExceptionAccessor.ExceptionProperty<EXC extends Throwable> Nested classes/interfaces inherited from interface org.refcodes.cli.MatchCountAccessor
MatchCountAccessor.MatchCountBuilder<B extends MatchCountAccessor.MatchCountBuilder<B>>, MatchCountAccessor.MatchCountMutator, MatchCountAccessor.MatchCountProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor
org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,
B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T, B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object> Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,
B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V, B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object> -
Field Summary
Fields inherited from class org.refcodes.cli.AbstractOperand
_matchCount
-
Constructor Summary
ConstructorDescriptionInstantiates a newEnumOption
with the given arguments.EnumOption
(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription) Instantiates a newEnumOption
with the given arguments.EnumOption
(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.EnumOption
(Character aShortOption, String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.EnumOption
(String aLongOption, Class<T> aType, String aDescription) Instantiates a newEnumOption
with the given arguments.Instantiates a newEnumOption
with the given arguments.EnumOption
(String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.EnumOption
(String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.EnumOption
(org.refcodes.struct.Relation<String, T> aProperty, Class<T> aType) Instantiates a newEnumOption
with the alias being the proerty's key and the value being the property's value.EnumOption
(org.refcodes.struct.Relation<String, T> aProperty, Class<T> aType, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the alias being the proerty's key and the value being the property's value. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed.protected static String[]
toArgsDiff
(String[] aArgs, String[] aArgsSubset) Creates the difference between the provided set and the provided subset.protected static String[]
toArgsDiff
(String[] aArgs, List<? extends Operand<?>> aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getArgs()
).protected static String[]
toArgsDiff
(String[] aArgs, Operand<?>[] aArgsSubset) Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getArgs()
).protected static String[]
toParsedArgs
(Operand<?>[]... aOperands) Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getArgs()
) to the result.protected T
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.Methods inherited from class org.refcodes.cli.AbstractOption
clone, contains, getLongOption, getShortOption, parseArgs, setParsedArgs, setValue, toException, toSchema, toSyntax
Methods inherited from class org.refcodes.cli.AbstractOperand
approve, compareTo, getAlias, getArgs, getMatchCount, getType, getValue, reset, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.cli.Operand
getAlias, getArgs, getValue, hasValue, toSpec, toSpec, toValue
Methods inherited from interface org.refcodes.mixin.Resetable
reset
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.cli.Term
getException, getMatchCount, parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.TypeAccessor
getType
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Field Details
-
_description
-
_exception
-
-
Constructor Details
-
EnumOption
Instantiates a newEnumOption
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aDescription
- The description of theEnumOption
-
EnumOption
public EnumOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription) Instantiates a newEnumOption
with the given arguments.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theEnumOption
-
EnumOption
Instantiates a newEnumOption
with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.- Parameters:
aProperty
- The key (=alias) and the value for the operand.aType
- The type of the enumeration to be used.
-
EnumOption
Instantiates a newEnumOption
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.- Parameters:
aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aDescription
- The description of theEnumOption
-
EnumOption
Instantiates a newEnumOption
with the given arguments.- Parameters:
aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theEnumOption
-
EnumOption
public EnumOption(Character aShortOption, String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aDescription
- The description of theEnumOption
aConsumer
- TheConsumer
being invoked in case thisEnumOption
participated in successfully parsing the command line arguments.
-
EnumOption
public EnumOption(Character aShortOption, String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theEnumOption
aConsumer
- TheConsumer
being invoked in case thisEnumOption
participated in successfully parsing the command line arguments.
-
EnumOption
public EnumOption(org.refcodes.struct.Relation<String, T> aProperty, Class<T> aType, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.- Parameters:
aProperty
- The key (=alias) and the value for the operand.aType
- The type of the enumeration to be used.aConsumer
- TheConsumer
being invoked in case thisEnumOption
participated in successfully parsing the command line arguments.
-
EnumOption
public EnumOption(String aLongOption, Class<T> aType, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.- Parameters:
aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aDescription
- The description of theEnumOption
aConsumer
- TheConsumer
being invoked in case thisEnumOption
participated in successfully parsing the command line arguments.
-
EnumOption
public EnumOption(String aLongOption, Class<T> aType, String aAlias, String aDescription, Consumer<EnumOption<T>> aConsumer) Instantiates a newEnumOption
with the given arguments.- Parameters:
aLongOption
- The long option to use.aType
- The type of the enumeration to be used.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theEnumOption
aConsumer
- TheConsumer
being invoked in case thisEnumOption
participated in successfully parsing the command line arguments.
-
-
Method Details
-
toType
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type. In case conversion failed, then an according exception is to be thrown.- Specified by:
toType
in classAbstractOperand<T extends Enum<T>>
- Parameters:
aArg
- The command line argument to be converted to an instance of the given type T.- Returns:
- An instance of type T from the provided command line argument.
- Throws:
ParseArgsException
- Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type.
-
getDescription
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
getException
Retrieves theArgsSyntaxException
exception in case invokingTerm.parseArgs(String[], CliContext)
failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by theTerm.parseArgs(String[], CliContext)
method depending on the semantics of theTerm
handing the exception (theAnyCondition
provides any exceptions it caught even though it did not throw them as of its semantics).- Specified by:
getException
in interfaceorg.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>
- Specified by:
getException
in interfaceTerm
- Returns:
- The
ArgsSyntaxException
exception occurring while parsing the arguments.
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the providedList
s therein found argument arrays subset (as ofOperand.getArgs()
).- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation being the lists containing theOperand
instances whose command line arguments are to be diffed.- Returns:
- The difference between the set and the subset.
-
toArgsDiff
Creates the difference between the provided set and the provided subset.- Parameters:
aArgs
- The set to be used for the diff operation.aArgsSubset
- The subset to be used for the diff operation.- Returns:
- The difference between the set and the subset.
-
toParsedArgs
Takes allOperand
instances found in the providedList
s and adds all therein found argument arrays (as ofOperand.getArgs()
) to the result.
-