Package io.thestencil.client.api

Class ImmutableWorkflow

java.lang.Object

io.thestencil.client.api.ImmutableWorkflow

All Implemented Interfaces:

StencilClient.EntityBody, StencilClient.Workflow, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableWorkflow
extends Object
implements StencilClient.Workflow

Immutable implementation of StencilClient.Workflow.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableWorkflow.Builder	builder()	Creates a builder for ImmutableWorkflow.
static ImmutableWorkflow	copyOf(StencilClient.Workflow instance)	Creates an immutable copy of a StencilClient.Workflow value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableWorkflow that have equal attribute values.
com.google.common.collect.ImmutableList<String>	getArticles()
Boolean	getDevMode()
com.google.common.collect.ImmutableList<StencilClient.LocaleLabel>	getLabels()
String	getValue()
int	hashCode()	Computes a hash code from attributes: value, devMode, articles, labels.
String	toString()	Prints the immutable value Workflow with attribute values.
ImmutableWorkflow	withArticles(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableWorkflow	withArticles(String... elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableWorkflow	withDevMode(Boolean value)	Copy the current immutable object by setting a value for the devMode attribute.
ImmutableWorkflow	withLabels(StencilClient.LocaleLabel... elements)	Copy the current immutable object with elements that replace the content of labels.
ImmutableWorkflow	withLabels(Iterable<? extends StencilClient.LocaleLabel> elements)	Copy the current immutable object with elements that replace the content of labels.
ImmutableWorkflow	withValue(String value)	Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public String getValue()

Specified by:

getValue in interface StencilClient.Workflow

Returns:

The value of the value attribute

getDevMode

@Nullable
public Boolean getDevMode()

Specified by:

getDevMode in interface StencilClient.Workflow

Returns:

The value of the devMode attribute

getArticles

public com.google.common.collect.ImmutableList<String> getArticles()

Specified by:

getArticles in interface StencilClient.Workflow

Returns:

The value of the articles attribute

getLabels

public com.google.common.collect.ImmutableList<StencilClient.LocaleLabel> getLabels()

Specified by:

getLabels in interface StencilClient.Workflow

Returns:

The value of the labels attribute

withValue

public final ImmutableWorkflow withValue(String value)

Copy the current immutable object by setting a value for the value attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

withDevMode

public final ImmutableWorkflow withDevMode(@Nullable
                                           Boolean value)

Copy the current immutable object by setting a value for the devMode attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for devMode (can be null)

Returns:

A modified copy of the this object

withArticles

public final ImmutableWorkflow withArticles(String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArticles

public final ImmutableWorkflow withArticles(Iterable<String> elements)

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

Parameters:

elements - An iterable of articles elements to set

Returns:

A modified copy of this object

withLabels

public final ImmutableWorkflow withLabels(StencilClient.LocaleLabel... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withLabels

public final ImmutableWorkflow withLabels(Iterable<? extends StencilClient.LocaleLabel> elements)

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

Parameters:

elements - An iterable of labels 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 ImmutableWorkflow 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: value, devMode, articles, labels.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Workflow with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableWorkflow copyOf(StencilClient.Workflow instance)

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

builder

public static ImmutableWorkflow.Builder builder()

Creates a builder for ImmutableWorkflow.

 ImmutableWorkflow.builder()
    .value(String) // required value
    .devMode(Boolean | null) // nullable devMode
    .addArticles|addAllArticles(String) // articles elements
    .addLabels|addAllLabels(io.thestencil.client.api.StencilClient.LocaleLabel) // labels elements
    .build();
 

Returns:

A new ImmutableWorkflow builder