- java.lang.Object
-
- org.refcodes.cli.AbstractOperand<T>
-
- org.refcodes.cli.AbstractOption<Boolean>
-
- org.refcodes.cli.Flag
-
- All Implemented Interfaces:
Cloneable
,Comparable<Operand<?>>
,ArgsAccessor
,Operand<Boolean>
,Option<Boolean>
,Syntaxable
,SyntaxUsage
,org.refcodes.component.Resetable
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.Clonable
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.TypeAccessor<Boolean>
,org.refcodes.mixin.ValueAccessor<Boolean>
- Direct Known Subclasses:
DaemonFlag
,DebugFlag
,ForceFlag
,HelpFlag
,InitFlag
,QuietFlag
,SysInfoFlag
,VerboseFlag
public class Flag extends AbstractOption<Boolean> implements Option<Boolean>, org.refcodes.mixin.EnabledAccessor
TheFlag
class implements theOption
interface for representing either atrue
or afalse
state: When a flag is provided to your command line arguments, then it is considered to betrue
, when it is omitted, then it is considered to befalse
as ofisEnabled()
.
-
-
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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isEnabled()
Returns true if the switch has been set (enabled).List<Operand<Boolean>>
parseArgs(String[] aArgs, String[] aOptions)
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 aArgsSyntax
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[], String[])
methods.void
reset()
protected Boolean
toType(String aArg)
Double dispatch hook to be implemented by subclasses of theAbstractOperand
for converting a command line argument to the requiredOperand
's type.String
toUsage(SyntaxNotation aSyntaxNotation, String aOptionEscCode, String aResetEscCode)
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, String, String)
is called from inside aSyntaxable
hierarchy.-
Methods inherited from class org.refcodes.cli.AbstractOption
clone, getLongOption, getOptionPrefixes, getShortOption, setArgs, setValue, toState, toSyntax
-
Methods inherited from class org.refcodes.cli.AbstractOperand
compareTo, getAlias, getArgs, getDescription, getType, getValue, 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.cli.Operand
getAlias, getArgs, getValue, hasValue, toValue
-
Methods inherited from interface org.refcodes.cli.Option
getLongOption, getOptions, getShortOption
-
Methods inherited from interface org.refcodes.cli.Syntaxable
parseArgs, toState, toSyntax, toSyntax, toSyntax, toSyntax
-
Methods inherited from interface org.refcodes.cli.SyntaxUsage
toUsage, toUsage, toUsage, toUsage
-
-
-
-
Constructor Detail
-
Flag
public Flag(String aShortOption, String aLongOption, String aAlias, String aDescription)
Constructs aFlag
.- 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.aAlias
- The alias identifying thisFlag
.aDescription
- A description without any line breaks.
-
Flag
public Flag(String aLongOption, String aAlias, String aDescription)
Constructs aFlag
.- Parameters:
aLongOption
- The long-option being a multi-character sequence with at least two characters with the additional double hyphen-minus "--" prefix.aAlias
- The alias identifying thisFlag
.aDescription
- A description without any line breaks.
-
-
Method Detail
-
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) throws UnknownArgsException, AmbiguousArgsException, ParseArgsException, SuperfluousArgsException
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 aArgsSyntax
, traversing the childSyntaxable
instances'Syntaxable.parseArgs(String[], 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 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 theSyntaxable
instance being traversed. This method is commonly used by a rootSyntaxable
'sArgsParser.evalArgs(String[])
method, which delegates to theSyntaxable.parseArgs(String[], 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[], 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 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.- 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 typeSuperfluousArgsException
- in case there were arguments found not being used (superfluous arguments), thrown only in very specific cases (throw with care!).
-
reset
public void reset()
- Specified by:
reset
in interfaceorg.refcodes.component.Resetable
- Overrides:
reset
in classAbstractOperand<Boolean>
-
toType
protected Boolean toType(String aArg) throws ParseArgsException
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.
-
toUsage
public String toUsage(SyntaxNotation aSyntaxNotation, String aOptionEscCode, String aResetEscCode)
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, String, String)
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.aOptionEscCode
- The escape code to be used when processing an option, e.g. this can be an ANSI Escape-Code to highlight the option parameters (for example "--help", "-q" and so on).aResetEscCode
- The escape code to close (reset) any Escape-Code being set before.- Returns:
- The human readable (verbose) command line arguments syntax.
-
-