<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Exception: P4Error
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!P4Error.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (P)</a> »
<span class="title">P4Error</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Exception: P4Error
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">RuntimeError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RuntimeError</li>
<li class="next">P4Error</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/p4_error.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Any error we get from the Perforce server is generally encapsulated in a
P4Error, which allows us to get some basic diagnostic information from the
Perforce server out to the user.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="ERROR_CODE_BASE-constant" class="">ERROR_CODE_BASE =
<div class="docstring">
<div class="discussion">
<p>All error codes must be greater than this number.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>15_360</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#message_code-instance_method" title="#message_code (instance method)">- (Object) <strong>message_code</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_severity-instance_method" title="#message_severity (instance method)">- (Object) <strong>message_severity</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#message_text-instance_method" title="#message_text (instance method)">- (Object) <strong>message_text</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Note: We use 15_361 for 'unhandled' ruby errors.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default_error-class_method" title="default_error (class method)">+ (Object) <strong>default_error</strong>(message_text) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Class method to create a valid P4Error object from a simple string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error%3F-class_method" title="error? (class method)">+ (Boolean) <strong>error?</strong>(p4, severity: P4::E_FAILED) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if there's an error.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (P4Error) <strong>initialize</strong>(code, severity, text) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of P4Error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#system_error%3F-instance_method" title="#system_error? (instance method)">- (Boolean) <strong>system_error?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if the exception is truly a system problem.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_error%3F-instance_method" title="#user_error? (instance method)">- (Boolean) <strong>user_error?</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if the exception should actually be considered a user error
instead of a system exception.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="P4Error (class)">P4Error</a></span></tt>) <strong>initialize</strong>(code, severity, text)
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of P4Error</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span> <span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='ivar'>@message_code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
<span class='ivar'>@message_severity</span> <span class='op'>=</span> <span class='id identifier rubyid_severity'>severity</span>
<span class='ivar'>@message_text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="message_code=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="message_code-instance_method">
- (<tt>Object</tt>) <strong>message_code</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_code'>message_code</span>
<span class='ivar'>@message_code</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="message_severity=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="message_severity-instance_method">
- (<tt>Object</tt>) <strong>message_severity</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_severity'>message_severity</span>
<span class='ivar'>@message_severity</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="message_text=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="message_text-instance_method">
- (<tt>Object</tt>) <strong>message_text</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Note: We use 15_361 for 'unhandled' ruby errors</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_message_text'>message_text</span>
<span class='ivar'>@message_text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="default_error-class_method">
+ (<tt>Object</tt>) <strong>default_error</strong>(message_text)
</h3><div class="docstring">
<div class="discussion">
<p>Class method to create a valid P4Error object from a simple string. Used
when we get errors for which no P4::Message object is available.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 21</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_error'>default_error</span><span class='lparen'>(</span><span class='id identifier rubyid_message_text'>message_text</span><span class='rparen'>)</span>
<span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>ERROR_CODE_BASE</span><span class='comma'>,</span>
<span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span><span class='comma'>,</span>
<span class='id identifier rubyid_message_text'>message_text</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error?-class_method">
+ (<tt>Boolean</tt>) <strong>error?</strong>(p4, severity: P4::E_FAILED)
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if there's an error</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 28</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_error?'>error?</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='comma'>,</span> <span class='label'>severity:</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span> <span class='op'>&&</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_severity'>severity</span> <span class='op'>>=</span> <span class='id identifier rubyid_severity'>severity</span><span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="system_error?-instance_method">
- (<tt>Boolean</tt>) <strong>system_error?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if the exception is truly a system problem.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_system_error?'>system_error?</span>
<span class='kw'>return</span> <span class='ivar'>@message_severity</span> <span class='op'>==</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FATAL</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_s-instance_method">
- (<tt>Object</tt>) <strong>to_s</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='ivar'>@message_text</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user_error?-instance_method">
- (<tt>Boolean</tt>) <strong>user_error?</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if the exception should actually be considered a user error
instead of a system exception.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/p4_error.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_error?'>user_error?</span>
<span class='kw'>return</span> <span class='ivar'>@message_severity</span> <span class='op'>==</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FAILED</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Sep 15 01:20:28 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.3).
</div>
</body>
</html>
| # |
Change |
User |
Description |
Committed |
|
|
#1
|
15741 |
ptomiak |
Branch HWS for my use. |
|
|