Package io.thestencil.client.api

Class ImmutableEntity.Builder<T extends StencilClient.EntityBody>

java.lang.Object

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

Enclosing class:

ImmutableEntity<T extends StencilClient.EntityBody>

@NotThreadSafe
public static final class ImmutableEntity.Builder<T extends StencilClient.EntityBody>
extends Object

Builds instances of type ImmutableEntity. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableEntity.Builder<T>	body(T body)	Initializes the value for the body attribute.
ImmutableEntity<T>	build()	Builds a new ImmutableEntity.
ImmutableEntity.Builder<T>	from(StencilClient.Entity<T> instance)	Fill a builder with attribute values from the provided Entity instance.
ImmutableEntity.Builder<T>	id(String id)	Initializes the value for the id attribute.
ImmutableEntity.Builder<T>	type(StencilClient.EntityType type)	Initializes the value for the type attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableEntity.Builder<T> from(StencilClient.Entity<T> instance)

Fill a builder with attribute values from the provided Entity instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

id

@CanIgnoreReturnValue
public final ImmutableEntity.Builder<T> id(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

type

@CanIgnoreReturnValue
public final ImmutableEntity.Builder<T> type(StencilClient.EntityType type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

body

@CanIgnoreReturnValue
public final ImmutableEntity.Builder<T> body(T body)

Initializes the value for the body attribute.

Parameters:

body - The value for body

Returns:

this builder for use in a chained invocation

build

public ImmutableEntity<T> build()

Builds a new ImmutableEntity.

Returns:

An immutable instance of Entity

Throws:

IllegalStateException - if any required attributes are missing