de.flapdoodle.testdoc

Class ImmutableTemplateReference.Builder

java.lang.Object

de.flapdoodle.testdoc.ImmutableTemplateReference.Builder

Enclosing class:

ImmutableTemplateReference

public static final class ImmutableTemplateReference.Builder
extends Object

Builds instances of type ImmutableTemplateReference. 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
ImmutableTemplateReference	build() Builds a new ImmutableTemplateReference.
ImmutableTemplateReference.Builder	clazz(Class<?> clazz) Initializes the value for the clazz attribute.
ImmutableTemplateReference.Builder	from(TemplateReference instance) Fill a builder with attribute values from the provided TemplateReference instance.
ImmutableTemplateReference.Builder	templateName(String templateName) Initializes the value for the templateName attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableTemplateReference.Builder from(TemplateReference instance)

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

clazz

public final ImmutableTemplateReference.Builder clazz(Class<?> clazz)

Initializes the value for the clazz attribute.

Parameters:

clazz - The value for clazz

Returns:

this builder for use in a chained invocation

templateName

public final ImmutableTemplateReference.Builder templateName(String templateName)

Initializes the value for the templateName attribute.

Parameters:

templateName - The value for templateName

Returns:

this builder for use in a chained invocation

build

public ImmutableTemplateReference build()

Builds a new ImmutableTemplateReference.

Returns:

An immutable instance of TemplateReference

Throws:

IllegalStateException - if any required attributes are missing