Package com.petrolpark.core.scratch.argument

Record Class ExpressionArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

IScratchArgument<ENVIRONMENT,TYPE>, IScratchContextHolder

public record ExpressionArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>(ExpressionAndArguments<? super ENVIRONMENT extends IScratchEnvironment,TYPE,?> expressionAndArguments, ExpressionArgument.ExpressionParameter<? super 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	ExpressionArgument.ExpressionParameter<ENVIRONMENT extends IScratchEnvironment,TYPE>

Constructor Summary

Constructors

Constructor	Description
ExpressionArgument(ExpressionAndArguments<? super ENVIRONMENT,TYPE,?> expressionAndArguments, ExpressionArgument.ExpressionParameter<? super ENVIRONMENT,TYPE> parameter)	Creates an instance of a ExpressionArgument record class.

Method Summary

Modifier and Type	Method	Description
boolean	canEvaluate()	Whether this Argument can evaluate without crashing.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ExpressionAndArguments<? super ENVIRONMENT,TYPE,?>	expressionAndArguments()	Returns the value of the expressionAndArguments record component.
TYPE	get(ENVIRONMENT environment)
final int	hashCode()	Returns a hash code value for this object.
static final <TYPE> ExpressionArgument.ExpressionParameter<IScratchEnvironment,List<TYPE>>	listParameter(String key, IScratchClass<TYPE,?> scratchClass)
ExpressionArgument.ExpressionParameter<? super ENVIRONMENT,TYPE>	parameter()	Returns the value of the parameter record component.
static final <ENVIRONMENT extends IScratchEnvironment, TYPE> ExpressionArgument.ExpressionParameter<ENVIRONMENT,TYPE>	parameter(String key, IScratchClass<TYPE,?> scratchClass)
<CONTEXT extends IScratchContext<CONTEXT>> void	populateContext(IScratchContextProvider<CONTEXT> contextProvider, CONTEXT context)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ExpressionArgument

public ExpressionArgument(ExpressionAndArguments<? super ENVIRONMENT,TYPE,?> expressionAndArguments,
 ExpressionArgument.ExpressionParameter<? super ENVIRONMENT,TYPE> parameter)

Creates an instance of a ExpressionArgument record class.

Parameters:

expressionAndArguments - the value for the expressionAndArguments record component

parameter - the value for the parameter record component

Method Details

parameter

public static final <ENVIRONMENT extends IScratchEnvironment,
TYPE>
ExpressionArgument.ExpressionParameter<ENVIRONMENT,TYPE> parameter(String key,
 IScratchClass<TYPE,?> scratchClass)

listParameter

public static final <TYPE>
ExpressionArgument.ExpressionParameter<IScratchEnvironment,List<TYPE>> listParameter(String key,
 IScratchClass<TYPE,?> scratchClass)

get

public TYPE get(ENVIRONMENT environment)

Specified by:

get in interface IScratchArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

canEvaluate

public boolean canEvaluate()

Description copied from interface: IScratchArgument

Whether this Argument can evaluate without crashing.

Specified by:

canEvaluate 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.

expressionAndArguments

public ExpressionAndArguments<? super ENVIRONMENT,TYPE,?> expressionAndArguments()

Returns the value of the expressionAndArguments record component.

Returns:

the value of the expressionAndArguments record component

parameter

public ExpressionArgument.ExpressionParameter<? super 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