Package org.skriptlang.skript.common.function

Record Class FunctionReferenceParser

java.lang.Object

java.lang.Record

org.skriptlang.skript.common.function.FunctionReferenceParser

Record Components:

context - The context of parsing.

flags - The active parsing flags.

public record FunctionReferenceParser(ParseContext context, int flags)
extends Record

A class containing the methods to parse an expression to a FunctionReference.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionReferenceParser.EmptyExpression	Represents an empty value used to make DefaultFunction calling work correctly.

Constructor Summary

Constructors

Constructor	Description
FunctionReferenceParser(ParseContext context, int flags)	Creates an instance of a FunctionReferenceParser record class.

Method Summary

Modifier and Type	Method	Description
ParseContext	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()	Returns the value of the flags record component.
final int	hashCode()	Returns a hash code value for this object.
<T> FunctionReference<T>	parseFunctionReference(String expr)	Attempts to parse expr as a function reference.
<T> FunctionReference<T>	parseFunctionReference(String name, FunctionReference.Argument<String>[] arguments, ParseLogHandler log)	Attempts to parse a function reference.
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

FunctionReferenceParser

public FunctionReferenceParser(ParseContext context,
 int flags)

Creates an instance of a FunctionReferenceParser record class.

Parameters:

context - the value for the context record component

flags - the value for the flags record component

Method Details

parseFunctionReference

public <T> FunctionReference<T> parseFunctionReference(String expr)

Attempts to parse expr as a function reference.

Type Parameters:

T - The return type of the function.

Returns:

A FunctionReference if a function is found, or null if none is found.

parseFunctionReference

public <T> FunctionReference<T> parseFunctionReference(String name,
 FunctionReference.Argument<String>[] arguments,
 ParseLogHandler log)

Attempts to parse a function reference.

Type Parameters:

T - The return type of the function.

Parameters:

name - The function name.

arguments - The passed arguments to the function as an array of Arguments, usually parsed with a FunctionArgumentParser.

log - The log handler.

Returns:

A FunctionReference if a function is found, or null if none is found.

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.

context

public ParseContext context()

Returns the value of the context record component.

Returns:

the value of the context record component

flags

public int flags()

Returns the value of the flags record component.

Returns:

the value of the flags record component