diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/IsolationLevel.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/IsolationLevel.html | 510 |
1 files changed, 510 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/IsolationLevel.html b/apidocs/com/amazon/carbonado/IsolationLevel.html new file mode 100644 index 0000000..e79cf52 --- /dev/null +++ b/apidocs/com/amazon/carbonado/IsolationLevel.html @@ -0,0 +1,510 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IsolationLevel (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="IsolationLevel (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/IsolationLevel.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/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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</div> +<h2 title="Enum IsolationLevel" class="title">Enum IsolationLevel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.IsolationLevel</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">IsolationLevel</span> +extends java.lang.Enum<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></pre> +<div class="block">Describes a transaction isolation level. Transaction levels, in order from + lowest to highest are: + + <ul> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_UNCOMMITTED"><code>READ_UNCOMMITTED</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_COMMITTED"><code>READ_COMMITTED</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#REPEATABLE_READ"><code>REPEATABLE_READ</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#SNAPSHOT"><code>SNAPSHOT</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#SERIALIZABLE"><code>SERIALIZABLE</code></a> + </ul> + + A transaction's isolation level is usually <code>READ_COMMITTED</code> or + <code>REPEATABLE_READ</code> by default. Forcing a lower level, like + <code>READ_COMMITTED</code>, is useful when performing a long cursor + iteration. It releases locks during iteration rather than holding on to them + until the transaction exits. + + <p><code>SNAPSHOT</code> isolation is special in that it uses multiversion + concurrency control (MVCC). A commit may fail with an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a>. Few repositories are expected to support this + level, however.</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/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><code>Transaction</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#NONE">NONE</a></strong></code> +<div class="block">Indicates that no actual transaction is in progress.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_COMMITTED">READ_COMMITTED</a></strong></code> +<div class="block">Indicates that dirty reads are prevented.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_UNCOMMITTED">READ_UNCOMMITTED</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads can + occur.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#REPEATABLE_READ">REPEATABLE_READ</a></strong></code> +<div class="block">Indicates that dirty reads and non-repeatable reads are prevented.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#SERIALIZABLE">SERIALIZABLE</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#SNAPSHOT">SNAPSHOT</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.</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"> </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/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#highestCommon(com.amazon.carbonado.IsolationLevel)">highestCommon</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#isAtLeast(com.amazon.carbonado.IsolationLevel)">isAtLeast</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#isAtMost(com.amazon.carbonado.IsolationLevel)">isAtMost</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is no higher than the one given.</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/IsolationLevel.html#lowestCommon(com.amazon.carbonado.IsolationLevel)">lowestCommon</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/IsolationLevel.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/IsolationLevel.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NONE</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> NONE</pre> +<div class="block">Indicates that no actual transaction is in progress. If this level is + specified when entering a transaction, it uses auto-commit mode.</div> +</li> +</ul> +<a name="READ_UNCOMMITTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_UNCOMMITTED</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> READ_UNCOMMITTED</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads can + occur. This level allows modifications by one transaction to be read by + another transaction before any changes have been committed (a "dirty + read"). If any of the changes are rolled back, the second transaction + will have retrieved an invalid modification. + + <p>This level is also known as degree 1 isolation.</div> +</li> +</ul> +<a name="READ_COMMITTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_COMMITTED</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> READ_COMMITTED</pre> +<div class="block">Indicates that dirty reads are prevented. Non-repeatable reads and + phantom reads can occur. This level only prohibits a transaction from + reading modifications with uncommitted changes in it. + + <p>This level is also known as degree 2 isolation.</div> +</li> +</ul> +<a name="REPEATABLE_READ"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REPEATABLE_READ</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> REPEATABLE_READ</pre> +<div class="block">Indicates that dirty reads and non-repeatable reads are prevented. + Phantom reads can occur. This level prohibits a transaction from reading + uncommitted changes, and it also prohibits the situation where one + transaction reads a record, a second transaction alters the record, and + the first transaction rereads the record, getting different values the + second time (a "non-repeatable read").</div> +</li> +</ul> +<a name="SNAPSHOT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SNAPSHOT</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> SNAPSHOT</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Commits can still fail however, as snapshot isolation avoids + using locks.</div> +</li> +</ul> +<a name="SERIALIZABLE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SERIALIZABLE</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> SERIALIZABLE</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Phantoms are records returned as a result of a search, but + which were not seen by the same transaction when the identical search + criteria was previously used. For example, another transaction may have + inserted records which match the original search. + + <p>This level is also known as degree 3 isolation.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (IsolationLevel c : IsolationLevel.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="isAtLeast(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAtLeast</h4> +<pre>public boolean isAtLeast(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</li> +</ul> +<a name="isAtMost(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAtMost</h4> +<pre>public boolean isAtMost(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</li> +</ul> +<a name="lowestCommon(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lowestCommon</h4> +<pre>public <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> lowestCommon(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</li> +</ul> +<a name="highestCommon(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>highestCommon</h4> +<pre>public <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> highestCommon(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns the highest common isolation level between this and the one + given.</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/IsolationLevel.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/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> |