org.jruby

Class RubyException

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyException

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

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

public class RubyException
extends RubyObject

Author:

jpetersen

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 and Description
protected BacktraceData	backtraceData
static ObjectAllocator	EXCEPTION_ALLOCATOR
static java.lang.String[]	FULL_MESSAGE_KEYS
static int	TRACE_HEAD
static int	TRACE_MAX
static 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, UNTRUST_F, 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 and Description
protected	RubyException(Ruby runtime, RubyClass rubyClass)
	RubyException(Ruby runtime, RubyClass rubyClass, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
IRubyObject	backtrace_locations(ThreadContext context)
IRubyObject	backtrace()
IRubyObject	cause(ThreadContext context)
protected RaiseException	constructThrowable(java.lang.String message)
void	copySpecialInstanceVariables(IRubyObject clone) Lots of MRI objects keep their state in non-lookupable ivars (e:g.
static RubyClass	createExceptionClass(Ruby runtime)
RubyException	exception(IRubyObject[] args)
static IRubyObject	exception(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
void	forceBacktrace(IRubyObject backtrace)
IRubyObject	full_message(ThreadContext context)
IRubyObject	full_message(ThreadContext context, IRubyObject opts)
IRubyObject	getBacktrace()
BacktraceData	getBacktraceData()
RubyStackTraceElement[]	getBacktraceElements()
java.lang.Object	getCause()
IRubyObject	getMessage()
java.lang.String	getMessageAsJavaString()
java.util.List<Variable<java.lang.Object>>	getVariableList() Gets a list of all variables in this object.
java.util.List<java.lang.String>	getVariableNameList() Gets a name list of all variables in this object.
void	initBacktrace()
IRubyObject	initialize(IRubyObject[] args, Block block)
RubyString	inspect(ThreadContext context) inspects an object and return a kind of debug information
IRubyObject	message(ThreadContext context)
static RubyException	newException(Ruby runtime, RubyClass excptnClass, java.lang.String msg)
static IRubyObject	newException(ThreadContext context, RubyClass exceptionClass, IRubyObject message) Deprecated.
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	prepareBacktrace(ThreadContext context)
void	prepareIntegratedBacktrace(ThreadContext context, java.lang.StackTraceElement[] javaTrace) Prepare an "integrated" backtrace that includes the normal Ruby trace plus non-filtered Java frames.
void	printBacktrace(java.io.PrintStream errorStream) Print the Ruby exception's backtrace to the given PrintStream.
void	printBacktrace(java.io.PrintStream errorStream, int skip) Print the Ruby exception's backtrace to the given PrintStream.
IRubyObject	set_backtrace(IRubyObject obj)
void	setBacktraceData(BacktraceData backtraceData)
void	setCause(IRubyObject cause)
void	setMessage(IRubyObject message) Set the message for this NameError.
IRubyObject	to_s(ThreadContext context)
IRubyObject	to_s19(ThreadContext context) Deprecated.
<T> T	toJava(java.lang.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, createObjectClass, dig, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, trust, type_deprecated, 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

Field Detail

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

FULL_MESSAGE_KEYS

public static final java.lang.String[] FULL_MESSAGE_KEYS

backtraceData

protected BacktraceData backtraceData

EXCEPTION_ALLOCATOR

public static ObjectAllocator EXCEPTION_ALLOCATOR

Constructor Detail

RubyException

protected RubyException(Ruby runtime,
                        RubyClass rubyClass)

RubyException

public RubyException(Ruby runtime,
                     RubyClass rubyClass,
                     java.lang.String message)

Method Detail

exception

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

op_eqq

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

constructThrowable

protected RaiseException constructThrowable(java.lang.String message)

createExceptionClass

public static RubyClass createExceptionClass(Ruby runtime)

newException

public static RubyException newException(Ruby runtime,
                                         RubyClass excptnClass,
                                         java.lang.String msg)

newException

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

Deprecated.

full_message

public IRubyObject full_message(ThreadContext context)

full_message

public IRubyObject full_message(ThreadContext context,
                                IRubyObject opts)

initialize

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

backtrace

public IRubyObject backtrace()

set_backtrace

public IRubyObject set_backtrace(IRubyObject obj)

backtrace_locations

public IRubyObject backtrace_locations(ThreadContext context)

exception

public RubyException exception(IRubyObject[] args)

to_s

public IRubyObject to_s(ThreadContext context)

to_s19

@Deprecated
public IRubyObject to_s19(ThreadContext context)

Deprecated.

message

public IRubyObject message(ThreadContext context)

inspect

public RubyString inspect(ThreadContext context)

inspects an object and return a kind of debug information

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(java.lang.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

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 java.lang.Object getCause()

setBacktraceData

public void setBacktraceData(BacktraceData backtraceData)

getBacktraceData

public BacktraceData getBacktraceData()

getBacktraceElements

public RubyStackTraceElement[] getBacktraceElements()

prepareBacktrace

public void prepareBacktrace(ThreadContext context)

prepareIntegratedBacktrace

public void prepareIntegratedBacktrace(ThreadContext context,
                                       java.lang.StackTraceElement[] javaTrace)

Prepare an "integrated" backtrace that includes the normal Ruby trace plus non-filtered Java frames. Used by Java integration to show the Java frames for a JI-called method.

Parameters:

context -

javaTrace -

forceBacktrace

public void forceBacktrace(IRubyObject backtrace)

getBacktrace

public IRubyObject getBacktrace()

initBacktrace

public void initBacktrace()

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(java.io.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(java.io.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 java.lang.String getMessageAsJavaString()

getVariableList

public java.util.List<Variable<java.lang.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/cvar/constant/internal)

getVariableNameList

public java.util.List<java.lang.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)