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 --- .../com/amazon/carbonado/info/ChainedProperty.html | 625 ++++++++++++++ apidocs/com/amazon/carbonado/info/Direction.html | 388 +++++++++ .../com/amazon/carbonado/info/OrderedProperty.html | 444 ++++++++++ .../com/amazon/carbonado/info/StorableIndex.html | 791 ++++++++++++++++++ .../com/amazon/carbonado/info/StorableInfo.html | 522 ++++++++++++ .../carbonado/info/StorableIntrospector.html | 319 +++++++ apidocs/com/amazon/carbonado/info/StorableKey.html | 245 ++++++ .../amazon/carbonado/info/StorableProperty.html | 929 +++++++++++++++++++++ .../carbonado/info/StorablePropertyAdapter.html | 432 ++++++++++ .../carbonado/info/StorablePropertyAnnotation.html | 324 +++++++ .../carbonado/info/StorablePropertyConstraint.html | 264 ++++++ .../carbonado/info/class-use/ChainedProperty.html | 385 +++++++++ .../amazon/carbonado/info/class-use/Direction.html | 432 ++++++++++ .../carbonado/info/class-use/OrderedProperty.html | 447 ++++++++++ .../carbonado/info/class-use/StorableIndex.html | 544 ++++++++++++ .../carbonado/info/class-use/StorableInfo.html | 288 +++++++ .../info/class-use/StorableIntrospector.html | 163 ++++ .../carbonado/info/class-use/StorableKey.html | 247 ++++++ .../carbonado/info/class-use/StorableProperty.html | 479 +++++++++++ .../info/class-use/StorablePropertyAdapter.html | 229 +++++ .../info/class-use/StorablePropertyAnnotation.html | 167 ++++ .../info/class-use/StorablePropertyConstraint.html | 167 ++++ .../com/amazon/carbonado/info/package-frame.html | 36 + .../com/amazon/carbonado/info/package-summary.html | 230 +++++ .../com/amazon/carbonado/info/package-tree.html | 163 ++++ apidocs/com/amazon/carbonado/info/package-use.html | 443 ++++++++++ 26 files changed, 9703 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/info/ChainedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/Direction.html create mode 100644 apidocs/com/amazon/carbonado/info/OrderedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableIndex.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableKey.html create mode 100644 apidocs/com/amazon/carbonado/info/StorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html create mode 100644 apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/Direction.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableKey.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html create mode 100644 apidocs/com/amazon/carbonado/info/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/info/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/info/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/info/package-use.html (limited to 'apidocs/com/amazon/carbonado/info') diff --git a/apidocs/com/amazon/carbonado/info/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/ChainedProperty.html new file mode 100644 index 0000000..de0ae35 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/ChainedProperty.html @@ -0,0 +1,625 @@ + + + + + + +ChainedProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class ChainedProperty<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class ChainedProperty<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    Represents a property to filter on or to order by. Properties may be + specified in a simple form, like "firstName", or in a chained form, like + "address.state". In both forms, the first property is the "prime" + property. All properties that follow are chained.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime)
        +
        Returns a canonical instance which has no chain.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime,
+                                          StorableProperty<?>... chain)
        +
        Returns a canonical instance.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null or if chained + properties are not formed properly
        +
        • +
      + + + +
        +
      • +

        get

        +
        public static <S extends Storable> ChainedProperty<S> get(StorableProperty<S> prime,
+                                          StorableProperty<?>[] chain,
+                                          boolean[] outerJoin)
        +
        Returns a canonical instance.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if prime is null or if chained + properties are not formed properly
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> ChainedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses a chained property.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any parameter is null or string + format is incorrect
        +
        • +
      + + + + + + + +
        +
      • +

        getType

        +
        public java.lang.Class<?> getType()
        +
        Returns the type of the last property in the chain, or of the prime + property if the chain is empty.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Returns true if any property in the chain can be null.
        +
        Since:
        +
        1.2
        +
        See Also:
        Nullable
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        public boolean isDerived()
        +
        Returns true if any property in the chain is derived.
        +
        Since:
        +
        1.2
        +
        See Also:
        Derived
        +
        • +
      + + + +
        +
      • +

        getLastProperty

        +
        public StorableProperty<?> getLastProperty()
        +
        Returns the last property in the chain, or the prime property if chain + is empty.
        +
        • +
      + + + +
        +
      • +

        getChainCount

        +
        public int getChainCount()
        +
        Returns amount of properties chained from prime property, which may be + zero.
        +
        • +
      + + + +
        +
      • +

        getChainedProperty

        +
        public StorableProperty<?> getChainedProperty(int index)
+                                       throws java.lang.IndexOutOfBoundsException
        +
        Parameters:
        index - valid range is 0 to chainCount - 1
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        isOuterJoin

        +
        public boolean isOuterJoin(int index)
+                    throws java.lang.IndexOutOfBoundsException
        +
        Returns true if the property at the given index should be treated as an + outer join. Index zero is the prime property.
        +
        Parameters:
        index - valid range is 0 to chainCount
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        append

        +
        public ChainedProperty<S> append(StorableProperty<?> property,
+                        boolean outerJoin)
        +
        Returns a new ChainedProperty with another property appended.
        +
        Parameters:
        outerJoin - pass true for outer join
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        trim

        +
        public ChainedProperty<S> trim()
        +
        Returns a new ChainedProperty with the last property in the chain removed.
        +
        Throws:
        +
        java.lang.IllegalStateException - if chain count is zero
        +
        • +
      + + + +
        +
      • +

        tail

        +
        public ChainedProperty<?> tail()
        +
        Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.
        +
        Throws:
        +
        java.lang.IllegalStateException - if chain count is zero
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Appends the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html new file mode 100644 index 0000000..b1e7db0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/Direction.html @@ -0,0 +1,388 @@ + + + + + + +Direction (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Enum Direction

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<Direction>
    +
    +
    +
    +
    public enum Direction
+extends java.lang.Enum<Direction>
    +
    Describes a property sorting direction.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static DirectionfromCharacter(char c) +
      Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
      +
      Directionreverse() +
      Returns the reverse direction of this.
      +
      chartoCharacter() +
      Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
      +
      static DirectionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static Direction[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        ASCENDING

        +
        public static final Direction ASCENDING
        +
        • +
      + + + +
        +
      • +

        DESCENDING

        +
        public static final Direction DESCENDING
        +
        • +
      + + + +
        +
      • +

        UNSPECIFIED

        +
        public static final Direction UNSPECIFIED
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static Direction[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (Direction c : Direction.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static Direction valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public Direction reverse()
        +
        Returns the reverse direction of this.
        +
        • +
      + + + +
        +
      • +

        toCharacter

        +
        public char toCharacter()
        +
        Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
        +
        • +
      + + + +
        +
      • +

        fromCharacter

        +
        public static Direction fromCharacter(char c)
        +
        Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/OrderedProperty.html new file mode 100644 index 0000000..48833a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/OrderedProperty.html @@ -0,0 +1,444 @@ + + + + + + +OrderedProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class OrderedProperty<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    +
    public class OrderedProperty<S extends Storable>
+extends java.lang.Object
+implements java.io.Serializable, Appender
    +
    Represents a property paired with a preferred ordering direction.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> OrderedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction. If + ordering prefix not specified, default direction is ascending.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any required parameter is null or + string format is incorrect
        +
        • +
      + + + +
        +
      • +

        parse

        +
        public static <S extends Storable> OrderedProperty<S> parse(StorableInfo<S> info,
+                                            java.lang.String str,
+                                            Direction defaultDirection)
+                                                 throws java.lang.IllegalArgumentException
        +
        Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction.
        +
        Parameters:
        info - Info for Storable type containing property
        str - string to parse
        defaultDirection - default direction if not specified in + string. If null, ascending order is defaulted.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any required parameter is null or + string format is incorrect
        +
        • +
      + + + + + + + +
        +
      • +

        getDirection

        +
        public Direction getDirection()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns the chained property in a parseable form.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Description copied from interface: Appender
        +
        Append the string representation of this object to the given Appendable.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableIndex.html b/apidocs/com/amazon/carbonado/info/StorableIndex.html new file mode 100644 index 0000000..863b3bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIndex.html @@ -0,0 +1,791 @@ + + + + + + +StorableIndex (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorableIndex<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Appender
    +
    +
    +
    +
    public class StorableIndex<S extends Storable>
+extends java.lang.Object
+implements Appender
    +
    Represents an index that must be defined for a specific Storable type.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Index
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null, if lengths + do not match, or if any length is zero.
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions,
+             boolean unique)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index.
        +
        Parameters:
        properties -
        directions -
        unique -
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableProperty<S>[] properties,
+             Direction[] directions,
+             boolean unique,
+             boolean clustered)
        +
        Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index as well as clustered option.
        +
        Parameters:
        properties -
        directions -
        unique -
        clustered -
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(StorableKey<S> key,
+             Direction direction)
        +
        Creates a StorableIndex from a StorableKey.
        +
        Parameters:
        direction - optional direction to apply to each key property that + has an unspecified direction
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if key is null or it has + no properties
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(OrderedProperty<S>[] properties,
+             Direction direction)
        +
        Creates a StorableIndex from OrderedProperties.
        +
        Parameters:
        direction - optional direction to apply to each property that + has an unspecified direction
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if no properties supplied
        +
        • +
      + + + +
        +
      • +

        StorableIndex

        +
        public StorableIndex(java.lang.Class<S> type,
+             IndexInfo indexInfo)
        +
        Creates a StorableIndex from an IndexInfo.
        +
        Parameters:
        type - type of storable index is defined for
        indexInfo - IndexInfo returned from storage object
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any argument is null, if any + properties are invalid, or if index info has no properties
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseNameDescriptor

        +
        public static <S extends Storable> StorableIndex<S> parseNameDescriptor(java.lang.String desc,
+                                                        StorableInfo<S> info)
+                                                             throws java.lang.IllegalArgumentException
        +
        Parses an index descriptor and returns an index object.
        +
        Parameters:
        desc - name descriptor, as created by getNameDescriptor()
        info - info on storable type
        +
        Returns:
        index represented by descriptor
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if error in descriptor syntax or if it + refers to unknown properties
        +
        • +
      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Returns the type of storable this index applies to.
        +
        • +
      + + + +
        +
      • +

        getPropertyCount

        +
        public int getPropertyCount()
        +
        Returns the count of properties in this index.
        +
        • +
      + + + +
        +
      • +

        getProperty

        +
        public StorableProperty<S> getProperty(int index)
        +
        Returns a specific property in this index.
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public StorableProperty<S>[] getProperties()
        +
        Returns a new array with all the properties in it.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirection

        +
        public Direction getPropertyDirection(int index)
        +
        Returns the requested direction of a specific property in this index.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        public Direction[] getPropertyDirections()
        +
        Returns a new array with all the property directions in it.
        +
        • +
      + + + +
        +
      • +

        getOrderedProperty

        +
        public OrderedProperty<S> getOrderedProperty(int index)
        +
        Returns a specific property in this index, with the direction folded in.
        +
        • +
      + + + +
        +
      • +

        getOrderedProperties

        +
        public OrderedProperty<S>[] getOrderedProperties()
        +
        Returns a new array with all the properties in it, with directions + folded in.
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        public boolean isUnique()
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        public boolean isClustered()
        +
        Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.
        +
        • +
      + + + +
        +
      • +

        unique

        +
        public StorableIndex<S> unique(boolean unique)
        +
        Returns a StorableIndex instance which is unique or not.
        +
        • +
      + + + +
        +
      • +

        clustered

        +
        public StorableIndex<S> clustered(boolean clustered)
        +
        Returns a StorableIndex instance which is clustered or not.
        +
        • +
      + + + +
        +
      • +

        reverse

        +
        public StorableIndex<S> reverse()
        +
        Returns a StorableIndex instance with all the properties reversed.
        +
        • +
      + + + +
        +
      • +

        setDefaultDirection

        +
        public StorableIndex<S> setDefaultDirection(Direction direction)
        +
        Returns a StorableIndex instance with all unspecified directions set to + the given direction. Returns this if all directions are already + specified.
        +
        Parameters:
        direction - direction to replace all unspecified directions
        +
        • +
      + + + +
        +
      • +

        addProperty

        +
        public StorableIndex<S> addProperty(StorableProperty<S> property,
+                           Direction direction)
        +
        Returns a StorableIndex with the given property added. If this index + already contained the given property (regardless of sort direction), + this index is returned.
        +
        Parameters:
        property - property to add unless already in this index
        direction - direction to apply to property, if added
        +
        Returns:
        new index with added property or this if index already contained property
        +
        • +
      + + + +
        +
      • +

        uniquify

        +
        public StorableIndex<S> uniquify(StorableKey<S> key)
        +
        Returns a StorableIndex which is unique, possibly by appending + properties from the given key. If index is already unique, it is + returned as-is.
        +
        • +
      + + + +
        +
      • +

        getNameDescriptor

        +
        public java.lang.String getNameDescriptor()
        +
        Converts this index into a parseable name descriptor string, whose + general format is: + +

        <storable type>~<attr><+|-|~><property><+|-|~><property>... + +

        Attr is "U" for a unique index, "N" for a non-unique index. + +

        Example: my.pkg.UserInfo~N+lastName+firstName-birthDate

        +
        See Also:
        parseNameDescriptor(String, StorableInfo)
        +
        • +
      + + + +
        +
      • +

        getTypeDescriptor

        +
        public java.lang.String getTypeDescriptor()
        +
        Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together. There is + one slight difference. Types which may be null are prefixed with a 'N' + character.
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        public void appendTo(java.lang.Appendable app)
+              throws java.io.IOException
        +
        Appends the same results as toString, but without the "StorableIndex" + prefix.
        +
        +
        Specified by:
        +
        appendTo in interface Appender
        +
        Parameters:
        app - Appendable object to receive string representation
        +
        Throws:
        +
        java.io.IOException - if thrown from given Appendable
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableInfo.html b/apidocs/com/amazon/carbonado/info/StorableInfo.html new file mode 100644 index 0000000..ac528bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableInfo.html @@ -0,0 +1,522 @@ + + + + + + +StorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableInfo<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetAlias(int index) +
      Returns a specific alias for the Storable.
      +
      intgetAliasCount() +
      Returns the count of aliases for the Storable.
      +
      java.lang.String[]getAliases() +
      Returns a new array with all the alias names in it.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getAllProperties() +
      Returns all the storable properties in an unmodifiable map.
      +
      StorableKey<S>getAlternateKey(int index) +
      Returns a specific alternate key for the Storable.
      +
      intgetAlternateKeyCount() +
      Returns the count of alternate keys for the Storable.
      +
      StorableKey<S>[]getAlternateKeys() +
      Returns a new array with all the alternate keys in it.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getDataProperties() +
      Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.
      +
      StorableIndex<S>getIndex(int index) +
      Returns a specific index for the Storable.
      +
      intgetIndexCount() +
      Returns the count of indexes defined for the Storable.
      +
      StorableIndex<S>[]getIndexes() +
      Returns a new array with all the indexes in it.
      +
      java.lang.StringgetName() +
      Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
      +
      StorableKey<S>getPartitionKey() +
      Returns the partition key for the Storable, or null if none exists.
      +
      StorableKey<S>getPrimaryKey() +
      Returns the primary key for the Storable, never null.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getPrimaryKeyProperties() +
      Returns a subset of the storable properties in an unmodifiable map + that define the primary key.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable described by this StorableInfo.
      +
      StorableProperty<S>getVersionProperty() +
      Returns the designated version property, or null if none.
      +
      booleanisAuthoritative() 
      booleanisIndependent() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
        +
        • +
      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable described by this StorableInfo.
        +
        • +
      + + + +
        +
      • +

        getAllProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getAllProperties()
        +
        Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getPrimaryKeyProperties()
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getDataProperties

        +
        java.util.Map<java.lang.String,? extends StorableProperty<S>> getDataProperties()
        +
        Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.
        +
        Returns:
        maps property names to property objects
        +
        • +
      + + + +
        +
      • +

        getVersionProperty

        +
        StorableProperty<S> getVersionProperty()
        +
        Returns the designated version property, or null if none.
        +
        • +
      + + + +
        +
      • +

        getPrimaryKey

        +
        StorableKey<S> getPrimaryKey()
        +
        Returns the primary key for the Storable, never null.
        +
        • +
      + + + +
        +
      • +

        getAlternateKeyCount

        +
        int getAlternateKeyCount()
        +
        Returns the count of alternate keys for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlternateKey

        +
        StorableKey<S> getAlternateKey(int index)
        +
        Returns a specific alternate key for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlternateKeys

        +
        StorableKey<S>[] getAlternateKeys()
        +
        Returns a new array with all the alternate keys in it.
        +
        • +
      + + + +
        +
      • +

        getPartitionKey

        +
        StorableKey<S> getPartitionKey()
        +
        Returns the partition key for the Storable, or null if none exists.
        +
        • +
      + + + +
        +
      • +

        getAliasCount

        +
        int getAliasCount()
        +
        Returns the count of aliases for the Storable.
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        java.lang.String getAlias(int index)
+                          throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific alias for the Storable.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getAliases

        +
        java.lang.String[] getAliases()
        +
        Returns a new array with all the alias names in it.
        +
        • +
      + + + +
        +
      • +

        getIndexCount

        +
        int getIndexCount()
        +
        Returns the count of indexes defined for the Storable.
        +
        • +
      + + + +
        +
      • +

        getIndex

        +
        StorableIndex<S> getIndex(int index)
+                                           throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific index for the Storable.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getIndexes

        +
        StorableIndex<S>[] getIndexes()
        +
        Returns a new array with all the indexes in it.
        +
        • +
      + + + +
        +
      • +

        isIndependent

        +
        boolean isIndependent()
        +
        See Also:
        Independent
        +
        • +
      + + + +
        +
      • +

        isAuthoritative

        +
        boolean isAuthoritative()
        +
        See Also:
        Authoritative
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html new file mode 100644 index 0000000..61f6695 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html @@ -0,0 +1,319 @@ + + + + + + +StorableIntrospector (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorableIntrospector

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    JDBCStorableIntrospector
    +
    +
    +
    +
    public class StorableIntrospector
+extends java.lang.Object
    +
    Supports examination of Storable types, returning all metadata + associated with it. As part of the examination, all annotations are gathered + up. All examined data is cached, so repeat examinations are fast, unless the + examination failed.
    +
    Author:
    +
    Brian S O'Neill, Fang Chen, Tobias Holgers, Archit Shivaprakash
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      StorableInfo<S>      		examine(java.lang.Class<S> type) +
      Examines the given class and returns a StorableInfo describing it.
      +
      static java.lang.Class<? extends Storable>inferType(java.lang.Class clazz) +
      Examines a class and determines what Storable type it implements.
      +
      static voidmain(java.lang.String[] args) +
      Test program which examines candidate Storable classes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StorableIntrospector

        +
        public StorableIntrospector()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
+                 throws java.lang.Exception
        +
        Test program which examines candidate Storable classes. If any fail, an + exception is thrown.
        +
        Parameters:
        args - names of classes to examine
        +
        Throws:
        +
        java.lang.Exception
        +
        • +
      + + + +
        +
      • +

        examine

        +
        public static <S extends Storable> StorableInfo<S> examine(java.lang.Class<S> type)
        +
        Examines the given class and returns a StorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is an invalid Storable type.
        +
        Parameters:
        type - Storable type to examine
        +
        Throws:
        +
        MalformedTypeException - if Storable type is invalid
        +
        java.lang.IllegalArgumentException - if type is null
        +
        • +
      + + + +
        +
      • +

        inferType

        +
        public static java.lang.Class<? extends Storable> inferType(java.lang.Class clazz)
        +
        Examines a class and determines what Storable type it implements. If it + cannot be unambiguously inferred, null is returned. A non-null return + value does not imply that the Storable type is valid, however. It must + be examined to check validity.
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableKey.html b/apidocs/com/amazon/carbonado/info/StorableKey.html new file mode 100644 index 0000000..5dc66cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableKey.html @@ -0,0 +1,245 @@ + + + + + + +StorableKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableKey<S extends Storable>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.Set<? extends OrderedProperty<S>>getProperties() +
      Returns all the properties of the key in a properly ordered, + unmodifiable set.
      +
      booleanisPrimary() +
      Returns true if this key is primary, false otherwise.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isPrimary

        +
        boolean isPrimary()
        +
        Returns true if this key is primary, false otherwise.
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        java.util.Set<? extends OrderedProperty<S>> getProperties()
        +
        Returns all the properties of the key in a properly ordered, + unmodifiable set.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorableProperty.html b/apidocs/com/amazon/carbonado/info/StorableProperty.html new file mode 100644 index 0000000..66cdb58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableProperty.html @@ -0,0 +1,929 @@ + + + + + + +StorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Interface StorableProperty<S extends Storable>

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Appender, java.io.Serializable
    +
    +
    +
    All Known Subinterfaces:
    +
    JDBCStorableProperty<S>
    +
    +
    +
    +
    public interface StorableProperty<S extends Storable>
+extends java.io.Serializable, Appender
    +
    Contains all the metadata describing a property of a specific Storable type.
    +
    Author:
    +
    Brian S O'Neill, Tobias Holgers, Archit Shivaprakash
    +
    See Also:
    StorableIntrospector
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorablePropertyAdaptergetAdapter() +
      Returns this property's adapter, or null if none.
      +
      java.lang.StringgetAlias(int index) +
      Returns a specific alias for this property.
      +
      intgetAliasCount() +
      Returns the count of aliases for this property.
      +
      java.lang.String[]getAliases() +
      Returns a new array with all the alias names in it.
      +
      java.lang.StringgetBeanName() +
      Returns the bean name of this property, which is derived from the read + and write method names.
      +
      StorablePropertyConstraintgetConstraint(int index) +
      Returns a specific constraint for this property.
      +
      intgetConstraintCount() +
      Returns the count of constraints for this property.
      +
      StorablePropertyConstraint[]getConstraints() +
      Returns a new array with all the constraints in it.
      +
      java.lang.Class<?>[]getCovariantTypes() +
      Returns additional types of this property, all of which are assignable + by the primary type.
      +
      ChainedProperty<S>[]getDerivedFromProperties() +
      Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.
      +
      ChainedProperty<?>[]getDerivedToProperties() +
      Returns a new array with all the properties which are derived from this + one.
      +
      java.lang.Class<S>getEnclosingType() +
      Returns the enclosing type of this property.
      +
      StorableProperty<?>getExternalJoinElement(int index) +
      Returns a specific property in the joined class that participates in the + join.
      +
      StorableProperty<?>[]getExternalJoinElements() +
      Returns a new array with all the external join elements in it.
      +
      StorableProperty<S>getInternalJoinElement(int index) +
      Returns a specific property in this property's class that participates + in the join.
      +
      StorableProperty<S>[]getInternalJoinElements() +
      Returns a new array with all the internal join elements in it.
      +
      java.lang.Class<? extends Storable>getJoinedType() +
      Returns the type of property this is joined to, or null if not joined.
      +
      intgetJoinElementCount() +
      Returns the count of properties that participate in this property's + join.
      +
      java.lang.StringgetName() +
      Returns the name of this property, which is the same as the bean name + unless it has been renamed.
      +
      intgetNumber() +
      Returns the zero-based numerical position of this property within its + enclosing type.
      +
      java.lang.reflect.MethodgetReadMethod() +
      Returns a no-arg method used to read the property value, or null if + reading is not allowed.
      +
      java.lang.StringgetReadMethodName() +
      Returns the name of the read method, even if no read method was actually + declared.
      +
      java.lang.StringgetSequenceName() +
      Returns the property's sequence name, or null if none.
      +
      java.lang.Class<?>getType() +
      Returns the primary type of this property.
      +
      java.lang.reflect.MethodgetWriteMethod() +
      Returns a one argument method used to write the property value, or null + if writing is not allowed.
      +
      java.lang.StringgetWriteMethodName() +
      Returns the name of the write method, even if no write method was + actually declared.
      +
      booleanisAlternateKeyMember() +
      Returns true if this property is a member of an alternate key.
      +
      booleanisAutomatic() +
      Returns true of this property is given an automatic value upon insert.
      +
      booleanisDerived() +
      Returns true if this property is derived.
      +
      booleanisIndependent() +
      Returns true if this property has been designated independent.
      +
      booleanisJoin() +
      Returns true if this property is joined in any way to another Storable.
      +
      booleanisNullable() +
      Returns true if this property can be null.
      +
      booleanisOneToOneJoin() +
      Returns true if this property is one-to-one joined to another Storable.
      +
      booleanisPartitionKeyMember() +
      Returns true if this property is a member of a partition key.
      +
      booleanisPrimaryKeyMember() +
      Returns true if this property is a member of a primary key.
      +
      booleanisQuery() +
      Returns true if this property is a query, which also implies that it is + a join property.
      +
      booleanisVersion() +
      Returns true if this property is the designated version number for the + Storable.
      +
      booleanshouldCopyDerived() +
      Returns true if this derived property should be included when copying a + storable.
      +
      java.lang.StringtoString() 
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this property, which is the same as the bean name + unless it has been renamed.
        +
        • +
      + + + +
        +
      • +

        getBeanName

        +
        java.lang.String getBeanName()
        +
        Returns the bean name of this property, which is derived from the read + and write method names.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getType

        +
        java.lang.Class<?> getType()
        +
        Returns the primary type of this property.
        +
        • +
      + + + +
        +
      • +

        getCovariantTypes

        +
        java.lang.Class<?>[] getCovariantTypes()
        +
        Returns additional types of this property, all of which are assignable + by the primary type.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        getNumber

        +
        int getNumber()
        +
        Returns the zero-based numerical position of this property within its + enclosing type.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getEnclosingType

        +
        java.lang.Class<S> getEnclosingType()
        +
        Returns the enclosing type of this property.
        +
        • +
      + + + +
        +
      • +

        getReadMethod

        +
        java.lang.reflect.Method getReadMethod()
        +
        Returns a no-arg method used to read the property value, or null if + reading is not allowed. The return type matches the type of this + property.
        +
        • +
      + + + +
        +
      • +

        getReadMethodName

        +
        java.lang.String getReadMethodName()
        +
        Returns the name of the read method, even if no read method was actually + declared. That is, this method always returns a method name, but + getReadMethod may still return null.
        +
        • +
      + + + +
        +
      • +

        getWriteMethod

        +
        java.lang.reflect.Method getWriteMethod()
        +
        Returns a one argument method used to write the property value, or null + if writing is not allowed. The first argument is the value to set, which + is the type of this property.
        +
        • +
      + + + +
        +
      • +

        getWriteMethodName

        +
        java.lang.String getWriteMethodName()
        +
        Returns the name of the write method, even if no write method was + actually declared. That is, this method always returns a method name, + but getWriteMethod may still return null.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        Returns true if this property can be null.
        +
        See Also:
        Nullable
        +
        • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        boolean isPrimaryKeyMember()
        +
        Returns true if this property is a member of a primary key.
        +
        See Also:
        PrimaryKey
        +
        • +
      + + + +
        +
      • +

        isAlternateKeyMember

        +
        boolean isAlternateKeyMember()
        +
        Returns true if this property is a member of an alternate key.
        +
        See Also:
        AlternateKeys
        +
        • +
      + + + +
        +
      • +

        isPartitionKeyMember

        +
        boolean isPartitionKeyMember()
        +
        Returns true if this property is a member of a partition key.
        +
        See Also:
        PartitionKey
        +
        • +
      + + + +
        +
      • +

        getAliasCount

        +
        int getAliasCount()
        +
        Returns the count of aliases for this property.
        +
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        getAlias

        +
        java.lang.String getAlias(int index)
+                          throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific alias for this property.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        getAliases

        +
        java.lang.String[] getAliases()
        +
        Returns a new array with all the alias names in it.
        +
        See Also:
        Alias
        +
        • +
      + + + +
        +
      • +

        isJoin

        +
        boolean isJoin()
        +
        Returns true if this property is joined in any way to another Storable.
        +
        See Also:
        Join
        +
        • +
      + + + +
        +
      • +

        isOneToOneJoin

        +
        boolean isOneToOneJoin()
        +
        Returns true if this property is one-to-one joined to another Storable.
        +
        Since:
        +
        1.2
        +
        See Also:
        Join
        +
        • +
      + + + +
        +
      • +

        getJoinedType

        +
        java.lang.Class<? extends Storable> getJoinedType()
        +
        Returns the type of property this is joined to, or null if not joined.
        +
        • +
      + + + +
        +
      • +

        getJoinElementCount

        +
        int getJoinElementCount()
        +
        Returns the count of properties that participate in this property's + join. If this property is not a join, then zero is returned.
        +
        • +
      + + + +
        +
      • +

        getInternalJoinElement

        +
        StorableProperty<S> getInternalJoinElement(int index)
+                                                            throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific property in this property's class that participates + in the join.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getInternalJoinElements

        +
        StorableProperty<S>[] getInternalJoinElements()
        +
        Returns a new array with all the internal join elements in it.
        +
        • +
      + + + +
        +
      • +

        getExternalJoinElement

        +
        StorableProperty<?> getExternalJoinElement(int index)
+                                           throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific property in the joined class that participates in the + join.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getExternalJoinElements

        +
        StorableProperty<?>[] getExternalJoinElements()
        +
        Returns a new array with all the external join elements in it.
        +
        • +
      + + + +
        +
      • +

        isQuery

        +
        boolean isQuery()
        +
        Returns true if this property is a query, which also implies that it is + a join property.
        +
        See Also:
        Query
        +
        • +
      + + + +
        +
      • +

        getConstraintCount

        +
        int getConstraintCount()
        +
        Returns the count of constraints for this property.
        +
        • +
      + + + +
        +
      • +

        getConstraint

        +
        StorablePropertyConstraint getConstraint(int index)
+                                         throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific constraint for this property.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getSequenceName

        +
        java.lang.String getSequenceName()
        +
        Returns the property's sequence name, or null if none.
        +
        See Also:
        Sequence
        +
        • +
      + + + +
        +
      • +

        isAutomatic

        +
        boolean isAutomatic()
        +
        Returns true of this property is given an automatic value upon insert.
        +
        Since:
        +
        1.2
        +
        See Also:
        Automatic
        +
        • +
      + + + +
        +
      • +

        isVersion

        +
        boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
        See Also:
        Version
        +
        • +
      + + + +
        +
      • +

        isIndependent

        +
        boolean isIndependent()
        +
        Returns true if this property has been designated independent.
        +
        See Also:
        Independent
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        boolean isDerived()
        +
        Returns true if this property is derived.
        +
        Since:
        +
        1.2
        +
        See Also:
        Derived
        +
        • +
      + + + +
        +
      • +

        getDerivedFromProperties

        +
        ChainedProperty<S>[] getDerivedFromProperties()
        +
        Returns a new array with all the derived-from properties, which is empty + if this is not a derived property. Otherwise, the set is the transitive + closure of all dependent properties. This set may include joins and + other derived properties.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getDerivedToProperties

        +
        ChainedProperty<?>[] getDerivedToProperties()
        +
        Returns a new array with all the properties which are derived from this + one. The set is the transitive closure of all derived properties which + depend on this one. + +

        Each property in the set is represented as a chain, where the prime + property is the actual dependent property, and the tail is the path to + reach this property's enclosing type. If a derived property resides in + the same enclosing type as this one, the chain count is zero.

        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        shouldCopyDerived

        +
        boolean shouldCopyDerived()
        +
        Returns true if this derived property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined.
        +
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        toString

        +
        java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

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

Class StorablePropertyAdapter

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyAdapter
+extends java.lang.Object
    +
    Information about an adapter annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StorablePropertyAdapter(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType) +
      Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodfindAdaptMethod(java.lang.Class from, + java.lang.Class to) +
      Returns an adapt method that supports the given conversion, or null if + none.
      +
      java.lang.reflect.Method[]findAdaptMethodsFrom(java.lang.Class from) +
      Returns all the adapt methods that convert from the given type.
      +
      java.lang.reflect.Method[]findAdaptMethodsTo(java.lang.Class to) +
      Returns all the adapt methods that convert to the given type.
      +
      java.lang.reflect.ConstructorgetAdapterConstructor() +
      Returns the constructor for the adapter class.
      +
      java.lang.ObjectgetAdapterInstance() +
      Returns an instance of the adapter, for which an adapt method is applied to.
      +
      java.lang.reflect.MethodgetAdaptMethod(int index) +
      Returns a specific adapt method.
      +
      intgetAdaptMethodCount() +
      Returns the count of all defined adapt methods.
      +
      java.lang.reflect.Method[]getAdaptMethods() +
      Returns a new array with all the adapt methods in it.
      +
      StorablePropertyAnnotationgetAnnotation() +
      Returns the annotation that applied this adapter, or null if none.
      +
      java.lang.Class[]getStorageTypePreferences() +
      Returns the adapter's storage type preferences.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StorablePropertyAdapter

        +
        public StorablePropertyAdapter(java.lang.String propertyName,
+                       java.lang.Class<?> propertyType,
+                       java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)
        +
        Construct a generic StorablePropertyAdapter instance not attached to a + storable definition. Call StorableProperty.getAdapter() to gain + access to adapter information on actual storable definitions.
        +
        Parameters:
        propertyName - name of property with adapter
        propertyType - declated type of adapted property
        adapterType - adapter type
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if adapterType is not an adapter + definition.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAnnotation

        +
        public StorablePropertyAnnotation getAnnotation()
        +
        Returns the annotation that applied this adapter, or null if none.
        +
        • +
      + + + +
        +
      • +

        getAdapterConstructor

        +
        public java.lang.reflect.Constructor getAdapterConstructor()
        +
        Returns the constructor for the adapter class. It has the signature + (Class type, String propertyName, Annotation), where + Annotation is the fully resolved annotation.
        +
        • +
      + + + +
        +
      • +

        getAdapterInstance

        +
        public java.lang.Object getAdapterInstance()
        +
        Returns an instance of the adapter, for which an adapt method is applied to.
        +
        • +
      + + + + + + + +
        +
      • +

        findAdaptMethod

        +
        public java.lang.reflect.Method findAdaptMethod(java.lang.Class from,
+                                       java.lang.Class to)
        +
        Returns an adapt method that supports the given conversion, or null if + none.
        +
        • +
      + + + +
        +
      • +

        findAdaptMethodsFrom

        +
        public java.lang.reflect.Method[] findAdaptMethodsFrom(java.lang.Class from)
        +
        Returns all the adapt methods that convert from the given type.
        +
        • +
      + + + +
        +
      • +

        findAdaptMethodsTo

        +
        public java.lang.reflect.Method[] findAdaptMethodsTo(java.lang.Class to)
        +
        Returns all the adapt methods that convert to the given type.
        +
        • +
      + + + +
        +
      • +

        getAdaptMethodCount

        +
        public int getAdaptMethodCount()
        +
        Returns the count of all defined adapt methods.
        +
        • +
      + + + +
        +
      • +

        getAdaptMethod

        +
        public java.lang.reflect.Method getAdaptMethod(int index)
+                                        throws java.lang.IndexOutOfBoundsException
        +
        Returns a specific adapt method.
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException
        +
        • +
      + + + +
        +
      • +

        getAdaptMethods

        +
        public java.lang.reflect.Method[] getAdaptMethods()
        +
        Returns a new array with all the adapt methods in it.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html new file mode 100644 index 0000000..331aad5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html @@ -0,0 +1,324 @@ + + + + + + +StorablePropertyAnnotation (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorablePropertyAnnotation

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyAnnotation
+extends java.lang.Object
    +
    Information about a custom annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      StorablePropertyAnnotation(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method) +
      Use this constructor if an annotation was actually defined.
      +
      StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method) +
      Use this constructor if an annotation was not defined, but instead is + being automatically applied.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodgetAnnotatedMethod() +
      Returns the method that has the annotation.
      +
      java.lang.annotation.AnnotationgetAnnotation() +
      Returns the actual annotation instance, which may be null if annotation + was automatically applied.
      +
      java.lang.Class<? extends java.lang.annotation.Annotation>getAnnotationType() +
      Returns the type of annotation that was applied to the property method.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StorablePropertyAnnotation

        +
        public StorablePropertyAnnotation(java.lang.annotation.Annotation annotation,
+                          java.lang.reflect.Method method)
        +
        Use this constructor if an annotation was actually defined.
        +
        Parameters:
        annotation - annotation on method
        method - method with annotation
        +
        • +
      + + + +
        +
      • +

        StorablePropertyAnnotation

        +
        public StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType,
+                          java.lang.reflect.Method method)
        +
        Use this constructor if an annotation was not defined, but instead is + being automatically applied.
        +
        Parameters:
        annotationType - annotation type on method
        method - method with annotation
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAnnotation

        +
        public java.lang.annotation.Annotation getAnnotation()
        +
        Returns the actual annotation instance, which may be null if annotation + was automatically applied.
        +
        • +
      + + + +
        +
      • +

        getAnnotationType

        +
        public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()
        +
        Returns the type of annotation that was applied to the property method.
        +
        • +
      + + + +
        +
      • +

        getAnnotatedMethod

        +
        public java.lang.reflect.Method getAnnotatedMethod()
        +
        Returns the method that has the annotation.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html new file mode 100644 index 0000000..5d682cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html @@ -0,0 +1,264 @@ + + + + + + +StorablePropertyConstraint (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.info
+

Class StorablePropertyConstraint

+
+
+ +
+
    +
  • +
    +
    +
    public class StorablePropertyConstraint
+extends java.lang.Object
    +
    Information about a constraint annotation applied to a property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorablePropertyAnnotationgetAnnotation() +
      Returns the annotation that applied this constraint.
      +
      java.lang.reflect.MethodgetConstrainMethod() +
      Returns the best matching property checking method in the validator.
      +
      java.lang.reflect.ConstructorgetConstraintConstructor() +
      Returns the constructor for the constraint class.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + + + + + +
        +
      • +

        getConstraintConstructor

        +
        public java.lang.reflect.Constructor getConstraintConstructor()
        +
        Returns the constructor for the constraint class. It has the signature + (Class type, String propertyName, Annotation), where + Annotation is the fully resolved annotation.
        +
        • +
      + + + +
        +
      • +

        getConstrainMethod

        +
        public java.lang.reflect.Method getConstrainMethod()
        +
        Returns the best matching property checking method in the validator.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html new file mode 100644 index 0000000..5b8c49d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html @@ -0,0 +1,385 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.ChainedProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.ChainedProperty

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/Direction.html b/apidocs/com/amazon/carbonado/info/class-use/Direction.html new file mode 100644 index 0000000..8e942f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/Direction.html @@ -0,0 +1,432 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.Direction (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.Direction

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

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

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

Uses of Class
com.amazon.carbonado.info.OrderedProperty

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html new file mode 100644 index 0000000..16c5fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html @@ -0,0 +1,544 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.StorableIndex (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.info.StorableIndex

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html new file mode 100644 index 0000000..dc7e131 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html @@ -0,0 +1,288 @@ + + + + + + +Uses of Interface com.amazon.carbonado.info.StorableInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableInfo

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

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

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

Uses of Class
com.amazon.carbonado.info.StorableIntrospector

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html new file mode 100644 index 0000000..377457c --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html @@ -0,0 +1,247 @@ + + + + + + +Uses of Interface com.amazon.carbonado.info.StorableKey (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableKey

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html new file mode 100644 index 0000000..f71a060 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html @@ -0,0 +1,479 @@ + + + + + + +Uses of Interface com.amazon.carbonado.info.StorableProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.info.StorableProperty

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

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

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

Uses of Class
com.amazon.carbonado.info.StorablePropertyAdapter

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

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

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

Uses of Class
com.amazon.carbonado.info.StorablePropertyAnnotation

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

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

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

Uses of Class
com.amazon.carbonado.info.StorablePropertyConstraint

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

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

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

com.amazon.carbonado.info

+
+

Interfaces

+ +

Classes

+ +

Enums

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

Package com.amazon.carbonado.info

+
+
Introspection support for Storables.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.info Description

+
Introspection support for Storables.
+
See Also:
StorableIntrospector
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.info

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.info

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

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

+ + -- cgit v1.2.3