Package io.thestencil.client.api

Class ImmutableArticle.Builder

java.lang.Object

io.thestencil.client.api.ImmutableArticle.Builder

Enclosing class:

ImmutableArticle

@NotThreadSafe
public static final class ImmutableArticle.Builder
extends Object

Builds instances of type ImmutableArticle. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableArticle	build()	Builds a new ImmutableArticle.
ImmutableArticle.Builder	from(StencilClient.Article instance)	Fill a builder with attribute values from the provided Article instance.
ImmutableArticle.Builder	name(String name)	Initializes the value for the name attribute.
ImmutableArticle.Builder	order(Integer order)	Initializes the value for the order attribute.
ImmutableArticle.Builder	parentId(String parentId)	Initializes the value for the parentId attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableArticle.Builder from(StencilClient.Article instance)

Fill a builder with attribute values from the provided Article instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

parentId

@CanIgnoreReturnValue
public final ImmutableArticle.Builder parentId(@Nullable
                                               String parentId)

Initializes the value for the parentId attribute.

Parameters:

parentId - The value for parentId (can be null)

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableArticle.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

order

@CanIgnoreReturnValue
public final ImmutableArticle.Builder order(Integer order)

Initializes the value for the order attribute.

Parameters:

order - The value for order

Returns:

this builder for use in a chained invocation

build

public ImmutableArticle build()

Builds a new ImmutableArticle.

Returns:

An immutable instance of Article

Throws:

IllegalStateException - if any required attributes are missing