Package com.petrolpark.core.scratch.argument

Record Class ExpressionOrDropdownArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

IScratchArgument<ENVIRONMENT,TYPE>, IScratchContextHolder

public record ExpressionOrDropdownArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>(int index, Optional<ExpressionArgument<ENVIRONMENT extends IScratchEnvironment,TYPE>> expression, ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<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	ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT extends IScratchEnvironment,TYPE>

Constructor Summary

Constructors

Constructor	Description
ExpressionOrDropdownArgument(int index, Optional<ExpressionArgument<ENVIRONMENT,TYPE>> expression, ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT,TYPE> parameter)	Creates an instance of a ExpressionOrDropdownArgument record class.

Method Summary

Modifier and Type	Method	Description
static final <ENVIRONMENT extends IScratchEnvironment> ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT,Boolean>	booleanParameter(String key)
boolean	canEvaluate()	Whether this Argument can evaluate without crashing.
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.
int	index()	Returns the value of the index record component.
ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT,TYPE>	parameter()	Returns the value of the parameter record component.
<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

ExpressionOrDropdownArgument

public ExpressionOrDropdownArgument(int index,
 Optional<ExpressionArgument<ENVIRONMENT,TYPE>> expression,
 ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT,TYPE> parameter)

Creates an instance of a ExpressionOrDropdownArgument record class.

Parameters:

index - the value for the index record component

expression - the value for the expression record component

parameter - the value for the parameter record component

Method Details

booleanParameter

public static final <ENVIRONMENT extends IScratchEnvironment>
ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<ENVIRONMENT,Boolean> booleanParameter(String key)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index 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 ExpressionOrDropdownArgument.ExpressionOrDropdownParameter<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