Package org.jruby

Class RubyException

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyException

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

NativeException, RubyFatal, RubyNoMemoryError, RubyScriptError, RubySecurityError, RubySignalException, RubyStandardError, RubySystemExit, RubySystemStackError

public class RubyException
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
static final ObjectAllocator	EXCEPTION_ALLOCATOR
static final int	TRACE_HEAD
static final int	TRACE_MAX
static final int	TRACE_TAIL

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RubyException(Ruby runtime, RubyClass rubyClass)
	RubyException(Ruby runtime, RubyClass rubyClass, String message)

Method Summary

Modifier and Type	Method	Description
IRubyObject	backtrace()
IRubyObject	backtrace_locations(ThreadContext context)
void	captureBacktrace(ThreadContext context)
IRubyObject	cause(ThreadContext context)
protected RaiseException	constructThrowable(String message)
void	copySpecialInstanceVariables(IRubyObject clone)	Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createExceptionClass(ThreadContext context, RubyClass Object)
IRubyObject	detailed_message(ThreadContext context)
IRubyObject	detailed_message(ThreadContext context, IRubyObject opts)
IRubyObject	detailed_message(ThreadContext context, IRubyObject[] args)
RubyException	exception(IRubyObject[] args)
static IRubyObject	exception(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
IRubyObject	full_message(ThreadContext context)
IRubyObject	full_message(ThreadContext context, IRubyObject opts)
IRubyObject	getBacktrace()
RubyStackTraceElement[]	getBacktraceElements()
Object	getCause()
IRubyObject	getMessage()
String	getMessageAsJavaString()
List<Variable<Object>>	getVariableList()	Gets a list of all variables in this object.
List<String>	getVariableNameList()	Gets a name list of all variables in this object.
IRubyObject	initialize(IRubyObject[] args, Block block)
IRubyObject	initialize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0)
IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
RubyString	inspect(ThreadContext context)	inspects an object and return a kind of debug information
IRubyObject	message(ThreadContext context)
static RubyException	newException(Ruby runtime, RubyClass exceptionClass, String msg)
static RubyException	newException(ThreadContext context, RubyClass exceptionClass, RubyString message)	Construct a new RubyException object from the given exception class and message.
static IRubyObject	newException(ThreadContext context, RubyClass exceptionClass, IRubyObject message)	Deprecated.
static RubyException	newException(ThreadContext context, RubyClass exceptionClass, IRubyObject... args)	Construct a new RubyException object from the given exception class and message.
static IRubyObject	op_eqq(ThreadContext context, IRubyObject recv, IRubyObject other)
RubyBoolean	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
void	prepareIntegratedBacktrace(ThreadContext context, StackTraceElement[] javaTrace)	Deprecated.
void	printBacktrace(PrintStream errorStream)	Print the Ruby exception's backtrace to the given PrintStream.
void	printBacktrace(PrintStream errorStream, int skip)	Print the Ruby exception's backtrace to the given PrintStream.
static IRubyObject	retrieveBacktrace(RubyException exception)	Retrieve the current backtrace object for a given exception.
IRubyObject	set_backtrace(IRubyObject obj)	Deprecated.
IRubyObject	set_backtrace(ThreadContext context, IRubyObject obj)
void	setBacktrace(ThreadContext context, IRubyObject obj)
void	setCause(IRubyObject cause)
void	setMessage(IRubyObject message)	Set the message for this NameError.
IRubyObject	to_s(ThreadContext context)
static IRubyObject	to_tty_p(ThreadContext context, IRubyObject recv)
<T> T	toJava(Class<T> target)	Coerce this Ruby exception to the requested Java type, if possible.
RaiseException	toThrowable()	Get a throwable suitable for throwing in Java.

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, dup, marshalLiveVariables

Field Details

TRACE_HEAD

public static final int TRACE_HEAD

See Also:

• Constant Field Values

TRACE_TAIL

public static final int TRACE_TAIL

See Also:

• Constant Field Values

TRACE_MAX

public static final int TRACE_MAX

See Also:

• Constant Field Values

EXCEPTION_ALLOCATOR

public static final ObjectAllocator EXCEPTION_ALLOCATOR

Constructor Details

RubyException

protected RubyException(Ruby runtime,
 RubyClass rubyClass)

RubyException

public RubyException(Ruby runtime,
 RubyClass rubyClass,
 String message)

Method Details

exception

public static IRubyObject exception(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

to_tty_p

public static IRubyObject to_tty_p(ThreadContext context,
 IRubyObject recv)

op_eqq

public static IRubyObject op_eqq(ThreadContext context,
 IRubyObject recv,
 IRubyObject other)

constructThrowable

protected RaiseException constructThrowable(String message)

createExceptionClass

public static RubyClass createExceptionClass(ThreadContext context,
 RubyClass Object)

newException

public static RubyException newException(Ruby runtime,
 RubyClass exceptionClass,
 String msg)

newException

public static RubyException newException(ThreadContext context,
 RubyClass exceptionClass,
 RubyString message)

Construct a new RubyException object from the given exception class and message.

Parameters:

context - the current thread context

exceptionClass - the exception class

message - the message for the exception

Returns:

the new exception object

newException

public static RubyException newException(ThreadContext context,
 RubyClass exceptionClass,
 IRubyObject... args)

Construct a new RubyException object from the given exception class and message.

Parameters:

context - the current thread context

exceptionClass - the exception class

args - the arguments for the exception's constructor

Returns:

the new exception object

full_message

public IRubyObject full_message(ThreadContext context)

full_message

public IRubyObject full_message(ThreadContext context,
 IRubyObject opts)

detailed_message

public IRubyObject detailed_message(ThreadContext context)

detailed_message

public IRubyObject detailed_message(ThreadContext context,
 IRubyObject opts)

detailed_message

public IRubyObject detailed_message(ThreadContext context,
 IRubyObject[] args)

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject arg0)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject arg0,
 IRubyObject arg1)

initialize

public IRubyObject initialize(IRubyObject[] args,
 Block block)

backtrace

public IRubyObject backtrace()

set_backtrace

@Deprecated(since="10.0")
public IRubyObject set_backtrace(IRubyObject obj)

Deprecated.

set_backtrace

public IRubyObject set_backtrace(ThreadContext context,
 IRubyObject obj)

setBacktrace

public void setBacktrace(ThreadContext context,
 IRubyObject obj)

backtrace_locations

public IRubyObject backtrace_locations(ThreadContext context)

exception

public RubyException exception(IRubyObject[] args)

to_s

public IRubyObject to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

message

public IRubyObject message(ThreadContext context)

inspect

public RubyString inspect(ThreadContext context)

inspects an object and return a kind of debug information

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

Returns:

A RubyString containing the debug information.

op_equal

public RubyBoolean op_equal(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

cause

public IRubyObject cause(ThreadContext context)

toJava

public <T> T toJava(Class<T> target)

Coerce this Ruby exception to the requested Java type, if possible. If the requested type is a supertype of RaiseException, the attached throwable will be returned. Otherwise, it will fall back on RubyBasicObject toJava logic.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyBasicObject

Type Parameters:

T - type

Parameters:

target - the target type to which this object should be converted

Returns:

the converted result

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

toThrowable

public RaiseException toThrowable()

Get a throwable suitable for throwing in Java. The throwable here will be constructed lazily by calling constructThrowable and then cached for future calls. All throwables returned by Ruby exception objects will descend from RaiseException and follow the Throwable hierarchy below Exception

Returns:

setCause

public void setCause(IRubyObject cause)

getCause

public Object getCause()

getBacktraceElements

public RubyStackTraceElement[] getBacktraceElements()

captureBacktrace

public void captureBacktrace(ThreadContext context)

getBacktrace

public IRubyObject getBacktrace()

retrieveBacktrace

public static IRubyObject retrieveBacktrace(RubyException exception)

Retrieve the current backtrace object for a given exception.

Parameters:

exception -

Returns:

set (or already generated) backtrace, null otherwise

Note: Internal API.

copySpecialInstanceVariables

public void copySpecialInstanceVariables(IRubyObject clone)

Description copied from class: RubyBasicObject

Lots of MRI objects keep their state in non-lookupable ivars (e:g. Range, Struct, etc). This method is responsible for dupping our java field equivalents

Specified by:

copySpecialInstanceVariables in interface IRubyObject

Overrides:

copySpecialInstanceVariables in class RubyBasicObject

printBacktrace

public void printBacktrace(PrintStream errorStream)

Print the Ruby exception's backtrace to the given PrintStream.

Parameters:

errorStream - the PrintStream to which backtrace should be printed

printBacktrace

public void printBacktrace(PrintStream errorStream,
 int skip)

Print the Ruby exception's backtrace to the given PrintStream. This version accepts a number of lines to skip and is primarily used internally for exception printing where the first line is treated specially.

Parameters:

errorStream - the PrintStream to which backtrace should be printed

getMessage

public IRubyObject getMessage()

Returns:

error message if provided or nil

setMessage

public void setMessage(IRubyObject message)

Set the message for this NameError.

Parameters:

message - the message

getMessageAsJavaString

public String getMessageAsJavaString()

getVariableList

public List<Variable<Object>> getVariableList()

Description copied from class: RubyBasicObject

Gets a list of all variables in this object.

Specified by:

getVariableList in interface IRubyObject

Overrides:

getVariableList in class RubyBasicObject

Returns:

a list of all variables (ivar/internal)

getVariableNameList

public List<String> getVariableNameList()

Description copied from class: RubyBasicObject

Gets a name list of all variables in this object.

Specified by:

getVariableNameList in interface IRubyObject

Overrides:

getVariableNameList in class RubyBasicObject

Returns:

a list of all variable names (ivar/cvar/constant/internal)

prepareIntegratedBacktrace

@Deprecated
public void prepareIntegratedBacktrace(ThreadContext context,
 StackTraceElement[] javaTrace)

Deprecated.

newException

@Deprecated
public static IRubyObject newException(ThreadContext context,
 RubyClass exceptionClass,
 IRubyObject message)

Deprecated.