Package io.dialob.client.api

Class ImmutableComposerState.Builder

java.lang.Object

io.dialob.client.api.ImmutableComposerState.Builder

Enclosing class:

ImmutableComposerState

@NotThreadSafe
public static final class ImmutableComposerState.Builder
extends Object

Builds instances of type ImmutableComposerState. 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
ImmutableComposerState	build()	Builds a new ImmutableComposerState.
ImmutableComposerState.Builder	forms(Map<String,? extends DialobDocument.FormDocument> entries)	Sets or replaces all mappings from the specified map as entries for the forms map.
ImmutableComposerState.Builder	from(DialobComposer.ComposerState instance)	Fill a builder with attribute values from the provided ComposerState instance.
ImmutableComposerState.Builder	putAllForms(Map<String,? extends DialobDocument.FormDocument> entries)	Put all mappings from the specified map as entries to forms map.
ImmutableComposerState.Builder	putAllReleases(Map<String,? extends DialobDocument.FormReleaseDocument> entries)	Put all mappings from the specified map as entries to releases map.
ImmutableComposerState.Builder	putAllRevs(Map<String,? extends DialobDocument.FormRevisionDocument> entries)	Put all mappings from the specified map as entries to revs map.
ImmutableComposerState.Builder	putForms(String key, DialobDocument.FormDocument value)	Put one entry to the forms map.
ImmutableComposerState.Builder	putForms(Map.Entry<String,? extends DialobDocument.FormDocument> entry)	Put one entry to the forms map.
ImmutableComposerState.Builder	putReleases(String key, DialobDocument.FormReleaseDocument value)	Put one entry to the releases map.
ImmutableComposerState.Builder	putReleases(Map.Entry<String,? extends DialobDocument.FormReleaseDocument> entry)	Put one entry to the releases map.
ImmutableComposerState.Builder	putRevs(String key, DialobDocument.FormRevisionDocument value)	Put one entry to the revs map.
ImmutableComposerState.Builder	putRevs(Map.Entry<String,? extends DialobDocument.FormRevisionDocument> entry)	Put one entry to the revs map.
ImmutableComposerState.Builder	releases(Map<String,? extends DialobDocument.FormReleaseDocument> entries)	Sets or replaces all mappings from the specified map as entries for the releases map.
ImmutableComposerState.Builder	revs(Map<String,? extends DialobDocument.FormRevisionDocument> entries)	Sets or replaces all mappings from the specified map as entries for the revs map.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder from(DialobComposer.ComposerState instance)

Fill a builder with attribute values from the provided ComposerState instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

putForms

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putForms(String key,
                                                     DialobDocument.FormDocument value)

Put one entry to the forms map.

Parameters:

key - The key in the forms map

value - The associated value in the forms map

Returns:

this builder for use in a chained invocation

putForms

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putForms(Map.Entry<String,? extends DialobDocument.FormDocument> entry)

Put one entry to the forms map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

forms

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder forms(Map<String,? extends DialobDocument.FormDocument> entries)

Sets or replaces all mappings from the specified map as entries for the forms map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the forms map

Returns:

this builder for use in a chained invocation

putAllForms

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putAllForms(Map<String,? extends DialobDocument.FormDocument> entries)

Put all mappings from the specified map as entries to forms map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the forms map

Returns:

this builder for use in a chained invocation

putRevs

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putRevs(String key,
                                                    DialobDocument.FormRevisionDocument value)

Put one entry to the revs map.

Parameters:

key - The key in the revs map

value - The associated value in the revs map

Returns:

this builder for use in a chained invocation

putRevs

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putRevs(Map.Entry<String,? extends DialobDocument.FormRevisionDocument> entry)

Put one entry to the revs map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

revs

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder revs(Map<String,? extends DialobDocument.FormRevisionDocument> entries)

Sets or replaces all mappings from the specified map as entries for the revs map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the revs map

Returns:

this builder for use in a chained invocation

putAllRevs

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putAllRevs(Map<String,? extends DialobDocument.FormRevisionDocument> entries)

Put all mappings from the specified map as entries to revs map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the revs map

Returns:

this builder for use in a chained invocation

putReleases

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putReleases(String key,
                                                        DialobDocument.FormReleaseDocument value)

Put one entry to the releases map.

Parameters:

key - The key in the releases map

value - The associated value in the releases map

Returns:

this builder for use in a chained invocation

putReleases

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putReleases(Map.Entry<String,? extends DialobDocument.FormReleaseDocument> entry)

Put one entry to the releases map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

releases

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder releases(Map<String,? extends DialobDocument.FormReleaseDocument> entries)

Sets or replaces all mappings from the specified map as entries for the releases map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the releases map

Returns:

this builder for use in a chained invocation

putAllReleases

@CanIgnoreReturnValue
public final ImmutableComposerState.Builder putAllReleases(Map<String,? extends DialobDocument.FormReleaseDocument> entries)

Put all mappings from the specified map as entries to releases map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the releases map

Returns:

this builder for use in a chained invocation

build

public ImmutableComposerState build()

Builds a new ImmutableComposerState.

Returns:

An immutable instance of ComposerState

Throws:

IllegalStateException - if any required attributes are missing