Package io.thestencil.client.api

Class ImmutableEntity<T extends StencilClient.EntityBody>

java.lang.Object

io.thestencil.client.api.ImmutableEntity<T>

All Implemented Interfaces:

StencilClient.Entity<T>, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableEntity<T extends StencilClient.EntityBody>
extends Object
implements StencilClient.Entity<T>

Immutable implementation of StencilClient.Entity.

Use the builder to create immutable instances: ImmutableEntity.builder().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableEntity.Builder<T extends StencilClient.EntityBody>	Builds instances of type ImmutableEntity.

Method Summary

Modifier and Type	Method	Description
static <T extends StencilClient.EntityBody> ImmutableEntity.Builder<T>	builder()	Creates a builder for ImmutableEntity.
static <T extends StencilClient.EntityBody> ImmutableEntity<T>	copyOf(StencilClient.Entity<T> instance)	Creates an immutable copy of a StencilClient.Entity value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableEntity that have equal attribute values.
T	getBody()
String	getId()
StencilClient.EntityType	getType()
int	hashCode()	Computes a hash code from attributes: id, type, body.
String	toString()	Prints the immutable value Entity with attribute values.
ImmutableEntity<T>	withBody(T value)	Copy the current immutable object by setting a value for the body attribute.
ImmutableEntity<T>	withId(String value)	Copy the current immutable object by setting a value for the id attribute.
ImmutableEntity<T>	withType(StencilClient.EntityType value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Specified by:

getId in interface StencilClient.Entity<T extends StencilClient.EntityBody>

Returns:

The value of the id attribute

getType

public StencilClient.EntityType getType()

Specified by:

getType in interface StencilClient.Entity<T extends StencilClient.EntityBody>

Returns:

The value of the type attribute

getBody

public T getBody()

Specified by:

getBody in interface StencilClient.Entity<T extends StencilClient.EntityBody>

Returns:

The value of the body attribute

withId

public final ImmutableEntity<T> withId(String value)

Copy the current immutable object by setting a value for the id attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for id

Returns:

A modified copy of the this object

withType

public final ImmutableEntity<T> withType(StencilClient.EntityType value)

Copy the current immutable object by setting a value for the type attribute. A value 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

withBody

public final ImmutableEntity<T> withBody(T value)

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

Parameters:

value - A new value for body

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableEntity 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: id, type, body.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Entity with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <T extends StencilClient.EntityBody> ImmutableEntity<T> copyOf(StencilClient.Entity<T> instance)

Creates an immutable copy of a StencilClient.Entity 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:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable Entity instance

builder

public static <T extends StencilClient.EntityBody> ImmutableEntity.Builder<T> builder()

Creates a builder for ImmutableEntity.

 ImmutableEntity.<T>builder()
    .id(String) // required id
    .type(io.thestencil.client.api.StencilClient.EntityType) // required type
    .body(T) // required body
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableEntity builder