org.refcodes.console

Interface Operand<T>

All Superinterfaces:

ArgsAccessor, Comparable<Operand<?>>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.component.Resetable, Syntaxable, org.refcodes.mixin.TypeAccessor, org.refcodes.mixin.ValueAccessor<T>

All Known Subinterfaces:

Option<T>, Switch

All Known Implementing Classes:

AbstractOperand, AbstractOption, EnumOptionImpl, ForceSwitchImpl, HelpSwitchImpl, IntegerOptionImpl, QuietSwitchImpl, StringOperandImpl, StringOptionImpl, SwitchImpl, SysInfoSwitchImpl, VerboseSwitchImpl

public interface Operand<T>
extends org.refcodes.mixin.ValueAccessor<T>, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.TypeAccessor, Syntaxable, ArgsAccessor, Comparable<Operand<?>>

An Operand represents a value parsed from command line arguments. In comparison to an Option an Operand just represents a plain value without an identifier in front of it. An Operand has a state which changes with each invocation of the Syntaxable.parseArgs(String[]) method.

It is recommended to put your Operand instance(s) at the end of your top Condition to enforce it to be the last Syntaxable(s) when parsing the command line arguments - this makes sure that any Options pick their option arguments so that the Operand(s) will correctly be left over for parsing command line argument(s); the Operand will not pick by mistake an option argument.

Nested Class Summary

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

org.refcodes.mixin.TypeAccessor.TypeMutator, org.refcodes.mixin.TypeAccessor.TypeProperty

Nested classes/interfaces inherited from interface org.refcodes.console.ArgsAccessor

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

Method Summary

Modifier and Type	Method and Description
String[]	getArgs() When being parsed via the Syntaxable.parseArgs(String[]) method, then the getArgs() method returns the command line arguments representing this Operand instance (also including the short or the long options, see Operand).
String	getParameterName() Retrieves the name of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface.
T	getValue() When being parsed via the Syntaxable.parseArgs(String[]) method, then the getValue() method returns the parsed value.
default boolean	hasValue() When being parsed via the Syntaxable.parseArgs(String[]) method, use this method to determine whether the getValue() method contains parsed value.

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.console.Syntaxable

parseArgs, parseSyntax, toState, toSyntax

Methods inherited from interface org.refcodes.component.Resetable

reset

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getValue

T getValue()

When being parsed via the Syntaxable.parseArgs(String[]) method, then the getValue() method returns the parsed value.

Specified by:

getValue in interface org.refcodes.mixin.ValueAccessor<T>

Returns:

The parsed value when being parsed via the Syntaxable.parseArgs(String[]) method.

hasValue

default boolean hasValue()

When being parsed via the Syntaxable.parseArgs(String[]) method, use this method to determine whether the getValue() method contains parsed value.

Returns:

The true in case there a value has been parsed via the Syntaxable.parseArgs(String[]) method.

getArgs

String[] getArgs()

When being parsed via the Syntaxable.parseArgs(String[]) method, then the getArgs() method returns the command line arguments representing this Operand instance (also including the short or the long options, see Operand).

Specified by:

getArgs in interface ArgsAccessor

Returns:

The parsed command line arguments representing this Operand instance.

getParameterName

String getParameterName()

Retrieves the name of the parameter value which can be the name of the operand (Operand) or the option argument (Option), depending on the sub-type inheriting from this interface. The parameter name is merely used for constructing the command line arguments syntax String via Syntaxable.toSyntax(SyntaxNotation) and the command line arguments detail description when creating a command line tool's help output.

Returns:

The name of the parameter, r.g the name of the operand or the name of the option argument.