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/AbstractRepositoryBuilder.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html | 405 |
1 files changed, 405 insertions, 0 deletions
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> |