org.graalvm.compiler.debug

Class GraalError

java.lang.Object

java.lang.Throwable

java.lang.Error

org.graalvm.compiler.debug.GraalError

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BytecodeParser.BytecodeParserError, GraalGraphError

public class GraalError
extends Error

Indicates a condition that should never occur during normal operation.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GraalError	addContext(String newContext)
GraalError	addContext(String name, Object obj)
String	context()
static void	guarantee(boolean condition, String msg) Checks a given condition and throws a GraalError if it is false.
static void	guarantee(boolean condition, String msg, Object arg) Checks a given condition and throws a GraalError if it is false.
static void	guarantee(boolean condition, String msg, Object arg1, Object arg2) Checks a given condition and throws a GraalError if it is false.
static void	guarantee(boolean condition, String msg, Object arg1, Object arg2, Object arg3) Checks a given condition and throws a GraalError if it is false.
static void	guarantee(boolean condition, String msg, Object arg1, Object arg2, Object arg3, Object arg4) Checks a given condition and throws a GraalError if it is false.
static RuntimeException	shouldNotReachHere()
static RuntimeException	shouldNotReachHere(String msg)
static RuntimeException	shouldNotReachHere(Throwable cause)
static RuntimeException	shouldNotReachHere(Throwable cause, String msg)
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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GraalError

public GraalError(String msg)

This constructor creates a GraalError with a given message.

Parameters:

msg - the message that will be associated with the error

GraalError

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

This constructor creates a GraalError 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.

GraalError

public GraalError(Throwable cause)

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

Parameters:

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

GraalError

public GraalError(Throwable cause,
                  String msg,
                  Object... args)

This constructor creates a GraalError for a given causing Throwable instance with detailed error message.

GraalError

public GraalError(GraalError e)

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

Parameters:

e - the original GraalError

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)

shouldNotReachHere

public static RuntimeException shouldNotReachHere(Throwable cause,
                                                  String msg)

guarantee

public static void guarantee(boolean condition,
                             String msg)

Checks a given condition and throws a GraalError 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

guarantee

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

Checks a given condition and throws a GraalError 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

arg - argument to the format string in msg

guarantee

public static void guarantee(boolean condition,
                             String msg,
                             Object arg1,
                             Object arg2)

Checks a given condition and throws a GraalError 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

arg1 - argument to the format string in msg

arg2 - argument to the format string in msg

guarantee

public static void guarantee(boolean condition,
                             String msg,
                             Object arg1,
                             Object arg2,
                             Object arg3)

Checks a given condition and throws a GraalError 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

arg1 - argument to the format string in msg

arg2 - argument to the format string in msg

arg3 - argument to the format string in msg

guarantee

public static void guarantee(boolean condition,
                             String msg,
                             Object arg1,
                             Object arg2,
                             Object arg3,
                             Object arg4)

Checks a given condition and throws a GraalError 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

arg1 - argument to the format string in msg

arg2 - argument to the format string in msg

arg3 - argument to the format string in msg

arg4 - argument to the format string in msg

toString

public String toString()

Overrides:

toString in class Throwable

context

public String context()

addContext

public GraalError addContext(String newContext)

addContext

public GraalError addContext(String name,
                             Object obj)