Module org.refcodes.cli

Package org.refcodes.cli

Class Operation

java.lang.Object

org.refcodes.cli.AbstractOperand<Boolean>

org.refcodes.cli.Operation

All Implemented Interfaces:

Cloneable, Comparable<Operand<?>>, MatchCountAccessor, Operand<Boolean>, ParsedArgsAccessor, 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.EnabledAccessor, org.refcodes.mixin.Resetable, org.refcodes.mixin.TypeAccessor<Boolean>, org.refcodes.mixin.ValueAccessor<Boolean>, org.refcodes.schema.Schemable

public class Operation
extends AbstractOperand<Boolean>
implements org.refcodes.mixin.EnabledAccessor

The Operation is an argument representing a function or a method ("command") and is either provided or not provided as of isEnabled(). It must neither be prefixed with "-" nor with "--" in contrast to the Option or the Flag type.

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

Fields inherited from class org.refcodes.cli.AbstractOperand

_matchCount

Constructor Summary

Constructors

Constructor	Description
Operation(String aOperation, String aDescription)	Constructs a Operation with the given arguments.
Operation(String aOperation, String aAlias, String aDescription)	Constructs a Operation with the given arguments.
Operation(String aOperation, String aAlias, String aDescription, Consumer<Operation> aConsumer)	Constructs a Operation with the given arguments.
Operation(String aOperation, String aDescription, Consumer<Operation> aConsumer)	Constructs a Operation with the given arguments.

Method Summary

Modifier and Type	Method	Description
Object	clone()
String	getDescription()
ArgsSyntaxException	getException()	Retrieves the ArgsSyntaxException exception in case invoking Term.parseArgs(String[], CliContext) failed.
String	getOperation()	Returns the operation's name.
boolean	isEnabled()	Returns true if the switch has been set (enabled).
boolean	isVisible()	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
Operand<Boolean>[]	parseArgs(String[] aArgs, String[] aOptions, CliContext aCliContext)	Parses the provided command line arguments and determines the according values by evaluating this Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods.
void	reset()
void	setVisible(boolean isVisible)	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).
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.
String	toSyntax(CliContext aCliCtx)	This method is to be called from inside the Term hierarchy; use the method Synopsisable.toSynopsis(SyntaxNotation) in case you invoke syntax retrieval from the root Term.
protected Boolean	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.
Operation	withVisible(boolean isVisible)	Visibility in this context means displaying or hiding this Term's existence to the user (defaults to true).

Methods inherited from class org.refcodes.cli.AbstractOperand

approve, compareTo, getAlias, getMatchCount, getParsedArgs, getType, getValue, setParsedArgs, setValue, 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.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.cli.Operand

hasValue, toSpec, toSpec, toUsage, toUsage, toValue

Methods inherited from interface org.refcodes.cli.Synopsisable

toSynopsis, toSynopsis, toSynopsis, toSynopsis

Methods inherited from interface org.refcodes.cli.Term

getException, isVisible, parseArgs, setVisible, toSynopsis, toSyntax, toSyntax, toSyntax, toSyntax

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

_description

protected String _description

_exception

protected ArgsSyntaxException _exception

_isVisible

protected boolean _isVisible

Constructor Details

Operation

public Operation(String aOperation,
 String aDescription)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

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

Operation

public Operation(String aOperation,
 String aDescription,
 Consumer<Operation> aConsumer)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

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

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

Operation

public Operation(String aOperation,
 String aAlias,
 String aDescription)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aAlias - The operation's name to be used when constructing the syntax.

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

Operation

public Operation(String aOperation,
 String aAlias,
 String aDescription,
 Consumer<Operation> aConsumer)

Constructs a Operation with the given arguments.

Parameters:

aOperation - The operation to declare.

aAlias - The operation's name to be used when constructing the syntax.

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

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

Method Details

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface org.refcodes.mixin.Clonable

Overrides:

clone in class AbstractOperand<Boolean>

Throws:

CloneNotSupportedException

getOperation

public String getOperation()

Returns the operation's name.

Returns:

The according operation's name.

isEnabled

public boolean isEnabled()

Returns true if the switch has been set (enabled).

Specified by:

isEnabled in interface org.refcodes.mixin.EnabledAccessor

Returns:

True in case the Flag has been provided (set), else false.

parseArgs

public 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 Term instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Term instances' Term.parseArgs(String[], String[], CliContext) methods. In case of successfully parsing this Term and / or the child Term instances, the evaluated command line arguments are returned: Depending on the Term 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 Term instance being traversed. This method is commonly used by a root Term's ParseArgs.evalArgs(String[]) method, which delegates to the Term.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 Term.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 Term

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.

reset

public void reset()

Specified by:

reset in interface org.refcodes.mixin.Resetable

Overrides:

reset in class AbstractOperand<Boolean>

toSyntax

public String toSyntax(CliContext aCliCtx)

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

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.

withVisible

public Operation withVisible(boolean isVisible)

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

Specified by:

withVisible in interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder<Term>

toType

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

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