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/info/StorableIntrospector.html | 319 +++++++++++++++++++++ 1 file changed, 319 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/info/StorableIntrospector.html (limited to 'apidocs/com/amazon/carbonado/info/StorableIntrospector.html') 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.

+ + -- cgit v1.2.3