org.refcodes.console.impls

Class QuietSwitchImpl

java.lang.Object

org.refcodes.console.impls.AbstractOperand<T>

org.refcodes.console.impls.AbstractOption<Boolean>

org.refcodes.console.impls.SwitchImpl

org.refcodes.console.impls.QuietSwitchImpl

All Implemented Interfaces:

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

public class QuietSwitchImpl
extends SwitchImpl

A predefined "be quiet" switch.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	LONG_OPTION
static String	SHORT_OPTION

Constructor Summary

Constructors

Constructor and Description
QuietSwitchImpl() Constructs the predefined quiet switch.
QuietSwitchImpl(String aDescription) Constructs the predefined quiet switch.

Method Summary

Modifier and Type	Method and Description
String	parseSyntax(SyntaxNotation aSyntaxNotation) This method is to be called from from the root Syntaxable; when invoking syntax retrieval inside the Syntaxable hierarchy use the method Syntaxable.toSyntax(SyntaxNotation) .

Methods inherited from class org.refcodes.console.impls.SwitchImpl

parseArgs, reset, toValue

Methods inherited from class org.refcodes.console.impls.AbstractOption

getLongOption, getShortOption, setArgs, setValue, toState, toSyntax

Methods inherited from class org.refcodes.console.impls.AbstractOperand

compareTo, getArgs, getDescription, getParameterName, getType, getValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.console.Option

getLongOption, getShortOption

Methods inherited from interface org.refcodes.console.Operand

getArgs, getParameterName, getValue, hasValue

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

parseSyntax, toState, toSyntax

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

LONG_OPTION

public static final String LONG_OPTION

See Also:

Constant Field Values

SHORT_OPTION

public static final String SHORT_OPTION

See Also:

Constant Field Values

Constructor Detail

QuietSwitchImpl

public QuietSwitchImpl(String aDescription)

Constructs the predefined quiet switch.

Parameters:

aDescription - A description without any line breaks.

QuietSwitchImpl

public QuietSwitchImpl()

Constructs the predefined quiet switch.

Method Detail

parseSyntax

public String parseSyntax(SyntaxNotation aSyntaxNotation)

Description copied from interface: Syntaxable

This method is to be called from from the root Syntaxable; when invoking syntax retrieval inside the Syntaxable hierarchy use the method Syntaxable.toSyntax(SyntaxNotation) . Returns the human readable (verbose) syntax of this Syntaxable instance including, in case of being a node in the syntax tree (such as a Condition, the syntax of the child Syntaxable instances. ATTENTION: As of different parenthesis settings for some notations regarding the root Syntaxable and the child Syntaxables, the method Syntaxable.toSyntax(SyntaxNotation) is called from inside the Syntaxable hierarchy. In case the syntax is to be retrieved from the root Syntaxable, then the applicable method to be called is Syntaxable.parseSyntax(SyntaxNotation), as for some notations it will for example not create the most outer braces.

Specified by:

parseSyntax in interface Syntaxable

Parameters:

aSyntaxNotation - The syntax notation used for generating the command line arguments syntax.

Returns:

The human readable (verbose) command line arguments syntax.