de.flapdoodle.formula.solver

Class ImmutableContext

java.lang.Object

de.flapdoodle.formula.solver.Context

de.flapdoodle.formula.solver.ImmutableContext

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableContext
extends Context

Immutable implementation of Context.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableContext.Builder	builder() Creates a builder for ImmutableContext.
static ImmutableContext	copyOf(Context instance) Creates an immutable copy of a Context value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableContext that have equal attribute values.
int	hashCode() Computes a hash code from attributes: unvalidated, validatedValues, validationErrorMap.
String	toString() Prints the immutable value Context with attribute values.
protected ValueContainer	unvalidated()
protected ValueContainer	validatedValues()
protected com.google.common.collect.ImmutableMap<Value<?>,ValidationError>	validationErrorMap()
ImmutableContext	withUnvalidated(ValueContainer value) Copy the current immutable object by setting a value for the unvalidated attribute.
ImmutableContext	withValidatedValues(ValueContainer value) Copy the current immutable object by setting a value for the validatedValues attribute.
ImmutableContext	withValidationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries) Copy the current immutable object by replacing the validationErrorMap map with the specified map.

Methods inherited from class de.flapdoodle.formula.solver.Context

add, addIfNotExist, addIfNotExist, addInvalid, addUnvalidated, asResult, check, empty, getUnvalidated, getValidated, isInvalid, isValid, validationError

Methods inherited from class java.lang.Object

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

Method Detail

unvalidated

protected ValueContainer unvalidated()

Overrides:

unvalidated in class Context

Returns:

The value of the unvalidated attribute

validatedValues

protected ValueContainer validatedValues()

Overrides:

validatedValues in class Context

Returns:

The value of the validatedValues attribute

validationErrorMap

protected com.google.common.collect.ImmutableMap<Value<?>,ValidationError> validationErrorMap()

Specified by:

validationErrorMap in class Context

Returns:

The value of the validationErrorMap attribute

withUnvalidated

public final ImmutableContext withUnvalidated(ValueContainer value)

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

Parameters:

value - A new value for unvalidated

Returns:

A modified copy of the this object

withValidatedValues

public final ImmutableContext withValidatedValues(ValueContainer value)

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

Parameters:

value - A new value for validatedValues

Returns:

A modified copy of the this object

withValidationErrorMap

public final ImmutableContext withValidationErrorMap(Map<? extends Value<?>,? extends ValidationError> entries)

Copy the current immutable object by replacing the validationErrorMap map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the validationErrorMap map

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableContext 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: unvalidated, validatedValues, validationErrorMap.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Context with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableContext copyOf(Context instance)

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

builder

public static ImmutableContext.Builder builder()

Creates a builder for ImmutableContext.

 ImmutableContext.builder()
    .unvalidated(de.flapdoodle.formula.ValueContainer) // optional unvalidated
    .validatedValues(de.flapdoodle.formula.ValueContainer) // optional validatedValues
    .putValidationErrorMap|putAllValidationErrorMap(de.flapdoodle.formula.Value<?> => de.flapdoodle.formula.validation.ValidationError) // validationErrorMap mappings
    .build();
 

Returns:

A new ImmutableContext builder