com.oracle.truffle.api.vm

Class PolyglotEngine.Language

java.lang.Object

com.oracle.truffle.api.vm.PolyglotEngine.Language

Enclosing class:

PolyglotEngine

public class PolyglotEngine.Language
extends Object

A handle for a Truffle language installed in a PolyglotEngine. The handle provides access to the language's metadata, including the language's name, version, and supported MIME types.

A Truffle language implementation is an extension of the abstract class TruffleLanguage, where more details about interactions between languages and engines can be found.

Since:

0.9

See Also:

PolyglotEngine.getLanguages()

Method Summary

Modifier and Type	Method and Description
PolyglotEngine.Value	eval(Source source) Evaluates code using this language, ignoring the code's MIME type.
PolyglotEngine.Value	getGlobalObject() Returns this language's global object, null if not supported.
Set<String>	getMimeTypes() Gets the MIME types supported by this language.
String	getName() Gets the human-readable name of this language.
String	getVersion() Gets the version of this language.
boolean	isInteractive() Returns whether this language supports interactive evaluation of sources.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getMimeTypes

public Set<String> getMimeTypes()

Gets the MIME types supported by this language.

Returns:

an immutable set of supported MIME types

Since:

0.9

getName

public String getName()

Gets the human-readable name of this language.

Returns:

a human-friendly name

Since:

0.9

getVersion

public String getVersion()

Gets the version of this language.

Returns:

a version string

Since:

0.9

isInteractive

public boolean isInteractive()

Returns whether this language supports interactive evaluation of sources. Such languages should be displayed in interactive environments and presented to the user.

Returns:

true if and only if this language implements an interactive response to evaluation of interactive sources.

Since:

0.22

eval

public PolyglotEngine.Value eval(Source source)

Evaluates code using this language, ignoring the code's MIME type.

When evaluating an interactive source the result of the evaluation is tested to be visible and if the value is visible, it gets converted to string and printed to standard output.

Parameters:

source - code to execute

Returns:

a non-null PolyglotEngine.Value that holds the result

Throws:

Exception - thrown to signal errors while processing the code

Since:

0.9

getGlobalObject

public PolyglotEngine.Value getGlobalObject()

Returns this language's global object, null if not supported.

The result is expected to be a TruffleObject (e.g. a native object from the other language) but technically it can also be one of Java's primitive wrappers ( Integer , Double, Short, etc.).

Returns:

this language's global object, null if the language has none

Since:

0.9

toString

public String toString()

Overrides:

toString in class Object

Since:

0.9