de.flapdoodle.testdoc

Class ImmutableTemplate.Builder

java.lang.Object

de.flapdoodle.testdoc.ImmutableTemplate.Builder

Enclosing class:

ImmutableTemplate

public static final class ImmutableTemplate.Builder
extends Object

Builds instances of type ImmutableTemplate. 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 and Description
ImmutableTemplate	build() Builds a new ImmutableTemplate.
ImmutableTemplate.Builder	from(Template instance) Fill a builder with attribute values from the provided Template instance.
ImmutableTemplate.Builder	pattern(ReplacementPattern pattern) Initializes the value for the pattern attribute.
ImmutableTemplate.Builder	source(String source) Initializes the value for the source attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final ImmutableTemplate.Builder from(Template instance)

Fill a builder with attribute values from the provided Template instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

source

public final ImmutableTemplate.Builder source(String source)

Initializes the value for the source attribute.

Parameters:

source - The value for source

Returns:

this builder for use in a chained invocation

pattern

public final ImmutableTemplate.Builder pattern(ReplacementPattern pattern)

Initializes the value for the pattern attribute.

If not set, this attribute will have a default value as returned by the initializer of pattern.

Parameters:

pattern - The value for pattern

Returns:

this builder for use in a chained invocation

build

public ImmutableTemplate build()

Builds a new ImmutableTemplate.

Returns:

An immutable instance of Template

Throws:

IllegalStateException - if any required attributes are missing