de.flapdoodle.testdoc

Class ImmutableRecordings.Builder

java.lang.Object

de.flapdoodle.testdoc.ImmutableRecordings.Builder

Enclosing class:

ImmutableRecordings

public static final class ImmutableRecordings.Builder
extends Object

Builds instances of type ImmutableRecordings. 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
ImmutableRecordings.Builder	addAllLines(Iterable<? extends HasLine> elements) Adds elements to lines list.
ImmutableRecordings.Builder	addAllLinesOfCode(Iterable<String> elements) Adds elements to linesOfCode list.
ImmutableRecordings.Builder	addLines(HasLine... elements) Adds elements to lines list.
ImmutableRecordings.Builder	addLines(HasLine element) Adds one element to lines list.
ImmutableRecordings.Builder	addLinesOfCode(String... elements) Adds elements to linesOfCode list.
ImmutableRecordings.Builder	addLinesOfCode(String element) Adds one element to linesOfCode list.
ImmutableRecordings	build() Builds a new ImmutableRecordings.
ImmutableRecordings.Builder	classes(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the classes map.
ImmutableRecordings.Builder	from(Recordings instance) Fill a builder with attribute values from the provided Recordings instance.
ImmutableRecordings.Builder	lines(Iterable<? extends HasLine> elements) Sets or replaces all elements for lines list.
ImmutableRecordings.Builder	linesOfCode(Iterable<String> elements) Sets or replaces all elements for linesOfCode list.
ImmutableRecordings.Builder	methodsCalled(Map<String,? extends CalledMethod> entries) Sets or replaces all mappings from the specified map as entries for the methodsCalled map.
ImmutableRecordings.Builder	output(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the output map.
ImmutableRecordings.Builder	putAllClasses(Map<String,? extends String> entries) Put all mappings from the specified map as entries to classes map.
ImmutableRecordings.Builder	putAllMethodsCalled(Map<String,? extends CalledMethod> entries) Put all mappings from the specified map as entries to methodsCalled map.
ImmutableRecordings.Builder	putAllOutput(Map<String,? extends String> entries) Put all mappings from the specified map as entries to output map.
ImmutableRecordings.Builder	putAllResources(Map<String,? extends String> entries) Put all mappings from the specified map as entries to resources map.
ImmutableRecordings.Builder	putClasses(Map.Entry<String,? extends String> entry) Put one entry to the classes map.
ImmutableRecordings.Builder	putClasses(String key, String value) Put one entry to the classes map.
ImmutableRecordings.Builder	putMethodsCalled(Map.Entry<String,? extends CalledMethod> entry) Put one entry to the methodsCalled map.
ImmutableRecordings.Builder	putMethodsCalled(String key, CalledMethod value) Put one entry to the methodsCalled map.
ImmutableRecordings.Builder	putOutput(Map.Entry<String,? extends String> entry) Put one entry to the output map.
ImmutableRecordings.Builder	putOutput(String key, String value) Put one entry to the output map.
ImmutableRecordings.Builder	putResources(Map.Entry<String,? extends String> entry) Put one entry to the resources map.
ImmutableRecordings.Builder	putResources(String key, String value) Put one entry to the resources map.
ImmutableRecordings.Builder	replacementNotFoundFallback(BiFunction<String,Set<String>,String> replacementNotFoundFallback) Initializes the optional value replacementNotFoundFallback to replacementNotFoundFallback.
ImmutableRecordings.Builder	replacementNotFoundFallback(Optional<? extends BiFunction<String,Set<String>,String>> replacementNotFoundFallback) Initializes the optional value replacementNotFoundFallback to replacementNotFoundFallback.
ImmutableRecordings.Builder	resources(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the resources map.
ImmutableRecordings.Builder	templateReference(TemplateReference templateReference) Initializes the value for the templateReference attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableRecordings.Builder from(Recordings instance)

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

templateReference

public final ImmutableRecordings.Builder templateReference(TemplateReference templateReference)

Initializes the value for the templateReference attribute.

Parameters:

templateReference - The value for templateReference

Returns:

this builder for use in a chained invocation

addLinesOfCode

public final ImmutableRecordings.Builder addLinesOfCode(String element)

Adds one element to linesOfCode list.

Parameters:

element - A linesOfCode element

Returns:

this builder for use in a chained invocation

addLinesOfCode

public final ImmutableRecordings.Builder addLinesOfCode(String... elements)

Adds elements to linesOfCode list.

Parameters:

elements - An array of linesOfCode elements

Returns:

this builder for use in a chained invocation

linesOfCode

public final ImmutableRecordings.Builder linesOfCode(Iterable<String> elements)

Sets or replaces all elements for linesOfCode list.

Parameters:

elements - An iterable of linesOfCode elements

Returns:

this builder for use in a chained invocation

addAllLinesOfCode

public final ImmutableRecordings.Builder addAllLinesOfCode(Iterable<String> elements)

Adds elements to linesOfCode list.

Parameters:

elements - An iterable of linesOfCode elements

Returns:

this builder for use in a chained invocation

addLines

public final ImmutableRecordings.Builder addLines(HasLine element)

Adds one element to lines list.

Parameters:

element - A lines element

Returns:

this builder for use in a chained invocation

addLines

public final ImmutableRecordings.Builder addLines(HasLine... elements)

Adds elements to lines list.

Parameters:

elements - An array of lines elements

Returns:

this builder for use in a chained invocation

lines

public final ImmutableRecordings.Builder lines(Iterable<? extends HasLine> elements)

Sets or replaces all elements for lines list.

Parameters:

elements - An iterable of lines elements

Returns:

this builder for use in a chained invocation

addAllLines

public final ImmutableRecordings.Builder addAllLines(Iterable<? extends HasLine> elements)

Adds elements to lines list.

Parameters:

elements - An iterable of lines elements

Returns:

this builder for use in a chained invocation

putMethodsCalled

public final ImmutableRecordings.Builder putMethodsCalled(String key,
                                                          CalledMethod value)

Put one entry to the methodsCalled map.

Parameters:

key - The key in the methodsCalled map

value - The associated value in the methodsCalled map

Returns:

this builder for use in a chained invocation

putMethodsCalled

public final ImmutableRecordings.Builder putMethodsCalled(Map.Entry<String,? extends CalledMethod> entry)

Put one entry to the methodsCalled map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

methodsCalled

public final ImmutableRecordings.Builder methodsCalled(Map<String,? extends CalledMethod> entries)

Sets or replaces all mappings from the specified map as entries for the methodsCalled map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the methodsCalled map

Returns:

this builder for use in a chained invocation

putAllMethodsCalled

public final ImmutableRecordings.Builder putAllMethodsCalled(Map<String,? extends CalledMethod> entries)

Put all mappings from the specified map as entries to methodsCalled map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the methodsCalled map

Returns:

this builder for use in a chained invocation

putClasses

public final ImmutableRecordings.Builder putClasses(String key,
                                                    String value)

Put one entry to the classes map.

Parameters:

key - The key in the classes map

value - The associated value in the classes map

Returns:

this builder for use in a chained invocation

putClasses

public final ImmutableRecordings.Builder putClasses(Map.Entry<String,? extends String> entry)

Put one entry to the classes map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

classes

public final ImmutableRecordings.Builder classes(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the classes map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the classes map

Returns:

this builder for use in a chained invocation

putAllClasses

public final ImmutableRecordings.Builder putAllClasses(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to classes map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the classes map

Returns:

this builder for use in a chained invocation

putResources

public final ImmutableRecordings.Builder putResources(String key,
                                                      String value)

Put one entry to the resources map.

Parameters:

key - The key in the resources map

value - The associated value in the resources map

Returns:

this builder for use in a chained invocation

putResources

public final ImmutableRecordings.Builder putResources(Map.Entry<String,? extends String> entry)

Put one entry to the resources map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

resources

public final ImmutableRecordings.Builder resources(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the resources map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the resources map

Returns:

this builder for use in a chained invocation

putAllResources

public final ImmutableRecordings.Builder putAllResources(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to resources map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the resources map

Returns:

this builder for use in a chained invocation

putOutput

public final ImmutableRecordings.Builder putOutput(String key,
                                                   String value)

Put one entry to the output map.

Parameters:

key - The key in the output map

value - The associated value in the output map

Returns:

this builder for use in a chained invocation

putOutput

public final ImmutableRecordings.Builder putOutput(Map.Entry<String,? extends String> entry)

Put one entry to the output map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

output

public final ImmutableRecordings.Builder output(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the output map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the output map

Returns:

this builder for use in a chained invocation

putAllOutput

public final ImmutableRecordings.Builder putAllOutput(Map<String,? extends String> entries)

Put all mappings from the specified map as entries to output map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the output map

Returns:

this builder for use in a chained invocation

replacementNotFoundFallback

public final ImmutableRecordings.Builder replacementNotFoundFallback(BiFunction<String,Set<String>,String> replacementNotFoundFallback)

Initializes the optional value replacementNotFoundFallback to replacementNotFoundFallback.

Parameters:

replacementNotFoundFallback - The value for replacementNotFoundFallback

Returns:

this builder for chained invocation

replacementNotFoundFallback

public final ImmutableRecordings.Builder replacementNotFoundFallback(Optional<? extends BiFunction<String,Set<String>,String>> replacementNotFoundFallback)

Initializes the optional value replacementNotFoundFallback to replacementNotFoundFallback.

Parameters:

replacementNotFoundFallback - The value for replacementNotFoundFallback

Returns:

this builder for use in a chained invocation

build

public ImmutableRecordings build()

Builds a new ImmutableRecordings.

Returns:

An immutable instance of Recordings

Throws:

IllegalStateException - if any required attributes are missing