Package io.thestencil.client.api

Class ImmutablePage

java.lang.Object

io.thestencil.client.api.ImmutablePage

All Implemented Interfaces:

StencilClient.EntityBody, StencilClient.Page, Serializable

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

Immutable implementation of StencilClient.Page.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getArticle

public String getArticle()

Specified by:

getArticle in interface StencilClient.Page

Returns:

The value of the article attribute

getLocale

public String getLocale()

Specified by:

getLocale in interface StencilClient.Page

Returns:

The value of the locale attribute

getContent

public String getContent()

Specified by:

getContent in interface StencilClient.Page

Returns:

The value of the content attribute

withArticle

public final ImmutablePage withArticle(String value)

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

Parameters:

value - A new value for article

Returns:

A modified copy of the this object

withLocale

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

withContent

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

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Page with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePage copyOf(StencilClient.Page instance)

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

builder

public static ImmutablePage.Builder builder()

Creates a builder for ImmutablePage.

 ImmutablePage.builder()
    .article(String) // required article
    .locale(String) // required locale
    .content(String) // required content
    .build();
 

Returns:

A new ImmutablePage builder