- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Constituent
,Operand<Boolean>
,Option<Boolean>
,Synopsisable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.Resetable
,org.refcodes.mixin.Schemable<CliSchema>
,org.refcodes.mixin.TypeAccessor<Boolean>
,org.refcodes.mixin.ValueAccessor<Boolean>
- Direct Known Subclasses:
CleanFlag
,DaemonFlag
,DebugFlag
,ForceFlag
,HelpFlag
,InitFlag
,QuietFlag
,SysInfoFlag
,VerboseFlag
public class Flag
extends AbstractOption<Boolean>
implements Option<Boolean>, org.refcodes.mixin.EnabledAccessor
The
Flag
class implements the Option
interface for
representing either a true
or a false
state: When a
flag is provided to your command line arguments, then it is considered to be
true
, when it is omitted, then it is considered to be
false
as of isEnabled()
.-
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.mixin.EnabledAccessor
org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B extends org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B>>, org.refcodes.mixin.EnabledAccessor.EnabledMutator, org.refcodes.mixin.EnabledAccessor.EnabledProperty
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
_value
-
Constructor Summary
ConstructorDescriptionInstantiates a newFlag
with the given arguments.Instantiates a newFlag
with the given arguments.Instantiates a newFlag
with the given arguments.Instantiates a newFlag
with the given arguments.Instantiates a newFlag
with the alias being the proerty's key and the value being the property's value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if the switch has been set (enabled).parseArgs
(String[] aArgs, String[] aOptions, CliContext aCliCtx) Parses the provided command line arguments and determines the according values by evaluating thisConstituent
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childConstituent
instances'Constituent.parseArgs(String[], String[], CliContext)
methods.void
reset()
toSyntax
(CliContext aCliCtx) This method is to be called from inside theConstituent
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootConstituent
.protected Boolean
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, setParsedArgs, setValue, toOptionArgument, toOptionArgument, toSchema
Methods inherited from class org.refcodes.cli.AbstractOperand
compareTo, getAlias, getType, getValue, toParsedArgs, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.mixin.Clonable
clone
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.refcodes.cli.Constituent
parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor
getDescription
Methods inherited from interface org.refcodes.cli.Operand
getAlias, getValue, hasValue, toParsedArgs, toSpec, toValue
Methods inherited from interface org.refcodes.cli.Option
getLongOption, getShortOption
Methods inherited from interface org.refcodes.mixin.Schemable
toSchema
Methods inherited from interface org.refcodes.cli.Synopsisable
toSynopsis, toSynopsis, toSynopsis, toSynopsis
Methods inherited from interface org.refcodes.mixin.TypeAccessor
getType
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
-
Field Details
-
_description
-
-
Constructor Details
-
Flag
Instantiates a newFlag
with the given arguments.- Parameters:
aShortOption
- The short option to use.aLongOption
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theFlag
-
Flag
Instantiates a newFlag
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.aDescription
- The description of theFlag
-
Flag
Instantiates a newFlag
with the given arguments.- Parameters:
aLongOption
- The long option to use.aAlias
- The alias to be used for naming purposes.aDescription
- The description of theFlag
-
Flag
Instantiates a newFlag
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.aDescription
- The description of theFlag
-
Flag
Instantiates a newFlag
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.
-
-
Method Details
-
isEnabled
public boolean isEnabled()Returns true if the switch has been set (enabled).- Specified by:
isEnabled
in interfaceorg.refcodes.mixin.EnabledAccessor
- Returns:
- True in case the
Flag
has been provided (set), else false.
-
parseArgs
public List<Operand<Boolean>> parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx) throws ArgsSyntaxException Parses the provided command line arguments and determines the according values by evaluating thisConstituent
instance or, in case of being a node in the syntax tree (such as aCondition
, traversing the childConstituent
instances'Constituent.parseArgs(String[], String[], CliContext)
methods. In case of successfully parsing thisConstituent
and / or the childConstituent
instances, the evaluated command line arguments are returned: Depending on theConstituent
subclasses representing the evaluated command line arguments, instances ofFlag
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 theConstituent
instance being traversed. This method is commonly used by a rootConstituent
'sArgsParser.evalArgs(String[])
method, which delegates to theConstituent.parseArgs(String[], String[], CliContext)
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'sConstituent.parseArgs(String[], String[], CliContext)
method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.- Specified by:
parseArgs
in interfaceConstituent
- Overrides:
parseArgs
in classAbstractOption<Boolean>
- Parameters:
aArgs
- The command line arguments to be parsed.aOptions
- The list of options (short and as well as long) which are reserved and cannot be used as value.aCliCtx
- the cli context- Returns:
- The list of evaluated command line arguments being instances of
the
Operand
interfaces or its sub-types. - Throws:
ArgsSyntaxException
- thrown in case of a command line arguments mismatch regarding provided and expected args.
-
toSyntax
This method is to be called from inside theConstituent
hierarchy; use the methodSynopsisable.toSynopsis(SyntaxNotation)
in case you invoke syntax retrieval from the rootConstituent
. Returns the human readable (verbose) syntax of thisConstituent
instance including, in case of being a node in the syntax tree (such as aCondition
, the syntax of the childConstituent
instances. ATTENTION: As of different parenthesis settings for some notations regarding the rootConstituent
and the childConstituent
s, the methodConstituent.toSyntax(CliContext)
is called from inside theConstituent
hierarchy. In case the syntax is to be retrieved from the rootConstituent
, then the applicable method to be called isSynopsisable.toSynopsis(SyntaxNotation)
, as for some notations it will for example not create the most outer braces.- Specified by:
toSyntax
in interfaceConstituent
- Overrides:
toSyntax
in classAbstractOption<Boolean>
- Parameters:
aCliCtx
- TheCliContext
for which the syntax is being generated.- Returns:
- The human readable (verbose) command line arguments syntax.
-
reset
public void reset()- Specified by:
reset
in interfaceorg.refcodes.mixin.Resetable
- Overrides:
reset
in classAbstractOperand<Boolean>
-
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<Boolean>
- 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
-