de.flapdoodle.eval.core.parser

Class ImmutableToken

java.lang.Object

de.flapdoodle.eval.core.parser.ImmutableToken

All Implemented Interfaces:

Token

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableToken
extends Object
implements Token

Immutable implementation of Token.

Use the builder to create immutable instances: ImmutableToken.builder(). Use the static factory method to create immutable instances: ImmutableToken.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableToken.Builder Builds instances of type ImmutableToken.

Method Summary

Modifier and Type	Method and Description
static ImmutableToken.Builder	builder() Creates a builder for ImmutableToken.
static ImmutableToken	copyOf(Token instance) Creates an immutable copy of a Token value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableToken that have equal attribute values.
int	hashCode() Computes a hash code from attributes: start, value, type.
static ImmutableToken	of(int start, String value, TokenType type) Construct a new immutable Token instance.
int	start()
String	toString() Prints the immutable value Token with attribute values.
TokenType	type()
String	value()
ImmutableToken	withStart(int value) Copy the current immutable object by setting a value for the start attribute.
ImmutableToken	withType(TokenType value) Copy the current immutable object by setting a value for the type attribute.
ImmutableToken	withValue(String value) Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

start

public int start()

Specified by:

start in interface Token

Returns:

The value of the start attribute

value

public String value()

Specified by:

value in interface Token

Returns:

The value of the value attribute

type

public TokenType type()

Specified by:

type in interface Token

Returns:

The value of the type attribute

withStart

public final ImmutableToken withStart(int value)

Copy the current immutable object by setting a value for the start attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for start

Returns:

A modified copy of the this object

withValue

public final ImmutableToken withValue(String value)

Copy the current immutable object by setting a value for the value attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

withType

public final ImmutableToken withType(TokenType value)

Copy the current immutable object by setting a value for the type attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableToken that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: start, value, type.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Token with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableToken of(int start,
                                String value,
                                TokenType type)

Construct a new immutable Token instance.

Specified by:

of in interface Token

Parameters:

start - The value for the start attribute

value - The value for the value attribute

type - The value for the type attribute

Returns:

An immutable Token instance

copyOf

public static ImmutableToken copyOf(Token instance)

Creates an immutable copy of a Token value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Token instance

builder

public static ImmutableToken.Builder builder()

Creates a builder for ImmutableToken.

 ImmutableToken.builder()
    .start(int) // required start
    .value(String) // required value
    .type(de.flapdoodle.eval.core.parser.TokenType) // required type
    .build();
 

Returns:

A new ImmutableToken builder