Modifier and Type	Class and Description
private static class	RubyException.Backtrace

Modifier and Type	Field and Description
private final RubyException.Backtrace	backtrace
private IRubyObject	cause
public static final ObjectAllocator	EXCEPTION_ALLOCATOR
private static final ObjectMarshal<RubyException>	EXCEPTION_MARSHAL
pack-priv IRubyObject	message
private RaiseException	throwable
public static final int	TRACE_HEAD
public static final int	TRACE_MAX
public static final int	TRACE_TAIL

Access	Constructor and Description
protected	RubyException(Ruby runtime, RubyClass rubyClass)
public	RubyException(Ruby runtime, RubyClass rubyClass, String message)

Method Summary

Modifier and Type	Method and Description
private static RubyThread.Location	asBacktraceLocation(IRubyObject object)
public IRubyObject	backtrace()
public IRubyObject	backtrace_locations(ThreadContext context)
public void	captureBacktrace(ThreadContext context)
public IRubyObject	cause(ThreadContext context)
private static IRubyObject	checkBacktrace(ThreadContext context, IRubyObject obj)
protected RaiseException	constructThrowable(String message)
public void	copySpecialInstanceVariables(IRubyObject clone) Overrides org.jruby.RubyBasicObject.copySpecialInstanceVariables. Implements org.jruby.runtime.builtin.IRubyObject.copySpecialInstanceVariables. Lots of MRI objects keep their state in non-lookupable ivars (e:g.
public static RubyClass	createExceptionClass(ThreadContext context, RubyClass Object)
public IRubyObject	detailed_message(ThreadContext context)
public IRubyObject	detailed_message(ThreadContext context, IRubyObject opts)
public IRubyObject	detailed_message(ThreadContext context, IRubyObject[] args)
public static IRubyObject	exception(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)
public RubyException	exception(IRubyObject[] args)
public IRubyObject	full_message(ThreadContext context)
public IRubyObject	full_message(ThreadContext context, IRubyObject opts)
public IRubyObject	getBacktrace()
public RubyStackTraceElement[]	getBacktraceElements()
public Object	getCause()
public IRubyObject	Returns: error message if provided or nil getMessage()
public String	getMessageAsJavaString()
public List<Variable<Object>>	getVariableList() Overrides org.jruby.RubyBasicObject.getVariableList. Implements org.jruby.runtime.builtin.IRubyObject.getVariableList. Gets a list of all variables in this object.
public List<String>	getVariableNameList() Overrides org.jruby.RubyBasicObject.getVariableNameList. Implements org.jruby.runtime.builtin.IRubyObject.getVariableNameList. Gets a name list of all variables in this object.
public IRubyObject	initialize(ThreadContext context) Overrides org.jruby.RubyBasicObject.initialize.
public IRubyObject	initialize(ThreadContext context, IRubyObject arg0)
public IRubyObject	initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1)
public IRubyObject	initialize(IRubyObject[] args, Block block)
public RubyString	Returns: A RubyString containing the debug information. inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. inspects an object and return a kind of debug information
private static boolean	isArrayOfStrings(IRubyObject backtrace)
private BacktraceData	locationArrayToBacktrace(IRubyObject ary)
public IRubyObject	message(ThreadContext context)
public static RubyException	newException(Ruby runtime, RubyClass exceptionClass, String msg)
public static RubyException	Returns: the new exception object newException(ThreadContext the current thread context context, RubyClass the exception class exceptionClass, RubyString the message for the exception message) Construct a new RubyException object from the given exception class and message.
public static RubyException	Returns: the new exception object newException(ThreadContext the current thread context context, RubyClass the exception class exceptionClass, IRubyObject... the arguments for the exception's constructor args) Construct a new RubyException object from the given exception class and message.
public static IRubyObject	newException(ThreadContext context, RubyClass exceptionClass, IRubyObject message) Deprecated
public static IRubyObject	op_eqq(ThreadContext context, IRubyObject recv, IRubyObject other)
public RubyBoolean	op_equal(ThreadContext context, IRubyObject other) Overrides org.jruby.RubyBasicObject.op_equal. Implements org.jruby.runtime.builtin.IRubyObject.op_equal. rb_obj_equal Will by default use identity equality to compare objects.
public void	prepareIntegratedBacktrace(ThreadContext context, StackTraceElement[] javaTrace) Deprecated
public void	printBacktrace(PrintStream the PrintStream to which backtrace should be printed errorStream) Print the Ruby exception's backtrace to the given PrintStream.
public void	printBacktrace(PrintStream the PrintStream to which backtrace should be printed errorStream, int skip) Print the Ruby exception's backtrace to the given PrintStream.
public static IRubyObject	Returns: set (or already generated) backtrace, null otherwise Note Internal API. retrieveBacktrace(RubyException exception) Retrieve the current backtrace object for a given exception.
public IRubyObject	set_backtrace(IRubyObject obj) Deprecated since 10.0.
public IRubyObject	set_backtrace(ThreadContext context, IRubyObject obj)
public void	setBacktrace(ThreadContext context, IRubyObject obj)
public void	setCause(IRubyObject cause)
public void	setMessage(IRubyObject the message message) Set the message for this NameError.
public IRubyObject	to_s(ThreadContext context) Overrides org.jruby.RubyBasicObject.to_s.
public static IRubyObject	to_tty_p(ThreadContext context, IRubyObject recv)
public <T> T	Returns: the converted result toJava(Class<T> the target type to which this object should be converted target) Overrides org.jruby.RubyBasicObject.toJava. Implements org.jruby.runtime.builtin.IRubyObject.toJava. Coerce this Ruby exception to the requested Java type, if possible.
public RaiseException	toThrowable() Get a throwable suitable for throwing in Java.

Field Detail

backtrace	back to summary
private final RubyException.Backtrace backtrace

cause	back to summary
private IRubyObject cause

EXCEPTION_ALLOCATOR	back to summary
public static final ObjectAllocator EXCEPTION_ALLOCATOR

EXCEPTION_MARSHAL	back to summary
private static final ObjectMarshal<RubyException> EXCEPTION_MARSHAL

message	back to summary
pack-priv IRubyObject message

throwable	back to summary
private RaiseException throwable

TRACE_HEAD	back to summary
public static final int TRACE_HEAD

TRACE_MAX	back to summary
public static final int TRACE_MAX

TRACE_TAIL	back to summary
public static final int TRACE_TAIL

Constructor Detail

RubyException	back to summary
protected RubyException(Ruby runtime, RubyClass rubyClass)

RubyException	back to summary
public RubyException(Ruby runtime, RubyClass rubyClass, String message)

Method Detail

asBacktraceLocation	back to summary
private static RubyThread.Location asBacktraceLocation(IRubyObject object)

backtrace	back to summary
public IRubyObject backtrace() Annotations @JRubyMethod

backtrace_locations	back to summary
public IRubyObject backtrace_locations(ThreadContext context) Annotations @JRubyMethod omit:true

captureBacktrace	back to summary
public void captureBacktrace(ThreadContext context)

cause	back to summary
public IRubyObject cause(ThreadContext context) Annotations @JRubyMethod name:cause

checkBacktrace	back to summary
private static IRubyObject checkBacktrace(ThreadContext context, IRubyObject obj)

constructThrowable	back to summary
protected RaiseException constructThrowable(String message)

copySpecialInstanceVariables	back to summary
public void copySpecialInstanceVariables(IRubyObject clone) Overrides org.jruby.RubyBasicObject.copySpecialInstanceVariables. Implements org.jruby.runtime.builtin.IRubyObject.copySpecialInstanceVariables. Doc from org.jruby.RubyBasicObject.copySpecialInstanceVariables. 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 Annotations @Override

copySpecialInstanceVariables

back to summary

public void copySpecialInstanceVariables(IRubyObject clone)

Overrides org.jruby.RubyBasicObject.copySpecialInstanceVariables.

Implements org.jruby.runtime.builtin.IRubyObject.copySpecialInstanceVariables.

Doc from org.jruby.RubyBasicObject.copySpecialInstanceVariables.

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

Annotations

@Override

createExceptionClass	back to summary
public static RubyClass createExceptionClass(ThreadContext context, RubyClass Object)

detailed_message	back to summary
public IRubyObject detailed_message(ThreadContext context) Annotations @JRubyMethod

detailed_message	back to summary
public IRubyObject detailed_message(ThreadContext context, IRubyObject opts) Annotations @JRubyMethod

detailed_message	back to summary
public IRubyObject detailed_message(ThreadContext context, IRubyObject[] args) Annotations @JRubyMethod optional:1

exception	back to summary
public static IRubyObject exception(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block) Annotations @JRubyMethod name:exception rest:true meta:true

exception	back to summary
public RubyException exception(IRubyObject[] args) Annotations @JRubyMethod optional:1 checkArity:false

full_message	back to summary
public IRubyObject full_message(ThreadContext context) Annotations @JRubyMethod

full_message	back to summary
public IRubyObject full_message(ThreadContext context, IRubyObject opts) Annotations @JRubyMethod

getBacktrace	back to summary
public IRubyObject getBacktrace()

getBacktraceElements	back to summary
public RubyStackTraceElement[] getBacktraceElements()

getCause	back to summary
public Object getCause()

getMessage	back to summary
public IRubyObject getMessage() Returns:IRubyObject error message if provided or nil

getMessageAsJavaString	back to summary
public String getMessageAsJavaString()

getVariableList	back to summary
public List<Variable<Object>> getVariableList() Overrides org.jruby.RubyBasicObject.getVariableList. Implements org.jruby.runtime.builtin.IRubyObject.getVariableList. Doc from org.jruby.RubyBasicObject.getVariableList. Gets a list of all variables in this object. Returns:List<Variable<Object>> Doc from org.jruby.runtime.builtin.IRubyObject.getVariableList. a list of all variables (ivar/internal) Annotations @Override

getVariableList

back to summary

public List<Variable<Object>> getVariableList()

Overrides org.jruby.RubyBasicObject.getVariableList.

Implements org.jruby.runtime.builtin.IRubyObject.getVariableList.

Doc from org.jruby.RubyBasicObject.getVariableList.

Gets a list of all variables in this object.

Returns:List<Variable<Object>>

Doc from org.jruby.runtime.builtin.IRubyObject.getVariableList.

a list of all variables (ivar/internal)

Annotations

@Override

getVariableNameList	back to summary
public List<String> getVariableNameList() Overrides org.jruby.RubyBasicObject.getVariableNameList. Implements org.jruby.runtime.builtin.IRubyObject.getVariableNameList. Doc from org.jruby.RubyBasicObject.getVariableNameList. Gets a name list of all variables in this object. Returns:List<String> Doc from org.jruby.runtime.builtin.IRubyObject.getVariableNameList. a list of all variable names (ivar/cvar/constant/internal) Annotations @Override

getVariableNameList

back to summary

public List<String> getVariableNameList()

Overrides org.jruby.RubyBasicObject.getVariableNameList.

Implements org.jruby.runtime.builtin.IRubyObject.getVariableNameList.

Doc from org.jruby.RubyBasicObject.getVariableNameList.

Gets a name list of all variables in this object.

Returns:List<String>

Doc from org.jruby.runtime.builtin.IRubyObject.getVariableNameList.

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

Annotations

@Override

initialize	back to summary
public IRubyObject initialize(ThreadContext context) Overrides org.jruby.RubyBasicObject.initialize. Annotations @JRubyMethod visibility:PRIVATE

initialize

back to summary

public IRubyObject initialize(ThreadContext context)

Overrides org.jruby.RubyBasicObject.initialize.

Annotations

@JRubyMethod
visibility:PRIVATE

initialize	back to summary
public IRubyObject initialize(ThreadContext context, IRubyObject arg0) Annotations @JRubyMethod visibility:PRIVATE

initialize	back to summary
public IRubyObject initialize(ThreadContext context, IRubyObject arg0, IRubyObject arg1) Annotations @JRubyMethod visibility:PRIVATE

initialize	back to summary
public IRubyObject initialize(IRubyObject[] args, Block block)

inspect	back to summary
public RubyString inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. inspects an object and return a kind of debug information Returns:RubyString A RubyString containing the debug information. Annotations @JRubyMethod name:inspect

inspect

back to summary

public RubyString inspect(ThreadContext context)

Overrides org.jruby.RubyBasicObject.inspect.

Overrides default org.jruby.runtime.builtin.IRubyObject.inspect.

inspects an object and return a kind of debug information

Returns:RubyString

A RubyString containing the debug information.

Annotations

@JRubyMethod
name:inspect

isArrayOfStrings	back to summary
private static boolean isArrayOfStrings(IRubyObject backtrace)

locationArrayToBacktrace	back to summary
private BacktraceData locationArrayToBacktrace(IRubyObject ary)

message	back to summary
public IRubyObject message(ThreadContext context) Annotations @JRubyMethod name:message

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

newException	back to summary
public static RubyException newException(ThreadContext context, RubyClass exceptionClass, RubyString message) Construct a new RubyException object from the given exception class and message. Parameters context:ThreadContext the current thread context exceptionClass:RubyClass the exception class message:RubyString the message for the exception Returns:RubyException the new exception object

newException

back to summary

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

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

Parameters

context:ThreadContext: the current thread context
exceptionClass:RubyClass: the exception class
message:RubyString: the message for the exception

Returns:RubyException

the new exception object

newException	back to summary
public static RubyException newException(ThreadContext context, RubyClass exceptionClass, IRubyObject... args) Construct a new RubyException object from the given exception class and message. Parameters context:ThreadContext the current thread context exceptionClass:RubyClass the exception class args:IRubyObject[] the arguments for the exception's constructor Returns:RubyException the new exception object

newException

back to summary

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

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

Parameters

context:ThreadContext: the current thread context
exceptionClass:RubyClass: the exception class
args:IRubyObject[]: the arguments for the exception's constructor

Returns:RubyException

the new exception object

newException	back to summary
public static IRubyObject newException(ThreadContext context, RubyClass exceptionClass, IRubyObject message) Deprecated Annotations @Deprecated

op_eqq	back to summary
public static IRubyObject op_eqq(ThreadContext context, IRubyObject recv, IRubyObject other) Annotations @JRubyMethod name:=== meta:true

op_equal

back to summary

public RubyBoolean op_equal(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyBasicObject.op_equal.

Implements org.jruby.runtime.builtin.IRubyObject.op_equal.

Doc from org.jruby.RubyBasicObject.op_equal.

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

Annotations

@Override
@JRubyMethod
name:==

prepareIntegratedBacktrace	back to summary
public void prepareIntegratedBacktrace(ThreadContext context, StackTraceElement[] javaTrace) Deprecated Annotations @Deprecated

printBacktrace

back to summary

public void printBacktrace(PrintStream errorStream)

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

Parameters

errorStream:PrintStream: the PrintStream to which backtrace should be printed

printBacktrace

back to summary

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:PrintStream: the PrintStream to which backtrace should be printed

retrieveBacktrace

back to summary

public static IRubyObject retrieveBacktrace(RubyException exception)

Retrieve the current backtrace object for a given exception.

Returns:IRubyObject: set (or already generated) backtrace, null otherwise
Note
Internal API.

set_backtrace	back to summary
public IRubyObject set_backtrace(IRubyObject obj) Deprecated since 10.0. Annotations @Deprecated since:10.0

set_backtrace	back to summary
public IRubyObject set_backtrace(ThreadContext context, IRubyObject obj) Annotations @JRubyMethod

setBacktrace	back to summary
public void setBacktrace(ThreadContext context, IRubyObject obj)

setCause	back to summary
public void setCause(IRubyObject cause)

setMessage

back to summary

public void setMessage(IRubyObject message)

Set the message for this NameError.

Parameters

message:IRubyObject: the message

to_s

back to summary

public IRubyObject to_s(ThreadContext context)

Overrides org.jruby.RubyBasicObject.to_s.

Annotations

@JRubyMethod
name:to_s

to_tty_p	back to summary
public static IRubyObject to_tty_p(ThreadContext context, IRubyObject recv) Annotations @JRubyMethod name:to_tty? meta:true

toJava

back to summary

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

Overrides org.jruby.RubyBasicObject.toJava.

Implements org.jruby.runtime.builtin.IRubyObject.toJava.

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.

Parameters

<T>: Doc from org.jruby.runtime.builtin.IRubyObject.toJava. type
target:Class<T>: the target type to which this object should be converted

Returns:T

the converted result

Annotations

@Override

toThrowable	back to summary
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`

org.jruby back to summary

private Class RubyException.Backtrace

Class Inheritance

extends Object

java.lang.Object
org.jruby.RubyException.Backtrace

Field Summary

Modifier and Type	Field and Description
private BacktraceData	backtraceData
private IRubyObject	backtraceLocations
private IRubyObject	backtraceObject

Constructor Summary

Access	Constructor and Description
private	Backtrace()

Method Summary

Modifier and Type	Method and Description
public void	copy(RubyException.Backtrace clone)
public IRubyObject	Returns: the generated Ruby backtrace generateBacktrace(Ruby runtime) Generate a new backtrace (or returns nil if no backtrace data exists).
public IRubyObject	Returns: the array of backtrace locations generateBacktraceLocations(ThreadContext the current thread context context) Generate an array of backtrace location objects for this backtrace.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

backtraceData	back to summary
private BacktraceData backtraceData

backtraceLocations	back to summary
private IRubyObject backtraceLocations

backtraceObject	back to summary
private IRubyObject backtraceObject

Constructor Detail

Backtrace	back to summary
private Backtrace()

Method Detail

copy	back to summary
public void copy(RubyException.Backtrace clone)

generateBacktrace

back to summary

public IRubyObject generateBacktrace(Ruby runtime)

Generate a new backtrace (or returns nil if no backtrace data exists).

Returns:IRubyObject: the generated Ruby backtrace

generateBacktraceLocations

back to summary

public IRubyObject generateBacktraceLocations(ThreadContext context)

Generate an array of backtrace location objects for this backtrace.

Parameters

context:ThreadContext: the current thread context

Returns:IRubyObject

the array of backtrace locations

public Class RubyException

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class RubyException.Backtrace

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail