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

+ + -- cgit v1.2.3