uk.co.real_logic.sbe.ir

Class Token.Builder

java.lang.Object

uk.co.real_logic.sbe.ir.Token.Builder

Enclosing class:

Token

public static class Token.Builder
extends Object

Builder for Token which can simplify construction.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Token	build() Build a new Token based on the values.
Token.Builder	componentTokenCount(int componentTokenCount) Count of tokens in the component.
Token.Builder	deprecated(int deprecated) Deprecated version attribute for the Token.
Token.Builder	description(String description) Description attribute for the Token.
Token.Builder	encoding(Encoding encoding) Encoding type for the Token.
Token.Builder	id(int id) ID attribute for the Token.
Token.Builder	name(String name) Name for the Token.
Token.Builder	offset(int offset) Offset in the message for the Token.
Token.Builder	packageName(String packageName) Package name for the Token, default is null.
Token.Builder	referencedName(String referencedName) Referenced type name for the Token.
Token.Builder	signal(Signal signal) Signal for the Token.
Token.Builder	size(int size) Size of the type for the Token.
Token.Builder	version(int version) Version attribute value for the Token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

signal

public Token.Builder signal(Signal signal)

Signal for the Token.

Parameters:

signal - for the Token.

Returns:

this for a fluent API.

name

public Token.Builder name(String name)

Name for the Token.

Parameters:

name - for the Token.

Returns:

this for a fluent API.

packageName

public Token.Builder packageName(String packageName)

Package name for the Token, default is null. Use for BEGIN_MESSAGE tokens for types that require an explicit package.

Parameters:

packageName - for the Token.

Returns:

this for a fluent API.

referencedName

public Token.Builder referencedName(String referencedName)

Referenced type name for the Token.

Parameters:

referencedName - for the Token.

Returns:

this for a fluent API.

description

public Token.Builder description(String description)

Description attribute for the Token.

Parameters:

description - for the Token.

Returns:

this for a fluent API.

id

public Token.Builder id(int id)

ID attribute for the Token.

Parameters:

id - for the Token.

Returns:

this for a fluent API.

version

public Token.Builder version(int version)

Version attribute value for the Token.

Parameters:

version - for the Token.

Returns:

this for a fluent API.

deprecated

public Token.Builder deprecated(int deprecated)

Deprecated version attribute for the Token.

Parameters:

deprecated - version for the Token.

Returns:

this for a fluent API.

size

public Token.Builder size(int size)

Size of the type for the Token.

Parameters:

size - for the Token.

Returns:

this for a fluent API.

offset

public Token.Builder offset(int offset)

Offset in the message for the Token.

Parameters:

offset - for the Token.

Returns:

this for a fluent API.

componentTokenCount

public Token.Builder componentTokenCount(int componentTokenCount)

Count of tokens in the component.

Parameters:

componentTokenCount - for the component.

Returns:

this for a fluent API.

encoding

public Token.Builder encoding(Encoding encoding)

Encoding type for the Token.

Parameters:

encoding - for the Token.

Returns:

this for a fluent API.

build

public Token build()

Build a new Token based on the values.

Returns:

a new Token based on the values.