Package io.thestencil.staticontent.api

Class ImmutableLinkResource.Builder

java.lang.Object

io.thestencil.staticontent.api.ImmutableLinkResource.Builder

Enclosing class:

ImmutableLinkResource

@NotThreadSafe
public static final class ImmutableLinkResource.Builder
extends Object

Builds instances of type ImmutableLinkResource. 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
ImmutableLinkResource.Builder	addAllLocale(Iterable<String> elements)	Adds elements to locale list.
ImmutableLinkResource.Builder	addLocale(String element)	Adds one element to locale list.
ImmutableLinkResource.Builder	addLocale(String... elements)	Adds elements to locale list.
ImmutableLinkResource	build()	Builds a new ImmutableLinkResource.
ImmutableLinkResource.Builder	desc(String desc)	Initializes the value for the desc attribute.
ImmutableLinkResource.Builder	from(StaticContentClient.LinkResource instance)	Fill a builder with attribute values from the provided LinkResource instance.
ImmutableLinkResource.Builder	global(Boolean global)	Initializes the value for the global attribute.
ImmutableLinkResource.Builder	id(String id)	Initializes the value for the id attribute.
ImmutableLinkResource.Builder	locale(Iterable<String> elements)	Sets or replaces all elements for locale list.
ImmutableLinkResource.Builder	path(String path)	Initializes the value for the path attribute.
ImmutableLinkResource.Builder	type(String type)	Initializes the value for the type attribute.
ImmutableLinkResource.Builder	value(String value)	Initializes the value for the value attribute.
ImmutableLinkResource.Builder	workflow(Boolean workflow)	Initializes the value for the workflow 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 ImmutableLinkResource.Builder from(StaticContentClient.LinkResource instance)

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

id

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder id(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

type

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

path

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder path(String path)

Initializes the value for the path attribute.

Parameters:

path - The value for path

Returns:

this builder for use in a chained invocation

value

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

addLocale

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder addLocale(String element)

Adds one element to locale list.

Parameters:

element - A locale element

Returns:

this builder for use in a chained invocation

addLocale

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder addLocale(String... elements)

Adds elements to locale list.

Parameters:

elements - An array of locale elements

Returns:

this builder for use in a chained invocation

locale

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder locale(Iterable<String> elements)

Sets or replaces all elements for locale list.

Parameters:

elements - An iterable of locale elements

Returns:

this builder for use in a chained invocation

addAllLocale

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder addAllLocale(Iterable<String> elements)

Adds elements to locale list.

Parameters:

elements - An iterable of locale elements

Returns:

this builder for use in a chained invocation

workflow

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder workflow(Boolean workflow)

Initializes the value for the workflow attribute.

Parameters:

workflow - The value for workflow

Returns:

this builder for use in a chained invocation

global

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder global(Boolean global)

Initializes the value for the global attribute.

Parameters:

global - The value for global

Returns:

this builder for use in a chained invocation

desc

@CanIgnoreReturnValue
public final ImmutableLinkResource.Builder desc(@Nullable
                                                String desc)

Initializes the value for the desc attribute.

Parameters:

desc - The value for desc (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableLinkResource build()

Builds a new ImmutableLinkResource.

Returns:

An immutable instance of LinkResource

Throws:

IllegalStateException - if any required attributes are missing