jdk.internal.jvmci.common

Class JVMCIError

java.lang.Object

java.lang.Throwable

java.lang.Error

jdk.internal.jvmci.common.JVMCIError

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BytecodeParser.BytecodeParserError, GraalGraphJVMCIError

public class JVMCIError
extends Error

Indicates a condition in JVMCI related code that should never occur during normal operation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayList<String>	context
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
JVMCIError(JVMCIError e) This constructor creates a JVMCIError and adds all the context of another JVMCIError.
JVMCIError(String msg, Object... args) This constructor creates a JVMCIError with a message assembled via String.format(String, Object...).
JVMCIError(Throwable cause) This constructor creates a JVMCIError for a given causing Throwable instance.

Method Summary

Modifier and Type	Method and Description
JVMCIError	addContext(String newContext)
JVMCIError	addContext(String name, Object obj)
private static String	format(String msg, Object... args)
static void	guarantee(boolean condition, String msg, Object... args) Checks a given condition and throws a JVMCIError if it is false.
static RuntimeException	shouldNotReachHere()
static RuntimeException	shouldNotReachHere(String msg)
static RuntimeException	shouldNotReachHere(Throwable cause)
String	toString()
static RuntimeException	unimplemented()
static RuntimeException	unimplemented(String msg)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

context

private final ArrayList<String> context

Constructor Detail

JVMCIError

public JVMCIError(String msg,
                  Object... args)

This constructor creates a JVMCIError with a message assembled via String.format(String, Object...). It always uses the ENGLISH locale in order to always generate the same output.

Parameters:

msg - the message that will be associated with the error, in String.format syntax

args - parameters to String.format - parameters that implement Iterable will be expanded into a [x, x, ...] representation.

JVMCIError

public JVMCIError(Throwable cause)

This constructor creates a JVMCIError for a given causing Throwable instance.

Parameters:

cause - the original exception that contains additional information on this error

JVMCIError

public JVMCIError(JVMCIError e)

This constructor creates a JVMCIError and adds all the context of another JVMCIError.

Parameters:

e - the original JVMCIError

Method Detail

unimplemented

public static RuntimeException unimplemented()

unimplemented

public static RuntimeException unimplemented(String msg)

shouldNotReachHere

public static RuntimeException shouldNotReachHere()

shouldNotReachHere

public static RuntimeException shouldNotReachHere(String msg)

shouldNotReachHere

public static RuntimeException shouldNotReachHere(Throwable cause)

guarantee

public static void guarantee(boolean condition,
                             String msg,
                             Object... args)

Checks a given condition and throws a JVMCIError if it is false. Guarantees are stronger than assertions in that they are always checked. Error messages for guarantee violations should clearly indicate the nature of the problem as well as a suggested solution if possible.

Parameters:

condition - the condition to check

msg - the message that will be associated with the error, in String.format(String, Object...) syntax

args - arguments to the format string

toString

public String toString()

Overrides:

toString in class Throwable

format

private static String format(String msg,
                             Object... args)

addContext

public JVMCIError addContext(String newContext)

addContext

public JVMCIError addContext(String name,
                             Object obj)