Package io.thestencil.client.api

Class ImmutableArticle

java.lang.Object

io.thestencil.client.api.ImmutableArticle

All Implemented Interfaces:

StencilClient.Article, StencilClient.EntityBody, Serializable

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

Immutable implementation of StencilClient.Article.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableArticle.Builder	builder()	Creates a builder for ImmutableArticle.
static ImmutableArticle	copyOf(StencilClient.Article instance)	Creates an immutable copy of a StencilClient.Article value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableArticle that have equal attribute values.
Boolean	getDevMode()
String	getName()
Integer	getOrder()
String	getParentId()
int	hashCode()	Computes a hash code from attributes: parentId, devMode, name, order.
String	toString()	Prints the immutable value Article with attribute values.
ImmutableArticle	withDevMode(Boolean value)	Copy the current immutable object by setting a value for the devMode attribute.
ImmutableArticle	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableArticle	withOrder(Integer value)	Copy the current immutable object by setting a value for the order attribute.
ImmutableArticle	withParentId(String value)	Copy the current immutable object by setting a value for the parentId attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getParentId

@Nullable
public String getParentId()

Specified by:

getParentId in interface StencilClient.Article

Returns:

The value of the parentId attribute

getDevMode

@Nullable
public Boolean getDevMode()

Specified by:

getDevMode in interface StencilClient.Article

Returns:

The value of the devMode attribute

getName

public String getName()

Specified by:

getName in interface StencilClient.Article

Returns:

The value of the name attribute

getOrder

public Integer getOrder()

Specified by:

getOrder in interface StencilClient.Article

Returns:

The value of the order attribute

withParentId

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

withDevMode

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

withName

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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableArticle 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: parentId, devMode, name, order.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Article with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableArticle copyOf(StencilClient.Article instance)

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

builder

public static ImmutableArticle.Builder builder()

Creates a builder for ImmutableArticle.

 ImmutableArticle.builder()
    .parentId(String | null) // nullable parentId
    .devMode(Boolean | null) // nullable devMode
    .name(String) // required name
    .order(Integer) // required order
    .build();
 

Returns:

A new ImmutableArticle builder