Class CharProperty

java.lang.Object

org.refcodes.cli.AbstractOperand<Character>

org.refcodes.cli.AbstractOption<Character>

org.refcodes.cli.AbstractProperty<Character>

org.refcodes.cli.CharProperty

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<Character>, Option<Character>, ParsedArgsAccessor, Property<Character>, Synopsisable, Term, ExceptionAccessor<ArgsSyntaxException>, VisibleAccessor, VisibleAccessor.VisibleBuilder<Term>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty, AliasAccessor, Clonable, DescriptionAccessor, Resetable, TypeAccessor<Character>, ValueAccessor<Character>, Diagnosable, Schemable<DiagnosticOptions>

public class CharProperty
extends AbstractProperty<Character>

The CharProperty represents an Property holding String values.

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface DescriptionAccessor

DescriptionAccessor.DescriptionBuilder<B>, DescriptionAccessor.DescriptionMutator, DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface ExceptionAccessor

ExceptionAccessor.ExceptionBuilder<EXC,B>, ExceptionAccessor.ExceptionMutator<EXC>, ExceptionAccessor.ExceptionProperty<EXC>

Nested classes/interfaces inherited from interface MatchCountAccessor

MatchCountAccessor.MatchCountBuilder<B>, MatchCountAccessor.MatchCountMutator, MatchCountAccessor.MatchCountProperty

Nested classes/interfaces inherited from interface ParsedArgsAccessor

ParsedArgsAccessor.ParsedArgsMutator, ParsedArgsAccessor.ParsedArgsProperty

Nested classes/interfaces inherited from interface TypeAccessor

TypeAccessor.TypeBuilder<T,B>, TypeAccessor.TypeMutator<T>, TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface ValueAccessor

ValueAccessor.ValueBuilder<V,B>, ValueAccessor.ValueMutator<V>, ValueAccessor.ValueProperty<V>

Nested classes/interfaces inherited from interface VisibleAccessor

VisibleAccessor.VisibleBuilder<B>, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty

Field Summary

Fields

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

Fields inherited from class AbstractOperand

_matchCount

Constructor Summary

Constructors

Constructor	Description
CharProperty(Character aShortProperty, String aLongProperty, String aDescription)	Instantiates a new CharProperty with the given arguments.
CharProperty(Character aShortProperty, String aLongProperty, String aAlias, String aDescription)	Instantiates the class CharProperty.
CharProperty(Character aShortOption, String aLongOption, String aAlias, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates the class CharProperty.
CharProperty(Character aShortOption, String aLongOption, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
CharProperty(String aLongProperty, String aDescription)	Instantiates a new CharProperty with the given arguments.
CharProperty(String aLongProperty, String aAlias, String aDescription)	Instantiates the class CharProperty.
CharProperty(String aLongOption, String aAlias, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates the class CharProperty.
CharProperty(String aLongOption, String aDescription, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty with the given arguments.
CharProperty(Relation<String, Character> aProperty)	Instantiates a new CharProperty with the alias being the proerty's key and the value being the property's value.
CharProperty(Relation<String, Character> aProperty, Consumer<CharProperty> aConsumer)	Instantiates a new CharProperty 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()
void	setVisible(boolean isVisible)
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 Character	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.
CharProperty	withVisible(boolean isVisible)

Methods inherited from class AbstractProperty

parseArgs, toPropertyArgument, toPropertyArgument

Methods inherited from class AbstractOption

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

Methods inherited from class AbstractOperand

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

Methods inherited from class Object

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

Methods inherited from interface Clonable

clone

Methods inherited from interface Comparable

compareTo

Methods inherited from interface DescriptionAccessor

getDescription

Methods inherited from interface Operand

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

Methods inherited from interface Option

getLongOption, getShortOption, toKeywords, toLongOption, toShortOption, toUsage

Methods inherited from interface Property

toSpec, toSyntax

Methods inherited from interface Resetable

reset

Methods inherited from interface Schemable

toSchema, toSchema

Methods inherited from interface Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface Term

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

Methods inherited from interface TypeAccessor

getType

Methods inherited from interface ValueAccessor

getValueOr

Methods inherited from interface VisibleAccessor

isHidden

Methods inherited from interface VisibleAccessor.VisibleBuilder

withHide, withShow

Methods inherited from interface VisibleAccessor.VisibleMutator

hide, show

Methods inherited from interface VisibleAccessor.VisibleProperty

letVisible

Field Details

_description

protected String _description

_exception

protected ArgsSyntaxException _exception

_isVisible

protected boolean _isVisible

Constructor Details

CharProperty

public CharProperty(Character aShortProperty,
 String aLongProperty,
 String aDescription)

Instantiates a new CharProperty 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 as alias.

Parameters:

aShortProperty - The short option to use.

aLongProperty - The long option to use.

aDescription - The description of the CharProperty

CharProperty

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

Instantiates a new CharProperty 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 as alias.

Parameters:

aShortOption - The short option to use.

aLongOption - The long option to use.

aDescription - The description of the CharProperty.

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

CharProperty

public CharProperty(Character aShortProperty,
 String aLongProperty,
 String aAlias,
 String aDescription)

Instantiates the class CharProperty.

See Also:

• AbstractProperty(Character, String, Class, String, String)

CharProperty

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

Instantiates the class CharProperty.

See Also:

• AbstractProperty(Character, String, Class, String, String, Consumer)

CharProperty

public CharProperty(Relation<String, Character> aProperty)

Instantiates a new CharProperty 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.

CharProperty

public CharProperty(Relation<String, Character> aProperty,
 Consumer<CharProperty> aConsumer)

Instantiates a new CharProperty 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 CharProperty participated in successfully parsing the command line arguments.

CharProperty

public CharProperty(String aLongProperty,
 String aDescription)

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

Parameters:

aLongProperty - The long option to use.

aDescription - The description of the CharProperty

CharProperty

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

Instantiates a new CharProperty 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 CharProperty.

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

CharProperty

public CharProperty(String aLongProperty,
 String aAlias,
 String aDescription)

Instantiates the class CharProperty.

See Also:

• AbstractProperty(String, Class, String, String)

CharProperty

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

Instantiates the class CharProperty.

See Also:

• AbstractProperty(String, Class, String, String, Consumer)

Method Details

withVisible

public CharProperty withVisible(boolean isVisible)

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

toType

protected Character 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<Character>

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