de.flapdoodle.eval.core.tree

Class ImmutableVariable

java.lang.Object

de.flapdoodle.eval.core.tree.Variable

de.flapdoodle.eval.core.tree.ImmutableVariable

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableVariable
extends Variable

Immutable implementation of Variable.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableVariable.Builder	builder() Creates a builder for ImmutableVariable.
static ImmutableVariable	copyOf(Variable instance) Creates an immutable copy of a Variable value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableVariable that have equal attribute values.
int	hash()
int	hashCode() Computes a hash code from attributes: hash, name, position.
String	name()
static ImmutableVariable	of(int hash, String name, int position) Construct a new immutable Variable instance.
int	position()
String	toString() Prints the immutable value Variable with attribute values.
ImmutableVariable	withHash(int value) Copy the current immutable object by setting a value for the hash attribute.
ImmutableVariable	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutableVariable	withPosition(int value) Copy the current immutable object by setting a value for the position attribute.

Methods inherited from class de.flapdoodle.eval.core.tree.Variable

of

Methods inherited from class java.lang.Object

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

Method Detail

hash

public int hash()

Specified by:

hash in class Variable

Returns:

The value of the hash attribute

name

public String name()

Specified by:

name in class Variable

Returns:

The value of the name attribute

position

public int position()

Specified by:

position in class Variable

Returns:

The value of the position attribute

withHash

public final ImmutableVariable withHash(int value)

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

Parameters:

value - A new value for hash

Returns:

A modified copy of the this object

withName

public final ImmutableVariable withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withPosition

public final ImmutableVariable withPosition(int value)

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

Parameters:

value - A new value for position

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableVariable 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: hash, name, position.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Variable with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableVariable of(int hash,
                                   String name,
                                   int position)

Construct a new immutable Variable instance.

Parameters:

hash - The value for the hash attribute

name - The value for the name attribute

position - The value for the position attribute

Returns:

An immutable Variable instance

copyOf

public static ImmutableVariable copyOf(Variable instance)

Creates an immutable copy of a Variable 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 Variable instance

builder

public static ImmutableVariable.Builder builder()

Creates a builder for ImmutableVariable.

 ImmutableVariable.builder()
    .hash(int) // required hash
    .name(String) // required name
    .position(int) // required position
    .build();
 

Returns:

A new ImmutableVariable builder