Class SyntaxMetricsBuilder.Builder

java.lang.Object

org.refcodes.cli.SyntaxMetricsBuilder.Builder

All Implemented Interfaces:

ArgumentPrefixAccessor.ArgumentPrefixBuilder<SyntaxMetricsBuilder.Builder>, ArgumentSuffixAccessor.ArgumentSuffixBuilder<SyntaxMetricsBuilder.Builder>, LongOptionPrefixAccessor.LongOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>, ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>

Enclosing class:

SyntaxMetricsBuilder

public static final class SyntaxMetricsBuilder.Builder
extends Object
implements ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>, LongOptionPrefixAccessor.LongOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>, ArgumentPrefixAccessor.ArgumentPrefixBuilder<SyntaxMetricsBuilder.Builder>, ArgumentSuffixAccessor.ArgumentSuffixBuilder<SyntaxMetricsBuilder.Builder>

Builder to build SyntaxMetrics instances.

Method Summary

Modifier and Type	Method	Description
SyntaxMetrics	build()	SyntaxMetricsBuilder.Builder for fluently building a SyntaxMetrics instances.
SyntaxMetricsBuilder.Builder	withAllSymbol(String aAllSymbol)	Sets the symbol for representing an ALL notation.
SyntaxMetricsBuilder.Builder	withAndSymbol(String aAndSymbol)	Sets the symbol for representing an AND notation.
SyntaxMetricsBuilder.Builder	withAnySymbol(String aAnySymbol)	Sets the symbol for representing an ANY notation.
SyntaxMetricsBuilder.Builder	withArgumentPrefix(String aArgNotationPrefix)	Sets the argument prefix for the argument prefix property.
SyntaxMetricsBuilder.Builder	withArgumentSuffix(String aArgNotationSuffix)	Sets the argument suffix for the argument suffix property.
SyntaxMetricsBuilder.Builder	withAssignmentOperator(String aAssignmentOperator)	Sets the assignment operator to be used in the syntax for separating a name from a value.
SyntaxMetricsBuilder.Builder	withBeginArraySymbol(String aBeginArraySymbol)	Sets the symbol representing the beginning of an array, e.g. an opening square brace.
SyntaxMetricsBuilder.Builder	withBeginListSymbol(String aBeginListSymbol)	Sets the symbol representing the beginning of a list, e.g. an opening brace.
SyntaxMetricsBuilder.Builder	withBeginOptionalSymbol(String aBeginOptionalSymbol)	Sets the symbol representing the beginning optional elements, e.g. an opening square brace.
SyntaxMetricsBuilder.Builder	withBeginRangeSymbol(String aBeginRangeSymbol)	Sets the symbol representing the beginning of a range, e.g. an opening square brace.
SyntaxMetricsBuilder.Builder	withEMptySymbol(String aEmptySymbol)	Sets the symbol for representing an EMPTY notation.
SyntaxMetricsBuilder.Builder	withEndArraySymbol(String aEndArraySymbol)	Sets the symbol representing the end of an array, e.g. a closing square brace.
SyntaxMetricsBuilder.Builder	withEndListSymbol(String aEndListSymbol)	Sets the symbol representing the end of a list, e.g. a closing brace.
SyntaxMetricsBuilder.Builder	withEndOptionalSymbol(String aEndOptionalSymbol)	Sets the symbol representing the end of optional elements, e.g. a closing square brace.
SyntaxMetricsBuilder.Builder	withEndRangeSymbol(String aEndRangeSymbol)	Sets the symbol representing the end of a range, e.g. a closing square brace.
SyntaxMetricsBuilder.Builder	withIntervalSymbol(String aIntervalSymbol)	Sets the symbol representing an interval, e.g. "..." or "-".
SyntaxMetricsBuilder.Builder	withLongOptionPrefix(String aLongOptionPrefix)	Sets the long option prefix for the long option prefix property.
SyntaxMetricsBuilder.Builder	withOrSymbol(String aOrSymbol)	Sets the symbol for representing an OR notation.
SyntaxMetricsBuilder.Builder	withShortOptionPrefix(Character aShortOptionPrefix)	Sets the short option prefix for the short option prefix property.
SyntaxMetricsBuilder.Builder	withUndefinedSymbol(String aUndefinedSymbol)	Sets the symbol representing for something unknowingly (name, alias, value).
SyntaxMetricsBuilder.Builder	withXorSymbol(String aXorSymbol)	Sets the symbol for representing an XOR notation.

Methods inherited from class java.lang.Object

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

Method Details

build

public SyntaxMetrics build()

SyntaxMetricsBuilder.Builder for fluently building a SyntaxMetrics instances.

Returns:

The according constructed SyntaxMetrics instance.

withAllSymbol

public SyntaxMetricsBuilder.Builder withAllSymbol(String aAllSymbol)

Sets the symbol for representing an ALL notation.

Parameters:

aAllSymbol - The according ALL symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withAndSymbol

public SyntaxMetricsBuilder.Builder withAndSymbol(String aAndSymbol)

Sets the symbol for representing an AND notation.

Parameters:

aAndSymbol - The according AND symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withAnySymbol

public SyntaxMetricsBuilder.Builder withAnySymbol(String aAnySymbol)

Sets the symbol for representing an ANY notation.

Parameters:

aAnySymbol - The according ANY symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withArgumentPrefix

public SyntaxMetricsBuilder.Builder withArgumentPrefix(String aArgNotationPrefix)

Sets the argument prefix for the argument prefix property.

Specified by:

withArgumentPrefix in interface ArgumentPrefixAccessor.ArgumentPrefixBuilder<SyntaxMetricsBuilder.Builder>

Parameters:

aArgNotationPrefix - The argument prefix to be stored by the argument prefix property.

Returns:

The builder for applying multiple build operations.

withArgumentSuffix

public SyntaxMetricsBuilder.Builder withArgumentSuffix(String aArgNotationSuffix)

Sets the argument suffix for the argument suffix property.

Specified by:

withArgumentSuffix in interface ArgumentSuffixAccessor.ArgumentSuffixBuilder<SyntaxMetricsBuilder.Builder>

Parameters:

aArgNotationSuffix - The argument suffix to be stored by the argument suffix property.

Returns:

The builder for applying multiple build operations.

withBeginArraySymbol

public SyntaxMetricsBuilder.Builder withBeginArraySymbol(String aBeginArraySymbol)

Sets the symbol representing the beginning of an array, e.g. an opening square brace.

Parameters:

aBeginArraySymbol - The symbol representing the beginning of a array.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withBeginListSymbol

public SyntaxMetricsBuilder.Builder withBeginListSymbol(String aBeginListSymbol)

Sets the symbol representing the beginning of a list, e.g. an opening brace.

Parameters:

aBeginListSymbol - The symbol representing the beginning of a list.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withBeginOptionalSymbol

public SyntaxMetricsBuilder.Builder withBeginOptionalSymbol(String aBeginOptionalSymbol)

Sets the symbol representing the beginning optional elements, e.g. an opening square brace.

Parameters:

aBeginOptionalSymbol - The symbol representing the beginning of optional elements.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withBeginRangeSymbol

public SyntaxMetricsBuilder.Builder withBeginRangeSymbol(String aBeginRangeSymbol)

Sets the symbol representing the beginning of a range, e.g. an opening square brace.

Parameters:

aBeginRangeSymbol - The symbol representing the beginning of a range.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withEMptySymbol

public SyntaxMetricsBuilder.Builder withEMptySymbol(String aEmptySymbol)

Sets the symbol for representing an EMPTY notation.

Parameters:

aEmptySymbol - The according EMPTY symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withEndArraySymbol

public SyntaxMetricsBuilder.Builder withEndArraySymbol(String aEndArraySymbol)

Sets the symbol representing the end of an array, e.g. a closing square brace.

Parameters:

aEndArraySymbol - The symbol representing the end of a array.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withEndListSymbol

public SyntaxMetricsBuilder.Builder withEndListSymbol(String aEndListSymbol)

Sets the symbol representing the end of a list, e.g. a closing brace.

Parameters:

aEndListSymbol - The symbol representing the end of a list.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withEndOptionalSymbol

public SyntaxMetricsBuilder.Builder withEndOptionalSymbol(String aEndOptionalSymbol)

Sets the symbol representing the end of optional elements, e.g. a closing square brace.

Parameters:

aEndOptionalSymbol - The symbol representing the end of optional elements.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withEndRangeSymbol

public SyntaxMetricsBuilder.Builder withEndRangeSymbol(String aEndRangeSymbol)

Sets the symbol representing the end of a range, e.g. a closing square brace.

Parameters:

aEndRangeSymbol - The symbol representing the end of a range.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withIntervalSymbol

public SyntaxMetricsBuilder.Builder withIntervalSymbol(String aIntervalSymbol)

Sets the symbol representing an interval, e.g. "..." or "-".

Parameters:

aIntervalSymbol - The symbol representing an interval.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withLongOptionPrefix

public SyntaxMetricsBuilder.Builder withLongOptionPrefix(String aLongOptionPrefix)

Sets the long option prefix for the long option prefix property.

Specified by:

withLongOptionPrefix in interface LongOptionPrefixAccessor.LongOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>

Parameters:

aLongOptionPrefix - The long option prefix to be stored by the long option prefix property.

Returns:

The builder for applying multiple build operations.

withOrSymbol

public SyntaxMetricsBuilder.Builder withOrSymbol(String aOrSymbol)

Sets the symbol for representing an OR notation.

Parameters:

aOrSymbol - The according OR symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withShortOptionPrefix

public SyntaxMetricsBuilder.Builder withShortOptionPrefix(Character aShortOptionPrefix)

Sets the short option prefix for the short option prefix property.

Specified by:

withShortOptionPrefix in interface ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<SyntaxMetricsBuilder.Builder>

Parameters:

aShortOptionPrefix - The short option prefix to be stored by the short option prefix property.

Returns:

The builder for applying multiple build operations.

withXorSymbol

public SyntaxMetricsBuilder.Builder withXorSymbol(String aXorSymbol)

Sets the symbol for representing an XOR notation.

Parameters:

aXorSymbol - The according XOR symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withUndefinedSymbol

public SyntaxMetricsBuilder.Builder withUndefinedSymbol(String aUndefinedSymbol)

Sets the symbol representing for something unknowingly (name, alias, value).

Parameters:

aUndefinedSymbol - The according undefined symbol.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.

withAssignmentOperator

public SyntaxMetricsBuilder.Builder withAssignmentOperator(String aAssignmentOperator)

Sets the assignment operator to be used in the syntax for separating a name from a value.

Parameters:

aAssignmentOperator - The according assignment operator.

Returns:

This SyntaxMetricsBuilder.Builder instance for chaining multiple builder methods.