Module technology.sola.script

Package technology.sola.script.parser

Record Class Stmt.Return

java.lang.Object

java.lang.Record

technology.sola.script.parser.Stmt.Return

Record Components:

keyword - the Token for the return keyword

value - the value to return to the caller or null

All Implemented Interfaces:

Stmt

Enclosing interface:

Stmt

public static record Stmt.Return(Token keyword, @Nullable Expr value)
extends Record
implements Stmt

Return statement exits a function while optionally returning a value for the caller to use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stmt.Return.Exception	Return is an exception utilized by the Interpreter to throw when a Stmt.Return is being interpreted so that the wrapping SolaScriptFunction can catch it and return the value as the result of the Expr.Call.

Nested classes/interfaces inherited from interface technology.sola.script.parser.Stmt

Stmt.Block, Stmt.Expression, Stmt.Function, Stmt.If, Stmt.Return, Stmt.Val, Stmt.Var, Stmt.Visitor<R>, Stmt.While

Constructor Summary

Constructors

Constructor	Description
Return(Token keyword, @Nullable Expr value)	Creates an instance of a Return record class.

Method Summary

Modifier and Type	Method	Description
<R> R	accept(Stmt.Visitor<R> visitor)	Executes this statement via the desired Stmt.Visitor
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Token	keyword()	Returns the value of the keyword record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Expr	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

Return

public Return(Token keyword,
 @Nullable Expr value)

Creates an instance of a Return record class.

Parameters:

keyword - the value for the keyword record component

value - the value for the value record component

Method Details

accept

public <R> R accept(Stmt.Visitor<R> visitor)

Description copied from interface: Stmt

Executes this statement via the desired Stmt.Visitor

Specified by:

accept in interface Stmt

Type Parameters:

R - the return type

Parameters:

visitor - the Stmt.Visitor to execute this statement

Returns:

the return value from the executed statement

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.

keyword

public Token keyword()

Returns the value of the keyword record component.

Returns:

the value of the keyword record component

value

public @Nullable Expr value()

Returns the value of the value record component.

Returns:

the value of the value record component