Module org.refcodes.cli

Package org.refcodes.cli

Class AllCondition

java.lang.Object

org.refcodes.cli.AbstractCondition

org.refcodes.cli.AllCondition

All Implemented Interfaces:

Condition, Constituent, Synopsisable, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable

public class AllCondition
extends AbstractCondition
implements Condition

The AllCondition enforces that the encapsulated Constituent consumes all arguments passed via invoking its Constituent.parseArgs(String[], CliContext), else a SuperfluousArgsException is thrown. This enables the construction of a syntax which otherwise would not be unambiguous when encapsulated within an XorCondition.

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_description

Constructor Summary

Constructors

Constructor	Description
AllCondition(Constituent aArg)	Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
List<? extends Operand<?>>	parseArgs(String[] aArgs, String[] aOptions, CliContext aCliCtx)	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.
void	reset()
String	toString()
String	toSynopsis(CliContext aCliCtx)	Returns the human readable (verbose) syntax of implementing class 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 a Constituent hierarchy.
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.

Methods inherited from class org.refcodes.cli.AbstractCondition

addChild, getChildren, getFirst, toOperand, toOperands, toSchema, toValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.cli.Condition

toOperand, toOperand, toOperand, toOperands

Methods inherited from interface org.refcodes.cli.Constituent

parseArgs, toSchema, toSyntax, toSyntax, toSyntax, toSyntax, toValue

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Field Details

_description

protected String _description

Constructor Details

AllCondition

public AllCondition(Constituent aArg)

Instantiates a new AllCondition with the Constituent (Condition) instance to be nested.

Parameters:

aArg - The Constituent (Condition) instance to be nested

Method Details

parseArgs

public List<? extends Operand<?>> parseArgs(String[] aArgs,
 String[] aOptions,
 CliContext aCliCtx)
                                     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 aCause unexpected behavior from the point of view of the invoker.

Specified by:

parseArgs in interface Constituent

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.

aCliCtx - 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 AbstractCondition

Parameters:

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

Returns:

The human readable (verbose) command line arguments syntax.

toSynopsis

public String toSynopsis(CliContext aCliCtx)

Returns the human readable (verbose) syntax of implementing class 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 a Constituent hierarchy. In case the syntax is to be retrieved from the root Constituent or an encapsulating and different type, 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:

toSynopsis in interface Constituent

Specified by:

toSynopsis in interface Synopsisable

Parameters:

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

Returns:

The human readable (verbose) command line arguments syntax.

reset

public void reset()

Specified by:

reset in interface org.refcodes.mixin.Resetable

Overrides:

reset in class AbstractCondition

toString

public String toString()

Overrides:

toString in class AbstractCondition

getDescription

public String getDescription()

Specified by:

getDescription in interface org.refcodes.mixin.DescriptionAccessor