From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../carbonado/constraint/IntegerConstraint.html | 293 +++++++++++++++++++++ 1 file changed, 293 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html (limited to 'apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html') 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 @@ + + + + + + +IntegerConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type IntegerConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface IntegerConstraint
    +
    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. + +

    Example:

    + public interface UserInfo extends Storable {
+     int getAge();
+     @IntegerConstraint(min=0, max=120)
+     void setAge(int value);
+
+     int getRoleID();
+     @IntegerConstraint(allowed={ROLE_REGULAR, ROLE_ADMIN})
+     void setRoleID(int role);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    FloatConstraint, +TextConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      long[]allowed +
      Specific allowed values for property.
      +
      long[]disallowed +
      Specific disallowed values for property.
      +
      longmax +
      Specify maximum allowed value for integer property.
      +
      longmin +
      Specify minimum allowed value for integer property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

        +
        public abstract long[] allowed
        +
        Specific allowed values for property. Default is unlimited.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        disallowed

        +
        public abstract long[] disallowed
        +
        Specific disallowed values for property. Default is none.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      + + + +
        +
      • +

        min

        +
        public abstract long min
        +
        Specify minimum allowed value for integer property. Default is unlimited.
        +
        +
        Default:
        +
        -9223372036854775808L
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract long max
        +
        Specify maximum allowed value for integer property. Default is unlimited.
        +
        +
        Default:
        +
        9223372036854775807L
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3