Module org.refcodes.cli

Package org.refcodes.cli

Class StringOption

java.lang.Object

org.refcodes.cli.AbstractOperand<String>

org.refcodes.cli.AbstractOption<String>

org.refcodes.cli.StringOption

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<String>, Option<String>, 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<String>, org.refcodes.mixin.ValueAccessor<String>, org.refcodes.schema.Schemable

Direct Known Subclasses:

ConfigOption

public class StringOption
extends AbstractOption<String>

The StringOption represents an Option holding String values.

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

Fields inherited from class org.refcodes.cli.AbstractOperand

_matchCount

Constructor Summary

Constructors

Constructor	Description
StringOption(Character aShortOption, String aLongOption, String aDescription)	Instantiates a new StringOption with the given arguments.
StringOption(Character aShortOption, String aLongOption, String aAlias, String aDescription)	Instantiates a new StringOption with the given arguments.
StringOption(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
StringOption(Character aShortOption, String aLongOption, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
StringOption(String aLongOption, String aDescription)	Instantiates a new StringOption with the given arguments.
StringOption(String aLongOption, String aAlias, String aDescription)	Instantiates a new StringOption with the given arguments.
StringOption(String aLongOption, String aAlias, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
StringOption(String aLongOption, String aDescription, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the given arguments.
StringOption(org.refcodes.struct.Relation<String,String> aProperty)	Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value.
StringOption(org.refcodes.struct.Relation<String,String> aProperty, Consumer<StringOption> aConsumer)	Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
ArgsSyntaxException	getException()	Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
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.
protected String	toType(String aArg)	Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type.
StringOption	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 org.refcodes.cli.AbstractOption

clone, contains, getLongOption, getShortOption, parseArgs, setParsedArgs, setValue, toException, toSchema, toString, toSyntax

Methods inherited from class org.refcodes.cli.AbstractOperand

approve, compareTo, getAlias, getMatchCount, getParsedArgs, getType, getValue, reset

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

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

StringOption

public StringOption(Character aShortOption,
 String aLongOption,
 String aDescription)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the StringOption

StringOption

public StringOption(Character aShortOption,
 String aLongOption,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

StringOption

public StringOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new StringOption with the given arguments.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

StringOption

public StringOption(Character aShortOption,
 String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option, else the short option is used ass alias.

Parameters:

aShortOption - The short option to use.

aLongOption - the string option

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

StringOption

public StringOption(org.refcodes.struct.Relation<String,String> aProperty)

Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.

Parameters:

aProperty - The key (=alias) and the value for the operand.

StringOption

public StringOption(org.refcodes.struct.Relation<String,String> aProperty,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the alias being the proerty's key and the value being the property's value. Depending on the provided property's key, the key is either used for the short option or the long option.

Parameters:

aProperty - The key (=alias) and the value for the operand.

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

StringOption

public StringOption(String aLongOption,
 String aDescription)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringOption

StringOption

public StringOption(String aLongOption,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments. In case a long option is provided, the intance's alias will automatically be set with the long option.

Parameters:

aLongOption - The long option to use.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

StringOption

public StringOption(String aLongOption,
 String aAlias,
 String aDescription)

Instantiates a new StringOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

StringOption

public StringOption(String aLongOption,
 String aAlias,
 String aDescription,
 Consumer<StringOption> aConsumer)

Instantiates a new StringOption with the given arguments.

Parameters:

aLongOption - The long option to use.

aAlias - The alias to be used for naming purposes.

aDescription - The description of the StringOption

aConsumer - The Consumer being invoked in case this StringOption participated in successfully parsing the command line arguments.

Method Details

withVisible

public StringOption withVisible(boolean isVisible)

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

toType

protected String toType(String aArg)
                 throws ParseArgsException

Double dispatch hook to be implemented by subclasses of the AbstractOperand for converting a command line argument to the required Operand's type. In case conversion failed, then an according exception is to be thrown.

Specified by:

toType in class AbstractOperand<String>

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.

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor

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.