Package io.thestencil.client.api

Class ImmutablePageMutator

java.lang.Object

io.thestencil.client.api.ImmutablePageMutator

All Implemented Interfaces:

UpdateBuilder.PageMutator

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

Immutable implementation of UpdateBuilder.PageMutator.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutablePageMutator.Builder	builder()	Creates a builder for ImmutablePageMutator.
static ImmutablePageMutator	copyOf(UpdateBuilder.PageMutator instance)	Creates an immutable copy of a UpdateBuilder.PageMutator value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutablePageMutator that have equal attribute values.
String	getContent()
String	getLocale()
String	getPageId()
int	hashCode()	Computes a hash code from attributes: pageId, content, locale.
String	toString()	Prints the immutable value PageMutator with attribute values.
ImmutablePageMutator	withContent(String value)	Copy the current immutable object by setting a value for the content attribute.
ImmutablePageMutator	withLocale(String value)	Copy the current immutable object by setting a value for the locale attribute.
ImmutablePageMutator	withPageId(String value)	Copy the current immutable object by setting a value for the pageId attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getPageId

public String getPageId()

Specified by:

getPageId in interface UpdateBuilder.PageMutator

Returns:

The value of the pageId attribute

getContent

public String getContent()

Specified by:

getContent in interface UpdateBuilder.PageMutator

Returns:

The value of the content attribute

getLocale

public String getLocale()

Specified by:

getLocale in interface UpdateBuilder.PageMutator

Returns:

The value of the locale attribute

withPageId

public final ImmutablePageMutator withPageId(String value)

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

Parameters:

value - A new value for pageId

Returns:

A modified copy of the this object

withContent

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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutablePageMutator 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: pageId, content, locale.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PageMutator with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePageMutator copyOf(UpdateBuilder.PageMutator instance)

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

builder

public static ImmutablePageMutator.Builder builder()

Creates a builder for ImmutablePageMutator.

 ImmutablePageMutator.builder()
    .pageId(String) // required pageId
    .content(String) // required content
    .locale(String) // required locale
    .build();
 

Returns:

A new ImmutablePageMutator builder