de.flapdoodle.formula.types

Class ImmutableId<O>

java.lang.Object

de.flapdoodle.formula.types.Id<O>

de.flapdoodle.formula.types.ImmutableId<O>

All Implemented Interfaces:

HasHumanReadableLabel

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableId<O>
extends Id<O>

Immutable implementation of Id.

Use the builder to create immutable instances: ImmutableId.builder(). Use the static factory method to create immutable instances: ImmutableId.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableId.Builder<O> Builds instances of type ImmutableId.

Nested classes/interfaces inherited from class de.flapdoodle.formula.types.Id

Id.ClearTypeCounter

Method Summary

Modifier and Type	Method and Description
static <O> ImmutableId.Builder<O>	builder() Creates a builder for ImmutableId.
static <O> ImmutableId<O>	copyOf(Id<O> instance) Creates an immutable copy of a Id value.
protected int	count()
boolean	equals(Object another) This instance is equal to all instances of ImmutableId that have equal attribute values.
int	hashCode() Computes a hash code from attributes: type, count.
static <O> ImmutableId<O>	of(Class<O> type, int count) Construct a new immutable Id instance.
protected Class<O>	type()
ImmutableId<O>	withCount(int value) Copy the current immutable object by setting a value for the count attribute.
ImmutableId<O>	withType(Class<O> value) Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class de.flapdoodle.formula.types.Id

asHumanReadable, asInstance, idFor, toString, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.types.HasHumanReadableLabel

asHumanReadable

Method Detail

type

protected Class<O> type()

Specified by:

type in class Id<O>

Returns:

The value of the type attribute

count

protected int count()

Specified by:

count in class Id<O>

Returns:

The value of the count attribute

withType

public final ImmutableId<O> withType(Class<O> 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

withCount

public final ImmutableId<O> withCount(int value)

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

Parameters:

value - A new value for count

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableId that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: type, count.

Overrides:

hashCode in class Object

Returns:

hashCode value

of

public static <O> ImmutableId<O> of(Class<O> type,
                                    int count)

Construct a new immutable Id instance.

Type Parameters:

O - generic parameter O

Parameters:

type - The value for the type attribute

count - The value for the count attribute

Returns:

An immutable Id instance

copyOf

public static <O> ImmutableId<O> copyOf(Id<O> instance)

Creates an immutable copy of a Id value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

O - generic parameter O

Parameters:

instance - The instance to copy

Returns:

A copied immutable Id instance

builder

public static <O> ImmutableId.Builder<O> builder()

Creates a builder for ImmutableId.

 ImmutableId.<O>builder()
    .type(Class<O>) // required type
    .count(int) // required count
    .build();
 

Type Parameters:

O - generic parameter O

Returns:

A new ImmutableId builder