de.flapdoodle.os.common.attributes

Class ImmutableMappedTextFile<T>

java.lang.Object

de.flapdoodle.os.common.attributes.ImmutableMappedTextFile<T>

All Implemented Interfaces:

Attribute<T>, MappedTextFile<T>

public final class ImmutableMappedTextFile<T>
extends Object
implements MappedTextFile<T>

Immutable implementation of MappedTextFile.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableMappedTextFile.Builder<T> Builds instances of type ImmutableMappedTextFile.

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableMappedTextFile.Builder<T>	builder() Creates a builder for ImmutableMappedTextFile.
Charset	charset()
Function<String,T>	converter()
static <T> ImmutableMappedTextFile<T>	copyOf(MappedTextFile<T> instance) Creates an immutable copy of a MappedTextFile value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableMappedTextFile that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name, converter, charset.
String	name()
static <T> ImmutableMappedTextFile<T>	of(String name, Function<String,T> converter) Construct a new immutable MappedTextFile instance.
String	toString() Prints the immutable value MappedTextFile with attribute values.
ImmutableMappedTextFile<T>	withCharset(Charset value) Copy the current immutable object by setting a value for the charset attribute.
ImmutableMappedTextFile<T>	withConverter(Function<String,T> value) Copy the current immutable object by setting a value for the converter attribute.
ImmutableMappedTextFile<T>	withName(String value) Copy the current immutable object by setting a value for the name attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.os.common.attributes.MappedTextFile

any

Method Detail

name

public String name()

Specified by:

name in interface MappedTextFile<T>

Returns:

The value of the name attribute

converter

public Function<String,T> converter()

Specified by:

converter in interface MappedTextFile<T>

Returns:

The value of the converter attribute

charset

public Charset charset()

Specified by:

charset in interface MappedTextFile<T>

Returns:

The value of the charset attribute

withName

public final ImmutableMappedTextFile<T> withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withConverter

public final ImmutableMappedTextFile<T> withConverter(Function<String,T> value)

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

Parameters:

value - A new value for converter

Returns:

A modified copy of the this object

withCharset

public final ImmutableMappedTextFile<T> withCharset(Charset value)

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

Parameters:

value - A new value for charset

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableMappedTextFile 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: name, converter, charset.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MappedTextFile with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> ImmutableMappedTextFile<T> of(String name,
                                                Function<String,T> converter)

Construct a new immutable MappedTextFile instance.

Type Parameters:

T - generic parameter T

Parameters:

name - The value for the name attribute

converter - The value for the converter attribute

Returns:

An immutable MappedTextFile instance

copyOf

public static <T> ImmutableMappedTextFile<T> copyOf(MappedTextFile<T> instance)

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

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable MappedTextFile instance

builder

public static <T> ImmutableMappedTextFile.Builder<T> builder()

Creates a builder for ImmutableMappedTextFile.

 ImmutableMappedTextFile.<T>builder()
    .name(String) // required name
    .converter(function.Function<String, T>) // required converter
    .charset(java.nio.charset.Charset) // optional charset
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableMappedTextFile builder