Package com.oracle.truffle.api.instrumentation

Class Tag

java.lang.Object

com.oracle.truffle.api.instrumentation.Tag

Direct Known Subclasses:

DebuggerTags.AlwaysHalt, StandardTags.CallTag, StandardTags.ExpressionTag, StandardTags.ReadVariableTag, StandardTags.RootBodyTag, StandardTags.RootTag, StandardTags.StatementTag, StandardTags.TryBlockTag, StandardTags.WriteVariableTag

public abstract class Tag
extends Object

Base class for tags used in the Truffle instrumentation framework.

Since:

0.33

See Also:

• For the standard set of tags
• to find a provided tag of a language

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Tag.Identifier	Annotation applied to Tag subclasses to specify the tag identifier.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Tag()	No instances of tags allowed.

Method Summary

Modifier and Type	Method	Description
static Class<? extends Tag>	findProvidedTag(LanguageInfo language, String tagId)	Finds a provided tag by the language using its identifier.
static String	getIdentifier(Class<? extends Tag> tag)	Returns the alias of a particular tag or null if no alias was specified for this tag.

Methods inherited from class java.lang.Object

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

Constructor Details

Tag

protected Tag()

No instances of tags allowed. Tags are marker classes.

Since:

0.33

Method Details

findProvidedTag

public static Class<? extends Tag> findProvidedTag(LanguageInfo language,
 String tagId)

Finds a provided tag by the language using its identifier. If the language implementation class is not yet loaded then this method will force the loading. Therefore it is not recommended to iterate over the entire list of languages and request all provided tags. It is guaranteed that there is only one provided tag class per tag identifier and language. For different languages the same tag id might refer to different tag classes.

Since:

0.33

getIdentifier

public static String getIdentifier(Class<? extends Tag> tag)

Returns the alias of a particular tag or null if no alias was specified for this tag.

Parameters:

tag - the tag to return the alias for.

Returns:

the alias string

Since:

0.33