de.flapdoodle.embed.process.io.directories

Class ImmutablePersistentDir

java.lang.Object

de.flapdoodle.embed.process.types.Wrapper<Path>

de.flapdoodle.embed.process.io.directories.PersistentDir

de.flapdoodle.embed.process.io.directories.ImmutablePersistentDir

public final class ImmutablePersistentDir
extends PersistentDir

Immutable implementation of PersistentDir.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutablePersistentDir.Builder	builder() Creates a builder for ImmutablePersistentDir.
static ImmutablePersistentDir	copyOf(PersistentDir instance) Creates an immutable copy of a PersistentDir value.
boolean	equals(Object another) This instance is equal to all instances of ImmutablePersistentDir that have equal attribute values.
int	hashCode() Computes a hash code from attributes: value.
static ImmutablePersistentDir	of(Path value) Construct a new immutable PersistentDir instance.
Path	value()
ImmutablePersistentDir	withValue(Path value) Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class de.flapdoodle.embed.process.io.directories.PersistentDir

userHome, userHome

Methods inherited from class de.flapdoodle.embed.process.types.Wrapper

toString

Methods inherited from class java.lang.Object

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

Method Detail

value

public Path value()

Specified by:

value in class Wrapper<Path>

Returns:

The value of the value attribute

withValue

public final ImmutablePersistentDir withValue(Path value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutablePersistentDir 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: value.

Overrides:

hashCode in class Object

Returns:

hashCode value

of

public static ImmutablePersistentDir of(Path value)

Construct a new immutable PersistentDir instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable PersistentDir instance

copyOf

public static ImmutablePersistentDir copyOf(PersistentDir instance)

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

builder

public static ImmutablePersistentDir.Builder builder()

Creates a builder for ImmutablePersistentDir.

 ImmutablePersistentDir.builder()
    .value(java.nio.file.Path) // required value
    .build();
 

Returns:

A new ImmutablePersistentDir builder