de.flapdoodle.testdoc

Class ImmutableTemplateReference

java.lang.Object

de.flapdoodle.testdoc.ImmutableTemplateReference

All Implemented Interfaces:

TemplateReference

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableTemplateReference
extends Object
implements TemplateReference

Immutable implementation of TemplateReference.

Use the builder to create immutable instances: ImmutableTemplateReference.builder(). Use the static factory method to create immutable instances: ImmutableTemplateReference.of().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableTemplateReference.Builder	builder() Creates a builder for ImmutableTemplateReference.
Class<?>	clazz()
static ImmutableTemplateReference	copyOf(TemplateReference instance) Creates an immutable copy of a TemplateReference value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableTemplateReference that have equal attribute values.
int	hashCode() Computes a hash code from attributes: clazz, templateName, replacementPattern.
static ImmutableTemplateReference	of(Class<?> clazz, String templateName) Construct a new immutable TemplateReference instance.
Optional<String>	readContent() Returns a lazily initialized value of the readContent attribute.
ReplacementPattern	replacementPattern()
String	templateName()
String	toString() Prints the immutable value TemplateReference with attribute values.
ImmutableTemplateReference	withClazz(Class<?> value) Copy the current immutable object by setting a value for the clazz attribute.
ImmutableTemplateReference	withReplacementPattern(ReplacementPattern value) Copy the current immutable object by setting a value for the replacementPattern attribute.
ImmutableTemplateReference	withTemplateName(String value) Copy the current immutable object by setting a value for the templateName attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.testdoc.TemplateReference

of, readContent

Method Detail

clazz

public Class<?> clazz()

Specified by:

clazz in interface TemplateReference

Returns:

The value of the clazz attribute

templateName

public String templateName()

Specified by:

templateName in interface TemplateReference

Returns:

The value of the templateName attribute

replacementPattern

public ReplacementPattern replacementPattern()

Specified by:

replacementPattern in interface TemplateReference

Returns:

The value of the replacementPattern attribute

withClazz

public final ImmutableTemplateReference withClazz(Class<?> value)

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

Parameters:

value - A new value for clazz

Returns:

A modified copy of the this object

withTemplateName

public final ImmutableTemplateReference withTemplateName(String value)

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

Parameters:

value - A new value for templateName

Returns:

A modified copy of the this object

withReplacementPattern

public final ImmutableTemplateReference withReplacementPattern(ReplacementPattern value)

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

Parameters:

value - A new value for replacementPattern

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableTemplateReference 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: clazz, templateName, replacementPattern.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value TemplateReference with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

readContent

public Optional<String> readContent()

Returns a lazily initialized value of the readContent attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

readContent in interface TemplateReference

Returns:

A lazily initialized value of the readContent attribute

of

public static ImmutableTemplateReference of(Class<?> clazz,
                                            String templateName)

Construct a new immutable TemplateReference instance.

Specified by:

of in interface TemplateReference

Parameters:

clazz - The value for the clazz attribute

templateName - The value for the templateName attribute

Returns:

An immutable TemplateReference instance

copyOf

public static ImmutableTemplateReference copyOf(TemplateReference instance)

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

builder

public static ImmutableTemplateReference.Builder builder()

Creates a builder for ImmutableTemplateReference.

 ImmutableTemplateReference.builder()
    .clazz(Class<?>) // required clazz
    .templateName(String) // required templateName
    .replacementPattern(de.flapdoodle.testdoc.ReplacementPattern) // optional replacementPattern
    .build();
 

Returns:

A new ImmutableTemplateReference builder