de.flapdoodle.formula.validation

Class ImmutableValidationError

java.lang.Object

de.flapdoodle.formula.validation.ImmutableValidationError

All Implemented Interfaces:

ValidationError

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableValidationError
extends Object
implements ValidationError

Immutable implementation of ValidationError.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableValidationError.Builder	builder() Creates a builder for ImmutableValidationError.
static ImmutableValidationError	copyOf(ValidationError instance) Creates an immutable copy of a ValidationError value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableValidationError that have equal attribute values.
com.google.common.collect.ImmutableList<ErrorMessage>	errorMessages()
int	hashCode() Computes a hash code from attributes: errorMessages, invalidReferences.
com.google.common.collect.ImmutableSet<ValueSource<?>>	invalidReferences()
static ImmutableValidationError	of(Iterable<? extends ErrorMessage> errorMessages, Iterable<? extends ValueSource<?>> invalidReferences) Construct a new immutable ValidationError instance.
static ImmutableValidationError	of(List<ErrorMessage> errorMessages, Set<ValueSource<?>> invalidReferences) Construct a new immutable ValidationError instance.
String	toString() Prints the immutable value ValidationError with attribute values.
ImmutableValidationError	withErrorMessages(ErrorMessage... elements) Copy the current immutable object with elements that replace the content of errorMessages.
ImmutableValidationError	withErrorMessages(Iterable<? extends ErrorMessage> elements) Copy the current immutable object with elements that replace the content of errorMessages.
ImmutableValidationError	withInvalidReferences(Iterable<? extends ValueSource<?>> elements) Copy the current immutable object with elements that replace the content of invalidReferences.
ImmutableValidationError	withInvalidReferences(ValueSource<?>... elements) Copy the current immutable object with elements that replace the content of invalidReferences.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.formula.validation.ValidationError

of

Method Detail

errorMessages

public com.google.common.collect.ImmutableList<ErrorMessage> errorMessages()

Specified by:

errorMessages in interface ValidationError

Returns:

The value of the errorMessages attribute

invalidReferences

public com.google.common.collect.ImmutableSet<ValueSource<?>> invalidReferences()

Specified by:

invalidReferences in interface ValidationError

Returns:

The value of the invalidReferences attribute

withErrorMessages

public final ImmutableValidationError withErrorMessages(ErrorMessage... elements)

Copy the current immutable object with elements that replace the content of errorMessages.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withErrorMessages

public final ImmutableValidationError withErrorMessages(Iterable<? extends ErrorMessage> elements)

Copy the current immutable object with elements that replace the content of errorMessages. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of errorMessages elements to set

Returns:

A modified copy of this object

withInvalidReferences

@SafeVarargs
public final ImmutableValidationError withInvalidReferences(ValueSource<?>... elements)

Copy the current immutable object with elements that replace the content of invalidReferences.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withInvalidReferences

public final ImmutableValidationError withInvalidReferences(Iterable<? extends ValueSource<?>> elements)

Copy the current immutable object with elements that replace the content of invalidReferences. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of invalidReferences elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableValidationError 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: errorMessages, invalidReferences.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ValidationError with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableValidationError of(List<ErrorMessage> errorMessages,
                                          Set<ValueSource<?>> invalidReferences)

Construct a new immutable ValidationError instance.

Parameters:

errorMessages - The value for the errorMessages attribute

invalidReferences - The value for the invalidReferences attribute

Returns:

An immutable ValidationError instance

of

public static ImmutableValidationError of(Iterable<? extends ErrorMessage> errorMessages,
                                          Iterable<? extends ValueSource<?>> invalidReferences)

Construct a new immutable ValidationError instance.

Parameters:

errorMessages - The value for the errorMessages attribute

invalidReferences - The value for the invalidReferences attribute

Returns:

An immutable ValidationError instance

copyOf

public static ImmutableValidationError copyOf(ValidationError instance)

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

builder

public static ImmutableValidationError.Builder builder()

Creates a builder for ImmutableValidationError.

 ImmutableValidationError.builder()
    .addErrorMessages|addAllErrorMessages(de.flapdoodle.formula.validation.ErrorMessage) // errorMessages elements
    .addInvalidReferences|addAllInvalidReferences(de.flapdoodle.formula.ValueSource<?>) // invalidReferences elements
    .build();
 

Returns:

A new ImmutableValidationError builder