Package io.thestencil.client.api

Class ImmutableCreateArticle

java.lang.Object

io.thestencil.client.api.ImmutableCreateArticle

All Implemented Interfaces:

CreateBuilder.CreateArticle

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableCreateArticle
extends Object
implements CreateBuilder.CreateArticle

Immutable implementation of CreateBuilder.CreateArticle.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableCreateArticle.Builder	builder()	Creates a builder for ImmutableCreateArticle.
static ImmutableCreateArticle	copyOf(CreateBuilder.CreateArticle instance)	Creates an immutable copy of a CreateBuilder.CreateArticle value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableCreateArticle that have equal attribute values.
String	getName()
Integer	getOrder()
String	getParentId()
int	hashCode()	Computes a hash code from attributes: parentId, name, order.
String	toString()	Prints the immutable value CreateArticle with attribute values.
ImmutableCreateArticle	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableCreateArticle	withOrder(Integer value)	Copy the current immutable object by setting a value for the order attribute.
ImmutableCreateArticle	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 CreateBuilder.CreateArticle

Returns:

The value of the parentId attribute

getName

public String getName()

Specified by:

getName in interface CreateBuilder.CreateArticle

Returns:

The value of the name attribute

getOrder

@Nullable
public Integer getOrder()

Specified by:

getOrder in interface CreateBuilder.CreateArticle

Returns:

The value of the order attribute

withParentId

public final ImmutableCreateArticle 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 ImmutableCreateArticle 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 ImmutableCreateArticle withOrder(@Nullable
                                              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 (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CreateArticle with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableCreateArticle copyOf(CreateBuilder.CreateArticle instance)

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

builder

public static ImmutableCreateArticle.Builder builder()

Creates a builder for ImmutableCreateArticle.

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

Returns:

A new ImmutableCreateArticle builder