org.refcodes.console.impls

Class OptionalConditionImpl

java.lang.Object

org.refcodes.console.impls.AbstractSyntaxable

org.refcodes.console.impls.AbstractCondition

org.refcodes.console.impls.OptionalConditionImpl

All Implemented Interfaces:

org.refcodes.component.Resetable, Condition, Syntaxable

public class OptionalConditionImpl
extends AbstractCondition

Author:

steiner

Constructor Summary

Constructors

Constructor and Description
OptionalConditionImpl(Syntaxable aSyntaxable)

Method Summary

Modifier and Type	Method and Description
List<? extends Operand<?>>	parseArgs(String[] aArgs) Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[]) methods.
void	reset()
String	toState() The Syntaxable.toState() method might be used by the #toString() method and prints out the state of the syntaxable and (if any) its children.
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.AbstractCondition

addChild, getChildren, toOperands

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

parseSyntax

Constructor Detail

OptionalConditionImpl

public OptionalConditionImpl(Syntaxable aSyntaxable)

Method Detail

parseArgs

public List<? extends Operand<?>> parseArgs(String[] aArgs)
                                     throws UnknownArgsException,
                                            AmbiguousArgsException,
                                            ParseArgsException

Description copied from interface: Syntaxable

Parses the provided command line arguments and determines the according values by evaluating this Syntaxable instance or, in case of being a node in the syntax tree (such as a Condition, traversing the child Syntaxable instances' Syntaxable.parseArgs(String[]) methods. In case of successfully parsing this Syntaxable and / or the child Syntaxable instances, the evaluated command line arguments are returned: Depending on the Syntaxable subclasses representing the evaluated command line arguments, instances of Switch 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 Syntaxable instance being traversed. This method is commonly used by a root Syntaxable's ArgsParser.evalArgs(String[]) method, which delegates to the Syntaxable.parseArgs(String[]) 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 Syntaxable.parseArgs(String[]) method as ignoring superfluous command line arguments will cause unexpected behavior from the point of view of the invoker.

Parameters:

aArgs - The command line arguments to be parsed.

Returns:

The list of evaluated command line arguments being instances of the Operand interfaces or its sub-types.

Throws:

UnknownArgsException - Thrown in case not one command line argument matched regarding the provided args vs. the expected args.

AmbiguousArgsException - Thrown in case at least one command line argument is ambiguous regarding expected args vs. provided args.

ParseArgsException - Thrown in case the provided command line arguments do not respect the required syntax or cannot be converted to the required type

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

Overrides:

toSyntax in class AbstractCondition

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

Overrides:

reset in class AbstractCondition

toState

public String toState()

Description copied from interface: Syntaxable

The Syntaxable.toState() method might be used by the #toString() method and prints out the state of the syntaxable and (if any) its children. Even in case parsing command line arguments failed, the state till failure can be inspected with this method.

Returns:

The state of this Syntaxable instance and (if any) its children.

toString

public String toString()

Overrides:

toString in class AbstractCondition