de.flapdoodle.testdoc

Class ImmutableTemplate

java.lang.Object

de.flapdoodle.testdoc.Template

de.flapdoodle.testdoc.ImmutableTemplate

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableTemplate
extends Template

Immutable implementation of Template.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableTemplate.Builder	builder() Creates a builder for ImmutableTemplate.
static ImmutableTemplate	copyOf(Template instance) Creates an immutable copy of a Template value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableTemplate that have equal attribute values.
int	hashCode() Computes a hash code from attributes: source, pattern.
ReplacementPattern	pattern()
String	source()
String	toString() Prints the immutable value Template with attribute values.
ImmutableTemplate	withPattern(ReplacementPattern value) Copy the current immutable object by setting a value for the pattern attribute.
ImmutableTemplate	withSource(String value) Copy the current immutable object by setting a value for the source attribute.

Methods inherited from class de.flapdoodle.testdoc.Template

of, of, render, render, render

Methods inherited from class java.lang.Object

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

Method Detail

source

public String source()

Specified by:

source in class Template

Returns:

The value of the source attribute

pattern

public ReplacementPattern pattern()

Overrides:

pattern in class Template

Returns:

The value of the pattern attribute

withSource

public final ImmutableTemplate withSource(String value)

Copy the current immutable object by setting a value for the source attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for source

Returns:

A modified copy of the this object

withPattern

public final ImmutableTemplate withPattern(ReplacementPattern value)

Copy the current immutable object by setting a value for the pattern attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for pattern

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableTemplate 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: source, pattern.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Template with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableTemplate copyOf(Template instance)

Creates an immutable copy of a Template 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 Template instance

builder

public static ImmutableTemplate.Builder builder()

Creates a builder for ImmutableTemplate.

 ImmutableTemplate.builder()
    .source(String) // required source
    .pattern(de.flapdoodle.testdoc.ReplacementPattern) // optional pattern
    .build();
 

Returns:

A new ImmutableTemplate builder