de.flapdoodle.types

Class ImmutableSome<T>

java.lang.Object

de.flapdoodle.types.Maybe<T>

de.flapdoodle.types.Maybe.Some<T>

de.flapdoodle.types.ImmutableSome<T>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableSome<T>
extends Maybe.Some<T>

Immutable implementation of Maybe.Some.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class de.flapdoodle.types.Maybe

Maybe.None<T>, Maybe.Some<T>

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableSome.Builder<T>	builder() Creates a builder for ImmutableSome.
static <T> ImmutableSome<T>	copyOf(Maybe.Some<T> instance) Creates an immutable copy of a Maybe.Some value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableSome that have equal attribute values.
int	hashCode() Computes a hash code from attributes: value.
static <T> ImmutableSome<T>	of(T value) Construct a new immutable Some instance.
String	toString() Prints the immutable value Some with attribute values.
protected T	value()
ImmutableSome<T>	withValue(T value) Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class de.flapdoodle.types.Maybe.Some

get, hasSome, map

Methods inherited from class de.flapdoodle.types.Maybe

getOrThrow, none, some

Methods inherited from class java.lang.Object

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

Method Detail

value

@Nullable
protected T value()

Specified by:

value in class Maybe.Some<T>

Returns:

The value of the value attribute

withValue

public final ImmutableSome<T> withValue(@Nullable
                                        T 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 (can be null)

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableSome 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

toString

public String toString()

Prints the immutable value Some with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> ImmutableSome<T> of(@Nullable
                                      T value)

Construct a new immutable Some instance.

Type Parameters:

T - generic parameter T

Parameters:

value - The value for the value attribute

Returns:

An immutable Some instance

copyOf

public static <T> ImmutableSome<T> copyOf(Maybe.Some<T> instance)

Creates an immutable copy of a Maybe.Some 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 Some instance

builder

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

Creates a builder for ImmutableSome.

 ImmutableSome.<T>builder()
    .value(T | null) // nullable value
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableSome builder