Module org.refcodes.cli

Package org.refcodes.cli

Class ArrayOperand<T>

java.lang.Object

org.refcodes.cli.ArrayOperand<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<T[]>, ParsedArgsAccessor, Synopsisable, Term, org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>, org.refcodes.graphical.VisibleAccessor, org.refcodes.graphical.VisibleAccessor.VisibleBuilder<Term>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.TypeAccessor<T[]>, org.refcodes.mixin.ValueAccessor<T[]>, org.refcodes.schema.Schemable

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

ParsedArgsAccessor.ParsedArgsMutator, ParsedArgsAccessor.ParsedArgsProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

Nested classes/interfaces inherited from interface org.refcodes.graphical.VisibleAccessor

org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B extends org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B>>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_description
protected ArgsSyntaxException	_exception
protected boolean	_isVisible

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	getDescription()
ArgsSyntaxException	getException()	Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
int	getMatchCount()	Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax.
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.
String[]	getParsedArgs()	Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).
Class<T[]>	getType()
T[]	getValue()
boolean	isVisible()	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
Operand<?>[]	parseArgs(String[] aArgs, String[] aOperands, CliContext aCliCtx)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
void	reset()
void	setVisible(boolean isVisible)	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
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 provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
protected static String[]	toArgsDiff(String[] aArgs, Operand<?>[] aArgsSubset)	Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).
protected static String[]	toParsedArgs(Operand<?>[]... aOperands)	Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.
CliSchema	toSchema()
String	toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
ArrayOperand<T>	withVisible(boolean isVisible)	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

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

hasValue, toSpec, toSpec, toUsage, toUsage, toValue

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface org.refcodes.cli.Term

getException, isVisible, parseArgs, setVisible, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder

withHide, withShow

Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleMutator

hide, show

Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleProperty

letVisible

Field Details

_description

protected String _description

_exception

protected ArgsSyntaxException _exception

_isVisible

protected boolean _isVisible

Constructor Details

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 Details

getMatchCount

public int getMatchCount()

Determines the number of args being matched by the Term.parseArgs(String[], CliContext) (and similar) method(s) of the according syntax. This way we can determine which part of the syntax (tree) had most matches.

Specified by:

getMatchCount in interface MatchCountAccessor

Specified by:

getMatchCount in interface Term

Returns:

The number of args matching the according syntax (tree).

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface org.refcodes.mixin.Clonable

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

compareTo

public int compareTo(Operand<?> o)

Specified by:

compareTo in interface Comparable<T>

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 Term.toSyntax(CliContext) 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 ApplicationProperties 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.

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor

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.

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.

getType

public Class<T[]> getType()

Specified by:

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

getValue

public T[] getValue()

Specified by:

getValue in interface Operand<T>

Specified by:

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

parseArgs

public Operand<?>[] parseArgs(String[] aArgs,
 String[] aOperands,
 CliContext aCliCtx)
                       throws ArgsSyntaxException

Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods. In case of successfully parsing this Term and / or the child Term instances, the evaluated command line arguments are returned: Depending on the Term 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 Term instance being traversed. This method is commonly used by a root Term's ParseArgs.evalArgs(String[]) method, which delegates to the Term.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's Term.parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will aCause unexpected behavior from the point of view of the invoker.

Specified by:

parseArgs in interface Term

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.

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.

reset

public void reset()

Specified by:

reset in interface org.refcodes.mixin.Resetable

getParsedArgs

public String[] getParsedArgs()

Retrieves the (command line) args which represent this Operand after being "parsed" (provided with command line args).

Specified by:

getParsedArgs in interface Operand<T>

Specified by:

getParsedArgs in interface ParsedArgsAccessor

Returns:

The according args from the command line args.

toSchema

public CliSchema toSchema()

Specified by:

toSchema in interface org.refcodes.schema.Schemable

Specified by:

toSchema in interface Term

toSyntax

public String toSyntax(CliContext aCliCtx)

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

Specified by:

toSyntax in interface Term

Parameters:

aCliCtx - The CliContext for which the syntax is being generated.

Returns:

The human readable (verbose) command line arguments syntax.

withVisible

public ArrayOperand<T> withVisible(boolean isVisible)

Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

Specified by:

withVisible in interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder<T>

getOperand

protected Operand<T> getOperand()

Hook for accessing the encapsulated Operand.

Returns:

The according Operand.

getException

public ArgsSyntaxException getException()

Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed. The exception (and the according suppressed ones alongside the causes) does not necessarily have been thrown by the Term.parseArgs(String[], CliContext) method depending on the semantics of the Term handing the exception (the AnyCondition provides any exceptions it caught even though it did not throw them as of its semantics).

Specified by:

getException in interface org.refcodes.exception.ExceptionAccessor<ArgsSyntaxException>

Specified by:

getException in interface Term

Returns:

The ArgsSyntaxException exception occurring while parsing the arguments.

setVisible

public void setVisible(boolean isVisible)

Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

Specified by:

setVisible in interface Term

Specified by:

setVisible in interface org.refcodes.graphical.VisibleAccessor.VisibleMutator

isVisible

public boolean isVisible()

Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

Specified by:

isVisible in interface Term

Specified by:

isVisible in interface org.refcodes.graphical.VisibleAccessor

toArgsDiff

protected static String[] toArgsDiff(String[] aArgs,
 List<? extends Operand<?>> aArgsSubset)

Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).

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 the Operand instances whose command line arguments are to be diffed.

Returns:

The difference between the set and the subset.

toArgsDiff

protected static String[] toArgsDiff(String[] aArgs,
 Operand<?>[] aArgsSubset)

Creates the difference between the provided set and the provided Lists therein found argument arrays subset (as of Operand.getParsedArgs()).

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 the Operand instances whose command line arguments are to be diffed.

Returns:

The difference between the set and the subset.

toArgsDiff

protected static String[] toArgsDiff(String[] aArgs,
 String[] aArgsSubset)

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

protected static String[] toParsedArgs(Operand<?>[]... aOperands)

Takes all Operand instances found in the provided Lists and adds all therein found argument arrays (as of Operand.getParsedArgs()) to the result.

Parameters:

aOperands - The lists containing the Operand instances whose command line arguments are to be added to the result.

Returns:

All the command line arguments detected in the provided Operands Lists.