Class AbstractProperty<T>

java.lang.Object

org.refcodes.cli.AbstractOperand<T>

org.refcodes.cli.AbstractOption<T>

org.refcodes.cli.AbstractProperty<T>

Type Parameters:

T - The generic type of the AbstractProperty's value.

All Implemented Interfaces:

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

Direct Known Subclasses:

BooleanProperty, CharProperty, DoubleProperty, EnumProperty, FileProperty, FloatProperty, IntProperty, LongProperty, StringProperty

public abstract class AbstractProperty<T>
extends AbstractOption<T>
implements Property<T>

The AbstractProperty is an abstract implementation of a Property providing the boiler plate when implementing the Property interface. A Property is a key=value pair passed as a single argument (e.g. "--file=someFile").

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

Modifier	Constructor	Description
protected	AbstractProperty(Character aShortProperty, String aLongProperty, Class<T> aType, String aDescription)	Instantiates the class AbstractProperty.
	AbstractProperty(Character aShortProperty, String aLongProperty, Class<T> aType, String aAlias, String aDescription)	Instantiates the class AbstractProperty.
	AbstractProperty(Character aShortProperty, String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Instantiates the class AbstractProperty.
protected	AbstractProperty(Character aShortProperty, String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Instantiates the class AbstractProperty.
	AbstractProperty(String aLongProperty, Class<T> aType, String aDescription)	Instantiates the class AbstractProperty.
	AbstractProperty(String aLongProperty, Class<T> aType, String aAlias, String aDescription)	Instantiates the class AbstractProperty.
	AbstractProperty(String aLongProperty, Class<T> aType, String aAlias, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Instantiates the class AbstractProperty.
	AbstractProperty(String aLongProperty, Class<T> aType, String aDescription, Consumer<? extends Operand<T>> aConsumer)	Instantiates the class AbstractProperty.
	AbstractProperty(Relation<String,T> aProperty, Class<T> aType)	Instantiates the class AbstractProperty.
	AbstractProperty(Relation<String,T> aProperty, Class<T> aType, Consumer<? extends Operand<T>> aConsumer)	Instantiates the class AbstractProperty.

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()
Operand<?>[]	parseArgs(String[] aArgs, String[] aKeywords, CliContext aCliCtx)	Parses the given command line arguments using the provided keyword set and CLI context.
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 static Relation<String,String>	toPropertyArgument(String[] aArgs, String aOption, CliContext aCliCtx)	Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.
protected Relation<String,String>	toPropertyArgument(String[] aArgs, CliContext aCliCtx)	Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments.

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, toType

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, withVisible

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

AbstractProperty

public AbstractProperty(Character aShortProperty,
 String aLongProperty,
 Class<T> aType,
 String aAlias,
 String aDescription)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(Character, String, Class, String, String)

AbstractProperty

public AbstractProperty(Character aShortProperty,
 String aLongProperty,
 Class<T> aType,
 String aAlias,
 String aDescription,
 Consumer<? extends Operand<T>> aConsumer)

Instantiates the class AbstractProperty.

See Also:

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

AbstractProperty

public AbstractProperty(Relation<String,T> aProperty,
 Class<T> aType)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(Relation, Class)

AbstractProperty

public AbstractProperty(Relation<String,T> aProperty,
 Class<T> aType,
 Consumer<? extends Operand<T>> aConsumer)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(Relation, Class, Consumer)

AbstractProperty

public AbstractProperty(String aLongProperty,
 Class<T> aType,
 String aDescription)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(String, Class, String)

AbstractProperty

public AbstractProperty(String aLongProperty,
 Class<T> aType,
 String aDescription,
 Consumer<? extends Operand<T>> aConsumer)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(String, Class, String, Consumer)

AbstractProperty

public AbstractProperty(String aLongProperty,
 Class<T> aType,
 String aAlias,
 String aDescription)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(String, Class, String, String)

AbstractProperty

public AbstractProperty(String aLongProperty,
 Class<T> aType,
 String aAlias,
 String aDescription,
 Consumer<? extends Operand<T>> aConsumer)

Instantiates the class AbstractProperty.

AbstractProperty

protected AbstractProperty(Character aShortProperty,
 String aLongProperty,
 Class<T> aType,
 String aDescription)

Instantiates the class AbstractProperty.

See Also:

• AbstractOption(Character, String, Class, String)

AbstractProperty

protected AbstractProperty(Character aShortProperty,
 String aLongProperty,
 Class<T> aType,
 String aDescription,
 Consumer<? extends Operand<T>> aConsumer)

Instantiates the class AbstractProperty.

See Also:

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

Method Details

parseArgs

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

Parses the given command line arguments using the provided keyword set and CLI context.

This method represents the core parsing operation. It evaluates this Term or, if this term is an inner node, delegates parsing to its child terms.

The aKeywords parameter defines reserved tokens such as option names that must not be interpreted as operand values.

This method does not validate whether all arguments have been consumed. Superfluous arguments must be handled by the caller.

Specified by:

parseArgs in interface Term

Overrides:

parseArgs in class AbstractOption<T>

Parameters:

aArgs - The command line arguments to parse

aKeywords - Reserved option and keyword tokens

aCliCtx - The CliContext controlling parsing and rendering

Returns:

The evaluated operands

Throws:

ArgsSyntaxException - If the arguments do not match the syntax

toPropertyArgument

protected Relation<String,String> toPropertyArgument(String[] aArgs,
 CliContext aCliCtx)

Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments. Depending on whether the short-option or the long-option was detected with a value, the result contains the according option as the key with the detected value in the Relation instance. Null is returned when either no option was found or no value for one of the options.

Parameters:

aArgs - The command line arguments from which to determine the Option's value.

aCliCtx - The CliContext to run this method with.

Returns:

A key/value-pair containing the detected (short / long) option alongside the detected value.

toPropertyArgument

protected static Relation<String,String> toPropertyArgument(String[] aArgs,
 String aOption,
 CliContext aCliCtx)

Takes the Option's short-option and long-option and tries to determine that Option's value in the provided command line arguments. Depending on whether the short-option or the long-option was detected with a value, the result contains the according option as the key with the detected value in the Relation instance. Null is returned when either no option was found or no value for one of the options.

Parameters:

aArgs - The command line arguments from which to determine the Option's value.

aOption - The option for which to get the value reserved and cannot be used as value.

Returns:

A key/value-pair containing the detected (short / long) option alongside the detected value.

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.