Module org.jruby.base

Package org.jruby.exceptions

Class RaiseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.jruby.exceptions.JumpException

org.jruby.exceptions.RaiseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Exception

public class RaiseException
extends JumpException

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.exceptions.JumpException

JumpException.FlowControlException, JumpException.SpecialJump

Field Summary

Fields inherited from class org.jruby.exceptions.JumpException

SPECIAL_JUMP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RaiseException(String message, RubyException exception)
	RaiseException(Ruby runtime, RubyClass exceptionClass, String msg)	Deprecated.
	RaiseException(Ruby runtime, RubyClass exceptionClass, String msg, boolean unused)	Deprecated.
	RaiseException(Ruby runtime, RubyClass exceptionClass, String msg, IRubyObject backtrace)	Deprecated.
	RaiseException(Ruby runtime, RubyClass exceptionClass, String msg, IRubyObject backtrace, boolean unused)	Deprecated.

Method Summary

Modifier and Type	Method	Description
final Throwable	fillInStackTrace()	This method don't do anything for performance reasons.
static RaiseException	from(Ruby runtime, String exceptionPath, String msg)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
static RaiseException	from(Ruby runtime, String exceptionPath, String msg, IRubyObject backtrace)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
static RaiseException	from(Ruby runtime, String exceptionPath, IRubyObject... args)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
static RaiseException	from(Ruby runtime, RubyClass exceptionClass, String msg)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
static RaiseException	from(Ruby runtime, RubyClass exceptionClass, String msg, IRubyObject backtrace)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
static RaiseException	from(Ruby runtime, RubyClass exceptionClass, IRubyObject... args)	Construct a new throwable RaiseException appropriate for the target Ruby exception class.
Throwable	getCause()
final RubyException	getException()	Gets the exception
String	getMessage()
static StackTraceElement[]	javaTraceFromRubyTrace(RubyStackTraceElement[] trace)
protected final void	setException(RubyException newException)	Sets the exception

Methods inherited from class org.jruby.exceptions.JumpException

originalFillInStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RaiseException

protected RaiseException(String message,
 RubyException exception)

RaiseException

@Deprecated(since="9.2.0.0")
public RaiseException(Ruby runtime,
 RubyClass exceptionClass,
 String msg)

Deprecated.

RaiseException

@Deprecated(since="9.2.0.0")
public RaiseException(Ruby runtime,
 RubyClass exceptionClass,
 String msg,
 boolean unused)

Deprecated.

RaiseException

@Deprecated(since="9.2.0.0")
public RaiseException(Ruby runtime,
 RubyClass exceptionClass,
 String msg,
 IRubyObject backtrace)

Deprecated.

RaiseException

@Deprecated(since="9.2.0.0")
public RaiseException(Ruby runtime,
 RubyClass exceptionClass,
 String msg,
 IRubyObject backtrace,
 boolean unused)

Deprecated.

Method Details

fillInStackTrace

public final Throwable fillInStackTrace()

Description copied from class: JumpException

This method don't do anything for performance reasons.

Overrides:

fillInStackTrace in class JumpException

See Also:

• Throwable.fillInStackTrace()

from

public static RaiseException from(Ruby runtime,
 RubyClass exceptionClass,
 String msg)

Construct a new throwable RaiseException appropriate for the target Ruby exception class. Note that this will produce a RaiseException that has fully prepared for being thrown, including:

• Populating the stack trace based on the current thread
• Setting the cause to any currently in-flight exception
• Setting the thread-local $! "error info" to this exception

This constructor should not be used to create a RubyException object to be raised on a different thread.

Parameters:

runtime - the current JRuby runtime

exceptionClass - the class of the exception to construct and raise

msg - a simple message for the exception

Returns:

a RaiseException instance appropriate for the target Ruby exception class

from

public static RaiseException from(Ruby runtime,
 RubyClass exceptionClass,
 String msg,
 IRubyObject backtrace)

Construct a new throwable RaiseException appropriate for the target Ruby exception class.

Parameters:

runtime - the current JRuby runtime

exceptionClass - the class of the exception to construct and raise

msg - a simple message for the exception

backtrace - a Ruby object (usually an Array) to use for the exception's backtrace

Returns:

a RaiseException instance appropriate for the target Ruby exception class

from

public static RaiseException from(Ruby runtime,
 RubyClass exceptionClass,
 IRubyObject... args)

Construct a new throwable RaiseException appropriate for the target Ruby exception class.

Parameters:

runtime - the current JRuby runtime

exceptionClass - the class of the exception to construct and raise

args - the arguments for the exception's constructor

Returns:

a RaiseException instance appropriate for the target Ruby exception class

from

public static RaiseException from(Ruby runtime,
 String exceptionPath,
 String msg)

Construct a new throwable RaiseException appropriate for the target Ruby exception class.

Parameters:

runtime - the current JRuby runtime

exceptionPath - a string representing the fully-qualified constant path to look up the exception

msg - a simple message for the exception

Returns:

a RaiseException instance appropriate for the target Ruby exception class

from

public static RaiseException from(Ruby runtime,
 String exceptionPath,
 String msg,
 IRubyObject backtrace)

Construct a new throwable RaiseException appropriate for the target Ruby exception class.

Parameters:

runtime - the current JRuby runtime

exceptionPath - a string representing the fully-qualified constant path to look up the exception

msg - a simple message for the exception

backtrace - a Ruby object (usually an Array) to use for the exception's backtrace

Returns:

a RaiseException instance appropriate for the target Ruby exception class

from

public static RaiseException from(Ruby runtime,
 String exceptionPath,
 IRubyObject... args)

Construct a new throwable RaiseException appropriate for the target Ruby exception class.

Parameters:

runtime - the current JRuby runtimeString exceptionPath

args - the arguments for the exception's constructor

Returns:

a RaiseException instance appropriate for the target Ruby exception class

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable

getException

public final RubyException getException()

Gets the exception

Returns:

Returns a RubyException

setException

protected final void setException(RubyException newException)

Sets the exception

Parameters:

newException - The exception to set

javaTraceFromRubyTrace

public static StackTraceElement[] javaTraceFromRubyTrace(RubyStackTraceElement[] trace)