de.flapdoodle.testdoc

Class ImmutableReplacements

java.lang.Object

de.flapdoodle.testdoc.ImmutableReplacements

All Implemented Interfaces:

Template.Replacements

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableReplacements
extends Object
implements Template.Replacements

Immutable implementation of Template.Replacements.

Use the builder to create immutable instances: ImmutableReplacements.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableReplacements.Builder Builds instances of type ImmutableReplacements.

Method Summary

Modifier and Type	Method and Description
static ImmutableReplacements.Builder	builder() Creates a builder for ImmutableReplacements.
static ImmutableReplacements	copyOf(Template.Replacements instance) Creates an immutable copy of a Template.Replacements value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableReplacements that have equal attribute values.
int	hashCode() Computes a hash code from attributes: replacement.
Map<String,String>	replacement()
String	toString() Prints the immutable value Replacements with attribute values.
ImmutableReplacements	withReplacement(Map<String,? extends String> entries) Copy the current immutable object by replacing the replacement map with the specified map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

replacement

public Map<String,String> replacement()

Specified by:

replacement in interface Template.Replacements

Returns:

The value of the replacement attribute

withReplacement

public final ImmutableReplacements withReplacement(Map<String,? extends String> entries)

Copy the current immutable object by replacing the replacement map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the replacement map

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableReplacements that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: replacement.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Replacements with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableReplacements copyOf(Template.Replacements instance)

Creates an immutable copy of a Template.Replacements value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Replacements instance

builder

public static ImmutableReplacements.Builder builder()

Creates a builder for ImmutableReplacements.

 ImmutableReplacements.builder()
    .putReplacement|putAllReplacement(String => String) // replacement mappings
    .build();
 

Specified by:

builder in interface Template.Replacements

Returns:

A new ImmutableReplacements builder