1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
|
<html><title>Programming Ruby: The Pragmatic Programmer's Guide</title><head><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><STYLE TYPE="text/css"><!--
BODY { margin-left: 1in;
width: 6in;
font-family: helvetica, arial, sans-serif;
}
H1 { color: #000080;
font-family: helvetica, arial, sans-serif;
font-size: 22pt;
margin-left: 0in
}
H2 { color: #000080; font: bold x-large helvetica, sans-serif;
margin-left: 0in }
H3 { color: #000080; font: bold large helvetica, sans-serif; }
H4 { color: #000080; font: italic large helvetica, sans-serif; }
.ruby { background: #fff0f0 }
.header { color: white }
.subheader { color: #ffdddd }
.sidebar { width: 6in }
span.sans { font-family: helvetica, arial, sans-serif }
-->
</STYLE><table bgcolor="#a03030" cellpadding="3" border="0" cellspacing="0"><tr><td colspan="3"><table bgcolor="#902020" cellpadding="20"><tr><td><h1 class="header">Programming Ruby</h1><h3 class="subheader">The Pragmatic Programmer's Guide</h3></td></tr></table></td></tr><tr><td width="33%" align="left"><a class="subheader" href="ref_c_dir.html">Previous <</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_falseclass.html">Next ></a><br></td></tr></table></head><body bgcolor="white">
<!--
Copyright (c) 2001 by Addison Wesley Longman. This
material may be distributed only subject to the terms and
conditions set forth in the Open Publication License, v1.0 or
later (the latest version is presently available at
http://www.opencontent.org/openpub/).
-->
<table><tr><td height="20"><img src="dot.gif" width="1" height="20"></td></tr></table><table border="0" width="100%" bgcolor="660066" cellpadding="10"><tr><td valign="center"><font color="white" size="7">class Exception</font></td><td><table border="0"><tr><td><font color="white">
Parent:
</font></td><td><font color="white">Object</font></td></tr><tr><td><font color="white">
Version:
</font></td><td><font color="white">
1.6
</font></td></tr></table></td></tr></table><p></p><H3>Index:</H3><a href="#exception">exception</a> <a href="#backtrace"><i>backtrace</i></a> <a href="#exception"><i>exception</i></a> <a href="#message"><i>message</i></a> <a href="#set_backtrace"><i>set_backtrace</i></a> <p></p><hr>
<P></P>
Descendents of class <code>Exception</code> are used to communicate
between <code>raise</code>
methods and <code>rescue</code> statements in <code>begin/end</code>
blocks. <code>Exception</code> objects carry information about the
exception---its type (the exception's class name), an optional
descriptive string, and optional traceback information.
<P></P>
<table border="0" width="100%" cellpadding="10"><tr><td valign="center" colspan="2" bgcolor="990066"><font color="white" size="6">class methods
</font></td></tr><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="exception"><b>exception</b></a></font></td><td bgcolor="#ffaaaa">
Exception.exception( <i>[</i><i>aString</i><i>]</i> )
-> <i>anException</i>
</td></tr><td></td><td>
<P></P>
Creates and returns a new exception object, optionally setting the message to
<i>aString</i>.
<P></P>
</td></table>
<P></P>
<table border="0" width="100%" cellpadding="10"><tr><td valign="center" colspan="2" bgcolor="990066"><font color="white" size="6">instance methods
</font></td></tr><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="backtrace"><b>backtrace</b></a></font></td><td bgcolor="#ffaaaa">
<i>exc</i>.backtrace
-> <i>anArray</i>
</td></tr><td></td><td>
<P></P>
Returns any backtrace associated with the exception. The
backtrace is an array of strings, each containing
either ``filename:lineNo: in `method''' or ``filename:lineNo.''
<P></P>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="400"><tr><td><pre>
def a
raise "boom"
end
<P></P>
def b
a()
end
<P></P>
begin
b()
rescue => detail
print detail.backtrace.join("\n")
end
</pre></td></tr></table>
<em>produces:</em>
<table bgcolor="#fff0f0" cellspacing="0" border="0" cellpadding="3" width="400"><tr><td><pre>
prog.rb:2:in `a'
prog.rb:6:in `b'
prog.rb:10
</pre></td></tr></table>
<P></P>
</td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="exception"><b>exception</b></a></font></td><td bgcolor="#ffaaaa">
<i>exc</i>.exception( <i>[</i><i>aString</i><i>]</i> )
-> <i>anException</i> or <i>exc</i>
</td></tr><td></td><td>
<P></P>
With no argument, returns the receiver. Otherwise, creates a new
exception object of the same class as the receiver, but with a
different message.
<P></P>
</td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="message"><b>message</b></a></font></td><td bgcolor="#ffaaaa">
<i>exc</i>.message -> <i>aString</i>
</td></tr><td></td><td>
<P></P>
Returns the message associated with this exception.
<P></P>
</td><tr><td valign="center" bgcolor="#ff9999"><font size="4"><a name="set_backtrace"><b>set_backtrace</b></a></font></td><td bgcolor="#ffaaaa">
<i>exc</i>.set_backtrace( <i>anArray</i> )
-> <i>anArray</i>
</td></tr><td></td><td>
<P></P>
Sets the backtrace information associated with <i>exc</i>. The
argument must be an array of <code>String</code> objects in the format
described in <a href="ref_c_exception.html#backtrace"><code>Exception#backtrace</code></a>.
<P></P>
</td></table>
<P></P>
<p></p><hr><table bgcolor="#a03030" cellpadding="10" border="0" cellspacing="0"><tr><td width="33%" align="left"><a class="subheader" href="ref_c_dir.html">Previous <</a></td><td width="33%" align="center" valign="middle"><a class="subheader" href="builtins.html">Contents ^</a><br></td><td width="33%" align="right"><a class="subheader" href="ref_c_falseclass.html">Next ></a><br></td></tr></table><p></p><font size="-1">Extracted from the book "Programming Ruby -
The Pragmatic Programmer's Guide"</font><br><font size="-3">
Copyright
©
2000 Addison Wesley Longman, Inc. Released under the terms of the
<a href="http://www.opencontent.org/openpub/">Open Publication License</a> V1.0.
<br>
This reference is available for
<a href="http://www.pragmaticprogrammer.com/ruby/downloads/book.html">download</a>.
</font></body></html>
|