com.oracle.truffle.api

Class ContextLocal<T>

java.lang.Object

com.oracle.truffle.api.ContextLocal<T>

public abstract class ContextLocal<T>
extends Object

A context local reference that refers to a value that is created for each polyglot context. Context references can be used to attach data to a polyglot context. That data can be retrieved efficiently for the current context using ContextLocal.get() or for other contexts using ContextLocal.get(TruffleContext). Context locals can be created for languages and instruments. See links below for usage examples.

Since:

20.3

See Also:

Usage with languages., Usage with instruments.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextLocal(Object polyglotObject) Custom subclasses of context local are not allowed.

Method Summary

Modifier and Type	Method and Description
abstract T	get() Returns the context local value for the currently entered context.
abstract T	get(TruffleContext context) Returns the context local value for an explicit context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextLocal

protected ContextLocal(Object polyglotObject)

Custom subclasses of context local are not allowed.

Since:

20.3

Method Detail

get

public abstract T get()

Returns the context local value for the currently entered context. This method is intended to be used on compiled code paths. The return value is never null. Throws IllegalStateException if no current context is entered on the current thread.

Since:

20.3

get

public abstract T get(TruffleContext context)

Returns the context local value for an explicit context. This method is intended to be used on compiled code paths. The return value is never null. Throws IllegalStateException if no current context is entered on the current thread.

Since:

20.3