diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/util/ThrowUnchecked.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/util/ThrowUnchecked.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/util/ThrowUnchecked.html | 495 |
1 files changed, 495 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html new file mode 100644 index 0000000..3eb5816 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html @@ -0,0 +1,495 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ThrowUnchecked (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ThrowUnchecked (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThrowUnchecked.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.util</div> +<h2 title="Class ThrowUnchecked" class="title">Class ThrowUnchecked</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.ThrowUnchecked</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <code>ThrowUnchecked</code> instead</i></div> +</div> +<br> +<pre>public abstract class <span class="strong">ThrowUnchecked</span> +extends java.lang.Object</pre> +<div class="block">Allows exceptions to be thrown which aren't declared to be thrown. Use of + this technique can cause confusion since it violates the Java language rules + for undeclared checked exceptions. For this reason, this class should not be + used except under special circumstances such as to work around compiler + bugs. An exception can be made, if calling any of the fireDeclared methods + and the set of declared types matches what the caller is allowed to throw. + + <p>Example: + + <pre> + public <E extends Throwable> void someMethod(E exception) throws E { + ... + + // Apparent compiler bug sometimes disallows this. Doesn't appear to + // show up when compiling source files individually. + + //throw exception; + + // Throw it this way instead, and compiler doesn't know. + ThrowUnchecked.fire(exception); + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#ThrowUnchecked()">ThrowUnchecked</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#doFire(java.lang.Throwable)">doFire</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fire(java.lang.Throwable)">fire</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the given exception, even though it may be checked.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireCause(java.lang.Throwable)">fireCause</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the cause of the given exception, even though it may be + checked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclared(java.lang.Throwable, java.lang.Class...)">fireDeclared</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the given exception if it is unchecked or an instance of any of + the given declared types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredRootCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredRootCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclared(java.lang.Throwable, java.lang.Class...)">fireFirstDeclared</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireFirstDeclaredCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the first found cause that matches one of the given declared + types or is unchecked.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireRootCause(java.lang.Throwable)">fireRootCause</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the root cause of the given exception, even though it may be + checked.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ThrowUnchecked()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ThrowUnchecked</h4> +<pre>protected ThrowUnchecked()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fire(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fire</h4> +<pre>public static void fire(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the given exception, even though it may be checked. This method + only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception to throw</dd></dl> +</li> +</ul> +<a name="fireDeclared(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclared</h4> +<pre>public static void fireDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the given exception if it is unchecked or an instance of any of + the given declared types. Otherwise, it is thrown as an + UndeclaredThrowableException. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception to throw</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireFirstDeclared(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireFirstDeclared</h4> +<pre>public static void fireFirstDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked. Otherwise, the + original exception is thrown as an UndeclaredThrowableException. This + method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireCause(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireCause</h4> +<pre>public static void fireCause(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the cause of the given exception, even though it may be + checked. If the cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd></dl> +</li> +</ul> +<a name="fireDeclaredCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclaredCause</h4> +<pre>public static void fireDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the cause is null, then the original + exception is thrown. This method only returns normally if the exception + is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireFirstDeclaredCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireFirstDeclaredCause</h4> +<pre>public static void fireFirstDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the first found cause that matches one of the given declared + types or is unchecked. Otherwise, the immediate cause is thrown as an + UndeclaredThrowableException. If the immediate cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireRootCause(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireRootCause</h4> +<pre>public static void fireRootCause(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the root cause of the given exception, even though it may be + checked. If the root cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose root cause is to be thrown</dd></dl> +</li> +</ul> +<a name="fireDeclaredRootCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclaredRootCause</h4> +<pre>public static void fireDeclaredRootCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the root cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose root cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="doFire(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doFire</h4> +<pre>protected abstract void doFire(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ThrowUnchecked.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |