Adding javadocs and Carbonado User Guidegh-pages

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/constraint/IntegerConstraint.html
1 files changed, 293 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html
new file mode 100644
index 0000000..eee9195
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html
@@ -0,0 +1,293 @@
+<!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>IntegerConstraint (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="IntegerConstraint (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/IntegerConstraint.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/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.html" target="_top">Frames</a></li>
+<li><a href="IntegerConstraint.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>Required&nbsp;|&nbsp;</li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#annotation_type_element_detail">Element</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.constraint</div>
+<h2 title="Annotation Type IntegerConstraint" class="title">Annotation Type IntegerConstraint</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">@ConstraintDefinition</a>
+public @interface <span class="strong">IntegerConstraint</span></pre>
+<div class="block">Limits the value of a property to be a member of a specific set. The
+ property value may be a boxed or unboxed byte, short, int, long, float,
+ double, String, CharSequence, char, Character, or character array. If the
+ property value is outside the set, an IllegalArgumentException is thrown.
+
+ <p>Example:<pre>
+ public interface UserInfo extends Storable {
+     int getAge();
+     <b>&#64;IntegerConstraint(min=0, max=120)</b>
+     void setAge(int value);
+
+     int getRoleID();
+     <b>&#64;IntegerConstraint(allowed={ROLE_REGULAR, ROLE_ADMIN})</b>
+     void setRoleID(int role);
+
+     ...
+ }
+ </pre></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/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a>, 
+<a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation_type_optional_element_summary">
+<!--   -->
+</a>
+<h3>Optional Element Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Optional Element and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#allowed()">allowed</a></strong></code>
+<div class="block">Specific allowed values for property.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#disallowed()">disallowed</a></strong></code>
+<div class="block">Specific disallowed values for property.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#max()">max</a></strong></code>
+<div class="block">Specify maximum allowed value for integer property.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a></strong></code>
+<div class="block">Specify minimum allowed value for integer property.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation_type_element_detail">
+<!--   -->
+</a>
+<h3>Element Detail</h3>
+<a name="allowed()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>allowed</h4>
+<pre>public abstract&nbsp;long[]&nbsp;allowed</pre>
+<div class="block">Specific allowed values for property. Default is unlimited.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="disallowed()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>disallowed</h4>
+<pre>public abstract&nbsp;long[]&nbsp;disallowed</pre>
+<div class="block">Specific disallowed values for property. Default is none.</div>
+<dl>
+<dt>Default:</dt>
+<dd>{}</dd>
+</dl>
+</li>
+</ul>
+<a name="min()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>min</h4>
+<pre>public abstract&nbsp;long&nbsp;min</pre>
+<div class="block">Specify minimum allowed value for integer property. Default is unlimited.</div>
+<dl>
+<dt>Default:</dt>
+<dd>-9223372036854775808L</dd>
+</dl>
+</li>
+</ul>
+<a name="max()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>max</h4>
+<pre>public abstract&nbsp;long&nbsp;max</pre>
+<div class="block">Specify maximum allowed value for integer property. Default is unlimited.</div>
+<dl>
+<dt>Default:</dt>
+<dd>9223372036854775807L</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/IntegerConstraint.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/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.html" target="_top">Frames</a></li>
+<li><a href="IntegerConstraint.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>Required&nbsp;|&nbsp;</li>
+<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li><a href="#annotation_type_element_detail">Element</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>
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/constraint/IntegerConstraint.html