Package org.immutables.generator.processor

Class ImmutableTrees.ValueDeclaration

java.lang.Object

org.immutables.generator.processor.ImmutableTrees.ValueDeclaration

All Implemented Interfaces:

Trees.Named, Trees.ValueDeclaration

Enclosing class:

ImmutableTrees

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

Immutable implementation of Trees.ValueDeclaration.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private com.google.common.base.Optional<Trees.TypeReference>	containedType
private Trees.Identifier	name
private com.google.common.base.Optional<Trees.TypeReference>	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ValueDeclaration(Trees.Identifier name, com.google.common.base.Optional<Trees.TypeReference> type, com.google.common.base.Optional<Trees.TypeReference> containedType)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private final Trees.Identifier name

type

private final com.google.common.base.Optional<Trees.TypeReference> type

containedType

private final com.google.common.base.Optional<Trees.TypeReference> containedType

Constructor Detail

ValueDeclaration

private ValueDeclaration(Trees.Identifier name,
                         com.google.common.base.Optional<Trees.TypeReference> type,
                         com.google.common.base.Optional<Trees.TypeReference> containedType)

Method Detail

name

public Trees.Identifier name()

Specified by:

name in interface Trees.Named

Returns:

The value of the name attribute

type

public com.google.common.base.Optional<Trees.TypeReference> type()

Specified by:

type in interface Trees.ValueDeclaration

Returns:

The value of the type attribute

containedType

public com.google.common.base.Optional<Trees.TypeReference> containedType()

Specified by:

containedType in interface Trees.ValueDeclaration

Returns:

The value of the containedType attribute

withName

public final ImmutableTrees.ValueDeclaration withName(Trees.Identifier value)

Copy the current immutable object by setting a value for the name attribute. A shallow reference equality check is 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

withType

public final ImmutableTrees.ValueDeclaration withType(Trees.TypeReference value)

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

Specified by:

withType in interface Trees.ValueDeclaration

Parameters:

value - The value for type

Returns:

A modified copy of this object

withType

public final ImmutableTrees.ValueDeclaration withType(com.google.common.base.Optional<? extends Trees.TypeReference> optional)

Copy the current immutable object by setting an optional value for the type 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 type

Returns:

A modified copy of this object

withContainedType

public final ImmutableTrees.ValueDeclaration withContainedType(Trees.TypeReference value)

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

Specified by:

withContainedType in interface Trees.ValueDeclaration

Parameters:

value - The value for containedType

Returns:

A modified copy of this object

withContainedType

public final ImmutableTrees.ValueDeclaration withContainedType(com.google.common.base.Optional<? extends Trees.TypeReference> optional)

Copy the current immutable object by setting an optional value for the containedType 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 containedType

Returns:

A modified copy of this object

equals

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

This instance is equal to all instances of ValueDeclaration 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.ValueDeclaration another)

hashCode

public int hashCode()

Computes a hash code from attributes: name, type, containedType.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value ValueDeclaration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableTrees.ValueDeclaration.Builder builder()

Creates a builder for ValueDeclaration.

 ImmutableTrees.ValueDeclaration.builder()
    .name(org.immutables.generator.processor.Trees.Identifier) // required name
    .type(org.immutables.generator.processor.Trees.TypeReference) // optional type
    .containedType(org.immutables.generator.processor.Trees.TypeReference) // optional containedType
    .build();
 

Returns:

A new ValueDeclaration builder