Module org.refcodes.cli

Package org.refcodes.cli

Class NoneOperand

java.lang.Object

org.refcodes.cli.AbstractOperand<Boolean>

org.refcodes.cli.NoneOperand

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, ArgsAccessor, Constituent, Operand<Boolean>, Synopsisable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.Clonable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.EnabledAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable<CliSchema>, org.refcodes.mixin.TypeAccessor<Boolean>, org.refcodes.mixin.ValueAccessor<Boolean>

public class NoneOperand
extends AbstractOperand<Boolean>
implements Operand<Boolean>, org.refcodes.mixin.EnabledAccessor

The NoneOperand represents an empty set of arguments, e.g. no command line argument is being passed. Usually only makes sense near the root of a Constituent tree (e.g. inside the main XorCondition) to test ALL arguments passed to an application and one invocation may have neither optional (as of AnyCondition) nor mandatory arguments allowed.

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

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

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

org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B extends org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B>>, org.refcodes.mixin.EnabledAccessor.EnabledMutator, org.refcodes.mixin.EnabledAccessor.EnabledProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor

org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_description

Fields inherited from class org.refcodes.cli.AbstractOperand

_value

Constructor Summary

Constructors

Constructor	Description
NoneOperand(String aDescription)	Instantiates a new NoneOperand.
NoneOperand(String aAlias, String aDescription)	Instantiates a new NoneOperand.
NoneOperand(org.refcodes.struct.Relation<String,Boolean> aProperty)	Instantiates a new NoneOperand.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
boolean	isEnabled()	Determines whether none arguments have been passed.
List<Operand<Boolean>>	parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' Constituent.parseArgs(String[], String[], CliContext) methods.
String	toSyntax(CliContext aCliCtx)	This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent.
protected Boolean	toType(String aArg)	To value.

Methods inherited from class org.refcodes.cli.AbstractOperand

clone, compareTo, getAlias, getType, getValue, reset, setParsedArgs, setValue, toParsedArgs, toSchema, toString

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

parseArgs, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.cli.Operand

getAlias, getValue, hasValue, toParsedArgs, toSpec, toValue

Methods inherited from interface org.refcodes.mixin.Resetable

reset

Methods inherited from interface org.refcodes.mixin.Schemable

toSchema

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Field Details

_description

protected String _description

Constructor Details

NoneOperand

public NoneOperand(String aDescription)

Instantiates a new NoneOperand.

Parameters:

aDescription - The description to be used (without any line breaks).

NoneOperand

public NoneOperand(String aAlias,
 String aDescription)

Instantiates a new NoneOperand.

Parameters:

aAlias - The identifier to be used when printing the syntax via the toSyntax(CliContext) method.

aDescription - The description to be used (without any line breaks).

NoneOperand

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

Instantiates a new NoneOperand.

Parameters:

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

Method Details

parseArgs

public List<Operand<Boolean>> parseArgs(String[] aArgs,
 String[] aOptions,
 CliContext aCliContext)
                                 throws ArgsSyntaxException

Parses the provided command line arguments and determines the according values by evaluating this Constituent instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Constituent instances' Constituent.parseArgs(String[], String[], CliContext) methods. In case of successfully parsing this Constituent and / or the child Constituent instances, the evaluated command line arguments are returned: Depending on the Constituent subclasses representing the evaluated command line arguments, instances of Flag classes, Option classes or Operand classes may be found in the result. In case of parsing failure, an according exception is thrown. ATTENTION: This method does not test for superfluous command line arguments being passed; e.g. command line arguments not being evaluated by any of the Constituent instance being traversed. This method is commonly used by a root Constituent's ArgsParser.evalArgs(String[]) method, which delegates to the Constituent.parseArgs(String[], String[], CliContext) method and after which it determines whether there are superfluous arguments to be taken care of (by throwing an according exception). Business logic therefore should invoke the root node's Constituent.parseArgs(String[], String[], CliContext) method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.

Specified by:

parseArgs in interface Constituent

Overrides:

parseArgs in class AbstractOperand<Boolean>

Parameters:

aArgs - The command line arguments to be parsed.

aOptions - The list of options (short and as well as long) which are reserved and cannot be used as value.

aCliContext - the cli context

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types.

Throws:

ArgsSyntaxException - thrown in case of a command line arguments mismatch regarding provided and expected args.

toSyntax

public String toSyntax(CliContext aCliCtx)

This method is to be called from inside the Constituent hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Constituent. Returns the human readable (verbose) syntax of this Constituent instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Constituent instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Constituent and the child Constituents, the method Constituent.toSyntax(CliContext) is called from inside the Constituent hierarchy. In case the syntax is to be retrieved from the root Constituent, 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 Constituent

Overrides:

toSyntax in class AbstractOperand<Boolean>

Parameters:

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

Returns:

The human readable (verbose) command line arguments syntax.

isEnabled

public boolean isEnabled()

Determines whether none arguments have been passed.

Specified by:

isEnabled in interface org.refcodes.mixin.EnabledAccessor

Returns:

True in case none arguments have been passed.

toType

protected Boolean toType(String aArg)

To value.

Specified by:

toType in class AbstractOperand<Boolean>

Parameters:

aArg - the arg

Returns:

the string

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor