org.refcodes.console.impls

Class AbstractCondition

java.lang.Object

org.refcodes.console.impls.AbstractSyntaxable

org.refcodes.console.impls.AbstractCondition

All Implemented Interfaces:

org.refcodes.component.Resetable, Condition, Syntaxable

Direct Known Subclasses:

AndConditionImpl, OptionalConditionImpl, OrConditionImpl, XorConditionImpl

public abstract class AbstractCondition
extends AbstractSyntaxable
implements Condition

The AbstractCondition is an abstract implementation of an Condition providing the boiler plate when implementing the Condition interface.

Constructor Summary

Constructors

Constructor and Description
AbstractCondition(Syntaxable... aElements)

Method Summary

Modifier and Type	Method and Description
protected void	addChild(Syntaxable aArgumentizer)
protected List<Syntaxable>	getChildren()
void	reset()
List<? extends Operand<?>>	toOperands() Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Switch or the Option; This is most useful when creating a list of Options, Switches and Operands when printing out detailed help.o
String	toString()
String	toSyntax(SyntaxNotation aSyntaxNotation) This method is to be called from inside the Syntaxable hierarchy; use the method Syntaxable.parseSyntax(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable.

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

parseSyntax

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.console.Syntaxable

parseArgs, parseSyntax, toState

Constructor Detail

AbstractCondition

public AbstractCondition(Syntaxable... aElements)

Method Detail

toSyntax

public String toSyntax(SyntaxNotation aSyntaxNotation)

Description copied from interface: Syntaxable

This method is to be called from inside the Syntaxable hierarchy; use the method Syntaxable.parseSyntax(SyntaxNotation) in case you invoke syntax retrieval from the root Syntaxable. 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:

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

reset

public void reset()

Specified by:

reset in interface org.refcodes.component.Resetable

toString

public String toString()

Overrides:

toString in class Object

toOperands

public List<? extends Operand<?>> toOperands()

Description copied from interface: Condition

Traverses the hierarchy of Conditions and collects all therein found Operands and sub-types such as the Switch or the Option; This is most useful when creating a list of Options, Switches and Operands when printing out detailed help.o

Specified by:

toOperands in interface Condition

Returns:

getChildren

protected List<Syntaxable> getChildren()

addChild

protected void addChild(Syntaxable aArgumentizer)