Package io.dialob.client.api

Class ImmutableFormAndTags

java.lang.Object

io.dialob.client.api.ImmutableFormAndTags

All Implemented Interfaces:

DialobComposer.FormAndTags, Serializable

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

Immutable implementation of DialobComposer.FormAndTags.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableFormAndTags.Builder	builder()	Creates a builder for ImmutableFormAndTags.
static ImmutableFormAndTags	copyOf(DialobComposer.FormAndTags instance)	Creates an immutable copy of a DialobComposer.FormAndTags value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableFormAndTags that have equal attribute values.
io.dialob.api.form.Form	getForm()
com.google.common.collect.ImmutableList<io.dialob.api.form.FormTag>	getTags()
int	hashCode()	Computes a hash code from attributes: form, tags.
String	toString()	Prints the immutable value FormAndTags with attribute values.
ImmutableFormAndTags	withForm(io.dialob.api.form.Form value)	Copy the current immutable object by setting a value for the form attribute.
ImmutableFormAndTags	withTags(io.dialob.api.form.FormTag... elements)	Copy the current immutable object with elements that replace the content of tags.
ImmutableFormAndTags	withTags(Iterable<? extends io.dialob.api.form.FormTag> elements)	Copy the current immutable object with elements that replace the content of tags.

Methods inherited from class java.lang.Object

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

Method Detail

getForm

public io.dialob.api.form.Form getForm()

Specified by:

getForm in interface DialobComposer.FormAndTags

Returns:

The value of the form attribute

getTags

public com.google.common.collect.ImmutableList<io.dialob.api.form.FormTag> getTags()

Specified by:

getTags in interface DialobComposer.FormAndTags

Returns:

The value of the tags attribute

withForm

public final ImmutableFormAndTags withForm(io.dialob.api.form.Form 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

withTags

public final ImmutableFormAndTags withTags(io.dialob.api.form.FormTag... elements)

Copy the current immutable object with elements that replace the content of tags.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTags

public final ImmutableFormAndTags withTags(Iterable<? extends io.dialob.api.form.FormTag> elements)

Copy the current immutable object with elements that replace the content of tags. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of tags elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableFormAndTags 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, tags.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FormAndTags with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableFormAndTags copyOf(DialobComposer.FormAndTags instance)

Creates an immutable copy of a DialobComposer.FormAndTags 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 FormAndTags instance

builder

public static ImmutableFormAndTags.Builder builder()

Creates a builder for ImmutableFormAndTags.

 ImmutableFormAndTags.builder()
    .form(io.dialob.api.form.Form) // required form
    .addTags|addAllTags(io.dialob.api.form.FormTag) // tags elements
    .build();
 

Returns:

A new ImmutableFormAndTags builder