Package org.immutables.generator.processor

Class ImmutableTrees.IterationGenerator

java.lang.Object

org.immutables.generator.processor.ImmutableTrees.IterationGenerator

All Implemented Interfaces:

Trees.GeneratorDeclaration, Trees.GeneratorValueDeclaration, Trees.IterationGenerator

Enclosing class:

ImmutableTrees

@Immutable
public static final class ImmutableTrees.IterationGenerator
extends java.lang.Object
implements Trees.IterationGenerator

Immutable implementation of Trees.IterationGenerator.

Use the builder to create immutable instances: ImmutableTrees.IterationGenerator.builder().

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private com.google.common.base.Optional<Trees.Expression>	condition
private Trees.ValueDeclaration	declaration
private Trees.Expression	from

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IterationGenerator(Trees.ValueDeclaration declaration, Trees.Expression from, com.google.common.base.Optional<Trees.Expression> condition)

Method Summary

Modifier and Type	Method	Description
static ImmutableTrees.IterationGenerator.Builder	builder()	Creates a builder for IterationGenerator.
com.google.common.base.Optional<Trees.Expression>	condition()
static ImmutableTrees.IterationGenerator	copyOf(Trees.IterationGenerator instance)	Creates an immutable copy of a Trees.IterationGenerator value.
Trees.ValueDeclaration	declaration()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of IterationGenerator that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableTrees.IterationGenerator another)
Trees.Expression	from()
int	hashCode()	Computes a hash code from attributes: declaration, from, condition.
java.lang.String	toString()	Prints the immutable value IterationGenerator with attribute values.
ImmutableTrees.IterationGenerator	withCondition(com.google.common.base.Optional<? extends Trees.Expression> optional)	Copy the current immutable object by setting an optional value for the condition attribute.
ImmutableTrees.IterationGenerator	withCondition(Trees.Expression value)	Copy the current immutable object by setting a present value for the optional condition attribute.
ImmutableTrees.IterationGenerator	withDeclaration(Trees.ValueDeclaration value)	Copy the current immutable object by setting a value for the declaration attribute.
ImmutableTrees.IterationGenerator	withFrom(Trees.Expression value)	Copy the current immutable object by setting a value for the from attribute.

Methods inherited from class java.lang.Object

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

Field Detail

declaration

private final Trees.ValueDeclaration declaration

from

private final Trees.Expression from

condition

private final com.google.common.base.Optional<Trees.Expression> condition

Constructor Detail

IterationGenerator

private IterationGenerator(Trees.ValueDeclaration declaration,
                           Trees.Expression from,
                           com.google.common.base.Optional<Trees.Expression> condition)

Method Detail

declaration

public Trees.ValueDeclaration declaration()

Specified by:

declaration in interface Trees.GeneratorValueDeclaration

Returns:

The value of the declaration attribute

from

public Trees.Expression from()

Specified by:

from in interface Trees.GeneratorValueDeclaration

Returns:

The value of the from attribute

condition

public com.google.common.base.Optional<Trees.Expression> condition()

Specified by:

condition in interface Trees.IterationGenerator

Returns:

The value of the condition attribute

withDeclaration

public final ImmutableTrees.IterationGenerator withDeclaration(Trees.ValueDeclaration value)

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

Parameters:

value - A new value for declaration

Returns:

A modified copy of the this object

withFrom

public final ImmutableTrees.IterationGenerator withFrom(Trees.Expression value)

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

Parameters:

value - A new value for from

Returns:

A modified copy of the this object

withCondition

public final ImmutableTrees.IterationGenerator withCondition(Trees.Expression value)

Copy the current immutable object by setting a present value for the optional condition attribute.

Parameters:

value - The value for condition

Returns:

A modified copy of this object

withCondition

public final ImmutableTrees.IterationGenerator withCondition(com.google.common.base.Optional<? extends Trees.Expression> optional)

Copy the current immutable object by setting an optional value for the condition attribute. A shallow reference equality check on the optional value is used to prevent copying of the same value by returning this.

Parameters:

optional - A value for condition

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      java.lang.Object another)

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

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

equalTo

private boolean equalTo(int synthetic,
                        ImmutableTrees.IterationGenerator another)

hashCode

public int hashCode()

Computes a hash code from attributes: declaration, from, condition.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value IterationGenerator with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

public static ImmutableTrees.IterationGenerator copyOf(Trees.IterationGenerator instance)

Creates an immutable copy of a Trees.IterationGenerator 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 IterationGenerator instance

builder

public static ImmutableTrees.IterationGenerator.Builder builder()

Creates a builder for IterationGenerator.

 ImmutableTrees.IterationGenerator.builder()
    .declaration(org.immutables.generator.processor.Trees.ValueDeclaration) // required declaration
    .from(org.immutables.generator.processor.Trees.Expression) // required from
    .condition(org.immutables.generator.processor.Trees.Expression) // optional condition
    .build();
 

Returns:

A new IterationGenerator builder