Package io.thestencil.client.api

Class ImmutableArticleMutator.Builder

java.lang.Object

io.thestencil.client.api.ImmutableArticleMutator.Builder

Enclosing class:

ImmutableArticleMutator

@NotThreadSafe
public static final class ImmutableArticleMutator.Builder
extends Object

Builds instances of type ImmutableArticleMutator. 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
ImmutableArticleMutator.Builder	addAllLinks(Iterable<String> elements)	Adds elements to links list.
ImmutableArticleMutator.Builder	addAllWorkflows(Iterable<String> elements)	Adds elements to workflows list.
ImmutableArticleMutator.Builder	addLinks(String element)	Adds one element to links list.
ImmutableArticleMutator.Builder	addLinks(String... elements)	Adds elements to links list.
ImmutableArticleMutator.Builder	addWorkflows(String element)	Adds one element to workflows list.
ImmutableArticleMutator.Builder	addWorkflows(String... elements)	Adds elements to workflows list.
ImmutableArticleMutator.Builder	articleId(String articleId)	Initializes the value for the articleId attribute.
ImmutableArticleMutator	build()	Builds a new ImmutableArticleMutator.
ImmutableArticleMutator.Builder	devMode(Boolean devMode)	Initializes the value for the devMode attribute.
ImmutableArticleMutator.Builder	from(UpdateBuilder.ArticleMutator instance)	Fill a builder with attribute values from the provided ArticleMutator instance.
ImmutableArticleMutator.Builder	links(Iterable<String> elements)	Sets or replaces all elements for links list.
ImmutableArticleMutator.Builder	name(String name)	Initializes the value for the name attribute.
ImmutableArticleMutator.Builder	order(Integer order)	Initializes the value for the order attribute.
ImmutableArticleMutator.Builder	parentId(String parentId)	Initializes the value for the parentId attribute.
ImmutableArticleMutator.Builder	workflows(Iterable<String> elements)	Sets or replaces all elements for workflows list.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder from(UpdateBuilder.ArticleMutator instance)

Fill a builder with attribute values from the provided ArticleMutator instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

articleId

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder articleId(String articleId)

Initializes the value for the articleId attribute.

Parameters:

articleId - The value for articleId

Returns:

this builder for use in a chained invocation

parentId

@CanIgnoreReturnValue
public final ImmutableArticleMutator.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 ImmutableArticleMutator.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 ImmutableArticleMutator.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

addLinks

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addLinks(String element)

Adds one element to links list.

Parameters:

element - A links element

Returns:

this builder for use in a chained invocation

addLinks

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addLinks(String... elements)

Adds elements to links list.

Parameters:

elements - An array of links elements

Returns:

this builder for use in a chained invocation

links

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder links(@Nullable
                                                   Iterable<String> elements)

Sets or replaces all elements for links list.

Parameters:

elements - An iterable of links elements

Returns:

this builder for use in a chained invocation

addAllLinks

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addAllLinks(Iterable<String> elements)

Adds elements to links list.

Parameters:

elements - An iterable of links elements

Returns:

this builder for use in a chained invocation

addWorkflows

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addWorkflows(String element)

Adds one element to workflows list.

Parameters:

element - A workflows element

Returns:

this builder for use in a chained invocation

addWorkflows

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addWorkflows(String... elements)

Adds elements to workflows list.

Parameters:

elements - An array of workflows elements

Returns:

this builder for use in a chained invocation

workflows

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder workflows(@Nullable
                                                       Iterable<String> elements)

Sets or replaces all elements for workflows list.

Parameters:

elements - An iterable of workflows elements

Returns:

this builder for use in a chained invocation

addAllWorkflows

@CanIgnoreReturnValue
public final ImmutableArticleMutator.Builder addAllWorkflows(Iterable<String> elements)

Adds elements to workflows list.

Parameters:

elements - An iterable of workflows elements

Returns:

this builder for use in a chained invocation

devMode

@CanIgnoreReturnValue
public final ImmutableArticleMutator.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

build

public ImmutableArticleMutator build()

Builds a new ImmutableArticleMutator.

Returns:

An immutable instance of ArticleMutator

Throws:

IllegalStateException - if any required attributes are missing