summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html')
-rw-r--r--apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html288
1 files changed, 288 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html
new file mode 100644
index 0000000..0b5234b
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html
@@ -0,0 +1,288 @@
+<!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>ConstraintDefinition (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="ConstraintDefinition (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/ConstraintDefinition.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>Prev Class</li>
+<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation 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/ConstraintDefinition.html" target="_top">Frames</a></li>
+<li><a href="ConstraintDefinition.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 ConstraintDefinition" class="title">Annotation Type ConstraintDefinition</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>@Documented
+@Retention(value=RUNTIME)
+@Target(value=ANNOTATION_TYPE)
+public @interface <span class="strong">ConstraintDefinition</span></pre>
+<div class="block">Allows annotations to be defined that restrict property values. The
+ annotation is just a pointer to a constraint checking class. If the
+ constraint class is not explicitly provided, it defaults to a static inner
+ class named "Constraint" in the annotation itself.
+
+ <p>The constraint class must have a public constructor that accepts the
+ annotation that has the ConstraintDefinition annotation. It must also define
+ several "constrain" methods which perform constraint checks on specific
+ property types.
+ <p>
+ Example integer constraint:
+ <pre>
+ &#64;Documented
+ <b>&#64;Retention(RetentionPolicy.RUNTIME)</b>
+ <b>&#64;Target(ElementType.METHOD)</b>
+ <b>&#64;ConstraintDefinition</b>
+ public &#64;interface IntegerConstraint {
+ int min() default Integer.MIN_VALUE;
+
+ int max() default Integer.MAX_VALUE;
+
+ public static class Constraint {
+ private final String propertyName;
+ private final int min;
+ private final int max;
+
+ // Constructor may throw a MalformedTypeException if
+ // params supplied by annotation are illegal.
+
+ /**
+ * @param type optional type of object that contains the constrained property
+ * @param propertyName name of property with constraint
+ * @param annotation specific annotation that binds to this constraint class
+ *&#47;
+ public Constraint(Class type, String propertyName, IntegerConstraint annotation) {
+ this.propertyName = propertyName;
+ this.min = annotation.min();
+ this.max = annotation.max();
+ }
+
+ // Define a constrain method for each supported property type.
+
+ /**
+ * @param propertyValue specific value to constrain
+ *&#47;
+ public void constrain(int propertyValue) throws IllegalArgumentException {
+ if (propertyValue < min || propertyValue > max) {
+ throw new IllegalArgumentException
+ ("Value for \"" + propertyName + "\" must be in range " +
+ min + ".." + max + ": " + propertyValue);
+ }
+ }
+ }
+ }
+ </pre>
+
+ The newly defined integer constraint can be applied to property mutators.
+
+ <pre>
+ public interface UserInfo extends Storable {
+ ...
+
+ int getAge();
+ // Constraint is called before setting age.
+ <b>&#64;IntegerConstraint(min=0, max=120)</b>
+ void setAge(int value);
+ }
+ </pre></div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</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>java.lang.Class</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html#implementation()">implementation</a></strong></code>
+<div class="block">Specify class which will perform constraint checking.</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="implementation()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>implementation</h4>
+<pre>public abstract&nbsp;java.lang.Class&nbsp;implementation</pre>
+<div class="block">Specify class which will perform constraint checking. Must have a public
+ constructor with the signature
+ <code>(Class type, String propertyName, <i>Annotation</i>)</code>,
+ where <code><i>Annotation</i></code> refers to the annotation with the
+ constraint definition.
+
+ <p>The implementation class need not be explicitly specified. By
+ default, the constraint class must be a static inner class of the
+ annotation, named "Constraint".</div>
+<dl>
+<dt>Default:</dt>
+<dd>void.class</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/ConstraintDefinition.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>Prev Class</li>
+<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation 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/ConstraintDefinition.html" target="_top">Frames</a></li>
+<li><a href="ConstraintDefinition.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>