summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html')
-rw-r--r--apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html512
1 files changed, 512 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html
new file mode 100644
index 0000000..d4dd7a4
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html
@@ -0,0 +1,512 @@
+<!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>SequenceValueGenerator (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="SequenceValueGenerator (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/SequenceValueGenerator.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/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueGenerator.html" target="_top">Frames</a></li>
+<li><a href="SequenceValueGenerator.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">com.amazon.carbonado.sequence</div>
+<h2 title="Class SequenceValueGenerator" class="title">Class SequenceValueGenerator</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">com.amazon.carbonado.sequence.AbstractSequenceValueProducer</a></li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.sequence.SequenceValueGenerator</li>
+</ul>
+</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/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">SequenceValueGenerator</span>
+extends <a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></pre>
+<div class="block">General purpose implementation of a sequence value generator.</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, bcastill</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a>,
+<a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INCREMENT">DEFAULT_INCREMENT</a></strong></code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INITIAL_VALUE">DEFAULT_INITIAL_VALUE</a></strong></code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_RESERVE_AMOUNT">DEFAULT_RESERVE_AMOUNT</a></strong></code>&nbsp;</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">&nbsp;</span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name)</code>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name,
+ long&nbsp;initialValue,
+ int&nbsp;increment)</code>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name,
+ long&nbsp;initialValue,
+ int&nbsp;increment,
+ int&nbsp;reserveAmount)</code>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextIntValue()">nextIntValue</a></strong>()</code>
+<div class="block">Returns the next value from the sequence, which may wrap negative if all
+ positive values are exhausted.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextLongValue()">nextLongValue</a></strong>()</code>
+<div class="block">Returns the next value from the sequence, which may wrap negative if all
+ positive values are exhausted.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#reset(int)">reset</a></strong>(int&nbsp;initialValue)</code>
+<div class="block">Reset the sequence.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#returnReservedValues()">returnReservedValues</a></strong>()</code>
+<div class="block">Allow any unused reserved values to be returned for re-use.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.sequence.AbstractSequenceValueProducer">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></h3>
+<code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a>, <a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</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&nbsp;java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="DEFAULT_RESERVE_AMOUNT">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DEFAULT_RESERVE_AMOUNT</h4>
+<pre>public static final&nbsp;int DEFAULT_RESERVE_AMOUNT</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_RESERVE_AMOUNT">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="DEFAULT_INITIAL_VALUE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DEFAULT_INITIAL_VALUE</h4>
+<pre>public static final&nbsp;int DEFAULT_INITIAL_VALUE</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_INITIAL_VALUE">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="DEFAULT_INCREMENT">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DEFAULT_INCREMENT</h4>
+<pre>public static final&nbsp;int DEFAULT_INCREMENT</pre>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_INCREMENT">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SequenceValueGenerator</h4>
+<pre>public&nbsp;SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name)
+ throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist. The initial sequence value is one,
+ and the increment is one.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</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="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SequenceValueGenerator</h4>
+<pre>public&nbsp;SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name,
+ long&nbsp;initialValue,
+ int&nbsp;increment)
+ throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</dd><dd><code>initialValue</code> - initial sequence value, if sequence needs to be created</dd><dd><code>increment</code> - amount to increment sequence by</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="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SequenceValueGenerator</h4>
+<pre>public&nbsp;SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>&nbsp;repo,
+ java.lang.String&nbsp;name,
+ long&nbsp;initialValue,
+ int&nbsp;increment,
+ int&nbsp;reserveAmount)
+ throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Construct a new SequenceValueGenerator which might create persistent
+ sequence data if it does not exist.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</dd><dd><code>initialValue</code> - initial sequence value, if sequence needs to be created</dd><dd><code>increment</code> - amount to increment sequence by</dd><dd><code>reserveAmount</code> - amount of sequence values to reserve</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="reset(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reset</h4>
+<pre>public&nbsp;void&nbsp;reset(int&nbsp;initialValue)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>,
+ <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
+<div class="block">Reset the sequence.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialValue</code> - first value produced by sequence</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>
+<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl>
+</li>
+</ul>
+<a name="nextLongValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nextLongValue</h4>
+<pre>public&nbsp;long&nbsp;nextLongValue()
+ throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
+<div class="block">Returns the next value from the sequence, which may wrap negative if all
+ positive values are exhausted. When sequence wraps back to initial
+ value, the sequence is fully exhausted, and an exception is thrown to
+ indicate this.
+
+ <p>Note: this method throws PersistException even for fetch failures
+ since this method is called by insert operations. Insert operations can
+ only throw a PersistException.</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> - for fetch/persist failure or if sequence is exhausted.</dd></dl>
+</li>
+</ul>
+<a name="nextIntValue()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nextIntValue</h4>
+<pre>public&nbsp;int&nbsp;nextIntValue()
+ throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
+<div class="block">Returns the next value from the sequence, which may wrap negative if all
+ positive values are exhausted. When sequence wraps back to initial
+ value, the sequence is fully exhausted, and an exception is thrown to
+ indicate this.
+
+ <p>Note: this method throws PersistException even for fetch failures
+ since this method is called by insert operations. Insert operations can
+ only throw a PersistException.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></dd>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextIntValue()">nextIntValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></code></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> - for fetch/persist failure or if sequence is
+ exhausted for int values.</dd></dl>
+</li>
+</ul>
+<a name="returnReservedValues()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>returnReservedValues</h4>
+<pre>public&nbsp;boolean&nbsp;returnReservedValues()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>,
+ <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
+<div class="block">Allow any unused reserved values to be returned for re-use. If the
+ repository is shared by other processes, then reserved values might not
+ be returnable.
+
+ <p>This method should be called during the shutdown process of a
+ repository, although calling it does not invalidate this
+ SequenceValueGenerator. If getNextValue is called again, it will reserve
+ values again.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if reserved values were returned</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>
+<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</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/SequenceValueGenerator.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/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueGenerator.html" target="_top">Frames</a></li>
+<li><a href="SequenceValueGenerator.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>