Package io.thestencil.staticontent.spi.visitor

Class ImmutableMarkdownAst.Builder

java.lang.Object

io.thestencil.staticontent.spi.visitor.ImmutableMarkdownAst.Builder

Enclosing class:

ImmutableMarkdownAst

@NotThreadSafe
public static final class ImmutableMarkdownAst.Builder
extends Object

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

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

addImages

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

Adds elements to images list.

Parameters:

elements - An iterable of images elements

Returns:

this builder for use in a chained invocation

addHeadings

@CanIgnoreReturnValue
public final ImmutableMarkdownAst.Builder addHeadings(StaticContentClient.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 ImmutableMarkdownAst.Builder addHeadings(StaticContentClient.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 ImmutableMarkdownAst.Builder headings(Iterable<? extends StaticContentClient.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 ImmutableMarkdownAst.Builder addAllHeadings(Iterable<? extends StaticContentClient.Heading> elements)

Adds elements to headings list.

Parameters:

elements - An iterable of headings elements

Returns:

this builder for use in a chained invocation

build

public ImmutableMarkdownAst build()

Builds a new ImmutableMarkdownAst.

Returns:

An immutable instance of MarkdownAst

Throws:

IllegalStateException - if any required attributes are missing