Enum Class Instruction.Argument.Kind

java.lang.Object

java.lang.Enum<Instruction.Argument.Kind>

com.oracle.truffle.api.bytecode.Instruction.Argument.Kind

All Implemented Interfaces:

Serializable, Comparable<Instruction.Argument.Kind>, Constable

Enclosing class:

Instruction.Argument

public static enum Instruction.Argument.Kind
extends Enum<Instruction.Argument.Kind>

Represents the kind of an Instruction.Argument.

Since:

24.2

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRANCH_PROFILE	A branch profile.
BYTECODE_INDEX	A bytecode index.
CONSTANT	A constant value.
INTEGER	An integer value.
LOCAL_INDEX	The unique index of a local variable.
LOCAL_OFFSET	The logical frame offset of a local variable.
NODE_PROFILE	A node profile.
TAG_NODE	A TagTreeNode.

Method Summary

Modifier and Type	Method	Description
static Instruction.Argument.Kind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Instruction.Argument.Kind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONSTANT

public static final Instruction.Argument.Kind CONSTANT

A constant value. Typically, constants are used to encode ConstantOperand and LoadConstant builtin operations.

Since:

24.2

See Also:

• Instruction.Argument.asConstant()

BYTECODE_INDEX

public static final Instruction.Argument.Kind BYTECODE_INDEX

A bytecode index. Typically, bytecode indices are used to encode branch targets or the locations of child instructions.

Since:

24.2

See Also:

• Instruction.Argument.asBytecodeIndex()

INTEGER

public static final Instruction.Argument.Kind INTEGER

An integer value. Typically, integer arguments are used to encode argument indices and other integer constants.

Since:

24.2

See Also:

• Instruction.Argument.asInteger()

LOCAL_OFFSET

public static final Instruction.Argument.Kind LOCAL_OFFSET

The logical frame offset of a local variable. If block scoping is enabled, multiple locals can share an offset; otherwise, a local's offset is the same as its index. Typically, local offset arguments are used to encode local variable metadata in local variable instructions.

The local offset does not represent a frame index that can be used to directly access locals from the frame. Instead, use local accessor instructions, LocalAccessor operands, or the helper methods defined by the BytecodeNode.

Since:

24.2

See Also:

• Instruction.Argument.asLocalOffset()

LOCAL_INDEX

public static final Instruction.Argument.Kind LOCAL_INDEX

The unique index of a local variable. Typically, local index arguments are used to encode local variable metadata in local variable instructions.

Since:

24.2

See Also:

• Instruction.Argument.asLocalIndex()

NODE_PROFILE

public static final Instruction.Argument.Kind NODE_PROFILE

A node profile. Typically, node profile arguments are used to encode cached nodes for user-defined operations.

Since:

24.2

See Also:

• Instruction.Argument.asCachedNode()

BRANCH_PROFILE

public static final Instruction.Argument.Kind BRANCH_PROFILE

A branch profile. Typically, branch profiles are used to profile the outcomes of conditional branch instructions.

Since:

24.2

See Also:

• Instruction.Argument.asBranchProfile()

TAG_NODE

public static final Instruction.Argument.Kind TAG_NODE

A TagTreeNode. Typically, tag tree nodes are used to represent nodes in the logical tag tree defined by Tag operations.

Method Details

values

public static Instruction.Argument.Kind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Instruction.Argument.Kind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null