Package org.immutables.generator.processor

Class ImmutableTrees.InvokableDeclaration

java.lang.Object

org.immutables.generator.processor.ImmutableTrees.InvokableDeclaration

All Implemented Interfaces:

Trees.InvokableDeclaration, Trees.Named

Enclosing class:

ImmutableTrees

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

Immutable implementation of Trees.InvokableDeclaration.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private Trees.Identifier	name
private com.google.common.collect.ImmutableList<Trees.Parameter>	parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InvokableDeclaration(Trees.Identifier name, com.google.common.collect.ImmutableList<Trees.Parameter> parameters)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private final Trees.Identifier name

parameters

private final com.google.common.collect.ImmutableList<Trees.Parameter> parameters

Constructor Detail

InvokableDeclaration

private InvokableDeclaration(Trees.Identifier name,
                             com.google.common.collect.ImmutableList<Trees.Parameter> parameters)

Method Detail

name

public Trees.Identifier name()

Specified by:

name in interface Trees.Named

Returns:

The value of the name attribute

parameters

public com.google.common.collect.ImmutableList<Trees.Parameter> parameters()

Specified by:

parameters in interface Trees.InvokableDeclaration

Returns:

The value of the parameters attribute

withName

public final ImmutableTrees.InvokableDeclaration 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

withParameters

public final ImmutableTrees.InvokableDeclaration withParameters(Trees.Parameter... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withParameters

public final ImmutableTrees.InvokableDeclaration withParameters(java.lang.Iterable<? extends Trees.Parameter> elements)

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

Parameters:

elements - An iterable of parameters elements to set

Returns:

A modified copy of this object

equals

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

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

hashCode

public int hashCode()

Computes a hash code from attributes: name, parameters.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value InvokableDeclaration with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

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

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

builder

public static ImmutableTrees.InvokableDeclaration.Builder builder()

Creates a builder for InvokableDeclaration.

 ImmutableTrees.InvokableDeclaration.builder()
    .name(org.immutables.generator.processor.Trees.Identifier) // required name
    .addParameters|addAllParameters(org.immutables.generator.processor.Trees.Parameter) // parameters elements
    .build();
 

Returns:

A new InvokableDeclaration builder