Package io.dialob.client.api

Class ImmutableFormDocument.Builder

java.lang.Object

io.dialob.client.api.ImmutableFormDocument.Builder

Enclosing class:

ImmutableFormDocument

@NotThreadSafe
public static final class ImmutableFormDocument.Builder
extends Object

Builds instances of type ImmutableFormDocument. 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
ImmutableFormDocument	build()	Builds a new ImmutableFormDocument.
ImmutableFormDocument.Builder	created(LocalDateTime created)	Initializes the value for the created attribute.
ImmutableFormDocument.Builder	data(io.dialob.api.form.Form data)	Initializes the value for the data attribute.
ImmutableFormDocument.Builder	description(String description)	Initializes the value for the description attribute.
ImmutableFormDocument.Builder	from(DialobDocument instance)	Fill a builder with attribute values from the provided io.dialob.client.api.DialobDocument instance.
ImmutableFormDocument.Builder	from(DialobDocument.FormDocument instance)	Fill a builder with attribute values from the provided io.dialob.client.api.DialobDocument.FormDocument instance.
ImmutableFormDocument.Builder	id(String id)	Initializes the value for the id attribute.
ImmutableFormDocument.Builder	name(String name)	Initializes the value for the name attribute.
ImmutableFormDocument.Builder	type(DialobDocument.DocumentType type)	Initializes the value for the type attribute.
ImmutableFormDocument.Builder	updated(LocalDateTime updated)	Initializes the value for the updated attribute.
ImmutableFormDocument.Builder	version(String version)	Initializes the value for the version 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 ImmutableFormDocument.Builder from(DialobDocument.FormDocument instance)

Fill a builder with attribute values from the provided io.dialob.client.api.DialobDocument.FormDocument instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder from(DialobDocument instance)

Fill a builder with attribute values from the provided io.dialob.client.api.DialobDocument instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

id

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder id(@Nullable
                                              String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id (can be null)

Returns:

this builder for use in a chained invocation

version

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder version(@Nullable
                                                   String version)

Initializes the value for the version attribute.

Parameters:

version - The value for version (can be null)

Returns:

this builder for use in a chained invocation

description

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder description(@Nullable
                                                       String description)

Initializes the value for the description attribute.

Parameters:

description - The value for description (can be null)

Returns:

this builder for use in a chained invocation

created

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder created(LocalDateTime created)

Initializes the value for the created attribute.

Parameters:

created - The value for created

Returns:

this builder for use in a chained invocation

data

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder data(io.dialob.api.form.Form data)

Initializes the value for the data attribute.

Parameters:

data - The value for data

Returns:

this builder for use in a chained invocation

updated

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder updated(LocalDateTime updated)

Initializes the value for the updated attribute.

Parameters:

updated - The value for updated

Returns:

this builder for use in a chained invocation

type

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder type(DialobDocument.DocumentType type)

Initializes the value for the type attribute.

If not set, this attribute will have a default value as returned by the initializer of type.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableFormDocument.Builder name(String name)

Initializes the value for the name attribute.

If not set, this attribute will have a default value as returned by the initializer of name.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

build

public ImmutableFormDocument build()

Builds a new ImmutableFormDocument.

Returns:

An immutable instance of FormDocument

Throws:

IllegalStateException - if any required attributes are missing