summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html')
-rw-r--r--apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html387
1 files changed, 387 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html
new file mode 100644
index 0000000..c1966eb
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html
@@ -0,0 +1,387 @@
+<!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>ExceptionTransformer (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="ExceptionTransformer (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/ExceptionTransformer.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/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/spi/ExceptionTransformer.html" target="_top">Frames</a></li>
+<li><a href="ExceptionTransformer.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.spi</div>
+<h2 title="Class ExceptionTransformer" class="title">Class ExceptionTransformer</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.spi.ExceptionTransformer</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="strong">ExceptionTransformer</span>
+extends java.lang.Object</pre>
+<div class="block">Supports transforming arbitrary exceptions into appropriate repository
+ exceptions. Repositories will likely extend this class, providing custom
+ transformation rules.</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">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#ExceptionTransformer()">ExceptionTransformer</a></strong>()</code>&nbsp;</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">&nbsp;</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>static <a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#getInstance()">getInstance</a></strong>()</code>
+<div class="block">Returns a generic instance.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Transforms the given throwable into an appropriate fetch exception.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Transforms the given throwable into an appropriate persist exception.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toRepositoryException(java.lang.Throwable)">toRepositoryException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Transforms the given throwable into an appropriate repository
+ exception.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoFetchException(java.lang.Throwable)">transformIntoFetchException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoPersistException(java.lang.Throwable)">transformIntoPersistException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoRepositoryException(java.lang.Throwable)">transformIntoRepositoryException</a></strong>(java.lang.Throwable&nbsp;e)</code>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable.</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&nbsp;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="ExceptionTransformer()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>ExceptionTransformer</h4>
+<pre>public&nbsp;ExceptionTransformer()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getInstance()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInstance</h4>
+<pre>public static&nbsp;<a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a>&nbsp;getInstance()</pre>
+<div class="block">Returns a generic instance.</div>
+</li>
+</ul>
+<a name="toFetchException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toFetchException</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>&nbsp;toFetchException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Transforms the given throwable into an appropriate fetch exception. If
+ it already is a fetch exception, it is simply casted.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>FetchException, never null</dd></dl>
+</li>
+</ul>
+<a name="toPersistException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toPersistException</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>&nbsp;toPersistException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Transforms the given throwable into an appropriate persist exception. If
+ it already is a persist exception, it is simply casted.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>PersistException, never null</dd></dl>
+</li>
+</ul>
+<a name="toRepositoryException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toRepositoryException</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>&nbsp;toRepositoryException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Transforms the given throwable into an appropriate repository
+ exception. If it already is a repository exception, it is simply casted.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>RepositoryException, never null</dd></dl>
+</li>
+</ul>
+<a name="transformIntoFetchException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>transformIntoFetchException</h4>
+<pre>protected&nbsp;<a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>&nbsp;transformIntoFetchException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable. Be sure to call super first. If it returns non-null, return
+ that result.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>FetchException, or null if no applicable transform</dd></dl>
+</li>
+</ul>
+<a name="transformIntoPersistException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>transformIntoPersistException</h4>
+<pre>protected&nbsp;<a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>&nbsp;transformIntoPersistException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable. Be sure to call super first. If it returns non-null, return
+ that result.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>PersistException, or null if no applicable transform</dd></dl>
+</li>
+</ul>
+<a name="transformIntoRepositoryException(java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>transformIntoRepositoryException</h4>
+<pre>protected&nbsp;<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>&nbsp;transformIntoRepositoryException(java.lang.Throwable&nbsp;e)</pre>
+<div class="block">Override to support custom transformations, returning null if none is
+ applicable. Be sure to call super first. If it returns non-null, return
+ that result.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd>
+<dt><span class="strong">Returns:</span></dt><dd>RepositoryException, or null if no applicable transform</dd></dl>
+</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/ExceptionTransformer.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/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/spi/ExceptionTransformer.html" target="_top">Frames</a></li>
+<li><a href="ExceptionTransformer.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>