Module org.refcodes.cli

Package org.refcodes.cli

Class ArrayOperand<T>

java.lang.Object

org.refcodes.cli.ArrayOperand<T>

All Implemented Interfaces:

Cloneable, Comparable<T>, ArgsAccessor, Operand<T[]>, Syntaxable, SyntaxUsage, org.refcodes.component.Resetable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.TypeAccessor<T>, org.refcodes.mixin.ValueAccessor<T>

Direct Known Subclasses:

ArrayOption

public class ArrayOperand<T>
extends Object
implements Operand<T[]>

Creates an array representation facade for the encapsulated Operand. This way any Operand can also be used as an array Operand, e.g. it can be provided multiple times in the command line arguments.

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.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>

Constructor Summary

Constructors

Constructor	Description
ArrayOperand(Operand<T> aOperand)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
ArrayOperand(Operand<T> aOperand, int aLength)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.
ArrayOperand(Operand<T> aOperand, int aMinLength, int aMaxLength)	Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.

Method Summary

Modifier and Type	Method	Description
Object	clone()
int	compareTo(Operand<?> o)
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.
String[]	getArgs()	Retrieves the command line arguments from the args property.
String	getDescription()
int	getMaxLength()	Retrieves the maximum number of array elements to be present, e.g.
int	getMinLength()	Retrieves the minimum number of array elements to be present, e.g.
protected Operand<T>	getOperand()	Hook for accessing the encapsulated Operand.
Class<T[]>	getType()
T[]	getValue()
List<Operand<?>>	parseArgs(String[] aArgs, String[] aOperands)	Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods.
void	reset()
String	toState()	The Syntaxable.toState() method might be used by the Object.toString() method and prints out the state of the syntaxable and (if any) its children.
String	toSyntax(SyntaxNotation aSyntaxNotation, String aOptionEscCode, String aResetEscCode)	This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.
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 root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.cli.Operand

get, hasValue

Methods inherited from interface org.refcodes.cli.Syntaxable

parseArgs, toSyntax

Methods inherited from interface org.refcodes.cli.SyntaxUsage

toUsage, toUsage, toUsage

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Constructor Detail

ArrayOperand

public ArrayOperand(Operand<T> aOperand)

Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

ArrayOperand

public ArrayOperand(Operand<T> aOperand,
                    int aLength)

Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

aLength - The number of array elements, or -1 if there is no limit.

ArrayOperand

public ArrayOperand(Operand<T> aOperand,
                    int aMinLength,
                    int aMaxLength)

Constructs the ArrayOperand by encapsulating the given Operand and providing its definition as array definition to the CLI.

Parameters:

aOperand - The Operand which's array counterpart is to be defined.

aMinLength - The minimum number of array elements, or -1 if there is no limit.

aMaxLength - The maximum number of array elements, or -1 if there is no limit.

Method Detail

getValue

public T[] getValue()

Specified by:

getValue in interface Operand<T>

Specified by:

getValue in interface org.refcodes.mixin.ValueAccessor<T>

getArgs

public String[] getArgs()

Retrieves the command line arguments from the args property.

Specified by:

getArgs in interface ArgsAccessor

Specified by:

getArgs in interface Operand<T>

Returns:

The command line arguments stored by the args property.

getAlias

public 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 syntax String via Syntaxable.toSyntax(SyntaxNotation, String, String) and the command line arguments detail description when creating a command line tool's help output. Attention: The alias can also be used as a key when putting an Operand's key/value-pair into a dictionary such as is done by the RuntimeProperties type provided by the refcodes-properties-ext-runime artifact!

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

Specified by:

getAlias in interface Operand<T>

Returns:

The name of the parameter, e.g the name of the operand or the name of the option argument.

toSyntax

public String toSyntax(SyntaxNotation aSyntaxNotation,
                       String aOptionEscCode,
                       String aResetEscCode)

This method is to be called from inside the Syntaxable hierarchy; use the method SyntaxUsage.toUsage(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable. Returns the human readable (verbose) syntax of this Syntaxable instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Syntaxable instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String) is called from inside the Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable, then the applicable method to be called is SyntaxUsage.toUsage(SyntaxNotation), as for some notations it will for example not create the most outer braces.

Specified by:

toSyntax in interface Syntaxable

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.

aResetEscCode - The escape code to close (reset) any Escape-Code being set before.

Returns:

The human readable (verbose) command line arguments syntax.

getType

public Class<T[]> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor<T>

parseArgs

public List<Operand<?>> parseArgs(String[] aArgs,
                                  String[] aOperands)
                           throws UnknownArgsException,
                                  AmbiguousArgsException,
                                  ParseArgsException

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[], String[]) methods. In case of successfully parsing this Syntaxable and / or the child Syntaxable instances, the evaluated command line arguments are returned: Depending on the Syntaxable subclasses representing the evaluated command line arguments, instances of Flag classes, Option classes or Operand 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 the Syntaxable instance being traversed. This method is commonly used by a root Syntaxable's ArgsParser.evalArgs(String[]) method, which delegates to the Syntaxable.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's Syntaxable.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 interface Syntaxable

Parameters:

aArgs - The command line arguments to be parsed.

aOperands - 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 type

toState

public String toState()

The Syntaxable.toState() method might be used by the Object.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 interface Syntaxable

Returns:

The state of this Syntaxable instance and (if any) its children.

reset

public void reset()

Specified by:

reset in interface org.refcodes.component.Resetable

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor

compareTo

public int compareTo(Operand<?> o)

Specified by:

compareTo in interface Comparable<T>

getMinLength

public int getMinLength()

Retrieves the minimum number of array elements to be present, e.g. minimum number of options provided in the command line arguments.

Returns:

The minimum number of array elements, or -1 if there is no limit.

getMaxLength

public int getMaxLength()

Retrieves the maximum number of array elements to be present, e.g. maximum number of options provided in the command line arguments.

Returns:

The maximum number of array elements, or -1 if there is no limit.

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface org.refcodes.mixin.Clonable

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getOperand

protected Operand<T> getOperand()

Hook for accessing the encapsulated Operand.

Returns:

The according Operand.

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 root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation, String, String) is called from inside a Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable or an encapsulating and different type, then the applicable method to be called is SyntaxUsage.toUsage(SyntaxNotation), as for some notations it will for example not create the most outer braces.

Specified by:

toUsage in interface SyntaxUsage

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.