Package org.immutables.value.processor.meta

Class ImmutableValueImmutableInfo

java.lang.Object

org.immutables.value.processor.meta.ValueImmutableInfo

org.immutables.value.processor.meta.ImmutableValueImmutableInfo

All Implemented Interfaces:

java.lang.annotation.Annotation

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableValueImmutableInfo
extends ValueImmutableInfo

Immutable implementation of ValueImmutableInfo.

Use the builder to create immutable instances: ImmutableValueImmutableInfo.theBuilder(). Use the static factory method to create immutable instances: ImmutableValueImmutableInfo.theOf().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableValueImmutableInfo.Builder	Builds instances of type ImmutableValueImmutableInfo.
private static class	ImmutableValueImmutableInfo.InternerHolder
private static class	ImmutableValueImmutableInfo.InternProxy

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	builder
private boolean	copy
private boolean	intern
private boolean	isDefault
private boolean	lazyhash
private boolean	prehash
private boolean	singleton

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableValueImmutableInfo(boolean builder, boolean copy, boolean intern, boolean prehash, boolean lazyhash, boolean singleton)
private	ImmutableValueImmutableInfo(boolean isDefault, boolean builder, boolean copy, boolean intern, boolean prehash, boolean lazyhash, boolean singleton)
private	ImmutableValueImmutableInfo(ImmutableValueImmutableInfo.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	builder()
boolean	copy()
boolean	equals(java.lang.Object another)	This instance is equal to all instances of ImmutableValueImmutableInfo that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableValueImmutableInfo another)
int	hashCode()	Computes a hash code from attributes: isDefault, builder, copy, intern, prehash, lazyhash, singleton.
boolean	intern()
boolean	isDefault()
boolean	lazyhash()
boolean	prehash()
boolean	singleton()
static ImmutableValueImmutableInfo.Builder	theBuilder()	Creates a builder for ImmutableValueImmutableInfo.
static ImmutableValueImmutableInfo	theCopyOf(ValueImmutableInfo instance)	Creates an immutable copy of a ValueImmutableInfo value.
static ImmutableValueImmutableInfo	theOf(boolean builder, boolean copy, boolean intern, boolean prehash, boolean lazyhash, boolean singleton)	Construct a new immutable ValueImmutableInfo instance.
java.lang.String	toString()	Prints the immutable value ValueImmutableInfo with attribute values.
private static ImmutableValueImmutableInfo	validate(ImmutableValueImmutableInfo instance)
ImmutableValueImmutableInfo	withBuilder(boolean value)	Copy the current immutable object by setting a value for the builder attribute.
ImmutableValueImmutableInfo	withCopy(boolean value)	Copy the current immutable object by setting a value for the copy attribute.
ImmutableValueImmutableInfo	withIntern(boolean value)	Copy the current immutable object by setting a value for the intern attribute.
ImmutableValueImmutableInfo	withIsDefault(boolean value)	Copy the current immutable object by setting a value for the isDefault attribute.
ImmutableValueImmutableInfo	withLazyhash(boolean value)	Copy the current immutable object by setting a value for the lazyhash attribute.
ImmutableValueImmutableInfo	withPrehash(boolean value)	Copy the current immutable object by setting a value for the prehash attribute.
ImmutableValueImmutableInfo	withSingleton(boolean value)	Copy the current immutable object by setting a value for the singleton attribute.

Methods inherited from class org.immutables.value.processor.meta.ValueImmutableInfo

annotationType, infoFrom

Methods inherited from class java.lang.Object

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

Field Detail

isDefault

private final boolean isDefault

builder

private final boolean builder

copy

private final boolean copy

intern

private final boolean intern

prehash

private final boolean prehash

lazyhash

private final boolean lazyhash

singleton

private final boolean singleton

Constructor Detail

ImmutableValueImmutableInfo

private ImmutableValueImmutableInfo(boolean builder,
                                    boolean copy,
                                    boolean intern,
                                    boolean prehash,
                                    boolean lazyhash,
                                    boolean singleton)

ImmutableValueImmutableInfo

private ImmutableValueImmutableInfo(ImmutableValueImmutableInfo.Builder builder)

ImmutableValueImmutableInfo

private ImmutableValueImmutableInfo(boolean isDefault,
                                    boolean builder,
                                    boolean copy,
                                    boolean intern,
                                    boolean prehash,
                                    boolean lazyhash,
                                    boolean singleton)

Method Detail

isDefault

public boolean isDefault()

Overrides:

isDefault in class ValueImmutableInfo

Returns:

The value of the isDefault attribute

builder

public boolean builder()

Specified by:

builder in class ValueImmutableInfo

Returns:

The value of the builder attribute

copy

public boolean copy()

Specified by:

copy in class ValueImmutableInfo

Returns:

The value of the copy attribute

intern

public boolean intern()

Specified by:

intern in class ValueImmutableInfo

Returns:

The value of the intern attribute

prehash

public boolean prehash()

Specified by:

prehash in class ValueImmutableInfo

Returns:

The value of the prehash attribute

lazyhash

public boolean lazyhash()

Specified by:

lazyhash in class ValueImmutableInfo

Returns:

The value of the lazyhash attribute

singleton

public boolean singleton()

Specified by:

singleton in class ValueImmutableInfo

Returns:

The value of the singleton attribute

withIsDefault

public final ImmutableValueImmutableInfo withIsDefault(boolean value)

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

Parameters:

value - A new value for isDefault

Returns:

A modified copy of the this object

withBuilder

public final ImmutableValueImmutableInfo withBuilder(boolean value)

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

Parameters:

value - A new value for builder

Returns:

A modified copy of the this object

withCopy

public final ImmutableValueImmutableInfo withCopy(boolean value)

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

Parameters:

value - A new value for copy

Returns:

A modified copy of the this object

withIntern

public final ImmutableValueImmutableInfo withIntern(boolean value)

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

Parameters:

value - A new value for intern

Returns:

A modified copy of the this object

withPrehash

public final ImmutableValueImmutableInfo withPrehash(boolean value)

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

Parameters:

value - A new value for prehash

Returns:

A modified copy of the this object

withLazyhash

public final ImmutableValueImmutableInfo withLazyhash(boolean value)

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

Parameters:

value - A new value for lazyhash

Returns:

A modified copy of the this object

withSingleton

public final ImmutableValueImmutableInfo withSingleton(boolean value)

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

Parameters:

value - A new value for singleton

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 ImmutableValueImmutableInfo that have equal attribute values. As instances of the ImmutableValueImmutableInfo class are interned, the equals method is implemented as an efficient reference equality check.

Specified by:

equals in interface java.lang.annotation.Annotation

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

equalTo

private boolean equalTo(int synthetic,
                        ImmutableValueImmutableInfo another)

hashCode

public int hashCode()

Computes a hash code from attributes: isDefault, builder, copy, intern, prehash, lazyhash, singleton.

Specified by:

hashCode in interface java.lang.annotation.Annotation

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value ValueImmutableInfo with attribute values.

Specified by:

toString in interface java.lang.annotation.Annotation

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

theOf

public static ImmutableValueImmutableInfo theOf(boolean builder,
                                                boolean copy,
                                                boolean intern,
                                                boolean prehash,
                                                boolean lazyhash,
                                                boolean singleton)

Construct a new immutable ValueImmutableInfo instance.

Parameters:

builder - The value for the builder attribute

copy - The value for the copy attribute

intern - The value for the intern attribute

prehash - The value for the prehash attribute

lazyhash - The value for the lazyhash attribute

singleton - The value for the singleton attribute

Returns:

An immutable ValueImmutableInfo instance

validate

private static ImmutableValueImmutableInfo validate(ImmutableValueImmutableInfo instance)

theCopyOf

public static ImmutableValueImmutableInfo theCopyOf(ValueImmutableInfo instance)

Creates an immutable copy of a ValueImmutableInfo 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 ValueImmutableInfo instance

theBuilder

public static ImmutableValueImmutableInfo.Builder theBuilder()

Creates a builder for ImmutableValueImmutableInfo.

 ImmutableValueImmutableInfo.theBuilder()
    .isDefault(boolean) // optional isDefault
    .builder(boolean) // required builder
    .copy(boolean) // required copy
    .intern(boolean) // required intern
    .prehash(boolean) // required prehash
    .lazyhash(boolean) // required lazyhash
    .singleton(boolean) // required singleton
    .build();
 

Returns:

A new ImmutableValueImmutableInfo builder