Package io.thestencil.client.api

Class ImmutableArticleMutator

java.lang.Object

io.thestencil.client.api.ImmutableArticleMutator

All Implemented Interfaces:

UpdateBuilder.ArticleMutator

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableArticleMutator
extends Object
implements UpdateBuilder.ArticleMutator

Immutable implementation of UpdateBuilder.ArticleMutator.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableArticleMutator.Builder	builder()	Creates a builder for ImmutableArticleMutator.
static ImmutableArticleMutator	copyOf(UpdateBuilder.ArticleMutator instance)	Creates an immutable copy of a UpdateBuilder.ArticleMutator value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableArticleMutator that have equal attribute values.
String	getArticleId()
com.google.common.collect.ImmutableList<String>	getLinks()
String	getName()
Integer	getOrder()
String	getParentId()
com.google.common.collect.ImmutableList<String>	getWorkflows()
int	hashCode()	Computes a hash code from attributes: articleId, parentId, name, order, links, workflows.
String	toString()	Prints the immutable value ArticleMutator with attribute values.
ImmutableArticleMutator	withArticleId(String value)	Copy the current immutable object by setting a value for the articleId attribute.
ImmutableArticleMutator	withLinks(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of links.
ImmutableArticleMutator	withLinks(String... elements)	Copy the current immutable object with elements that replace the content of links.
ImmutableArticleMutator	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableArticleMutator	withOrder(Integer value)	Copy the current immutable object by setting a value for the order attribute.
ImmutableArticleMutator	withParentId(String value)	Copy the current immutable object by setting a value for the parentId attribute.
ImmutableArticleMutator	withWorkflows(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of workflows.
ImmutableArticleMutator	withWorkflows(String... elements)	Copy the current immutable object with elements that replace the content of workflows.

Methods inherited from class java.lang.Object

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

Method Detail

getArticleId

public String getArticleId()

Specified by:

getArticleId in interface UpdateBuilder.ArticleMutator

Returns:

The value of the articleId attribute

getParentId

@Nullable
public String getParentId()

Specified by:

getParentId in interface UpdateBuilder.ArticleMutator

Returns:

The value of the parentId attribute

getName

public String getName()

Specified by:

getName in interface UpdateBuilder.ArticleMutator

Returns:

The value of the name attribute

getOrder

public Integer getOrder()

Specified by:

getOrder in interface UpdateBuilder.ArticleMutator

Returns:

The value of the order attribute

getLinks

@Nullable
public com.google.common.collect.ImmutableList<String> getLinks()

Specified by:

getLinks in interface UpdateBuilder.ArticleMutator

Returns:

The value of the links attribute

getWorkflows

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

Specified by:

getWorkflows in interface UpdateBuilder.ArticleMutator

Returns:

The value of the workflows attribute

withArticleId

public final ImmutableArticleMutator withArticleId(String value)

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

Parameters:

value - A new value for articleId

Returns:

A modified copy of the this object

withParentId

public final ImmutableArticleMutator withParentId(@Nullable
                                                  String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withName

public final ImmutableArticleMutator withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withOrder

public final ImmutableArticleMutator withOrder(Integer value)

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

Parameters:

value - A new value for order

Returns:

A modified copy of the this object

withLinks

public final ImmutableArticleMutator withLinks(@Nullable
                                               String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withLinks

public final ImmutableArticleMutator withLinks(@Nullable
                                               Iterable<String> elements)

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

Parameters:

elements - An iterable of links elements to set

Returns:

A modified copy of this object

withWorkflows

public final ImmutableArticleMutator withWorkflows(String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withWorkflows

public final ImmutableArticleMutator withWorkflows(Iterable<String> elements)

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

Parameters:

elements - An iterable of workflows 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 ImmutableArticleMutator 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: articleId, parentId, name, order, links, workflows.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ArticleMutator with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableArticleMutator copyOf(UpdateBuilder.ArticleMutator instance)

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

builder

public static ImmutableArticleMutator.Builder builder()

Creates a builder for ImmutableArticleMutator.

 ImmutableArticleMutator.builder()
    .articleId(String) // required articleId
    .parentId(String | null) // nullable parentId
    .name(String) // required name
    .order(Integer) // required order
    .links(List<String> | null) // nullable links
    .addWorkflows|addAllWorkflows(String) // workflows elements
    .build();
 

Returns:

A new ImmutableArticleMutator builder