de.flapdoodle.testdoc

Class ImmutableReplacements.Builder

java.lang.Object

de.flapdoodle.testdoc.ImmutableReplacements.Builder

Enclosing class:

ImmutableReplacements

public static final class ImmutableReplacements.Builder
extends Object

Builds instances of type ImmutableReplacements. 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
ImmutableReplacements	build() Builds a new ImmutableReplacements.
ImmutableReplacements.Builder	from(Replacements instance) Fill a builder with attribute values from the provided Replacements instance.
ImmutableReplacements.Builder	putAllReplacement(Map<String,? extends String> entries) Put all mappings from the specified map as entries to replacement map.
ImmutableReplacements.Builder	putReplacement(Map.Entry<String,? extends String> entry) Put one entry to the replacement map.
ImmutableReplacements.Builder	putReplacement(String key, String value) Put one entry to the replacement map.
ImmutableReplacements.Builder	replacement(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the replacement map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableReplacements.Builder from(Replacements instance)

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

putReplacement

public final ImmutableReplacements.Builder putReplacement(String key,
                                                          String value)

Put one entry to the replacement map.

Parameters:

key - The key in the replacement map

value - The associated value in the replacement map

Returns:

this builder for use in a chained invocation

putReplacement

public final ImmutableReplacements.Builder putReplacement(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

replacement

public final ImmutableReplacements.Builder replacement(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllReplacement

public final ImmutableReplacements.Builder putAllReplacement(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableReplacements build()

Builds a new ImmutableReplacements.

Returns:

An immutable instance of Replacements

Throws:

IllegalStateException - if any required attributes are missing