Package io.thestencil.client.api

Class ImmutablePage.Builder

java.lang.Object

io.thestencil.client.api.ImmutablePage.Builder

Enclosing class:

ImmutablePage

@NotThreadSafe
public static final class ImmutablePage.Builder
extends Object

Builds instances of type ImmutablePage. 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
ImmutablePage.Builder	article(String article)	Initializes the value for the article attribute.
ImmutablePage	build()	Builds a new ImmutablePage.
ImmutablePage.Builder	content(String content)	Initializes the value for the content attribute.
ImmutablePage.Builder	devMode(Boolean devMode)	Initializes the value for the devMode attribute.
ImmutablePage.Builder	from(StencilClient.Page instance)	Fill a builder with attribute values from the provided Page instance.
ImmutablePage.Builder	locale(String locale)	Initializes the value for the locale 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 ImmutablePage.Builder from(StencilClient.Page instance)

Fill a builder with attribute values from the provided Page 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

article

@CanIgnoreReturnValue
public final ImmutablePage.Builder article(String article)

Initializes the value for the article attribute.

Parameters:

article - The value for article

Returns:

this builder for use in a chained invocation

devMode

@CanIgnoreReturnValue
public final ImmutablePage.Builder devMode(@Nullable
                                           Boolean devMode)

Initializes the value for the devMode attribute.

Parameters:

devMode - The value for devMode (can be null)

Returns:

this builder for use in a chained invocation

locale

@CanIgnoreReturnValue
public final ImmutablePage.Builder locale(String locale)

Initializes the value for the locale attribute.

Parameters:

locale - The value for locale

Returns:

this builder for use in a chained invocation

content

@CanIgnoreReturnValue
public final ImmutablePage.Builder content(String content)

Initializes the value for the content attribute.

Parameters:

content - The value for content

Returns:

this builder for use in a chained invocation

build

public ImmutablePage build()

Builds a new ImmutablePage.

Returns:

An immutable instance of Page

Throws:

IllegalStateException - if any required attributes are missing