ImmutableRecordings (Flapdoodle Testdoc 1.3.3 API)

java.lang.Object
- de.flapdoodle.testdoc.ImmutableRecordings

All Implemented Interfaces:

Recordings
```
@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableRecordings
extends Object
implements Recordings
```
Immutable implementation of Recordings.
Use the builder to create immutable instances: ImmutableRecordings.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableRecordings.Builder
Builds instances of type ImmutableRecordings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableRecordings.Builder` Builds instances of type `ImmutableRecordings`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableRecordings.Builder`	`builder()` Creates a builder for `ImmutableRecordings`.
`Map<String,String>`	`classes()`
`static ImmutableRecordings`	`copyOf(Recordings instance)` Creates an immutable copy of a `Recordings` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableRecordings` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `templateReference`, `linesOfCode`, `lines`, `methodsCalled`, `classes`, `resources`, `output`, `replacementNotFoundFallback`.
`List<HasLine>`	`lines()`
`List<String>`	`linesOfCode()`
`Map<String,CalledMethod>`	`methodsCalled()`
`Map<String,String>`	`output()`
`Optional<BiFunction<String,Set<String>,String>>`	`replacementNotFoundFallback()`
`Map<String,String>`	`resources()`
`TemplateReference`	`templateReference()`
`String`	`toString()` Prints the immutable value `Recordings` with attribute values.
`ImmutableRecordings`	`withClasses(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `classes` map with the specified map.
`ImmutableRecordings`	`withLines(HasLine... elements)` Copy the current immutable object with elements that replace the content of `lines`.
`ImmutableRecordings`	`withLines(Iterable<? extends HasLine> elements)` Copy the current immutable object with elements that replace the content of `lines`.
`ImmutableRecordings`	`withLinesOfCode(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `linesOfCode`.
`ImmutableRecordings`	`withLinesOfCode(String... elements)` Copy the current immutable object with elements that replace the content of `linesOfCode`.
`ImmutableRecordings`	`withMethodsCalled(Map<String,? extends CalledMethod> entries)` Copy the current immutable object by replacing the `methodsCalled` map with the specified map.
`ImmutableRecordings`	`withOutput(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `output` map with the specified map.
`ImmutableRecordings`	`withReplacementNotFoundFallback(BiFunction<String,Set<String>,String> value)` Copy the current immutable object by setting a present value for the optional `replacementNotFoundFallback` attribute.
`ImmutableRecordings`	`withReplacementNotFoundFallback(Optional<? extends BiFunction<String,Set<String>,String>> optional)` Copy the current immutable object by setting an optional value for the `replacementNotFoundFallback` attribute.
`ImmutableRecordings`	`withResources(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `resources` map with the specified map.
`ImmutableRecordings`	`withTemplateReference(TemplateReference value)` Copy the current immutable object by setting a value for the `templateReference` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - templateReference
```
public TemplateReference templateReference()
```
    Specified by:
    
    templateReference in interface Recordings
    
    Returns:
    
    The value of the templateReference attribute
  - linesOfCode
```
public List<String> linesOfCode()
```
    Specified by:
    
    linesOfCode in interface Recordings
    
    Returns:
    
    The value of the linesOfCode attribute
  - lines
```
public List<HasLine> lines()
```
    Specified by:
    
    lines in interface Recordings
    
    Returns:
    
    The value of the lines attribute
  - methodsCalled
```
public Map<String,CalledMethod> methodsCalled()
```
    Specified by:
    
    methodsCalled in interface Recordings
    
    Returns:
    
    The value of the methodsCalled attribute
  - classes
```
public Map<String,String> classes()
```
    Specified by:
    
    classes in interface Recordings
    
    Returns:
    
    The value of the classes attribute
  - resources
```
public Map<String,String> resources()
```
    Specified by:
    
    resources in interface Recordings
    
    Returns:
    
    The value of the resources attribute
  - output
```
public Map<String,String> output()
```
    Specified by:
    
    output in interface Recordings
    
    Returns:
    
    The value of the output attribute
  - replacementNotFoundFallback
```
public Optional<BiFunction<String,Set<String>,String>> replacementNotFoundFallback()
```
    Specified by:
    
    replacementNotFoundFallback in interface Recordings
    
    Returns:
    
    The value of the replacementNotFoundFallback attribute
  - withTemplateReference
```
public final ImmutableRecordings withTemplateReference(TemplateReference value)
```
    Copy the current immutable object by setting a value for the templateReference attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for templateReference
    
    Returns:
    
    A modified copy of the this object
  - withLinesOfCode
```
public final ImmutableRecordings withLinesOfCode(String... elements)
```
    Copy the current immutable object with elements that replace the content of linesOfCode.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withLinesOfCode
```
public final ImmutableRecordings withLinesOfCode(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of linesOfCode. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of linesOfCode elements to set
    
    Returns:
    
    A modified copy of this object
  - withLines
```
public final ImmutableRecordings withLines(HasLine... elements)
```
    Copy the current immutable object with elements that replace the content of lines.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withLines
```
public final ImmutableRecordings withLines(Iterable<? extends HasLine> elements)
```
    Copy the current immutable object with elements that replace the content of lines. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of lines elements to set
    
    Returns:
    
    A modified copy of this object
  - withMethodsCalled
```
public final ImmutableRecordings withMethodsCalled(Map<String,? extends CalledMethod> entries)
```
    Copy the current immutable object by replacing the methodsCalled 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 methodsCalled map
    
    Returns:
    
    A modified copy of this object
  - withClasses
```
public final ImmutableRecordings withClasses(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the classes 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 classes map
    
    Returns:
    
    A modified copy of this object
  - withResources
```
public final ImmutableRecordings withResources(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the resources 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 resources map
    
    Returns:
    
    A modified copy of this object
  - withOutput
```
public final ImmutableRecordings withOutput(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the output 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 output map
    
    Returns:
    
    A modified copy of this object
  - withReplacementNotFoundFallback
```
public final ImmutableRecordings withReplacementNotFoundFallback(BiFunction<String,Set<String>,String> value)
```
    Copy the current immutable object by setting a present value for the optional replacementNotFoundFallback attribute.
    
    Parameters:
    
    value - The value for replacementNotFoundFallback
    
    Returns:
    
    A modified copy of this object
  - withReplacementNotFoundFallback
```
public final ImmutableRecordings withReplacementNotFoundFallback(Optional<? extends BiFunction<String,Set<String>,String>> optional)
```
    Copy the current immutable object by setting an optional value for the replacementNotFoundFallback attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for replacementNotFoundFallback
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableRecordings 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: templateReference, linesOfCode, lines, methodsCalled, classes, resources, output, replacementNotFoundFallback.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value Recordings with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableRecordings copyOf(Recordings instance)
```
    Creates an immutable copy of a Recordings 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 Recordings instance
  - builder
```
public static ImmutableRecordings.Builder builder()
```
    Creates a builder for ImmutableRecordings.
```
 ImmutableRecordings.builder()
    .templateReference(de.flapdoodle.testdoc.TemplateReference) // required templateReference
    .addLinesOfCode|addAllLinesOfCode(String) // linesOfCode elements
    .addLines|addAllLines(de.flapdoodle.testdoc.HasLine) // lines elements
    .putMethodsCalled|putAllMethodsCalled(String => de.flapdoodle.testdoc.CalledMethod) // methodsCalled mappings
    .putClasses|putAllClasses(String => String) // classes mappings
    .putResources|putAllResources(String => String) // resources mappings
    .putOutput|putAllOutput(String => String) // output mappings
    .replacementNotFoundFallback(function.BiFunction&lt;String, Set&lt;String&gt;, String&gt;) // optional replacementNotFoundFallback
    .build();
 
```
    Specified by:
    
    builder in interface Recordings
    
    Returns:
    
    A new ImmutableRecordings builder

Class ImmutableRecordings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

templateReference

linesOfCode

lines

methodsCalled

classes

resources

output

replacementNotFoundFallback

withTemplateReference

withLinesOfCode

withLinesOfCode

withLines

withLines

withMethodsCalled

withClasses

withResources

withOutput

withReplacementNotFoundFallback

withReplacementNotFoundFallback

equals

hashCode

toString

copyOf

builder