Package com.petrolpark.core.scratch.argument

Record Class ExpressionOrLiteralArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

java.lang.Object

java.lang.Record

com.petrolpark.core.scratch.argument.ExpressionOrLiteralArgument<ENVIRONMENT,TYPE>

All Implemented Interfaces:

IScratchArgument<ENVIRONMENT,TYPE>, IScratchContextHolder

public record ExpressionOrLiteralArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>(TYPE value, Optional<ExpressionArgument<ENVIRONMENT extends IScratchEnvironment,TYPE,?>> expression, ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT extends IScratchEnvironment,TYPE> parameter)
extends Record
implements IScratchArgument<ENVIRONMENT,TYPE>, IScratchContextHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT extends IScratchEnvironment,TYPE>

Constructor Summary

Constructors

Constructor	Description
ExpressionOrLiteralArgument(TYPE value, Optional<ExpressionArgument<ENVIRONMENT,TYPE,?>> expression, ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,TYPE> parameter)	Creates an instance of a ExpressionOrLiteralArgument record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<ExpressionArgument<ENVIRONMENT,TYPE,?>>	expression()	Returns the value of the expression record component.
TYPE	get(ENVIRONMENT environment)
final int	hashCode()	Returns a hash code value for this object.
static <ENVIRONMENT extends IScratchEnvironment> ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,Long>	integerParameter(String key)
ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,TYPE>	parameter()	Returns the value of the parameter record component.
<CONTEXT extends IScratchContext<CONTEXT>> void	populateContext(IScratchContextProvider<CONTEXT> contextProvider, CONTEXT context)
static <ENVIRONMENT extends IScratchEnvironment> ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,Double>	realParameter(String key)
static <ENVIRONMENT extends IScratchEnvironment> ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,String>	stringParameter(String key)
final String	toString()	Returns a string representation of this record class.
TYPE	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ExpressionOrLiteralArgument

public ExpressionOrLiteralArgument(TYPE value,
 Optional<ExpressionArgument<ENVIRONMENT,TYPE,?>> expression,
 ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,TYPE> parameter)

Creates an instance of a ExpressionOrLiteralArgument record class.

Parameters:

value - the value for the value record component

expression - the value for the expression record component

parameter - the value for the parameter record component

Method Details

integerParameter

public static <ENVIRONMENT extends IScratchEnvironment>
ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,Long> integerParameter(String key)

realParameter

public static <ENVIRONMENT extends IScratchEnvironment>
ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,Double> realParameter(String key)

stringParameter

public static <ENVIRONMENT extends IScratchEnvironment>
ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,String> stringParameter(String key)

get

public TYPE get(ENVIRONMENT environment)

Specified by:

get in interface IScratchArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

populateContext

public <CONTEXT extends IScratchContext<CONTEXT>>
void populateContext(IScratchContextProvider<CONTEXT> contextProvider,
 CONTEXT context)

Specified by:

populateContext in interface IScratchContextHolder

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

value

public TYPE value()

Returns the value of the value record component.

Returns:

the value of the value record component

expression

public Optional<ExpressionArgument<ENVIRONMENT,TYPE,?>> expression()

Returns the value of the expression record component.

Returns:

the value of the expression record component

parameter

public ExpressionOrLiteralArgument.ExpressionOrLiteralParameter<ENVIRONMENT,TYPE> parameter()

Returns the value of the parameter record component.

Specified by:

parameter in interface IScratchArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

Returns:

the value of the parameter record component