de.flapdoodle.formula.validation

Class ImmutableValidatedValue<T>

java.lang.Object

de.flapdoodle.formula.validation.ValidatedValue<T>

de.flapdoodle.formula.validation.ImmutableValidatedValue<T>

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableValidatedValue<T>
extends ValidatedValue<T>

Immutable implementation of ValidatedValue.

Use the builder to create immutable instances: ImmutableValidatedValue.builder().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableValidatedValue.Builder<T>	builder(ValueSource<T> source) Creates a builder for ImmutableValidatedValue.
static <T> ImmutableValidatedValue<T>	copyOf(ValidatedValue<T> instance) Creates an immutable copy of a ValidatedValue value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableValidatedValue that have equal attribute values.
List<ErrorMessage>	errors() Returns a lazily initialized value of the errors attribute.
int	hashCode() Computes a hash code from attributes: source, valueOrError.
Set<? extends ValueSource<?>>	invalidReferences() Returns a lazily initialized value of the invalidReferences attribute.
boolean	isValid() Returns a lazily initialized value of the isValid attribute.
ValueSource<T>	source()
String	toString() Prints the immutable value ValidatedValue with attribute values.
T	value() Returns a lazily initialized value of the value attribute.
de.flapdoodle.types.Either<T,ValidationError>	valueOrError()
ImmutableValidatedValue<T>	withSource(ValueSource<T> value) Copy the current immutable object by setting a value for the source attribute.
ImmutableValidatedValue<T>	withValueOrError(de.flapdoodle.types.Either<T,ValidationError> value) Copy the current immutable object by setting a value for the valueOrError attribute.

Methods inherited from class de.flapdoodle.formula.validation.ValidatedValue

of, of, of

Methods inherited from class java.lang.Object

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

Method Detail

source

public ValueSource<T> source()

Specified by:

source in class ValidatedValue<T>

Returns:

The value of the source attribute

valueOrError

public de.flapdoodle.types.Either<T,ValidationError> valueOrError()

Specified by:

valueOrError in class ValidatedValue<T>

Returns:

The value of the valueOrError attribute

withSource

public final ImmutableValidatedValue<T> withSource(ValueSource<T> value)

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

Parameters:

value - A new value for source

Returns:

A modified copy of the this object

withValueOrError

public final ImmutableValidatedValue<T> withValueOrError(de.flapdoodle.types.Either<T,ValidationError> value)

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

Parameters:

value - A new value for valueOrError

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableValidatedValue 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: source, valueOrError.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ValidatedValue with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

isValid

public boolean isValid()

Returns a lazily initialized value of the isValid 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.

Overrides:

isValid in class ValidatedValue<T>

Returns:

A lazily initialized value of the isValid attribute

errors

public List<ErrorMessage> errors()

Returns a lazily initialized value of the errors 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.

Overrides:

errors in class ValidatedValue<T>

Returns:

A lazily initialized value of the errors attribute

value

public T value()

Returns a lazily initialized value of the value 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.

Overrides:

value in class ValidatedValue<T>

Returns:

A lazily initialized value of the value attribute

invalidReferences

public Set<? extends ValueSource<?>> invalidReferences()

Returns a lazily initialized value of the invalidReferences 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.

Overrides:

invalidReferences in class ValidatedValue<T>

Returns:

A lazily initialized value of the invalidReferences attribute

copyOf

public static <T> ImmutableValidatedValue<T> copyOf(ValidatedValue<T> instance)

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

builder

public static <T> ImmutableValidatedValue.Builder<T> builder(ValueSource<T> source)

Creates a builder for ImmutableValidatedValue.

 ImmutableValidatedValue.<T>builder()
    .source(de.flapdoodle.formula.ValueSource<T>) // required source
    .valueOrError(de.flapdoodle.types.Either<T, de.flapdoodle.formula.validation.ValidationError>) // required valueOrError
    .build();
 

Type Parameters:

T - generic parameter T

Parameters:

source - source parameter

Returns:

A new ImmutableValidatedValue builder