Module org.refcodes.cli

Package org.refcodes.cli

Class ArrayOption<T>

java.lang.Object

org.refcodes.cli.ArrayOperand<T>

org.refcodes.cli.ArrayOption<T>

Type Parameters:

T - the generic type

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<T[]>, Option<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

public class ArrayOption<T>
extends ArrayOperand<T>
implements Option<T[]>

Creates an array representation facade for the encapsulated Option. This way any Option can also be used as an array Option, 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
ArrayOption(Option<T> aOption)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
ArrayOption(Option<T> aOption, int aLength)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.
ArrayOption(Option<T> aOption, int aMinLength, int aMaxLength)	Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.

Method Summary

Modifier and Type	Method	Description
ArgsSyntaxException	getException()	Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
String	getLongOption()	Returns the long-option representing an Option instance.
Character	getShortOption()	Returns the short-option representing an Option instance.
boolean	isVisible()	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
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.
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.

Methods inherited from class org.refcodes.cli.ArrayOperand

clone, compareTo, getAlias, getDescription, getMatchCount, getMaxLength, getMinLength, getOperand, getParsedArgs, getType, getValue, parseArgs, reset, toSchema, withVisible

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.cli.Operand

getAlias, getParsedArgs, getValue, hasValue, toSpec, toSpec, toUsage, toUsage, toValue

Methods inherited from interface org.refcodes.mixin.Resetable

reset

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface org.refcodes.cli.Term

getException, getMatchCount, isVisible, parseArgs, parseArgs, setVisible, toSchema, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

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

withHide, withShow, withVisible

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

ArrayOption

public ArrayOption(Option<T> aOption)

Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.

Parameters:

aOption - The Option which's array counterpart is to be defined.

ArrayOption

public ArrayOption(Option<T> aOption,
 int aLength)

Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.

Parameters:

aOption - The Option which's array counterpart is to be defined.

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

ArrayOption

public ArrayOption(Option<T> aOption,
 int aMinLength,
 int aMaxLength)

Constructs the ArrayOption by encapsulating the given Option and providing its definition as array definition to the CLI.

Parameters:

aOption - The Option 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

getLongOption

public String getLongOption()

Returns the long-option representing an Option instance. A long option usually is being prefixed with a double hyphen-minus "--" as defined in ArgsPrefix.POSIX_LONG_OPTION.

Specified by:

getLongOption in interface Option<T>

Returns:

The long-option String.

getShortOption

public Character getShortOption()

Returns the short-option representing an Option instance. A short option usually is being prefixed with a single hyphen-minus "-" as defined in ArgsPrefix.POSIX_SHORT_OPTION.

Specified by:

getShortOption in interface Option<T>

Returns:

The short-option String.

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

Overrides:

toSyntax in class ArrayOperand<T>

Parameters:

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

Returns:

The human readable (verbose) command line arguments syntax.

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.