Kind (Graal OpenJDK Project Documentation)

java.lang.Object
- java.lang.Enum<Kind>
- - jdk.internal.jvmci.meta.Kind

All Implemented Interfaces:

Serializable, Comparable<Kind>, PlatformKind
```
public enum Kind
extends Enum<Kind>
implements PlatformKind
```
Denotes the basic kinds of types in CRI, including the all the Java primitive types, for example, Int for int and Object for all object types. A kind has a single character short name, a Java name, and a set of flags further describing its behavior.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Kind.FormatWithToString
Marker interface for types that should be formatted with their Object.toString() value.
- Nested classes/interfaces inherited from interface jdk.internal.jvmci.meta.PlatformKind
  PlatformKind.EnumKey, PlatformKind.Key

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Kind.FormatWithToString` Marker interface for types that should be formatted with their `Object.toString()` value.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Boolean` The primitive boolean kind, represented as an int on the stack.
`Byte` The primitive byte kind, represented as an int on the stack.
`Char` The primitive char kind, represented as an int on the stack.
`Double` The primitive double kind.
`Float` The primitive float kind.
`Illegal` The non-type.
`Int` The primitive int kind, represented as an int on the stack.
`Long` The primitive long kind.
`Object` The Object kind, also used for arrays.
`Short` The primitive short kind, represented as an int on the stack.
`Void` The void float kind.

Field Summary

Fields
Modifier and Type	Field and Description
`private Class<?>`	`boxedJavaClass`
`private boolean`	`isStackInt`
`private String`	`javaName`
`private PlatformKind.EnumKey`	`key`
`private static int`	`MAX_FORMAT_ARRAY_LENGTH`
`private Class<?>`	`primitiveJavaClass`
`private int`	`slotCount`
`private char`	`typeChar`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`format(Object value)` Gets a formatted string for a given value of this kind.
`private static String`	`formatArray(Object array)`
`static Kind`	`fromJavaClass(Class<?> klass)` Returns the Kind representing the given Java class.
`static Kind`	`fromPrimitiveOrVoidTypeChar(char ch)` Returns the kind from the character describing a primitive or void.
`static Kind`	`fromTypeString(String typeString)` Returns the kind corresponding to the Java type string.
`static Kind`	`fromWordSize(int wordSizeInBytes)` Returns the kind of a word given the size of a word in bytes.
`int`	`getBitCount()` Number of bits that are necessary to represent a value of this kind.
`int`	`getByteCount()` Number of bytes that are necessary to represent a value of this kind.
`JavaConstant`	`getDefaultValue()`
`String`	`getJavaName()` Returns the name of this kind which will also be it Java programming language name if it is primitive or `void`.
`PlatformKind.Key`	`getKey()` Gets a value associated with this object that can be used as a stable key in a map.
`long`	`getMaxValue()` The maximum value that can be represented as a value of this kind.
`long`	`getMinValue()` The minimum value that can be represented as a value of this kind.
`int`	`getSlotCount()` Returns the number of stack slots occupied by this kind according to the Java bytecodes specification.
`Kind`	`getStackKind()` Returns the kind that represents this kind when on the Java operand stack.
`char`	`getTypeChar()` Returns the name of the kind as a single character.
`boolean`	`isNumericFloat()` Checks whether this type is a Java primitive type representing a floating point number.
`boolean`	`isNumericInteger()` Checks whether this type is a Java primitive type representing an integer number.
`boolean`	`isObject()` Checks whether this represent an Object of some sort.
`boolean`	`isPrimitive()` Checks whether this type is a Java primitive type.
`private static boolean`	`isToStringSafe(Class<?> c)` Classes for which invoking `Object.toString()` does not run user code.
`boolean`	`isUnsigned()` Checks whether this type is a Java primitive type representing an unsigned number.
`boolean`	`needsTwoSlots()` Returns whether this kind occupied two stack slots.
`Class<?>`	`toBoxedJavaClass()` Returns the Java class for instances of boxed values of this kind.
`Class<?>`	`toJavaClass()` Returns the Java class representing this kind.
`String`	`toString()` Converts this value type to a string.
`static Kind`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Kind[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jdk.internal.jvmci.meta.PlatformKind
getVectorLength, name

- Enum Constant Detail
  - Boolean
```
public static final Kind Boolean
```
    The primitive boolean kind, represented as an int on the stack.
  - Byte
```
public static final Kind Byte
```
    The primitive byte kind, represented as an int on the stack.
  - Short
```
public static final Kind Short
```
    The primitive short kind, represented as an int on the stack.
  - Char
```
public static final Kind Char
```
    The primitive char kind, represented as an int on the stack.
  - Int
```
public static final Kind Int
```
    The primitive int kind, represented as an int on the stack.
  - Float
```
public static final Kind Float
```
    The primitive float kind.
  - Long
```
public static final Kind Long
```
    The primitive long kind.
  - Double
```
public static final Kind Double
```
    The primitive double kind.
  - Object
```
public static final Kind Object
```
    The Object kind, also used for arrays.
  - Void
```
public static final Kind Void
```
    The void float kind.
  - Illegal
```
public static final Kind Illegal
```
    The non-type.
- Field Detail
  - typeChar
```
private final char typeChar
```
  - javaName
```
private final String javaName
```
  - isStackInt
```
private final boolean isStackInt
```
  - primitiveJavaClass
```
private final Class<?> primitiveJavaClass
```
  - boxedJavaClass
```
private final Class<?> boxedJavaClass
```
  - key
```
private final PlatformKind.EnumKey key
```
  - slotCount
```
private final int slotCount
```
  - MAX_FORMAT_ARRAY_LENGTH
```
private static final int MAX_FORMAT_ARRAY_LENGTH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Kind[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Kind c : Kind.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Kind valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getSlotCount
```
public int getSlotCount()
```
    Returns the number of stack slots occupied by this kind according to the Java bytecodes specification.
  - needsTwoSlots
```
public boolean needsTwoSlots()
```
    Returns whether this kind occupied two stack slots.
  - getTypeChar
```
public char getTypeChar()
```
    Returns the name of the kind as a single character.
  - getJavaName
```
public String getJavaName()
```
    Returns the name of this kind which will also be it Java programming language name if it is primitive or void.
  - getKey
```
public PlatformKind.Key getKey()
```
    Description copied from interface: PlatformKind
    
    Gets a value associated with this object that can be used as a stable key in a map. The Object.hashCode() implementation of the returned value should be stable between VM executions.
    
    Specified by:
    
    getKey in interface PlatformKind
  - isPrimitive
```
public boolean isPrimitive()
```
    Checks whether this type is a Java primitive type.
    
    Returns:
    
    true if this is Boolean, Byte, Char, Short, Int, Long, Float, Double, or Void.
  - getStackKind
```
public Kind getStackKind()
```
    Returns the kind that represents this kind when on the Java operand stack.
    
    Returns:
    
    the kind used on the operand stack
  - isNumericInteger
```
public boolean isNumericInteger()
```
    Checks whether this type is a Java primitive type representing an integer number.
    
    Returns:
    
    true if the stack kind is Int or Long.
  - isUnsigned
```
public boolean isUnsigned()
```
    Checks whether this type is a Java primitive type representing an unsigned number.
    
    Returns:
    
    true if the kind is Boolean or Char.
  - isNumericFloat
```
public boolean isNumericFloat()
```
    Checks whether this type is a Java primitive type representing a floating point number.
    
    Returns:
    
    true if this is Float or Double.
  - isObject
```
public boolean isObject()
```
    Checks whether this represent an Object of some sort.
    
    Returns:
    
    true if this is Object.
  - fromTypeString
```
public static Kind fromTypeString(String typeString)
```
    Returns the kind corresponding to the Java type string.
    
    Parameters:
    
    typeString - the Java type string
    
    Returns:
    
    the kind
  - fromWordSize
```
public static Kind fromWordSize(int wordSizeInBytes)
```
    Returns the kind of a word given the size of a word in bytes.
    
    Parameters:
    
    wordSizeInBytes - the size of a word in bytes
    
    Returns:
    
    the kind representing a word value
  - fromPrimitiveOrVoidTypeChar
```
public static Kind fromPrimitiveOrVoidTypeChar(char ch)
```
    Returns the kind from the character describing a primitive or void.
    
    Parameters:
    
    ch - the character
    
    Returns:
    
    the kind
  - fromJavaClass
```
public static Kind fromJavaClass(Class<?> klass)
```
    Returns the Kind representing the given Java class.
    
    Parameters:
    
    klass - the class
    
    Returns:
    
    the kind
  - toJavaClass
```
public Class<?> toJavaClass()
```
    Returns the Java class representing this kind.
    
    Returns:
    
    the Java class
  - toBoxedJavaClass
```
public Class<?> toBoxedJavaClass()
```
    Returns the Java class for instances of boxed values of this kind.
    
    Returns:
    
    the Java class
  - toString
```
public String toString()
```
    Converts this value type to a string.
    
    Overrides:
    
    toString in class Enum<Kind>
  - isToStringSafe
```
private static boolean isToStringSafe(Class<?> c)
```
    Classes for which invoking Object.toString() does not run user code.
  - format
```
public String format(Object value)
```
    Gets a formatted string for a given value of this kind.
    
    Parameters:
    
    value - a value of this kind
    
    Returns:
    
    a formatted string for value based on this kind
  - formatArray
```
private static String formatArray(Object array)
```
  - getMinValue
```
public long getMinValue()
```
    The minimum value that can be represented as a value of this kind.
    
    Returns:
    
    the minimum value
  - getMaxValue
```
public long getMaxValue()
```
    The maximum value that can be represented as a value of this kind.
    
    Returns:
    
    the maximum value
  - getByteCount
```
public int getByteCount()
```
    Number of bytes that are necessary to represent a value of this kind.
    
    Returns:
    
    the number of bytes
  - getBitCount
```
public int getBitCount()
```
    Number of bits that are necessary to represent a value of this kind.
    
    Returns:
    
    the number of bits
  - getDefaultValue
```
public JavaConstant getDefaultValue()
```
    Specified by:
    
    getDefaultValue in interface PlatformKind

Enum Kind

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.internal.jvmci.meta.PlatformKind

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface jdk.internal.jvmci.meta.PlatformKind

Enum Constant Detail

Boolean

Byte

Short

Char

Int

Float

Long

Double

Object

Void

Illegal

Field Detail

typeChar

javaName

isStackInt

primitiveJavaClass

boxedJavaClass

key

slotCount

MAX_FORMAT_ARRAY_LENGTH

Method Detail

values

valueOf

getSlotCount

needsTwoSlots

getTypeChar

getJavaName

getKey

isPrimitive

getStackKind

isNumericInteger

isUnsigned

isNumericFloat

isObject

fromTypeString

fromWordSize

fromPrimitiveOrVoidTypeChar

fromJavaClass

toJavaClass

toBoxedJavaClass

toString

isToStringSafe

format

formatArray

getMinValue

getMaxValue

getByteCount

getBitCount

getDefaultValue