Package io.thestencil.staticontent.api

Class ImmutableMarkdown.Builder

java.lang.Object

io.thestencil.staticontent.api.ImmutableMarkdown.Builder

Enclosing class:

ImmutableMarkdown

@NotThreadSafe
public static final class ImmutableMarkdown.Builder
extends Object

Builds instances of type ImmutableMarkdown. 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
ImmutableMarkdown.Builder	addAllHeadings(Iterable<? extends MarkdownContent.Heading> elements)	Adds elements to headings list.
ImmutableMarkdown.Builder	addAllImages(Iterable<? extends MarkdownContent.ImageTag> elements)	Adds elements to images list.
ImmutableMarkdown.Builder	addHeadings(MarkdownContent.Heading element)	Adds one element to headings list.
ImmutableMarkdown.Builder	addHeadings(MarkdownContent.Heading... elements)	Adds elements to headings list.
ImmutableMarkdown.Builder	addImages(MarkdownContent.ImageTag element)	Adds one element to images list.
ImmutableMarkdown.Builder	addImages(MarkdownContent.ImageTag... elements)	Adds elements to images list.
ImmutableMarkdown	build()	Builds a new ImmutableMarkdown.
ImmutableMarkdown.Builder	from(MarkdownContent.Markdown instance)	Fill a builder with attribute values from the provided Markdown instance.
ImmutableMarkdown.Builder	headings(Iterable<? extends MarkdownContent.Heading> elements)	Sets or replaces all elements for headings list.
ImmutableMarkdown.Builder	images(Iterable<? extends MarkdownContent.ImageTag> elements)	Sets or replaces all elements for images list.
ImmutableMarkdown.Builder	locale(String locale)	Initializes the value for the locale attribute.
ImmutableMarkdown.Builder	path(String path)	Initializes the value for the path attribute.
ImmutableMarkdown.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 ImmutableMarkdown.Builder from(MarkdownContent.Markdown instance)

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

locale

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

path

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

addHeadings

@CanIgnoreReturnValue
public final ImmutableMarkdown.Builder addHeadings(MarkdownContent.Heading element)

Adds one element to headings list.

Parameters:

element - A headings element

Returns:

this builder for use in a chained invocation

addHeadings

@CanIgnoreReturnValue
public final ImmutableMarkdown.Builder addHeadings(MarkdownContent.Heading... elements)

Adds elements to headings list.

Parameters:

elements - An array of headings elements

Returns:

this builder for use in a chained invocation

headings

@CanIgnoreReturnValue
public final ImmutableMarkdown.Builder headings(Iterable<? extends MarkdownContent.Heading> elements)

Sets or replaces all elements for headings list.

Parameters:

elements - An iterable of headings elements

Returns:

this builder for use in a chained invocation

addAllHeadings

@CanIgnoreReturnValue
public final ImmutableMarkdown.Builder addAllHeadings(Iterable<? extends MarkdownContent.Heading> elements)

Adds elements to headings list.

Parameters:

elements - An iterable of headings elements

Returns:

this builder for use in a chained invocation

addImages

@CanIgnoreReturnValue
public final ImmutableMarkdown.Builder addImages(MarkdownContent.ImageTag 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 ImmutableMarkdown.Builder addImages(MarkdownContent.ImageTag... 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 ImmutableMarkdown.Builder images(Iterable<? extends MarkdownContent.ImageTag> 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 ImmutableMarkdown.Builder addAllImages(Iterable<? extends MarkdownContent.ImageTag> elements)

Adds elements to images list.

Parameters:

elements - An iterable of images elements

Returns:

this builder for use in a chained invocation

build

public ImmutableMarkdown build()

Builds a new ImmutableMarkdown.

Returns:

An immutable instance of Markdown

Throws:

IllegalStateException - if any required attributes are missing