Package com.petrolpark.core.scratch.argument

Record Class VariableArgument

java.lang.Object

java.lang.Record

com.petrolpark.core.scratch.argument.VariableArgument

All Implemented Interfaces:

IScratchArgument<IVariableScratchEnvironment,ScratchVariableIdentifier>

public record VariableArgument(ScratchVariableIdentifier identifier, VariableArgument.VariableParameter parameter)
extends Record
implements IScratchArgument<IVariableScratchEnvironment,ScratchVariableIdentifier>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VariableArgument.VariableParameter

Constructor Summary

Constructors

Constructor	Description
VariableArgument(ScratchVariableIdentifier identifier, VariableArgument.VariableParameter parameter)	Creates an instance of a VariableArgument 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.
ScratchVariableIdentifier	get(IVariableScratchEnvironment environment)
final int	hashCode()	Returns a hash code value for this object.
ScratchVariableIdentifier	identifier()	Returns the value of the identifier record component.
VariableArgument.VariableParameter	parameter()	Returns the value of the parameter record component.
final String	toString()	Returns a string representation of this record class.
static final VariableArgument.VariableParameter	variable(String key)

Methods inherited from class java.lang.Object

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

Constructor Details

VariableArgument

public VariableArgument(ScratchVariableIdentifier identifier,
 VariableArgument.VariableParameter parameter)

Creates an instance of a VariableArgument record class.

Parameters:

identifier - the value for the identifier record component

parameter - the value for the parameter record component

Method Details

variable

public static final VariableArgument.VariableParameter variable(String key)

get

public ScratchVariableIdentifier get(IVariableScratchEnvironment environment)

Specified by:

get in interface IScratchArgument<IVariableScratchEnvironment,ScratchVariableIdentifier>

canEvaluate

public boolean canEvaluate()

Description copied from interface: IScratchArgument

Whether this Argument can evaluate without crashing.

Specified by:

canEvaluate in interface IScratchArgument<IVariableScratchEnvironment,ScratchVariableIdentifier>

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.

identifier

public ScratchVariableIdentifier identifier()

Returns the value of the identifier record component.

Returns:

the value of the identifier record component

parameter

public VariableArgument.VariableParameter parameter()

Returns the value of the parameter record component.

Specified by:

parameter in interface IScratchArgument<IVariableScratchEnvironment,ScratchVariableIdentifier>

Returns:

the value of the parameter record component