Package org.immutables.generator.processor

Class ImmutableTrees.Template

java.lang.Object

org.immutables.generator.processor.Trees.Template

org.immutables.generator.processor.ImmutableTrees.Template

All Implemented Interfaces:

Trees.Block, Trees.Directive, Trees.InvokableStatement, Trees.TemplatePart, Trees.UnitPart

Enclosing class:

ImmutableTrees

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

Immutable implementation of Trees.Template.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private Trees.InvokableDeclaration	declaration
private boolean	isPublic
private com.google.common.collect.ImmutableList<Trees.TemplatePart>	parts

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Template(com.google.common.collect.ImmutableList<Trees.TemplatePart> parts, Trees.InvokableDeclaration declaration, boolean isPublic)
private	Template(ImmutableTrees.Template.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ImmutableTrees.Template.Builder	builder()	Creates a builder for Template.
static ImmutableTrees.Template	copyOf(Trees.Template instance)	Creates an immutable copy of a Trees.Template value.
Trees.InvokableDeclaration	declaration()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of Template that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableTrees.Template another)
int	hashCode()	Computes a hash code from attributes: parts, declaration, isPublic.
boolean	isPublic()
com.google.common.collect.ImmutableList<Trees.TemplatePart>	parts()
java.lang.String	toString()	Prints the immutable value Template with attribute values.
ImmutableTrees.Template	withDeclaration(Trees.InvokableDeclaration value)	Copy the current immutable object by setting a value for the declaration attribute.
ImmutableTrees.Template	withIsPublic(boolean value)	Copy the current immutable object by setting a value for the isPublic attribute.
ImmutableTrees.Template	withParts(java.lang.Iterable<? extends Trees.TemplatePart> elements)	Copy the current immutable object with elements that replace the content of parts.
ImmutableTrees.Template	withParts(Trees.TemplatePart... elements)	Copy the current immutable object with elements that replace the content of parts.

Methods inherited from class java.lang.Object

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

Field Detail

parts

private final com.google.common.collect.ImmutableList<Trees.TemplatePart> parts

declaration

private final Trees.InvokableDeclaration declaration

isPublic

private final boolean isPublic

Constructor Detail

Template

private Template(ImmutableTrees.Template.Builder builder)

Template

private Template(com.google.common.collect.ImmutableList<Trees.TemplatePart> parts,
                 Trees.InvokableDeclaration declaration,
                 boolean isPublic)

Method Detail

parts

public com.google.common.collect.ImmutableList<Trees.TemplatePart> parts()

Returns:

The value of the parts attribute

declaration

public Trees.InvokableDeclaration declaration()

Returns:

The value of the declaration attribute

isPublic

public boolean isPublic()

Overrides:

isPublic in class Trees.Template

Returns:

The value of the isPublic attribute

withParts

public final ImmutableTrees.Template withParts(Trees.TemplatePart... elements)

Copy the current immutable object with elements that replace the content of parts.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withParts

public final ImmutableTrees.Template withParts(java.lang.Iterable<? extends Trees.TemplatePart> elements)

Copy the current immutable object with elements that replace the content of parts. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of parts elements to set

Returns:

A modified copy of this object

withDeclaration

public final ImmutableTrees.Template withDeclaration(Trees.InvokableDeclaration 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

withIsPublic

public final ImmutableTrees.Template withIsPublic(boolean value)

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

Parameters:

value - A new value for isPublic

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 Template 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.Template another)

hashCode

public int hashCode()

Computes a hash code from attributes: parts, declaration, isPublic.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value Template with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableTrees.Template.Builder builder()

Creates a builder for Template.

 ImmutableTrees.Template.builder()
    .addParts|addAllParts(org.immutables.generator.processor.Trees.TemplatePart) // parts elements
    .declaration(org.immutables.generator.processor.Trees.InvokableDeclaration) // required declaration
    .isPublic(boolean) // optional isPublic
    .build();
 

Returns:

A new Template builder