Package org.refcodes.console
Class AbstractOperand<T>
- java.lang.Object
-
- org.refcodes.console.AbstractOperand<T>
-
- Type Parameters:
T
- the generic type
- All Implemented Interfaces:
java.lang.Comparable<T>
,org.refcodes.component.Resetable
,ArgsAccessor
,Operand<T>
,Syntaxable
,SyntaxUsage
,org.refcodes.mixin.AliasAccessor
,org.refcodes.mixin.DescriptionAccessor
,org.refcodes.mixin.TypeAccessor<T>
,org.refcodes.mixin.ValueAccessor<T>
- Direct Known Subclasses:
AbstractOption
,StringOperand
public abstract class AbstractOperand<T> extends java.lang.Object implements Operand<T>
TheAbstractOperand
is an abstract implementation of anOperand
providing the boiler plate when implementing theOperand
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>
-
-
Constructor Summary
Constructors Constructor Description AbstractOperand(java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)
Constructs aOperand
with the given arguments.AbstractOperand(org.refcodes.structure.Relation<java.lang.String,T> aProperty, java.lang.Class<T> aType)
Instantiates a new operand.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
compareTo(Operand<?> obj)
java.lang.String
getAlias()
java.lang.String[]
getArgs()
Retrieves the command line arguments from the args property.java.lang.String
getDescription()
java.lang.Class<T>
getType()
T
getValue()
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.void
reset()
protected void
setArgs(java.lang.String[] aArgs)
Sets the command line argument(s) representing theOperand
and its value as parsed by theparseArgs(String[])
method.protected void
setValue(T aValue)
Sets the value for theOperand
as parsed by theparseArgs(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
toString()
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.protected abstract T
toValue(java.lang.String aArg)
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.refcodes.console.SyntaxUsage
toUsage, toUsage
-
-
-
-
Field Detail
-
_value
protected T _value
-
-
Constructor Detail
-
AbstractOperand
public AbstractOperand(java.lang.Class<T> aType, java.lang.String aAlias, java.lang.String aDescription)
Constructs aOperand
with the given arguments.- Parameters:
aType
- The type of the value returned by thegetValue()
method.aAlias
- TheOperand
's name, used for syntax creation.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 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[])
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
- 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
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor
-
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
- Parameters:
aSyntaxNotation
- The syntax notation used for generating the command line arguments syntax.- Returns:
- The human readable (verbose) command line arguments syntax.
-
getAlias
public java.lang.String getAlias()
Retrieves the name (alias) of the parameter value which can be the name of the operand (Operand
) or the option argument (Option
), depending on the sub-type inheriting from this interface. The parameter name is merely used for constructing the command line arguments syntaxString
viaSyntaxable.toSyntax(SyntaxNotation)
and the command line arguments detail description when creating a command line tool's help output.
-
getType
public java.lang.Class<T> getType()
- Specified by:
getType
in interfaceorg.refcodes.mixin.TypeAccessor<T>
-
getValue
public T getValue()
-
getArgs
public java.lang.String[] getArgs()
Retrieves the command line arguments from the args property.- Specified by:
getArgs
in interfaceArgsAccessor
- Specified by:
getArgs
in interfaceOperand<T>
- Returns:
- The command line arguments stored by the args property.
-
reset
public void reset()
- Specified by:
reset
in interfaceorg.refcodes.component.Resetable
-
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
- Returns:
- The state of this
Syntaxable
instance and (if any) its children.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(Operand<?> obj)
- Specified by:
compareTo
in interfacejava.lang.Comparable<T>
-
setValue
protected void setValue(T aValue)
Sets the value for theOperand
as parsed by theparseArgs(String[])
method.- 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 theparseArgs(String[])
method.- Parameters:
aArgs
- The command line arguments representing thisOperand
with its value.
-
toValue
protected abstract T toValue(java.lang.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.- 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 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.
-
-