de.flapdoodle.eval.core.evaluables

Class ImmutableParameter<T>

java.lang.Object

de.flapdoodle.eval.core.evaluables.ImmutableParameter<T>

All Implemented Interfaces:

Parameter<T>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableParameter<T>
extends Object
implements Parameter<T>

Immutable implementation of Parameter.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableParameter.Builder<T>	builder() Creates a builder for ImmutableParameter.
static <T> ImmutableParameter<T>	copyOf(Parameter<T> instance) Creates an immutable copy of a Parameter value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableParameter that have equal attribute values.
int	hashCode() Computes a hash code from attributes: type, isLazy, validators.
boolean	isLazy() Set to true, the parameter will not be evaluated in advance, but the corresponding ASTNode will be passed as a parameter value.
static <T> ImmutableParameter<T>	of(de.flapdoodle.reflection.TypeInfo<T> type) Construct a new immutable Parameter instance.
String	toString() Prints the immutable value Parameter with attribute values.
de.flapdoodle.reflection.TypeInfo<T>	type()
List<ParameterValidator<T>>	validators()
ImmutableParameter<T>	withIsLazy(boolean value) Copy the current immutable object by setting a value for the isLazy attribute.
ImmutableParameter<T>	withType(de.flapdoodle.reflection.TypeInfo<T> value) Copy the current immutable object by setting a value for the type attribute.
ImmutableParameter<T>	withValidators(Iterable<? extends ParameterValidator<T>> elements) Copy the current immutable object with elements that replace the content of validators.
ImmutableParameter<T>	withValidators(ParameterValidator<T>... elements) Copy the current immutable object with elements that replace the content of validators.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.eval.core.evaluables.Parameter

lazyWith, lazyWith, of, validate, validationError

Method Detail

type

public de.flapdoodle.reflection.TypeInfo<T> type()

Specified by:

type in interface Parameter<T>

Returns:

The value of the type attribute

isLazy

public boolean isLazy()

Set to true, the parameter will not be evaluated in advance, but the corresponding ASTNode will be passed as a parameter value.

Specified by:

isLazy in interface Parameter<T>

validators

public List<ParameterValidator<T>> validators()

Specified by:

validators in interface Parameter<T>

Returns:

The value of the validators attribute

withType

public final ImmutableParameter<T> withType(de.flapdoodle.reflection.TypeInfo<T> value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

withIsLazy

public final ImmutableParameter<T> withIsLazy(boolean value)

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

Parameters:

value - A new value for isLazy

Returns:

A modified copy of the this object

withValidators

@SafeVarargs
public final ImmutableParameter<T> withValidators(ParameterValidator<T>... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withValidators

public final ImmutableParameter<T> withValidators(Iterable<? extends ParameterValidator<T>> elements)

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

Parameters:

elements - An iterable of validators elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableParameter 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: type, isLazy, validators.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Parameter with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <T> ImmutableParameter<T> of(de.flapdoodle.reflection.TypeInfo<T> type)

Construct a new immutable Parameter instance.

Specified by:

of in interface Parameter<T>

Type Parameters:

T - generic parameter T

Parameters:

type - The value for the type attribute

Returns:

An immutable Parameter instance

copyOf

public static <T> ImmutableParameter<T> copyOf(Parameter<T> instance)

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

builder

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

Creates a builder for ImmutableParameter.

 ImmutableParameter.<T>builder()
    .type(de.flapdoodle.reflection.TypeInfo<T>) // required type
    .isLazy(boolean) // optional isLazy
    .addValidators|addAllValidators(de.flapdoodle.eval.core.validation.ParameterValidator<T>) // validators elements
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableParameter builder