Package io.dialob.client.api

Class ImmutableComposerDocumentState

java.lang.Object

io.dialob.client.api.ImmutableComposerDocumentState

All Implemented Interfaces:

DialobComposer.ComposerDocumentState, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableComposerDocumentState
extends Object
implements DialobComposer.ComposerDocumentState

Immutable implementation of DialobComposer.ComposerDocumentState.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableComposerDocumentState.Builder	Builds instances of type ImmutableComposerDocumentState.

Method Summary

Modifier and Type	Method	Description
static ImmutableComposerDocumentState.Builder	builder()	Creates a builder for ImmutableComposerDocumentState.
static ImmutableComposerDocumentState	copyOf(DialobComposer.ComposerDocumentState instance)	Creates an immutable copy of a DialobComposer.ComposerDocumentState value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableComposerDocumentState that have equal attribute values.
DialobDocument.FormDocument	getForm()
DialobDocument.FormRevisionDocument	getRevision()
int	hashCode()	Computes a hash code from attributes: form, revision.
String	toString()	Prints the immutable value ComposerDocumentState with attribute values.
ImmutableComposerDocumentState	withForm(DialobDocument.FormDocument value)	Copy the current immutable object by setting a value for the form attribute.
ImmutableComposerDocumentState	withRevision(DialobDocument.FormRevisionDocument value)	Copy the current immutable object by setting a value for the revision attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getForm

public DialobDocument.FormDocument getForm()

Specified by:

getForm in interface DialobComposer.ComposerDocumentState

Returns:

The value of the form attribute

getRevision

public DialobDocument.FormRevisionDocument getRevision()

Specified by:

getRevision in interface DialobComposer.ComposerDocumentState

Returns:

The value of the revision attribute

withForm

public final ImmutableComposerDocumentState withForm(DialobDocument.FormDocument value)

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

Parameters:

value - A new value for form

Returns:

A modified copy of the this object

withRevision

public final ImmutableComposerDocumentState withRevision(DialobDocument.FormRevisionDocument value)

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

Parameters:

value - A new value for revision

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableComposerDocumentState 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: form, revision.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ComposerDocumentState with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableComposerDocumentState copyOf(DialobComposer.ComposerDocumentState instance)

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

Parameters:

instance - The instance to copy

Returns:

A copied immutable ComposerDocumentState instance

builder

public static ImmutableComposerDocumentState.Builder builder()

Creates a builder for ImmutableComposerDocumentState.

 ImmutableComposerDocumentState.builder()
    .form(io.dialob.client.api.DialobDocument.FormDocument) // required form
    .revision(io.dialob.client.api.DialobDocument.FormRevisionDocument) // required revision
    .build();
 

Returns:

A new ImmutableComposerDocumentState builder