diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html new file mode 100644 index 0000000..8981984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html @@ -0,0 +1,343 @@ +<!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>BelatedStorageCreator (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="BelatedStorageCreator (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/BelatedStorageCreator.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/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.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/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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.spi</div> +<h2 title="Class BelatedStorageCreator" class="title">Class BelatedStorageCreator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.BelatedStorageCreator<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BelatedStorageCreator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></pre> +<div class="block">Generic one-shot Storage creator which supports late object creation. If + getting the Storage results in an exception or is taking too long, the + Storage produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Storage is accessed, then + the bogus Storage turns into a wrapper to the real Storage.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><code>BelatedRepositoryCreator</code></a></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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)">BelatedStorageCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> storableType, + int minRetryDelayMillis)</code> </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 <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createBogus()">createBogus</a></strong>()</code> +<div class="block">Create instance of bogus object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createReal()">createReal</a></strong>()</code> +<div class="block">Create instance of real object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long timedOutMillis)</code> +<div class="block">Notification that createReal is taking too long.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.BelatedCreator"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a>, <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></code></li> +</ul> +<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="BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedStorageCreator</h4> +<pre>public BelatedStorageCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> storableType, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>repo</code> - Repository to get Storage from</dd><dd><code>storableType</code> - type of Storable to get Storage for</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createReal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createReal</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> createReal() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of real object. If there is a recoverable error creating + the object, return null. Any error logging must be performed by the + implementation of this method. If null is returned, expect this method + to be called again in the future.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl> +</li> +</ul> +<a name="createBogus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createBogus</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> createBogus()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of bogus object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +</dl> +</li> +</ul> +<a name="timedOutNotification(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timedOutNotification</h4> +<pre>protected void timedOutNotification(long timedOutMillis)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">BelatedCreator</a></code></strong></div> +<div class="block">Notification that createReal is taking too long. This can be used to log + a message.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</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/BelatedStorageCreator.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/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.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/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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> |