Package org.immutables.value.processor.encode

Class ImmutableEncodedElement.Param

java.lang.Object

org.immutables.value.processor.encode.EncodedElement.Param

org.immutables.value.processor.encode.ImmutableEncodedElement.Param

Enclosing class:

ImmutableEncodedElement

@Immutable
static final class ImmutableEncodedElement.Param
extends EncodedElement.Param

Immutable implementation of EncodedElement.Param.

Use the static factory method to create immutable instances: ImmutableEncodedElement.Param.of().

Field Summary

Fields

Modifier and Type	Field	Description
private com.google.common.collect.ImmutableList<java.lang.String>	annotations
private java.lang.String	name
private Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Param(java.lang.String name, Type type, java.lang.Iterable<java.lang.String> annotations)
private	Param(ImmutableEncodedElement.Param original, java.lang.String name, Type type, com.google.common.collect.ImmutableList<java.lang.String> annotations)

Method Summary

Modifier and Type	Method	Description
(package private) com.google.common.collect.ImmutableList<java.lang.String>	annotations()
static EncodedElement.Param	copyOf(EncodedElement.Param instance)	Creates an immutable copy of a EncodedElement.Param value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of Param that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableEncodedElement.Param another)
int	hashCode()	Computes a hash code from attributes: name, type, annotations.
(package private) java.lang.String	name()
static EncodedElement.Param	of(java.lang.String name, Type type, java.lang.Iterable<java.lang.String> annotations)	Construct a new immutable Param instance.
static EncodedElement.Param	of(java.lang.String name, Type type, java.util.List<java.lang.String> annotations)	Construct a new immutable Param instance.
(package private) Type	type()
ImmutableEncodedElement.Param	withAnnotations(java.lang.Iterable<java.lang.String> elements)	Copy the current immutable object with elements that replace the content of annotations.
ImmutableEncodedElement.Param	withAnnotations(java.lang.String... elements)	Copy the current immutable object with elements that replace the content of annotations.
ImmutableEncodedElement.Param	withName(java.lang.String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableEncodedElement.Param	withType(Type value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class org.immutables.value.processor.encode.EncodedElement.Param

from, of, toString

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

type

private final Type type

annotations

private final com.google.common.collect.ImmutableList<java.lang.String> annotations

Constructor Detail

Param

private Param(java.lang.String name,
              Type type,
              java.lang.Iterable<java.lang.String> annotations)

Param

private Param(ImmutableEncodedElement.Param original,
              java.lang.String name,
              Type type,
              com.google.common.collect.ImmutableList<java.lang.String> annotations)

Method Detail

name

java.lang.String name()

Specified by:

name in class EncodedElement.Param

Returns:

The value of the name attribute

type

Type type()

Specified by:

type in class EncodedElement.Param

Returns:

The value of the type attribute

annotations

com.google.common.collect.ImmutableList<java.lang.String> annotations()

Specified by:

annotations in class EncodedElement.Param

Returns:

The value of the annotations attribute

withName

public final ImmutableEncodedElement.Param withName(java.lang.String value)

Copy the current immutable object by setting a value for the name attribute. An equals check 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 ImmutableEncodedElement.Param withType(Type 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

withAnnotations

public final ImmutableEncodedElement.Param withAnnotations(java.lang.String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withAnnotations

public final ImmutableEncodedElement.Param withAnnotations(java.lang.Iterable<java.lang.String> elements)

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

Parameters:

elements - An iterable of annotations 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 Param 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,
                        ImmutableEncodedElement.Param another)

hashCode

public int hashCode()

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

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

of

public static EncodedElement.Param of(java.lang.String name,
                                      Type type,
                                      java.util.List<java.lang.String> annotations)

Construct a new immutable Param instance.

Parameters:

name - The value for the name attribute

type - The value for the type attribute

annotations - The value for the annotations attribute

Returns:

An immutable Param instance

of

public static EncodedElement.Param of(java.lang.String name,
                                      Type type,
                                      java.lang.Iterable<java.lang.String> annotations)

Construct a new immutable Param instance.

Parameters:

name - The value for the name attribute

type - The value for the type attribute

annotations - The value for the annotations attribute

Returns:

An immutable Param instance

copyOf

public static EncodedElement.Param copyOf(EncodedElement.Param instance)

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