Package ortus.boxlang.runtime.context

Record Class IBoxContext.ScopeSearchResult

java.lang.Object

java.lang.Record

ortus.boxlang.runtime.context.IBoxContext.ScopeSearchResult

Record Components:

scope - The scope which was found

value - The value of the key in the scope

Enclosing interface:

IBoxContext

public static record IBoxContext.ScopeSearchResult(IReferenceable scope, Object value, Key key, boolean isScope)
extends Record

Represents the results of a successful scope hunting expedition.

Constructor Summary

Constructors

Constructor	Description
ScopeSearchResult(IReferenceable scope, Object value, Key key)
ScopeSearchResult(IReferenceable scope, Object value, Key key, boolean isScope)	Creates an instance of a ScopeSearchResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Key[]	getAssignmentKeys(Key... keys)	This allow abstraction of the use cases where local.foo = 1 should really be variables.local.foo = 1
final int	hashCode()	Returns a hash code value for this object.
boolean	isScope()	Returns the value of the isScope record component.
Key	key()	Returns the value of the key record component.
IReferenceable	scope()	Returns the value of the scope record component.
final String	toString()	Returns a string representation of this record class.
Object	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

ScopeSearchResult

public ScopeSearchResult(IReferenceable scope,
 Object value,
 Key key)

ScopeSearchResult

public ScopeSearchResult(IReferenceable scope,
 Object value,
 Key key,
 boolean isScope)

Creates an instance of a ScopeSearchResult record class.

Parameters:

scope - the value for the scope record component

value - the value for the value record component

key - the value for the key record component

isScope - the value for the isScope record component

Method Details

getAssignmentKeys

public Key[] getAssignmentKeys(Key... keys)

This allow abstraction of the use cases where local.foo = 1 should really be variables.local.foo = 1

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.

scope

public IReferenceable scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

value

public Object value()

Returns the value of the value record component.

Returns:

the value of the value record component

key

public Key key()

Returns the value of the key record component.

Returns:

the value of the key record component

isScope

public boolean isScope()

Returns the value of the isScope record component.

Returns:

the value of the isScope record component