Package io.thestencil.staticontent.api

Class ImmutableMarkdownContent.Builder

java.lang.Object

io.thestencil.staticontent.api.ImmutableMarkdownContent.Builder

Enclosing class:

ImmutableMarkdownContent

@NotThreadSafe
public static final class ImmutableMarkdownContent.Builder
extends Object

Builds instances of type ImmutableMarkdownContent. 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
ImmutableMarkdownContent.Builder	addAllImages(Iterable<? extends MarkdownContent.ImageResource> elements)	Adds elements to images list.
ImmutableMarkdownContent.Builder	addAllLinks(Iterable<? extends MarkdownContent.LinkResource> elements)	Adds elements to links list.
ImmutableMarkdownContent.Builder	addAllLocales(Iterable<String> elements)	Adds elements to locales list.
ImmutableMarkdownContent.Builder	addAllValues(Iterable<? extends MarkdownContent.Markdown> elements)	Adds elements to values list.
ImmutableMarkdownContent.Builder	addImages(MarkdownContent.ImageResource element)	Adds one element to images list.
ImmutableMarkdownContent.Builder	addImages(MarkdownContent.ImageResource... elements)	Adds elements to images list.
ImmutableMarkdownContent.Builder	addLinks(MarkdownContent.LinkResource element)	Adds one element to links list.
ImmutableMarkdownContent.Builder	addLinks(MarkdownContent.LinkResource... elements)	Adds elements to links list.
ImmutableMarkdownContent.Builder	addLocales(String element)	Adds one element to locales list.
ImmutableMarkdownContent.Builder	addLocales(String... elements)	Adds elements to locales list.
ImmutableMarkdownContent.Builder	addValues(MarkdownContent.Markdown element)	Adds one element to values list.
ImmutableMarkdownContent.Builder	addValues(MarkdownContent.Markdown... elements)	Adds elements to values list.
ImmutableMarkdownContent	build()	Builds a new ImmutableMarkdownContent.
ImmutableMarkdownContent.Builder	from(MarkdownContent instance)	Fill a builder with attribute values from the provided MarkdownContent instance.
ImmutableMarkdownContent.Builder	images(Iterable<? extends MarkdownContent.ImageResource> elements)	Sets or replaces all elements for images list.
ImmutableMarkdownContent.Builder	links(Iterable<? extends MarkdownContent.LinkResource> elements)	Sets or replaces all elements for links list.
ImmutableMarkdownContent.Builder	locales(Iterable<String> elements)	Sets or replaces all elements for locales list.
ImmutableMarkdownContent.Builder	values(Iterable<? extends MarkdownContent.Markdown> elements)	Sets or replaces all elements for values 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 ImmutableMarkdownContent.Builder from(MarkdownContent instance)

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

addValues

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addValues(MarkdownContent.Markdown element)

Adds one element to values list.

Parameters:

element - A values element

Returns:

this builder for use in a chained invocation

addValues

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addValues(MarkdownContent.Markdown... elements)

Adds elements to values list.

Parameters:

elements - An array of values elements

Returns:

this builder for use in a chained invocation

values

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder values(Iterable<? extends MarkdownContent.Markdown> elements)

Sets or replaces all elements for values list.

Parameters:

elements - An iterable of values elements

Returns:

this builder for use in a chained invocation

addAllValues

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addAllValues(Iterable<? extends MarkdownContent.Markdown> elements)

Adds elements to values list.

Parameters:

elements - An iterable of values elements

Returns:

this builder for use in a chained invocation

addImages

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addImages(MarkdownContent.ImageResource element)

Adds one element to images list.

Parameters:

element - A images element

Returns:

this builder for use in a chained invocation

addImages

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addImages(MarkdownContent.ImageResource... elements)

Adds elements to images list.

Parameters:

elements - An array of images elements

Returns:

this builder for use in a chained invocation

images

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder images(Iterable<? extends MarkdownContent.ImageResource> elements)

Sets or replaces all elements for images list.

Parameters:

elements - An iterable of images elements

Returns:

this builder for use in a chained invocation

addAllImages

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addAllImages(Iterable<? extends MarkdownContent.ImageResource> elements)

Adds elements to images list.

Parameters:

elements - An iterable of images elements

Returns:

this builder for use in a chained invocation

addLinks

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addLinks(MarkdownContent.LinkResource 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 ImmutableMarkdownContent.Builder addLinks(MarkdownContent.LinkResource... 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 ImmutableMarkdownContent.Builder links(Iterable<? extends MarkdownContent.LinkResource> 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 ImmutableMarkdownContent.Builder addAllLinks(Iterable<? extends MarkdownContent.LinkResource> elements)

Adds elements to links list.

Parameters:

elements - An iterable of links elements

Returns:

this builder for use in a chained invocation

addLocales

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addLocales(String element)

Adds one element to locales list.

Parameters:

element - A locales element

Returns:

this builder for use in a chained invocation

addLocales

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addLocales(String... elements)

Adds elements to locales list.

Parameters:

elements - An array of locales elements

Returns:

this builder for use in a chained invocation

locales

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder locales(Iterable<String> elements)

Sets or replaces all elements for locales list.

Parameters:

elements - An iterable of locales elements

Returns:

this builder for use in a chained invocation

addAllLocales

@CanIgnoreReturnValue
public final ImmutableMarkdownContent.Builder addAllLocales(Iterable<String> elements)

Adds elements to locales list.

Parameters:

elements - An iterable of locales elements

Returns:

this builder for use in a chained invocation

build

public ImmutableMarkdownContent build()

Builds a new ImmutableMarkdownContent.

Returns:

An immutable instance of MarkdownContent

Throws:

IllegalStateException - if any required attributes are missing