Package io.thestencil.persistence.api

Class ImmutableLinkMutator

java.lang.Object

io.thestencil.persistence.api.ImmutableLinkMutator

All Implemented Interfaces:

UpdateBuilder.LinkMutator

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

Immutable implementation of UpdateBuilder.LinkMutator.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableLinkMutator.Builder	builder()	Creates a builder for ImmutableLinkMutator.
static ImmutableLinkMutator	copyOf(UpdateBuilder.LinkMutator instance)	Creates an immutable copy of a UpdateBuilder.LinkMutator value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableLinkMutator that have equal attribute values.
com.google.common.collect.ImmutableList<String>	getArticles()
String	getContent()
String	getDescription()
String	getLinkId()
String	getLocale()
String	getType()
int	hashCode()	Computes a hash code from attributes: linkId, content, locale, description, type, articles.
String	toString()	Prints the immutable value LinkMutator with attribute values.
ImmutableLinkMutator	withArticles(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableLinkMutator	withArticles(String... elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableLinkMutator	withContent(String value)	Copy the current immutable object by setting a value for the content attribute.
ImmutableLinkMutator	withDescription(String value)	Copy the current immutable object by setting a value for the description attribute.
ImmutableLinkMutator	withLinkId(String value)	Copy the current immutable object by setting a value for the linkId attribute.
ImmutableLinkMutator	withLocale(String value)	Copy the current immutable object by setting a value for the locale attribute.
ImmutableLinkMutator	withType(String value)	Copy the current immutable object by setting a value for the type attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getLinkId

public String getLinkId()

Specified by:

getLinkId in interface UpdateBuilder.LinkMutator

Returns:

The value of the linkId attribute

getContent

public String getContent()

Specified by:

getContent in interface UpdateBuilder.LinkMutator

Returns:

The value of the content attribute

getLocale

public String getLocale()

Specified by:

getLocale in interface UpdateBuilder.LinkMutator

Returns:

The value of the locale attribute

getDescription

public String getDescription()

Specified by:

getDescription in interface UpdateBuilder.LinkMutator

Returns:

The value of the description attribute

getType

public String getType()

Specified by:

getType in interface UpdateBuilder.LinkMutator

Returns:

The value of the type attribute

getArticles

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

Specified by:

getArticles in interface UpdateBuilder.LinkMutator

Returns:

The value of the articles attribute

withLinkId

public final ImmutableLinkMutator withLinkId(String value)

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

Parameters:

value - A new value for linkId

Returns:

A modified copy of the this object

withContent

public final ImmutableLinkMutator withContent(String value)

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

Parameters:

value - A new value for content

Returns:

A modified copy of the this object

withLocale

public final ImmutableLinkMutator withLocale(String value)

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

Parameters:

value - A new value for locale

Returns:

A modified copy of the this object

withDescription

public final ImmutableLinkMutator withDescription(String value)

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

Parameters:

value - A new value for description

Returns:

A modified copy of the this object

withType

public final ImmutableLinkMutator withType(String value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

withArticles

public final ImmutableLinkMutator 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 ImmutableLinkMutator 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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableLinkMutator 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: linkId, content, locale, description, type, articles.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value LinkMutator with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableLinkMutator copyOf(UpdateBuilder.LinkMutator instance)

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

builder

public static ImmutableLinkMutator.Builder builder()

Creates a builder for ImmutableLinkMutator.

 ImmutableLinkMutator.builder()
    .linkId(String) // required linkId
    .content(String) // required content
    .locale(String) // required locale
    .description(String) // required description
    .type(String) // required type
    .addArticles|addAllArticles(String) // articles elements
    .build();
 

Returns:

A new ImmutableLinkMutator builder