Class CliContext.Builder

java.lang.Object

org.refcodes.cli.CliContext.Builder

All Implemented Interfaces:

ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<CliContext.Builder>, KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<CliContext.Builder>, SyntaxMetricsAccessor.SyntaxMetricsBuilder<CliContext.Builder>, EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<CliContext.Builder>, ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<CliContext.Builder>

Enclosing class:

CliContext

public static final class CliContext.Builder
extends Object
implements SyntaxMetricsAccessor.SyntaxMetricsBuilder<CliContext.Builder>, ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<CliContext.Builder>, KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<CliContext.Builder>, ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<CliContext.Builder>, EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<CliContext.Builder>

Builder to build SyntaxMetricsAccessor.SyntaxMetricsBuilder instances.

Method Summary

Modifier and Type	Method	Description
CliContext	build()	CliContext.Builder for fluently building a CliContext instances.
CliContext.Builder	withArgumentEscapeCode(String aArgumentEscapeCode)	Sets the argument Escape-Code for the argument Escape-Code property.
CliContext.Builder	withEscapeCodesEnabled(boolean isEscapeCodesEnabled)
CliContext.Builder	withKeywordEscapeCode(String aKeywordEscapeCode)	Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.
CliContext.Builder	withResetEscapeCode(String aResetEscapeCode)
CliContext.Builder	withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)	Sets the SyntaxMetrics for the SyntaxMetrics property.

Methods inherited from class Object

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

Methods inherited from interface SyntaxMetricsAccessor.SyntaxMetricsBuilder

withSyntaxMetrics

Method Details

build

public CliContext build()

CliContext.Builder for fluently building a CliContext instances.

Returns:

The according constructed CliContext instance.

withArgumentEscapeCode

public CliContext.Builder withArgumentEscapeCode(String aArgumentEscapeCode)

Sets the argument Escape-Code for the argument Escape-Code property.

Specified by:

withArgumentEscapeCode in interface ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<CliContext.Builder>

Parameters:

aArgumentEscapeCode - The argument Escape-Code to be stored by the argument Escape-Code property.

Returns:

The builder for applying multiple build operations.

withEscapeCodesEnabled

public CliContext.Builder withEscapeCodesEnabled(boolean isEscapeCodesEnabled)

Specified by:

withEscapeCodesEnabled in interface EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<CliContext.Builder>

withKeywordEscapeCode

public CliContext.Builder withKeywordEscapeCode(String aKeywordEscapeCode)

Sets the keyword (e.g. short- and long-options) Escape-Code for the keyword Escape-Code property.

Specified by:

withKeywordEscapeCode in interface KeywordEscapeCodeAccessor.KeywordEscapeCodeBuilder<CliContext.Builder>

Parameters:

aKeywordEscapeCode - The keyword (e.g. short- and long-options) Escape-Code to be stored by the option Escape-Code property.

Returns:

The builder for applying multiple build operations.

withResetEscapeCode

public CliContext.Builder withResetEscapeCode(String aResetEscapeCode)

Specified by:

withResetEscapeCode in interface ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<CliContext.Builder>

withSyntaxMetrics

public CliContext.Builder withSyntaxMetrics(SyntaxMetrics aSyntaxMetrics)

Sets the SyntaxMetrics for the SyntaxMetrics property.

Specified by:

withSyntaxMetrics in interface SyntaxMetricsAccessor.SyntaxMetricsBuilder<CliContext.Builder>

Parameters:

aSyntaxMetrics - The SyntaxMetrics to be stored by the SyntaxMetrics property.

Returns:

The builder for applying multiple build operations.