Class ConfigProperty

java.lang.Object

org.refcodes.cli.AbstractOperand<String>

org.refcodes.cli.AbstractOption<String>

org.refcodes.cli.AbstractProperty<String>

org.refcodes.cli.StringProperty

org.refcodes.cli.ConfigProperty

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<String>, Option<String>, ParsedArgsAccessor, Property<String>, 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.runtime.Diagnosable, org.refcodes.schema.Schemable<org.refcodes.runtime.DiagnosticOptions>

public class ConfigProperty
extends StringProperty

The ConfigProperty represents an Property holding a value specifying a configuration resource (file).

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
static final String	ALIAS
static final String	LONG_OPTION
static final Character	SHORT_OPTION

Fields inherited from class org.refcodes.cli.AbstractOperand

_matchCount

Constructor Summary

Constructors

Constructor	Description
ConfigProperty()	Constructs the predefined config (file) Property.
ConfigProperty(boolean hasShortProperty)	Instantiates the class ConfigProperty.
ConfigProperty(String aDescription)	Instantiates a new config (file) Property.
ConfigProperty(String aDescription, boolean hasShortProperty)	Instantiates the class ConfigProperty.

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.

Methods inherited from class org.refcodes.cli.StringProperty

toType, withVisible

Methods inherited from class org.refcodes.cli.AbstractProperty

parseArgs, toPropertyArgument, toPropertyArgument

Methods inherited from class org.refcodes.cli.AbstractOption

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

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 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, toSpec, toSpec, toUsage, toValue

Methods inherited from interface org.refcodes.cli.Option

getLongOption, getShortOption, toKeywords, toLongOption, toShortOption, toUsage

Methods inherited from interface org.refcodes.cli.Property

toSpec, toSyntax

Methods inherited from interface org.refcodes.mixin.Resetable

reset

Methods inherited from interface org.refcodes.schema.Schemable

toSchema

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface org.refcodes.cli.Term

argsParser, getException, getMatchCount, isVisible, 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

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

hide, show

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

letVisible

Field Details

ALIAS

public static final String ALIAS

See Also:

• Constant Field Values

LONG_OPTION

public static final String LONG_OPTION

See Also:

• Constant Field Values

SHORT_OPTION

public static final Character SHORT_OPTION

_description

protected String _description

_exception

protected ArgsSyntaxException _exception

_isVisible

protected boolean _isVisible

Constructor Details

ConfigProperty

public ConfigProperty()

Constructs the predefined config (file) Property.

ConfigProperty

public ConfigProperty(boolean hasShortProperty)

Instantiates the class ConfigProperty.

Parameters:

hasShortProperty - True in case to also enable the short option, else only the long option takes effect.

See Also:

• StringProperty(Character, String, String, String)

ConfigProperty

public ConfigProperty(String aDescription)

Instantiates a new config (file) Property.

Parameters:

aDescription - The description to use.

ConfigProperty

public ConfigProperty(String aDescription,
 boolean hasShortProperty)

Instantiates the class ConfigProperty.

Parameters:

hasShortProperty - True in case to also enable the short option, else only the long option takes effect.

See Also:

• StringProperty(Character, String, String, String)

Method Details

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.