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/ConstraintDefinition.html | 288 +++++++++++++++ .../constraint/FloatConstraint.Constraint.html | 330 +++++++++++++++++ .../carbonado/constraint/FloatConstraint.html | 289 +++++++++++++++ .../constraint/IntegerConstraint.Constraint.html | 343 +++++++++++++++++ .../carbonado/constraint/IntegerConstraint.html | 293 +++++++++++++++ .../constraint/LengthConstraint.Constraint.html | 404 +++++++++++++++++++++ .../carbonado/constraint/LengthConstraint.html | 247 +++++++++++++ .../constraint/TextConstraint.Constraint.html | 326 +++++++++++++++++ .../carbonado/constraint/TextConstraint.html | 249 +++++++++++++ .../constraint/class-use/ConstraintDefinition.html | 179 +++++++++ .../class-use/FloatConstraint.Constraint.html | 117 ++++++ .../constraint/class-use/FloatConstraint.html | 159 ++++++++ .../class-use/IntegerConstraint.Constraint.html | 117 ++++++ .../constraint/class-use/IntegerConstraint.html | 187 ++++++++++ .../class-use/LengthConstraint.Constraint.html | 117 ++++++ .../constraint/class-use/LengthConstraint.html | 159 ++++++++ .../class-use/TextConstraint.Constraint.html | 117 ++++++ .../constraint/class-use/TextConstraint.html | 159 ++++++++ .../amazon/carbonado/constraint/package-frame.html | 31 ++ .../carbonado/constraint/package-summary.html | 206 +++++++++++ .../amazon/carbonado/constraint/package-tree.html | 141 +++++++ .../amazon/carbonado/constraint/package-use.html | 197 ++++++++++ 22 files changed, 4655 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html create mode 100644 apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/FloatConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/LengthConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/TextConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/constraint/package-use.html (limited to 'apidocs/com/amazon/carbonado/constraint') 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 @@ + + + + + + +ConstraintDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type ConstraintDefinition

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

    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. +

    + Example integer constraint: + 

    + @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @ConstraintDefinition
+ public @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
+          */
+         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
+          */
+         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);
+             }
+         }
+     }
+ }
+
    + + The newly defined integer constraint can be applied to property mutators. + + 
    + public interface UserInfo extends Storable {
+     ...
+
+     int getAge();
+     // Constraint is called before setting age.
+     @IntegerConstraint(min=0, max=120)
+     void setAge(int value);
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Classimplementation +
      Specify class which will perform constraint checking.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        implementation

        +
        public abstract java.lang.Class implementation
        +
        Specify class which will perform constraint checking. Must have a public + constructor with the signature + (Class type, String propertyName, Annotation), + where Annotation refers to the annotation with the + constraint definition. + +

        The implementation class need not be explicitly specified. By + default, the constraint class must be a static inner class of the + annotation, named "Constraint".

        +
        +
        Default:
        +
        void.class
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html new file mode 100644 index 0000000..2ec9cdf --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html @@ -0,0 +1,330 @@ + + + + + + +FloatConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class FloatConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FloatConstraint
    +
    +
    +
    +
    public static class FloatConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for FloatConstraint.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + double min, + double max, + double[] allowed, + double[] disallowed) 
      FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + FloatConstraint ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(double propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FloatConstraint.Constraint

        +
        public FloatConstraint.Constraint(java.lang.Class<?> type,
+                          java.lang.String propertyName,
+                          FloatConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        FloatConstraint.Constraint

        +
        public FloatConstraint.Constraint(java.lang.Class<?> type,
+                          java.lang.String propertyName,
+                          double min,
+                          double max,
+                          double[] allowed,
+                          double[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed value
        max - maximum allowed value
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(double propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html new file mode 100644 index 0000000..2df53d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html @@ -0,0 +1,289 @@ + + + + + + +FloatConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type FloatConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface FloatConstraint
    +
    Limits the value of a property to be a member of a specific set. The + property value may be a boxed or unboxed float, double, String, + CharSequence, char, Character, or character array. If the property value is + outside the set, an IllegalArgumentException is thrown. + +

    Example:

    + public interface PolarCoordinate extends Storable {
+     double getTheta();
+     @FloatConstraint(min=0, max=Math.PI * 2, disallowed=Double.NaN)
+     void setTheta(double radians);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntegerConstraint, +TextConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      double[]allowed +
      Specific allowed values for property.
      +
      double[]disallowed +
      Specific disallowed values for property.
      +
      doublemax +
      Specify maximum allowed value for float/double property.
      +
      doublemin +
      Specify minimum allowed value for float/double property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

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

        disallowed

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

        min

        +
        public abstract double min
        +
        Specify minimum allowed value for float/double property. Default is unlimited.
        +
        +
        Default:
        +
        -1d/0d
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract double max
        +
        Specify maximum allowed value for float/double property. Default is unlimited.
        +
        +
        Default:
        +
        1d/0d
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html new file mode 100644 index 0000000..a5baafb --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html @@ -0,0 +1,343 @@ + + + + + + +IntegerConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class IntegerConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    IntegerConstraint
    +
    +
    +
    +
    public static class IntegerConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for IntegerConstraint.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(double propertyValue) 
      voidconstrain(long propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IntegerConstraint.Constraint

        +
        public IntegerConstraint.Constraint(java.lang.Class<?> type,
+                            java.lang.String propertyName,
+                            IntegerConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        IntegerConstraint.Constraint

        +
        public IntegerConstraint.Constraint(java.lang.Class<?> type,
+                            java.lang.String propertyName,
+                            long min,
+                            long max,
+                            long[] allowed,
+                            long[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed value
        max - maximum allowed value
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(long propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(double propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + 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.

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html new file mode 100644 index 0000000..49687a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html @@ -0,0 +1,404 @@ + + + + + + +LengthConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class LengthConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    LengthConstraint
    +
    +
    +
    +
    public static class LengthConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for LengthConstraint.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(boolean[] array) 
      voidconstrain(byte[] array) 
      voidconstrain(char[] array) 
      voidconstrain(java.lang.CharSequence str) 
      voidconstrain(double[] array) 
      voidconstrain(float[] array) 
      voidconstrain(int[] array) 
      voidconstrain(long[] array) 
      voidconstrain(java.lang.Object[] array) 
      voidconstrain(short[] array) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LengthConstraint.Constraint

        +
        public LengthConstraint.Constraint(java.lang.Class<?> type,
+                           java.lang.String propertyName,
+                           LengthConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        LengthConstraint.Constraint

        +
        public LengthConstraint.Constraint(java.lang.Class<?> type,
+                           java.lang.String propertyName,
+                           int min,
+                           int max)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        min - minimum allowed length
        max - maximum allowed length
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence str)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(boolean[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(byte[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(short[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(int[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(long[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(float[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(double[] array)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.Object[] array)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html new file mode 100644 index 0000000..378a28b --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html @@ -0,0 +1,247 @@ + + + + + + +LengthConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type LengthConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface LengthConstraint
    +
    Limits the value of a property to lie within a specific length range. The + property value may be a String, CharSequence, or any kind of array. If the + set property length is outside the range, an IllegalArgumentException is + thrown. + +

    Example:

    + public interface UserInfo extends Storable {
+     String getFirstName();
+     @LengthConstraint(min=1, max=50)
+     void setFirstName(String name);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      intmax +
      Specify maximum allowed length for property.
      +
      intmin +
      Specify minimum allowed length for property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        public abstract int min
        +
        Specify minimum allowed length for property. Default is zero.
        +
        +
        Default:
        +
        0
        +
        +
        • +
      + + + +
        +
      • +

        max

        +
        public abstract int max
        +
        Specify maximum allowed length for property. Default is unlimited.
        +
        +
        Default:
        +
        2147483647
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html new file mode 100644 index 0000000..3b005f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html @@ -0,0 +1,326 @@ + + + + + + +TextConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Class TextConstraint.Constraint

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextConstraint
    +
    +
    +
    +
    public static class TextConstraint.Constraint
+extends java.lang.Object
    +
    Constraint implementation for TextConstraint.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String[] allowed, + java.lang.String[] disallowed) 
      TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + TextConstraint ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidconstrain(char propertyValue) 
      voidconstrain(char[] propertyValue) 
      voidconstrain(java.lang.CharSequence propertyValue) 
      voidconstrain(java.lang.String propertyValue) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextConstraint.Constraint

        +
        public TextConstraint.Constraint(java.lang.Class<?> type,
+                         java.lang.String propertyName,
+                         TextConstraint ann)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        ann - specific annotation that binds to this constraint class
        +
        • +
      + + + +
        +
      • +

        TextConstraint.Constraint

        +
        public TextConstraint.Constraint(java.lang.Class<?> type,
+                         java.lang.String propertyName,
+                         java.lang.String[] allowed,
+                         java.lang.String[] disallowed)
        +
        Parameters:
        type - type of object that contains the constrained property
        propertyName - name of property with constraint
        allowed - optional set of allowed values
        disallowed - optional set of disallowed values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.CharSequence propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(java.lang.String propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char propertyValue)
        +
        • +
      + + + +
        +
      • +

        constrain

        +
        public void constrain(char[] propertyValue)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html new file mode 100644 index 0000000..e163aa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html @@ -0,0 +1,249 @@ + + + + + + +TextConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.constraint
+

Annotation Type TextConstraint

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@ConstraintDefinition
+public @interface TextConstraint
    +
    Limits the value of a property to be a member of a specific set. The + property value may be a 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 {
+     char isActive();
+     @TextConstraint(allowed={"Y", "N"})
+     void setActive(char value);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IntegerConstraint, +FloatConstraint
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]allowed +
      Specific allowed values for property.
      +
      java.lang.String[]disallowed +
      Specific disallowed values for property.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        allowed

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

        disallowed

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html b/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html new file mode 100644 index 0000000..393098a --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html @@ -0,0 +1,179 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.ConstraintDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.ConstraintDefinition

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html new file mode 100644 index 0000000..e6e63ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.FloatConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.FloatConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.FloatConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html new file mode 100644 index 0000000..8438555 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.FloatConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.FloatConstraint

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html new file mode 100644 index 0000000..e658437 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.IntegerConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.IntegerConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.IntegerConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html new file mode 100644 index 0000000..4c188f6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html @@ -0,0 +1,187 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.IntegerConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.IntegerConstraint

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html new file mode 100644 index 0000000..e029dcd --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.LengthConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.LengthConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.LengthConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html new file mode 100644 index 0000000..c665cc2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.LengthConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.LengthConstraint

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html new file mode 100644 index 0000000..64e7f68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.TextConstraint.Constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.TextConstraint.Constraint

+
+
No usage of com.amazon.carbonado.constraint.TextConstraint.Constraint
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html new file mode 100644 index 0000000..a142339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.constraint.TextConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.constraint.TextConstraint

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-frame.html b/apidocs/com/amazon/carbonado/constraint/package-frame.html new file mode 100644 index 0000000..c16cc70 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.constraint

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-summary.html b/apidocs/com/amazon/carbonado/constraint/package-summary.html new file mode 100644 index 0000000..02a0986 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-summary.html @@ -0,0 +1,206 @@ + + + + + + +com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.constraint

+
+
Contains annotations and implementations for supporting property constraints.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.constraint Description

+
Contains annotations and implementations for supporting property constraints.
+
See Also:
ConstraintDefinition
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-tree.html b/apidocs/com/amazon/carbonado/constraint/package-tree.html new file mode 100644 index 0000000..1ec966e --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-tree.html @@ -0,0 +1,141 @@ + + + + + + +com.amazon.carbonado.constraint Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.constraint

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/constraint/package-use.html b/apidocs/com/amazon/carbonado/constraint/package-use.html new file mode 100644 index 0000000..1348147 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-use.html @@ -0,0 +1,197 @@ + + + + + + +Uses of Package com.amazon.carbonado.constraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.constraint

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3