Package org.immutables.generator.processor

Class ImmutableTrees.TypeDeclaration

java.lang.Object

org.immutables.generator.processor.Trees.TypeDeclaration

org.immutables.generator.processor.ImmutableTrees.TypeDeclaration

All Implemented Interfaces:

Trees.TypeReference

Enclosing class:

ImmutableTrees

@Immutable
public static final class ImmutableTrees.TypeDeclaration
extends Trees.TypeDeclaration

Immutable implementation of Trees.TypeDeclaration.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.immutables.generator.processor.Trees.TypeDeclaration

Trees.TypeDeclaration.Kind

Field Summary

Fields

Modifier and Type	Field	Description
private Trees.TypeDeclaration.Kind	kind
private Trees.TypeIdentifier	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TypeDeclaration(ImmutableTrees.TypeDeclaration.Builder builder)
private	TypeDeclaration(Trees.TypeIdentifier type, Trees.TypeDeclaration.Kind kind)

Method Summary

Modifier and Type	Method	Description
static ImmutableTrees.TypeDeclaration.Builder	builder()	Creates a builder for TypeDeclaration.
static ImmutableTrees.TypeDeclaration	copyOf(Trees.TypeDeclaration instance)	Creates an immutable copy of a Trees.TypeDeclaration value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of TypeDeclaration that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableTrees.TypeDeclaration another)
int	hashCode()	Computes a hash code from attributes: type, kind.
Trees.TypeDeclaration.Kind	kind()
java.lang.String	toString()	Prints the immutable value TypeDeclaration with attribute values.
Trees.TypeIdentifier	type()
ImmutableTrees.TypeDeclaration	withKind(Trees.TypeDeclaration.Kind value)	Copy the current immutable object by setting a value for the kind attribute.
ImmutableTrees.TypeDeclaration	withType(Trees.TypeIdentifier value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Field Detail

type

private final Trees.TypeIdentifier type

kind

private final Trees.TypeDeclaration.Kind kind

Constructor Detail

TypeDeclaration

private TypeDeclaration(ImmutableTrees.TypeDeclaration.Builder builder)

TypeDeclaration

private TypeDeclaration(Trees.TypeIdentifier type,
                        Trees.TypeDeclaration.Kind kind)

Method Detail

type

public Trees.TypeIdentifier type()

Specified by:

type in class Trees.TypeDeclaration

Returns:

The value of the type attribute

kind

public Trees.TypeDeclaration.Kind kind()

Overrides:

kind in class Trees.TypeDeclaration

Returns:

The value of the kind attribute

withType

public final ImmutableTrees.TypeDeclaration withType(Trees.TypeIdentifier value)

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

withKind

public final ImmutableTrees.TypeDeclaration withKind(Trees.TypeDeclaration.Kind value)

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

Parameters:

value - A new value for kind

Returns:

A modified copy of the this object

equals

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

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

hashCode

public int hashCode()

Computes a hash code from attributes: type, kind.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value TypeDeclaration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableTrees.TypeDeclaration.Builder builder()

Creates a builder for TypeDeclaration.

 ImmutableTrees.TypeDeclaration.builder()
    .type(org.immutables.generator.processor.Trees.TypeIdentifier) // required type
    .kind(org.immutables.generator.processor.Trees.TypeDeclaration.Kind) // optional kind
    .build();
 

Returns:

A new TypeDeclaration builder