diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/Version.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/Version.html | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/Version.html b/apidocs/com/amazon/carbonado/Version.html new file mode 100644 index 0000000..00ea984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Version.html @@ -0,0 +1,189 @@ +<!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>Version (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="Version (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/Version.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/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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="Annotation Type Version" class="title">Annotation Type Version</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Version</span></pre> +<div class="block">Designates a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being the authoritative version + number for the entire Storable instance. Only one property can have this + designation. + + <p>Philosophically, a version property can be considered part of the + identity of the storable. Unless the version is <a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a>, the + repository is responsible for establishing the version on insert, and for + auto-incrementing it on update. Under no circumstances should a normal + version property be incremented manually; this can result in a false <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a>, or worse may allow the persistent record to become + corrupted. + + <p>When updating a storable which has a normal version property, a value for + the version must be specified along with its primary key. Otherwise, an + <code>IllegalStateException</code> is thrown when calling update. If the update + operation detects that the specified version doesn't exactly match the + version of the existing persisted storable, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown. For <a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a> versions, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown only if the update detects that the new + version hasn't incremented. + + <p>The actual type of the version property can be anything, but some + repositories might only support integers. For maximum portability, version + properties should be a regular 32-bit int. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@Version</b> + int getRecordVersionNumber(); + void setRecordVersionNumber(int version); + + ... + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a></dd></dl> +</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/Version.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/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> |