com.oracle.truffle.api

Annotation Type TruffleLanguage.Registration

@Retention(value=SOURCE)
 @Target(value=TYPE)
public static @interface TruffleLanguage.Registration

The annotation to use to register your language to the Truffle system. By annotating your implementation of TruffleLanguage by this annotation you are just a one JAR drop to the class path away from your users. Once they include your JAR in their application, your language will be available to the Truffle virtual machine.

Since:

0.8 or earlier

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	mimeType List of MIME types associated with your language.
String	name Unique name of your language.
String	version Unique string identifying the language version.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	interactive Specifies if the language is suitable for interactive evaluation of sources.

Element Detail

name

public abstract String name

Unique name of your language. This name will be exposed to users via the PolyglotEngine.Language.getName() getter.

Returns:

identifier of your language

version

public abstract String version

Unique string identifying the language version. This name will be exposed to users via the PolyglotEngine.Language.getVersion() getter.

Returns:

version of your language

mimeType

public abstract String[] mimeType

List of MIME types associated with your language. Users will use them (directly or indirectly) when executing their code snippets or their files.

Returns:

array of MIME types assigned to your language files

interactive

public abstract boolean interactive

Specifies if the language is suitable for interactive evaluation of sources. Interactive languages should be displayed in interactive environments and presented to the user. The default value of this attribute is true assuming majority of the languages is interactive. Change the value to false to opt-out and turn your language into non-interactive one.

Returns:

true if the language should be presented to end-user in an interactive environment

Since:

0.22

Default:

true