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/spi | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/spi')
36 files changed, 10106 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html new file mode 100644 index 0000000..1e5daa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html @@ -0,0 +1,759 @@ +<!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>AbstractRepository (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="AbstractRepository (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/AbstractRepository.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.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/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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 AbstractRepository" class="title">Class AbstractRepository<Txn></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.AbstractRepository<Txn></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>Txn</code> - Transaction type</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractRepository<Txn></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></pre> +<div class="block">Implements basic functionality required by a core Repository.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/spi/AbstractRepository.html#AbstractRepository(java.lang.String)">AbstractRepository</a></strong>(java.lang.String name)</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 java.util.Collection<<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#allStorage()">allStorage</a></strong>()</code> +<div class="block">Returns all available Storage instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#close()">close</a></strong>()</code> +<div class="block">Closes this repository reference, aborting any current + transactions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Called upon to create a new Storage instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction()">enterTransaction</a></strong>()</code> +<div class="block">Causes the current thread to enter a transaction scope.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><C extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract org.apache.commons.logging.Log</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getLog()">getLog</a></strong>()</code> +<div class="block">Return the main Log object for this Repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></strong>()</code> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#isClosed()">isClosed</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#localTransactionScope()">localTransactionScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#lockoutShutdown()">lockoutShutdown</a></strong>()</code> +<div class="block">Call to prevent shutdown hook from running.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></strong>(boolean enabled)</code> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</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/AbstractRepository.html#shutdownHook()">shutdownHook</a></strong>()</code> +<div class="block">Install custom shutdown logic by overriding this method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#transactionManager()">transactionManager</a></strong>()</code> +<div class="block">Returns the repository's TransactionManager.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#unlockoutShutdown()">unlockoutShutdown</a></strong>()</code> +<div class="block">Only call this to release lockoutShutdown.</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="AbstractRepository(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractRepository</h4> +<pre>protected AbstractRepository(java.lang.String name)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#getName()">Repository</a></code></strong></div> +<div class="block">Returns the name of this repository.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getName()">getName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="storageFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>storageFor</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> storageFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">Repository</a></code></strong></div> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>specific type of Storage instance</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> - if specified type cannot be supported</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if storage layer throws any other kind of + exception</dd></dl> +</li> +</ul> +<a name="enterTransaction()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a transaction scope. Call commit + inside the transaction in order for any updates to the repository to be + applied. Be sure to call exit when leaving the scope. + <p> + To ensure exit is called, use transactions as follows: + <pre> + Transaction txn = repository.enterTransaction(); + try { + // Make updates to storage layer + ... + + // Commit the changes up to this point + txn.commit(); + + // Optionally make more updates + ... + + // Commit remaining changes + txn.commit(); + } finally { + // Ensure transaction exits, aborting uncommitted changes if an exception was thrown + txn.exit(); + } + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()">enterTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="enterTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level. The actual isolation level may be higher than + requested, if the repository does not support the exact level. If the + repository does not support a high enough level, it throws an + UnsupportedOperationException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="enterTopTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTopTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTopTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level. The actual isolation level may be + higher than requested, if the repository does not support the exact + level. If the repository does not support a high enough level, it throws + an UnsupportedOperationException. + + <p>This method requests a top-level transaction, which means it never + has a parent transaction, but it still can be a parent transaction + itself. This kind of transaction is useful when a commit must absolutely + succeed, even if the current thread is already in a transaction + scope. If there was a parent transaction, then a commit might still be + rolled back by the parent. + + <p>Requesting a top-level transaction can be deadlock prone if the + current thread is already in a transaction scope. The top-level + transaction may not be able to obtain locks held by the parent + transaction. An alternative to requesting top-level transactions is to + execute transactions in separate threads.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="getTransactionIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionIsolationLevel</h4> +<pre>public <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getTransactionIsolationLevel()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">Repository</a></code></strong></div> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="getCapability(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCapability</h4> +<pre>public <C extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> C getCapability(java.lang.Class<C> capabilityType)</pre> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>capabilityType</code> - type of capability requested</dd> +<dt><span class="strong">Returns:</span></dt><dd>capability instance or null if not supported</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#close()">Repository</a></code></strong></div> +<div class="block">Closes this repository reference, aborting any current + transactions. Operations on objects returned by this repository will + fail when accessing the storage layer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +</li> +</ul> +<a name="isAutoShutdownEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoShutdownEnabled</h4> +<pre>public boolean isAutoShutdownEnabled()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">ShutdownCapability</a></code></strong></div> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="setAutoShutdownEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoShutdownEnabled</h4> +<pre>public void setAutoShutdownEnabled(boolean enabled)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">ShutdownCapability</a></code></strong></div> +<div class="block">Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void shutdown()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">ShutdownCapability</a></code></strong></div> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively <i>suspending</i> any + threads which continue to interact with this repository. <b>For this + reason, this method should only ever be called during a virtual machine + shutdown.</b> + + <p>Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="getSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceValueProducer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> getSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">SequenceCapability</a></code></strong></div> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - sequence name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="transactionManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transactionManager</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>> transactionManager()</pre> +<div class="block">Returns the repository's TransactionManager.</div> +</li> +</ul> +<a name="localTransactionScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localTransactionScope</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>> localTransactionScope()</pre> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</li> +</ul> +<a name="lockoutShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockoutShutdown</h4> +<pre>protected void lockoutShutdown()</pre> +<div class="block">Call to prevent shutdown hook from running. Be sure to call + unlockoutShutdown afterwards.</div> +</li> +</ul> +<a name="unlockoutShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unlockoutShutdown</h4> +<pre>protected void unlockoutShutdown()</pre> +<div class="block">Only call this to release lockoutShutdown.</div> +</li> +</ul> +<a name="allStorage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allStorage</h4> +<pre>protected java.util.Collection<<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>> allStorage()</pre> +<div class="block">Returns all available Storage instances.</div> +</li> +</ul> +<a name="shutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdownHook</h4> +<pre>protected void shutdownHook()</pre> +<div class="block">Install custom shutdown logic by overriding this method. By default it + does nothing.</div> +</li> +</ul> +<a name="getLog()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLog</h4> +<pre>protected abstract org.apache.commons.logging.Log getLog()</pre> +<div class="block">Return the main Log object for this Repository. If none provided, then + no messages are logged by AbstractRepository.</div> +</li> +</ul> +<a name="createStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStorage</h4> +<pre>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> createStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Called upon to create a new Storage instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSequenceValueProducer</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> createSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/AbstractRepository.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.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/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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> diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..80d38d6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html @@ -0,0 +1,405 @@ +<!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>AbstractRepositoryBuilder (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="AbstractRepositoryBuilder (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/AbstractRepositoryBuilder.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/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.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/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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 AbstractRepositoryBuilder" class="title">Class AbstractRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.AbstractRepositoryBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractRepositoryBuilder</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></pre> +<div class="block">Abstract builder class for opening repositories.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, 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/spi/AbstractRepositoryBuilder.html#AbstractRepositoryBuilder()">AbstractRepositoryBuilder</a></strong>()</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a></strong>()</code> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></strong>()</code> +<div class="block">Returns all the TriggerFactories which were added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Remove a TriggerFactory which was added earlier.</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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></h3> +<code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">getName</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">isMaster</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">setMaster</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">setName</a></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="AbstractRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractRepositoryBuilder</h4> +<pre>protected AbstractRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build() + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="addTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTriggerFactory</h4> +<pre>public boolean addTriggerFactory(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">RepositoryBuilder</a></code></strong></div> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered</dd></dl> +</li> +</ul> +<a name="removeTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTriggerFactory</h4> +<pre>public boolean removeTriggerFactory(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">RepositoryBuilder</a></code></strong></div> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory instance was removed, false if not added</dd></dl> +</li> +</ul> +<a name="getTriggerFactories()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTriggerFactories</h4> +<pre>public java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> getTriggerFactories()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns all the TriggerFactories which were added.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="assertReady()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>assertReady</h4> +<pre>public final void assertReady() + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code></dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/AbstractRepositoryBuilder.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/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.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/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html new file mode 100644 index 0000000..4849f11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html @@ -0,0 +1,361 @@ +<!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>BelatedRepositoryCreator (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="BelatedRepositoryCreator (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/BelatedRepositoryCreator.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/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.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/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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 BelatedRepositoryCreator" class="title">Class BelatedRepositoryCreator</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<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.BelatedRepositoryCreator</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BelatedRepositoryCreator</span> +extends <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></pre> +<div class="block">Generic one-shot Repository builder which supports late object creation. If + the Repository building results in an exception or is taking too long, the + Repository produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Repository is created, + then the bogus Repository turns into a wrapper to the real Repository.</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/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><code>BelatedStorageCreator</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/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + 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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.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/BelatedRepositoryCreator.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="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BelatedRepositoryCreator</h4> +<pre>public BelatedRepositoryCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</dd></dl> +</li> +</ul> +<a name="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedRepositoryCreator</h4> +<pre>public BelatedRepositoryCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>rootRef</code> - reference to root repository</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/Repository.html" title="interface in com.amazon.carbonado">Repository</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/Repository.html" title="interface in com.amazon.carbonado">Repository</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/Repository.html" title="interface in com.amazon.carbonado">Repository</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/Repository.html" title="interface in com.amazon.carbonado">Repository</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/Repository.html" title="interface in com.amazon.carbonado">Repository</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/BelatedRepositoryCreator.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/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.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/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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> 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> 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: </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 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"> </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> </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>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 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 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 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 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 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 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 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 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 <a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a> 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 <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException(java.lang.Throwable 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 <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException(java.lang.Throwable 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 <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> toRepositoryException(java.lang.Throwable 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 <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> transformIntoFetchException(java.lang.Throwable 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 <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> transformIntoPersistException(java.lang.Throwable 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 <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> transformIntoRepositoryException(java.lang.Throwable 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: </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> diff --git a/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html new file mode 100644 index 0000000..3e9f79a --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html @@ -0,0 +1,393 @@ +<!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>IndexInfoImpl (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="IndexInfoImpl (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/IndexInfoImpl.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/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/LobEngine.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/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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 IndexInfoImpl" class="title">Class IndexInfoImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.IndexInfoImpl</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexInfoImpl</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></pre> +<div class="block">Basic implementation of an <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl</a></strong>(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns the properties in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#isUnique()">isUnique</a></strong>()</code> +<div class="block">Returns true if index entries are unique.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#toString()">toString</a></strong>()</code> </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, 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="IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexInfoImpl</h4> +<pre>public IndexInfoImpl(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - optional name for index</dd><dd><code>unique</code> - true if index requires unique values</dd><dd><code>propertyNames</code> - required list of property names, must have at least + one name</dd><dd><code>propertyDirections</code> - optional property directions, may be null or + same length as property names array</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code></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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">IndexInfo</a></code></strong></div> +<div class="block">Returns the name of this index, or null if not applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>public boolean isUnique()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">IndexInfo</a></code></strong></div> +<div class="block">Returns true if index entries are unique.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>public boolean isClustered()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">IndexInfo</a></code></strong></div> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>public java.lang.String[] getPropertyNames()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">IndexInfo</a></code></strong></div> +<div class="block">Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">IndexInfo</a></code></strong></div> +<div class="block">Returns the directions of all the properties in this index. The length + of the array matches the length returned by <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()"><code>IndexInfo.getPropertyNames()</code></a>. The array is a copy, and so it may be safely + modified.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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/IndexInfoImpl.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/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/LobEngine.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/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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> diff --git a/apidocs/com/amazon/carbonado/spi/LobEngine.html b/apidocs/com/amazon/carbonado/spi/LobEngine.html new file mode 100644 index 0000000..c9dd1af --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/LobEngine.html @@ -0,0 +1,560 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>LobEngine (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="LobEngine (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/LobEngine.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/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.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/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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 LobEngine" class="title">Class LobEngine</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.LobEngine</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LobEngine</span> +extends java.lang.Object</pre> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine. Lobs are referenced by locators, + which are non-zero long integers. A zero locator is equivalent to null.</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/LobEngine.html#getSupportTrigger(java.lang.Class, int)"><code>getSupportTrigger(Class, int)</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/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</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><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(long)">deleteLob</a></strong>(long locator)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue</a></strong>(long locator)</code> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue</a></strong>(long locator)</code> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger</a></strong>(java.lang.Class<S> type, + int blockSize)</code> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#hasLobs(java.lang.Class)">hasLobs</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, java.io.InputStream)">setBlobValue</a></strong>(long locator, + java.io.InputStream data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, java.io.Reader)">setClobValue</a></strong>(long locator, + java.io.Reader data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</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="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorRepo</code> - storage for producing unique values for Lob locators + - should be root repository</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorSequenceProducer</code> - source of unique values for Lob locators</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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="hasLobs(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasLobs</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> boolean hasLobs(java.lang.Class<S> type)</pre> +</li> +</ul> +<a name="createNewBlob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewBlob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> createNewBlob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Blob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Blob</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="createNewClob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewClob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> createNewClob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Clob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Clob</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public long getLocator(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</pre> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ClassCastException</code> - if Lob is unrecognized</dd></dl> +</li> +</ul> +<a name="deleteLob(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(long locator) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="deleteLob(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getBlobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getBlobValue(long locator)</pre> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Blob value or null</dd></dl> +</li> +</ul> +<a name="getClobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> getClobValue(long locator)</pre> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Clob value or null</dd></dl> +</li> +</ul> +<a name="setBlobValue(long, com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setBlobValue(long, java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + java.io.InputStream data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, java.io.Reader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + java.io.Reader data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="getSupportTrigger(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSupportTrigger</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S> getSupportTrigger(java.lang.Class<S> type, + int blockSize)</pre> +<div class="block">Returns a Trigger for binding to this LobEngine. Storage implementations + which use LobEngine must install this Trigger. Trigger instances are + cached, so subsequent calls for the same trigger return the same + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to create trigger for</dd><dd><code>blockSize</code> - block size to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>support trigger or null if storable type has no lob properties</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/LobEngine.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/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.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/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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> diff --git a/apidocs/com/amazon/carbonado/spi/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html new file mode 100644 index 0000000..915be7b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html @@ -0,0 +1,370 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RAFInputStream (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="RAFInputStream (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/RAFInputStream.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/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.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/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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 RAFInputStream" class="title">Class RAFInputStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.io.InputStream</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RAFInputStream</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RAFInputStream</span> +extends java.io.InputStream</pre> +<div class="block">InputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileInputStream on it. Problem is that FileInputStream has a finalizer that + closes the RandomAccessFile.</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#RAFInputStream(java.io.RandomAccessFile)">RAFInputStream</a></strong>(java.io.RandomAccessFile raf)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read()">read</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[])">read</a></strong>(byte[] b)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[], int, int)">read</a></strong>(byte[] b, + int offset, + int length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#skip(long)">skip</a></strong>(long n)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.InputStream</h3> +<code>available, mark, markSupported, reset</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="RAFInputStream(java.io.RandomAccessFile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RAFInputStream</h4> +<pre>public RAFInputStream(java.io.RandomAccessFile raf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="read()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="read(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read(byte[] b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="read(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read(byte[] b, + int offset, + int length) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="skip(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skip</h4> +<pre>public long skip(long n) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>skip</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>close</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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/RAFInputStream.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/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.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/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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> diff --git a/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html new file mode 100644 index 0000000..a23245e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html @@ -0,0 +1,351 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RAFOutputStream (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="RAFOutputStream (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/RAFOutputStream.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/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.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/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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 RAFOutputStream" class="title">Class RAFOutputStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.io.OutputStream</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RAFOutputStream</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RAFOutputStream</span> +extends java.io.OutputStream</pre> +<div class="block">OutputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileOutputStream on it. Problem is that FileOutputStream has a finalizer + that closes the RandomAccessFile.</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#RAFOutputStream(java.io.RandomAccessFile)">RAFOutputStream</a></strong>(java.io.RandomAccessFile raf)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[])">write</a></strong>(byte[] b)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[], int, int)">write</a></strong>(byte[] b, + int offset, + int length)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(int)">write</a></strong>(int b)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.OutputStream</h3> +<code>flush</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="RAFOutputStream(java.io.RandomAccessFile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RAFOutputStream</h4> +<pre>public RAFOutputStream(java.io.RandomAccessFile raf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="write(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(int b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="write(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(byte[] b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="write(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(byte[] b, + int offset, + int length) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>close</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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/RAFOutputStream.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/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.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/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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> diff --git a/apidocs/com/amazon/carbonado/spi/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html new file mode 100644 index 0000000..ed413da --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html @@ -0,0 +1,271 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RepairExecutor (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="RepairExecutor (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/RepairExecutor.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/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoragePool.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/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 RepairExecutor" class="title">Class RepairExecutor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RepairExecutor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RepairExecutor</span> +extends java.lang.Object</pre> +<div class="block">A convenience class for repositories to run dynamic repairs in separate + threads. When a repository detects a consistency error during a user + operation, it should not perform the repair in the same thread. + + <p>If the repair was initiated by an exception, but the original exception + is re-thrown, a transaction exit will rollback the repair! Executing the + repair in a separate thread allows it to wait until the transaction has + exited. + + <p>Other kinds of inconsistencies might be detected during cursor + iteration. The repair will need to acquire write locks, but the open cursor + might not allow that, resulting in deadlock. Executing the repair in a + separate thread allows it to wait until the cursor has released locks. + + <p>This class keeps thread-local references to single-threaded executors. In + other words, each user thread has at most one associated repair thread. Each + repair thread has a fixed size queue, and they exit when they are idle. If + the queue is full, newly added repair tasks are silently discarded. + + <p>The following system properties are supported: + + <ul> + <li>com.amazon.carbonado.spi.RepairExecutor.keepAliveSeconds (default is 10) + <li>com.amazon.carbonado.spi.RepairExecutor.queueSize (default is 10000) + </ul></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"> +<!-- ========== 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>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html#execute(java.lang.Runnable)">execute</a></strong>(java.lang.Runnable repair)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html#waitForRepairsToFinish(long)">waitForRepairsToFinish</a></strong>(long timeoutMillis)</code> +<div class="block">Waits for repairs that were executed from the current thread to finish.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public static void execute(java.lang.Runnable repair)</pre> +</li> +</ul> +<a name="waitForRepairsToFinish(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>waitForRepairsToFinish</h4> +<pre>public static boolean waitForRepairsToFinish(long timeoutMillis) + throws java.lang.InterruptedException</pre> +<div class="block">Waits for repairs that were executed from the current thread to finish.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if all repairs are finished</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code></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/RepairExecutor.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/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoragePool.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/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/spi/StoragePool.html b/apidocs/com/amazon/carbonado/spi/StoragePool.html new file mode 100644 index 0000000..67a4167 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoragePool.html @@ -0,0 +1,333 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoragePool (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="StoragePool (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/StoragePool.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/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.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/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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 StoragePool" class="title">Class StoragePool</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoragePool</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">StoragePool</span> +extends <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></pre> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type. Storage instances are lazily created and pooled.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#StoragePool()">StoragePool</a></strong>()</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></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create</a></strong>(java.lang.Class type)</code> +<div class="block">Return a new value instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AbstractPool"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#clear()">clear</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#get(K)">get</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#remove(java.lang.Object)">remove</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#values()">values</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="StoragePool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoragePool</h4> +<pre>public StoragePool()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorage</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> getStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a>, + <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled. If multiple threads are requesting upon the same type + concurrently, at most one thread attempts to lazily create the + Storage. The others wait for it to become available.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="create(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>protected final <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> create(java.lang.Class type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">AbstractPool</a></code></strong></div> +<div class="block">Return a new value instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">create</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></code></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> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createStorage</h4> +<pre>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> createStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><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> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/StoragePool.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/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.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/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html new file mode 100644 index 0000000..3a20d54 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html @@ -0,0 +1,373 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoredLob.Block (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="StoredLob.Block (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/StoredLob.Block.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/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface 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/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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 StoredLob.Block" class="title">Class StoredLob.Block</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoredLob.Block</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>={"locator","+blockNumber"}) +public abstract static class <span class="strong">StoredLob.Block</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a>></pre> +<div class="block">Blocks stored here.</div> +</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/StoredLob.Block.html#StoredLob.Block()">StoredLob.Block</a></strong>()</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>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getBlockNumber()">getBlockNumber</a></strong>()</code> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getData()">getData</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getLocator()">getLocator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setBlockNumber(int)">setBlockNumber</a></strong>(int number)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setData(byte[])">setData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setLocator(long)">setLocator</a></strong>(long locator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setVersion(int)">setVersion</a></strong>(int version)</code> </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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></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="StoredLob.Block()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoredLob.Block</h4> +<pre>public StoredLob.Block()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public abstract long getLocator()</pre> +</li> +</ul> +<a name="setLocator(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocator</h4> +<pre>public abstract void setLocator(long locator)</pre> +</li> +</ul> +<a name="getBlockNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockNumber</h4> +<pre>public abstract int getBlockNumber()</pre> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number. This effectively makes the block number unsigned.</div> +</li> +</ul> +<a name="setBlockNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlockNumber</h4> +<pre>public abstract void setBlockNumber(int number)</pre> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public abstract byte[] getData()</pre> +</li> +</ul> +<a name="setData(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public abstract void setData(byte[] data)</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +public abstract int getVersion()</pre> +</li> +</ul> +<a name="setVersion(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>public abstract void setVersion(int version)</pre> +</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/StoredLob.Block.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/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface 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/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.html b/apidocs/com/amazon/carbonado/spi/StoredLob.html new file mode 100644 index 0000000..a42dc2c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.html @@ -0,0 +1,425 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoredLob (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="StoredLob (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/StoredLob.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/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.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/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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><a href="#nested_class_summary">Nested</a> | </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 StoredLob" class="title">Class StoredLob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoredLob</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a>></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>="locator") +<a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_LOB") +public abstract class <span class="strong">StoredLob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a>></pre> +<div class="block">Can be used internally by repositories for supporting Lobs.</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/LobEngine.html" title="class in com.amazon.carbonado.spi"><code>LobEngine</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></strong></code> +<div class="block">Blocks stored here.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/StoredLob.html#StoredLob()">StoredLob</a></strong>()</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getBlockCount()">getBlockCount</a></strong>()</code> +<div class="block">Returns number of blocks required to store Lob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getBlockSize()">getBlockSize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLastBlockLength()">getLastBlockLength</a></strong>()</code> +<div class="block">Returns expected length of last block.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLocator()">getLocator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setBlockSize(int)">setBlockSize</a></strong>(int size)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setLocator(long)">setLocator</a></strong>(long locator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setVersion(int)">setVersion</a></strong>(int version)</code> </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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></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="StoredLob()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoredLob</h4> +<pre>public StoredLob()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public abstract long getLocator()</pre> +</li> +</ul> +<a name="setLocator(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocator</h4> +<pre>public abstract void setLocator(long locator)</pre> +</li> +</ul> +<a name="getBlockSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockSize</h4> +<pre>public abstract int getBlockSize()</pre> +</li> +</ul> +<a name="setBlockSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlockSize</h4> +<pre><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">@IntegerConstraint</a>(<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a>=1L) +public abstract void setBlockSize(int size)</pre> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public abstract long getLength()</pre> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">@IntegerConstraint</a>(<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a>=0L) +public abstract void setLength(long length)</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +public abstract int getVersion()</pre> +</li> +</ul> +<a name="setVersion(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>public abstract void setVersion(int version)</pre> +</li> +</ul> +<a name="getBlockCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockCount</h4> +<pre>public long getBlockCount()</pre> +<div class="block">Returns number of blocks required to store Lob.</div> +</li> +</ul> +<a name="getLastBlockLength()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLastBlockLength</h4> +<pre>public int getLastBlockLength()</pre> +<div class="block">Returns expected length of last block. If zero, last block should be + full, unless the total length of Lob is zero.</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/StoredLob.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/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.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/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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><a href="#nested_class_summary">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/StoredSequence.html new file mode 100644 index 0000000..3100bf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredSequence.html @@ -0,0 +1,320 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoredSequence (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="StoredSequence (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/StoredSequence.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/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManager.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/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface StoredSequence" class="title">Interface StoredSequence</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a>></dd> +</dl> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +<br> +<pre>@Deprecated +<a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>="name") +<a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">@Authoritative</a> +<a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_SEQUENCE") +public interface <span class="strong">StoredSequence</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a>></pre> +<div class="block">Stores data for SequenceValueGenerator.</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"> +<!-- ========== 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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#getInitialValue()">getInitialValue</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Returns the initial value for the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#getName()">getName</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#getNextValue()">getNextValue</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setInitialValue(long)">setInitialValue</a></strong>(long value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setNextValue(long)">setNextValue</a></strong>(long value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>void setName(java.lang.String name)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="getInitialValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialValue</h4> +<pre>long getInitialValue()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Returns the initial value for the sequence.</div> +</li> +</ul> +<a name="setInitialValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialValue</h4> +<pre>void setInitialValue(long value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="getNextValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextValue</h4> +<pre>long getNextValue()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).</div> +</li> +</ul> +<a name="setNextValue(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setNextValue</h4> +<pre>void setNextValue(long value)</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/StoredSequence.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/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManager.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/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/TriggerManager.html new file mode 100644 index 0000000..747f969 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManager.html @@ -0,0 +1,1324 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TriggerManager (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="TriggerManager (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/TriggerManager.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/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface 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/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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><a href="#nested_classes_inherited_from_class_com.amazon.carbonado.Trigger">Nested</a> | </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 TriggerManager" class="title">Class TriggerManager<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/Trigger.html" title="class in com.amazon.carbonado">com.amazon.carbonado.Trigger</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.TriggerManager<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TriggerManager<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></pre> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers. This class is thread-safe and ensures that changes + to the trigger set do not affect transactions in progress.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></li> +</ul> +</li> +</ul> +<!-- ======== 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/TriggerManager.html#TriggerManager()">TriggerManager</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTriggers(java.lang.Class, java.lang.Iterable)">addTriggers</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterLoad(S)">afterLoad</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called right after a storable has been successfully loaded or + fetched.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedDelete(S, java.lang.Object)">failedDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedInsert(S, java.lang.Object)">failedInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableDelete()">locallyDisableDelete</a></strong>()</code> +<div class="block">Disables execution of all managed delete triggers for the current + thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableInsert()">locallyDisableInsert</a></strong>()</code> +<div class="block">Disables execution of all managed insert triggers for the current + thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableLoad()">locallyDisableLoad</a></strong>()</code> +<div class="block">Disables execution of all managed load triggers for the current + thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableUpdate()">locallyDisableUpdate</a></strong>()</code> +<div class="block">Disables execution of all managed update triggers for the current + thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableDelete()">locallyEnableDelete</a></strong>()</code> +<div class="block">Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableInsert()">locallyEnableInsert</a></strong>()</code> +<div class="block">Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableLoad()">locallyEnableLoad</a></strong>()</code> +<div class="block">Enables execution of all managed load triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableUpdate()">locallyEnableUpdate</a></strong>()</code> +<div class="block">Enables execution of all managed update triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</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="TriggerManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TriggerManager</h4> +<pre>public TriggerManager()</pre> +</li> +</ul> +<a name="TriggerManager(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TriggerManager</h4> +<pre>public TriggerManager(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>triggerFactories</code> - TriggerFactories which will be called upon to + optionally return a trigger to initially register</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="getInsertTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInsertTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getInsertTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getUpdateTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUpdateTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getUpdateTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getDeleteTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeleteTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getDeleteTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoadTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getLoadTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="addTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTrigger</h4> +<pre>public boolean addTrigger(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</pre> +</li> +</ul> +<a name="removeTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTrigger</h4> +<pre>public boolean removeTrigger(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</pre> +</li> +</ul> +<a name="addTriggers(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTriggers</h4> +<pre>public void addTriggers(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="locallyDisableInsert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableInsert</h4> +<pre>public void locallyDisableInsert()</pre> +<div class="block">Disables execution of all managed insert triggers for the current + thread. Call locallyEnableInsert to enable again. This call can be made + multiple times, but be sure to call locallyEnableInsert the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableInsert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableInsert</h4> +<pre>public void locallyEnableInsert()</pre> +<div class="block">Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableUpdate</h4> +<pre>public void locallyDisableUpdate()</pre> +<div class="block">Disables execution of all managed update triggers for the current + thread. Call locallyEnableUpdate to enable again. This call can be made + multiple times, but be sure to call locallyEnableUpdate the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableUpdate</h4> +<pre>public void locallyEnableUpdate()</pre> +<div class="block">Enables execution of all managed update triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableDelete</h4> +<pre>public void locallyDisableDelete()</pre> +<div class="block">Disables execution of all managed delete triggers for the current + thread. Call locallyEnableDelete to enable again. This call can be made + multiple times, but be sure to call locallyEnableDelete the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableDelete</h4> +<pre>public void locallyEnableDelete()</pre> +<div class="block">Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableLoad</h4> +<pre>public void locallyDisableLoad()</pre> +<div class="block">Disables execution of all managed load triggers for the current + thread. Call locallyEnableLoad to enable again. This call can be made + multiple times, but be sure to call locallyEnableLoad the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableLoad</h4> +<pre>public void locallyEnableLoad()</pre> +<div class="block">Enables execution of all managed load triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="beforeInsert(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeInsert(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>Trigger.beforeInsert(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeTryInsert(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>Trigger.beforeInsert(Object)</code></a>. Only override + if trigger needs to distinguish between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryInsert(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)"><code>Trigger.beforeTryInsert(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInsert</h4> +<pre>public void afterInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully inserted. The + default implementation does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterTryInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryInsert</h4> +<pre>public void afterTryInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)"><code>Trigger.afterInsert(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different insert + variants. + + <p>Any exception thrown by this method will cause the tryInsert + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeTryInsert method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedInsert</h4> +<pre>public void failedInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown. The main purpose of this method is + to allow any necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be inserted</dd><dd><code>state</code> - object returned by beforeInsert method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeUpdate(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeUpdate(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>Trigger.beforeUpdate(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeTryUpdate(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>Trigger.beforeUpdate(Object)</code></a>. Only override + if trigger needs to distinguish between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryUpdate(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)"><code>Trigger.beforeTryUpdate(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterUpdate</h4> +<pre>public void afterUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully updated. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being updated</dd><dd><code>state</code> - optional object returned by beforeUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterTryUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryUpdate</h4> +<pre>public void afterTryUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)"><code>Trigger.afterUpdate(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different update + variants. + + <p>Any exception thrown by this method will cause the tryUpdate + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being updated</dd><dd><code>state</code> - object returned by beforeTryUpdate method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedUpdate</h4> +<pre>public void failedUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be updated</dd><dd><code>state</code> - optional object returned by beforeUpdate + method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeDelete(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeDelete(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>Trigger.beforeDelete(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="beforeTryDelete(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>Trigger.beforeDelete(Object)</code></a>. Only override + if trigger needs to distinguish between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryDelete(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)"><code>Trigger.beforeTryDelete(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterDelete</h4> +<pre>public void afterDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully deleted. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being deleted</dd><dd><code>state</code> - optional object returned by beforeDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="afterTryDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryDelete</h4> +<pre>public void afterTryDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)"><code>Trigger.afterDelete(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different delete + variants. + + <p>Any exception thrown by this method will cause the tryDelete + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being deleted</dd><dd><code>state</code> - object returned by beforeTryDelete method</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedDelete</h4> +<pre>public void failedDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be deleted</dd><dd><code>state</code> - optional object returned by beforeDelete + method, but it may be null</dd></dl> +</li> +</ul> +<a name="afterLoad(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="afterLoad(S)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>afterLoad</h4> +<pre>public void afterLoad(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully loaded or + fetched. The default implementation does nothing.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being loaded or fetched</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></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/TriggerManager.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/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface 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/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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><a href="#nested_classes_inherited_from_class_com.amazon.carbonado.Trigger">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html new file mode 100644 index 0000000..c47f68b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html @@ -0,0 +1,222 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TriggerManagerCapability (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="TriggerManagerCapability (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/TriggerManagerCapability.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/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface TriggerManagerCapability" class="title">Interface TriggerManagerCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TriggerManagerCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Provides the capability to get the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Pranay Dalmia</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getTriggerManagerFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTriggerManagerFor</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S> getTriggerManagerFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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/TriggerManagerCapability.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/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html new file mode 100644 index 0000000..7326c96 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.AbstractRepository (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="Uses of Class com.amazon.carbonado.spi.AbstractRepository (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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.AbstractRepository" class="title">Uses of Class<br>com.amazon.carbonado.spi.AbstractRepository</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.AbstractRepository</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..1fe8cc9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html @@ -0,0 +1,295 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder (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="Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder (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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.spi.AbstractRepositoryBuilder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the indexed repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></strong></code> +<div class="block">Builds a repository instance backed by a JDBC accessible database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></strong></code> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></strong></code> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the replicated repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></strong></code> +<div class="block">Builder and configuration options for BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html new file mode 100644 index 0000000..9eaa0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator (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="Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator (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><a href="../../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator" class="title">Uses of Class<br>com.amazon.carbonado.spi.BelatedRepositoryCreator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.BelatedRepositoryCreator</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html new file mode 100644 index 0000000..4f07f2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.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="Uses of Class com.amazon.carbonado.spi.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><a href="../../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.BelatedStorageCreator" class="title">Uses of Class<br>com.amazon.carbonado.spi.BelatedStorageCreator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.BelatedStorageCreator</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html new file mode 100644 index 0000000..05b0c88 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.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="Uses of Class com.amazon.carbonado.spi.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><a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.ExceptionTransformer" class="title">Uses of Class<br>com.amazon.carbonado.spi.ExceptionTransformer</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></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> +<tbody> +<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"><span class="strong">ExceptionTransformer.</span><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html new file mode 100644 index 0000000..4a0d79d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.IndexInfoImpl (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="Uses of Class com.amazon.carbonado.spi.IndexInfoImpl (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><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.IndexInfoImpl" class="title">Uses of Class<br>com.amazon.carbonado.spi.IndexInfoImpl</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.IndexInfoImpl</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html new file mode 100644 index 0000000..6f6ee1d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.LobEngine (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="Uses of Class com.amazon.carbonado.spi.LobEngine (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><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.LobEngine" class="title">Uses of Class<br>com.amazon.carbonado.spi.LobEngine</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.LobEngine</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html new file mode 100644 index 0000000..a03e900 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RAFInputStream (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="Uses of Class com.amazon.carbonado.spi.RAFInputStream (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><a href="../../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RAFInputStream" class="title">Uses of Class<br>com.amazon.carbonado.spi.RAFInputStream</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RAFInputStream</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html new file mode 100644 index 0000000..d966568 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RAFOutputStream (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="Uses of Class com.amazon.carbonado.spi.RAFOutputStream (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><a href="../../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RAFOutputStream" class="title">Uses of Class<br>com.amazon.carbonado.spi.RAFOutputStream</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RAFOutputStream</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html new file mode 100644 index 0000000..3c1030b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RepairExecutor (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="Uses of Class com.amazon.carbonado.spi.RepairExecutor (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><a href="../../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RepairExecutor" class="title">Uses of Class<br>com.amazon.carbonado.spi.RepairExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RepairExecutor</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html new file mode 100644 index 0000000..d1978d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoragePool (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="Uses of Class com.amazon.carbonado.spi.StoragePool (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><a href="../../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoragePool" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoragePool</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoragePool</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html new file mode 100644 index 0000000..5546179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoredLob.Block (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="Uses of Class com.amazon.carbonado.spi.StoredLob.Block (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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoredLob.Block" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoredLob.Block</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredLob.Block</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html new file mode 100644 index 0000000..d1c031c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoredLob (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="Uses of Class com.amazon.carbonado.spi.StoredLob (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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoredLob" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoredLob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredLob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html new file mode 100644 index 0000000..360ae87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.spi.StoredSequence (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="Uses of Interface com.amazon.carbonado.spi.StoredSequence (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><a href="../../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.spi.StoredSequence" class="title">Uses of Interface<br>com.amazon.carbonado.spi.StoredSequence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredSequence</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html new file mode 100644 index 0000000..d94488c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.TriggerManager (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="Uses of Class com.amazon.carbonado.spi.TriggerManager (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><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.spi.TriggerManager" class="title">Uses of Class<br>com.amazon.carbonado.spi.TriggerManager</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><span class="strong">TriggerManagerCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html new file mode 100644 index 0000000..7292f09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability (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="Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability (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><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability" class="title">Uses of Interface<br>com.amazon.carbonado.spi.TriggerManagerCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.TriggerManagerCapability</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/package-frame.html b/apidocs/com/amazon/carbonado/spi/package-frame.html new file mode 100644 index 0000000..53b98ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-frame.html @@ -0,0 +1,38 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.spi (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/spi/package-summary.html" target="classFrame">com.amazon.carbonado.spi</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="StoredSequence.html" title="interface in com.amazon.carbonado.spi" target="classFrame"><i>StoredSequence</i></a></li> +<li><a href="TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi" target="classFrame"><i>TriggerManagerCapability</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractRepository.html" title="class in com.amazon.carbonado.spi" target="classFrame">AbstractRepository</a></li> +<li><a href="AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi" target="classFrame">AbstractRepositoryBuilder</a></li> +<li><a href="BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi" target="classFrame">BelatedRepositoryCreator</a></li> +<li><a href="BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi" target="classFrame">BelatedStorageCreator</a></li> +<li><a href="ExceptionTransformer.html" title="class in com.amazon.carbonado.spi" target="classFrame">ExceptionTransformer</a></li> +<li><a href="IndexInfoImpl.html" title="class in com.amazon.carbonado.spi" target="classFrame">IndexInfoImpl</a></li> +<li><a href="LobEngine.html" title="class in com.amazon.carbonado.spi" target="classFrame">LobEngine</a></li> +<li><a href="RAFInputStream.html" title="class in com.amazon.carbonado.spi" target="classFrame">RAFInputStream</a></li> +<li><a href="RAFOutputStream.html" title="class in com.amazon.carbonado.spi" target="classFrame">RAFOutputStream</a></li> +<li><a href="RepairExecutor.html" title="class in com.amazon.carbonado.spi" target="classFrame">RepairExecutor</a></li> +<li><a href="StoragePool.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoragePool</a></li> +<li><a href="StoredLob.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoredLob</a></li> +<li><a href="StoredLob.Block.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoredLob.Block</a></li> +<li><a href="TriggerManager.html" title="class in com.amazon.carbonado.spi" target="classFrame">TriggerManager</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/spi/package-summary.html b/apidocs/com/amazon/carbonado/spi/package-summary.html new file mode 100644 index 0000000..f7a106c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-summary.html @@ -0,0 +1,254 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.spi (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="com.amazon.carbonado.spi (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/sequence/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package com.amazon.carbonado.spi</h1> +<div class="docSummary"> +<div class="block">Service Provider Interface for Carbonado.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></td> +<td class="colLast">Deprecated +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></td> +<td class="colLast"> +<div class="block">Provides the capability to get the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></td> +<td class="colLast"> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></td> +<td class="colLast"> +<div class="block">Generic one-shot Repository builder which supports late object creation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Generic one-shot Storage creator which supports late object creation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></td> +<td class="colLast"> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></td> +<td class="colLast"> +<div class="block">Basic implementation of an <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></td> +<td class="colLast"> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></td> +<td class="colLast"> +<div class="block">InputStream that wraps a RandomAccessFile.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></td> +<td class="colLast"> +<div class="block">OutputStream that wraps a RandomAccessFile.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">RepairExecutor</a></td> +<td class="colLast"> +<div class="block">A convenience class for repositories to run dynamic repairs in separate + threads.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></td> +<td class="colLast"> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></td> +<td class="colLast"> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></td> +<td class="colLast"> +<div class="block">Blocks stored here.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.spi Description">Package com.amazon.carbonado.spi Description</h2> +<div class="block">Service Provider Interface for Carbonado. Repositories are free to use this + package to aid in their implementation. User-level applications have no need + to use this package.</div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/sequence/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/package-tree.html b/apidocs/com/amazon/carbonado/spi/package-tree.html new file mode 100644 index 0000000..b74945f --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-tree.html @@ -0,0 +1,176 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.spi Class Hierarchy (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="com.amazon.carbonado.spi Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sequence/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package com.amazon.carbonado.spi</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">AbstractPool</span></a><K,V,E> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoragePool</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepository</span></a><Txn> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a>, com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>)</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>)</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreator</span></a><T,E> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedRepositoryCreator</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedStorageCreator</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">ExceptionTransformer</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">IndexInfoImpl</span></a> (implements com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>)</li> +<li type="circle">java.io.InputStream (implements java.io.Closeable) +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFInputStream</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">LobEngine</span></a></li> +<li type="circle">java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFOutputStream</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">RepairExecutor</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob.Block</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">TriggerManager</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">TriggerManagerCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">StoredSequence</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sequence/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<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> diff --git a/apidocs/com/amazon/carbonado/spi/package-use.html b/apidocs/com/amazon/carbonado/spi/package-use.html new file mode 100644 index 0000000..bcc5806 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-use.html @@ -0,0 +1,303 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.spi (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="Uses of Package com.amazon.carbonado.spi (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</li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package com.amazon.carbonado.spi" class="title">Uses of Package<br>com.amazon.carbonado.spi</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.indexed">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.jdbc">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.logging">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.map">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.replicated">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.sleepycat">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/ExceptionTransformer.html#com.amazon.carbonado.spi">ExceptionTransformer</a> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/TriggerManager.html#com.amazon.carbonado.spi">TriggerManager</a> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<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> |