de.flapdoodle.os.common.attributes

Class ImmutableTextFile

java.lang.Object

de.flapdoodle.os.common.attributes.ImmutableTextFile

All Implemented Interfaces:

Attribute<String>, TextFile

public final class ImmutableTextFile
extends Object
implements TextFile

Immutable implementation of TextFile.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

any

Method Detail

name

public String name()

Specified by:

name in interface TextFile

Returns:

The value of the name attribute

charset

public Charset charset()

Specified by:

charset in interface TextFile

Returns:

The value of the charset attribute

withName

public final ImmutableTextFile 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

withCharset

public final ImmutableTextFile 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 ImmutableTextFile 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, charset.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value TextFile with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableTextFile of(String name)

Construct a new immutable TextFile instance.

Parameters:

name - The value for the name attribute

Returns:

An immutable TextFile instance

copyOf

public static ImmutableTextFile copyOf(TextFile instance)

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

builder

public static ImmutableTextFile.Builder builder()

Creates a builder for ImmutableTextFile.

 ImmutableTextFile.builder()
    .name(String) // required name
    .charset(java.nio.charset.Charset) // optional charset
    .build();
 

Returns:

A new ImmutableTextFile builder