Package io.thestencil.client.api

Class ImmutableLinkMutator.Builder

java.lang.Object

io.thestencil.client.api.ImmutableLinkMutator.Builder

Enclosing class:

ImmutableLinkMutator

@NotThreadSafe
public static final class ImmutableLinkMutator.Builder
extends Object

Builds instances of type ImmutableLinkMutator. 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
ImmutableLinkMutator.Builder	addAllArticles(Iterable<String> elements)	Adds elements to articles list.
ImmutableLinkMutator.Builder	addAllLabels(Iterable<? extends StencilClient.LocaleLabel> elements)	Adds elements to labels list.
ImmutableLinkMutator.Builder	addArticles(String element)	Adds one element to articles list.
ImmutableLinkMutator.Builder	addArticles(String... elements)	Adds elements to articles list.
ImmutableLinkMutator.Builder	addLabels(StencilClient.LocaleLabel element)	Adds one element to labels list.
ImmutableLinkMutator.Builder	addLabels(StencilClient.LocaleLabel... elements)	Adds elements to labels list.
ImmutableLinkMutator.Builder	articles(Iterable<String> elements)	Sets or replaces all elements for articles list.
ImmutableLinkMutator	build()	Builds a new ImmutableLinkMutator.
ImmutableLinkMutator.Builder	devMode(Boolean devMode)	Initializes the value for the devMode attribute.
ImmutableLinkMutator.Builder	from(UpdateBuilder.LinkMutator instance)	Fill a builder with attribute values from the provided LinkMutator instance.
ImmutableLinkMutator.Builder	labels(Iterable<? extends StencilClient.LocaleLabel> elements)	Sets or replaces all elements for labels list.
ImmutableLinkMutator.Builder	linkId(String linkId)	Initializes the value for the linkId attribute.
ImmutableLinkMutator.Builder	type(String type)	Initializes the value for the type attribute.
ImmutableLinkMutator.Builder	value(String value)	Initializes the value for the value 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 ImmutableLinkMutator.Builder from(UpdateBuilder.LinkMutator instance)

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

linkId

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder linkId(String linkId)

Initializes the value for the linkId attribute.

Parameters:

linkId - The value for linkId

Returns:

this builder for use in a chained invocation

value

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder value(String value)

Initializes the value for the value attribute.

Parameters:

value - The value for value

Returns:

this builder for use in a chained invocation

type

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder type(String type)

Initializes the value for the type attribute.

Parameters:

type - The value for type

Returns:

this builder for use in a chained invocation

addLabels

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addLabels(StencilClient.LocaleLabel element)

Adds one element to labels list.

Parameters:

element - A labels element

Returns:

this builder for use in a chained invocation

addLabels

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addLabels(StencilClient.LocaleLabel... elements)

Adds elements to labels list.

Parameters:

elements - An array of labels elements

Returns:

this builder for use in a chained invocation

labels

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder labels(@Nullable
                                                 Iterable<? extends StencilClient.LocaleLabel> elements)

Sets or replaces all elements for labels list.

Parameters:

elements - An iterable of labels elements

Returns:

this builder for use in a chained invocation

addAllLabels

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addAllLabels(Iterable<? extends StencilClient.LocaleLabel> elements)

Adds elements to labels list.

Parameters:

elements - An iterable of labels elements

Returns:

this builder for use in a chained invocation

addArticles

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addArticles(String element)

Adds one element to articles list.

Parameters:

element - A articles element

Returns:

this builder for use in a chained invocation

addArticles

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addArticles(String... elements)

Adds elements to articles list.

Parameters:

elements - An array of articles elements

Returns:

this builder for use in a chained invocation

articles

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder articles(@Nullable
                                                   Iterable<String> elements)

Sets or replaces all elements for articles list.

Parameters:

elements - An iterable of articles elements

Returns:

this builder for use in a chained invocation

addAllArticles

@CanIgnoreReturnValue
public final ImmutableLinkMutator.Builder addAllArticles(Iterable<String> elements)

Adds elements to articles list.

Parameters:

elements - An iterable of articles elements

Returns:

this builder for use in a chained invocation

devMode

@CanIgnoreReturnValue
public final ImmutableLinkMutator.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 ImmutableLinkMutator build()

Builds a new ImmutableLinkMutator.

Returns:

An immutable instance of LinkMutator

Throws:

IllegalStateException - if any required attributes are missing