Package io.dialob.rule.parser.api

Class ImmutableVariableFinder.Variable

java.lang.Object

io.dialob.rule.parser.api.ImmutableVariableFinder.Variable

All Implemented Interfaces:

VariableFinder.Var, VariableFinder.Variable

Enclosing class:

ImmutableVariableFinder

@Immutable
@CheckReturnValue
public static final class ImmutableVariableFinder.Variable
extends Object
implements VariableFinder.Variable

Immutable implementation of VariableFinder.Variable.

Use the builder to create immutable instances: ImmutableVariableFinder.Variable.builder().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableVariableFinder.Variable.Builder	builder()	Creates a builder for Variable.
static ImmutableVariableFinder.Variable	copyOf(VariableFinder.Variable instance)	Creates an immutable copy of a VariableFinder.Variable value.
boolean	equals(Object another)	This instance is equal to all instances of Variable that have equal attribute values.
String	getName()
Optional<Object>	getPlaceHolderValue()
Optional<String>	getScope()
Optional<String>	getValueSetId()
ValueType	getValueType()
int	hashCode()	Computes a hash code from attributes: name, valueType, scope, placeHolderValue, valueSetId.
String	toString()	Prints the immutable value Variable with attribute values.
ImmutableVariableFinder.Variable	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableVariableFinder.Variable	withPlaceHolderValue(Object value)	Copy the current immutable object by setting a present value for the optional placeHolderValue attribute.
ImmutableVariableFinder.Variable	withPlaceHolderValue(Optional<? extends Object> optional)	Copy the current immutable object by setting an optional value for the placeHolderValue attribute.
ImmutableVariableFinder.Variable	withScope(String value)	Copy the current immutable object by setting a present value for the optional scope attribute.
ImmutableVariableFinder.Variable	withScope(Optional<String> optional)	Copy the current immutable object by setting an optional value for the scope attribute.
ImmutableVariableFinder.Variable	withValueSetId(String value)	Copy the current immutable object by setting a present value for the optional valueSetId attribute.
ImmutableVariableFinder.Variable	withValueSetId(Optional<String> optional)	Copy the current immutable object by setting an optional value for the valueSetId attribute.
ImmutableVariableFinder.Variable	withValueType(ValueType value)	Copy the current immutable object by setting a value for the valueType attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Specified by:

getName in interface VariableFinder.Var

Returns:

The value of the name attribute

getValueType

public ValueType getValueType()

Specified by:

getValueType in interface VariableFinder.Var

Returns:

The value of the valueType attribute

getScope

public Optional<String> getScope()

Specified by:

getScope in interface VariableFinder.Variable

Returns:

The value of the scope attribute

getPlaceHolderValue

public Optional<Object> getPlaceHolderValue()

Specified by:

getPlaceHolderValue in interface VariableFinder.Variable

Returns:

The value of the placeHolderValue attribute

getValueSetId

public Optional<String> getValueSetId()

Specified by:

getValueSetId in interface VariableFinder.Variable

Returns:

The value of the valueSetId attribute

withName

public final ImmutableVariableFinder.Variable withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withValueType

public final ImmutableVariableFinder.Variable withValueType(ValueType value)

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

Parameters:

value - A new value for valueType

Returns:

A modified copy of the this object

withScope

public final ImmutableVariableFinder.Variable withScope(String value)

Copy the current immutable object by setting a present value for the optional scope attribute.

Parameters:

value - The value for scope

Returns:

A modified copy of this object

withScope

public final ImmutableVariableFinder.Variable withScope(Optional<String> optional)

Copy the current immutable object by setting an optional value for the scope attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for scope

Returns:

A modified copy of this object

withPlaceHolderValue

public final ImmutableVariableFinder.Variable withPlaceHolderValue(Object value)

Copy the current immutable object by setting a present value for the optional placeHolderValue attribute.

Parameters:

value - The value for placeHolderValue

Returns:

A modified copy of this object

withPlaceHolderValue

public final ImmutableVariableFinder.Variable withPlaceHolderValue(Optional<? extends Object> optional)

Copy the current immutable object by setting an optional value for the placeHolderValue attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - A value for placeHolderValue

Returns:

A modified copy of this object

withValueSetId

public final ImmutableVariableFinder.Variable withValueSetId(String value)

Copy the current immutable object by setting a present value for the optional valueSetId attribute.

Parameters:

value - The value for valueSetId

Returns:

A modified copy of this object

withValueSetId

public final ImmutableVariableFinder.Variable withValueSetId(Optional<String> optional)

Copy the current immutable object by setting an optional value for the valueSetId attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for valueSetId

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of Variable 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: name, valueType, scope, placeHolderValue, valueSetId.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Variable with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableVariableFinder.Variable copyOf(VariableFinder.Variable instance)

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

builder

public static ImmutableVariableFinder.Variable.Builder builder()

Creates a builder for Variable.

 ImmutableVariableFinder.Variable.builder()
    .name(String) // required name
    .valueType(io.dialob.rule.parser.api.ValueType) // required valueType
    .scope(String) // optional scope
    .placeHolderValue(Object) // optional placeHolderValue
    .valueSetId(String) // optional valueSetId
    .build();
 

Returns:

A new Variable builder