JavaConstant (Graal OpenJDK Project Documentation)

All Superinterfaces:

Constant, JavaValue, KindProvider, TrustedInterface, Value

All Known Subinterfaces:

HotSpotObjectConstant

All Known Implementing Classes:

HotSpotCompressedNullConstant, HotSpotMetaspaceConstantImpl, HotSpotObjectConstantImpl, NullConstant, PrimitiveConstant, RawConstant
```
public interface JavaConstant
extends Constant, JavaValue, Value
```
Represents a constant (boxed) value, such as an integer, floating point number, or object reference, within the compiler and across the compiler/runtime interface. Exports a set of JavaConstant instances that represent frequently used constant values, such as NULL_POINTER.

Nested Class Summary
- Nested classes/interfaces inherited from interface jdk.internal.jvmci.meta.Value
  Value.IllegalValue

Field Summary

Fields
Modifier and Type	Field and Description
`static PrimitiveConstant`	`DOUBLE_0`
`static PrimitiveConstant`	`DOUBLE_1`
`static PrimitiveConstant`	`FALSE`
`static PrimitiveConstant`	`FLOAT_0`
`static PrimitiveConstant`	`FLOAT_1`
`static PrimitiveConstant`	`INT_0`
`static PrimitiveConstant`	`INT_1`
`static PrimitiveConstant`	`INT_2`
`static PrimitiveConstant`	`INT_MINUS_1`
`static PrimitiveConstant`	`LONG_0`
`static PrimitiveConstant`	`LONG_1`
`static JavaConstant`	`NULL_POINTER`
`static PrimitiveConstant`	`TRUE`

Fields inherited from interface jdk.internal.jvmci.meta.Value
ILLEGAL, NO_VALUES

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static JavaConstant`	`add(JavaConstant x, JavaConstant y)` Adds two numeric constants.
`boolean`	`asBoolean()` Returns the primitive boolean value this constant represents.
`Object`	`asBoxedPrimitive()` Returns the value of this constant as a boxed Java value.
`double`	`asDouble()` Returns the primitive double value this constant represents.
`float`	`asFloat()` Returns the primitive float value this constant represents.
`int`	`asInt()` Returns the primitive int value this constant represents.
`long`	`asLong()` Returns the primitive long value this constant represents.
`static JavaConstant`	`defaultForKind(Kind kind)` Returns a constant with the default value for the given kind.
`static PrimitiveConstant`	`forBoolean(boolean i)` Creates a boxed boolean constant.
`static PrimitiveConstant`	`forBoxedPrimitive(Object value)` Creates a boxed constant for the given boxed primitive value.
`static PrimitiveConstant`	`forByte(byte i)` Creates a boxed byte constant.
`static PrimitiveConstant`	`forChar(char i)` Creates a boxed char constant.
`static PrimitiveConstant`	`forDouble(double d)` Creates a boxed double constant.
`static PrimitiveConstant`	`forFloat(float f)` Creates a boxed float constant.
`static PrimitiveConstant`	`forIllegal()`
`static PrimitiveConstant`	`forInt(int i)` Creates a boxed integer constant.
`static PrimitiveConstant`	`forIntegerKind(Kind kind, long i)` Creates a `JavaConstant` from a primitive integer of a certain kind.
`static PrimitiveConstant`	`forLong(long i)` Creates a boxed long constant.
`static PrimitiveConstant`	`forPrimitiveInt(int bits, long i)` Creates a `JavaConstant` from a primitive integer of a certain width.
`static PrimitiveConstant`	`forShort(short i)` Creates a boxed short constant.
`boolean`	`isDefaultForKind()` Checks whether this constant is the default value for its kind (null, 0, 0.0, false).
`default boolean`	`isNonNull()` Checks whether this constant is non-null.
`boolean`	`isNull()` Checks whether this constant is null.
`static boolean`	`isNull(Constant c)`
`static PrimitiveConstant`	`mul(JavaConstant x, JavaConstant y)` Multiplies two numeric constants.
`static JavaConstant`	`one(Kind kind)` Returns the one value for a given numeric kind.
`static String`	`toString(JavaConstant constant)`
`default String`	`toValueString()`
`static JavaConstant`	`zero(Kind kind)` Returns the zero value for a given numeric kind.

Methods inherited from interface jdk.internal.jvmci.meta.JavaValue
getKind

Methods inherited from interface jdk.internal.jvmci.meta.Value
getLIRKind, getPlatformKind, identityEquals

Methods inherited from interface jdk.internal.jvmci.meta.KindProvider
getKind

- Field Detail
  - NULL_POINTER
```
static final JavaConstant NULL_POINTER
```
  - INT_MINUS_1
```
static final PrimitiveConstant INT_MINUS_1
```
  - INT_0
```
static final PrimitiveConstant INT_0
```
  - INT_1
```
static final PrimitiveConstant INT_1
```
  - INT_2
```
static final PrimitiveConstant INT_2
```
  - LONG_0
```
static final PrimitiveConstant LONG_0
```
  - LONG_1
```
static final PrimitiveConstant LONG_1
```
  - FLOAT_0
```
static final PrimitiveConstant FLOAT_0
```
  - FLOAT_1
```
static final PrimitiveConstant FLOAT_1
```
  - DOUBLE_0
```
static final PrimitiveConstant DOUBLE_0
```
  - DOUBLE_1
```
static final PrimitiveConstant DOUBLE_1
```
  - TRUE
```
static final PrimitiveConstant TRUE
```
  - FALSE
```
static final PrimitiveConstant FALSE
```
- Method Detail
  - isNull
```
boolean isNull()
```
    Checks whether this constant is null.
    
    Returns:
    
    true if this constant is the null constant
  - isNull
```
static boolean isNull(Constant c)
```
  - isNonNull
```
default boolean isNonNull()
```
    Checks whether this constant is non-null.
    
    Returns:
    
    true if this constant is a primitive, or an object constant that is not null
  - isDefaultForKind
```
boolean isDefaultForKind()
```
    Checks whether this constant is the default value for its kind (null, 0, 0.0, false).
    
    Specified by:
    
    isDefaultForKind in interface Constant
    
    Returns:
    
    true if this constant is the default value for its kind
  - asBoxedPrimitive
```
Object asBoxedPrimitive()
```
    Returns the value of this constant as a boxed Java value.
    
    Returns:
    
    the value of this constant
  - asInt
```
int asInt()
```
    Returns the primitive int value this constant represents. The constant must have a Kind.getStackKind() of Kind.Int.
    
    Returns:
    
    the constant value
  - asBoolean
```
boolean asBoolean()
```
    Returns the primitive boolean value this constant represents. The constant must have kind Kind.Boolean.
    
    Returns:
    
    the constant value
  - asLong
```
long asLong()
```
    Returns the primitive long value this constant represents. The constant must have kind Kind.Long, a Kind.getStackKind() of Kind.Int.
    
    Returns:
    
    the constant value
  - asFloat
```
float asFloat()
```
    Returns the primitive float value this constant represents. The constant must have kind Kind.Float.
    
    Returns:
    
    the constant value
  - asDouble
```
double asDouble()
```
    Returns the primitive double value this constant represents. The constant must have kind Kind.Double.
    
    Returns:
    
    the constant value
  - toValueString
```
default String toValueString()
```
    Specified by:
    
    toValueString in interface Constant
  - toString
```
static String toString(JavaConstant constant)
```
  - forDouble
```
static PrimitiveConstant forDouble(double d)
```
    Creates a boxed double constant.
    
    Parameters:
    
    d - the double value to box
    
    Returns:
    
    a boxed copy of value
  - forFloat
```
static PrimitiveConstant forFloat(float f)
```
    Creates a boxed float constant.
    
    Parameters:
    
    f - the float value to box
    
    Returns:
    
    a boxed copy of value
  - forLong
```
static PrimitiveConstant forLong(long i)
```
    Creates a boxed long constant.
    
    Parameters:
    
    i - the long value to box
    
    Returns:
    
    a boxed copy of value
  - forInt
```
static PrimitiveConstant forInt(int i)
```
    Creates a boxed integer constant.
    
    Parameters:
    
    i - the integer value to box
    
    Returns:
    
    a boxed copy of value
  - forByte
```
static PrimitiveConstant forByte(byte i)
```
    Creates a boxed byte constant.
    
    Parameters:
    
    i - the byte value to box
    
    Returns:
    
    a boxed copy of value
  - forBoolean
```
static PrimitiveConstant forBoolean(boolean i)
```
    Creates a boxed boolean constant.
    
    Parameters:
    
    i - the boolean value to box
    
    Returns:
    
    a boxed copy of value
  - forChar
```
static PrimitiveConstant forChar(char i)
```
    Creates a boxed char constant.
    
    Parameters:
    
    i - the char value to box
    
    Returns:
    
    a boxed copy of value
  - forShort
```
static PrimitiveConstant forShort(short i)
```
    Creates a boxed short constant.
    
    Parameters:
    
    i - the short value to box
    
    Returns:
    
    a boxed copy of value
  - forIntegerKind
```
static PrimitiveConstant forIntegerKind(Kind kind,
                                        long i)
```
    Creates a JavaConstant from a primitive integer of a certain kind.
  - forPrimitiveInt
```
static PrimitiveConstant forPrimitiveInt(int bits,
                                         long i)
```
    Creates a JavaConstant from a primitive integer of a certain width.
  - forBoxedPrimitive
```
static PrimitiveConstant forBoxedPrimitive(Object value)
```
    Creates a boxed constant for the given boxed primitive value.
    
    Parameters:
    
    value - the Java boxed value
    
    Returns:
    
    the primitive constant holding the value
  - forIllegal
```
static PrimitiveConstant forIllegal()
```
  - defaultForKind
```
static JavaConstant defaultForKind(Kind kind)
```
    Returns a constant with the default value for the given kind.
  - zero
```
static JavaConstant zero(Kind kind)
```
    Returns the zero value for a given numeric kind.
  - one
```
static JavaConstant one(Kind kind)
```
    Returns the one value for a given numeric kind.
  - add
```
static JavaConstant add(JavaConstant x,
                        JavaConstant y)
```
    Adds two numeric constants.
  - mul
```
static PrimitiveConstant mul(JavaConstant x,
                             JavaConstant y)
```
    Multiplies two numeric constants.

Interface JavaConstant

Nested Class Summary

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

Field Summary

Fields inherited from interface jdk.internal.jvmci.meta.Value

Method Summary

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

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

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

Field Detail

NULL_POINTER

INT_MINUS_1

INT_0

INT_1

INT_2

LONG_0

LONG_1

FLOAT_0

FLOAT_1

DOUBLE_0

DOUBLE_1

TRUE

FALSE

Method Detail

isNull

isNull

isNonNull

isDefaultForKind

asBoxedPrimitive

asInt

asBoolean

asLong

asFloat

asDouble

toValueString

toString

forDouble

forFloat

forLong

forInt

forByte

forBoolean

forChar

forShort

forIntegerKind

forPrimitiveInt

forBoxedPrimitive

forIllegal

defaultForKind

zero

one

add

mul