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 --- .../capability/StorableInfoCapability.html | 265 +++++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html (limited to 'apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html') diff --git a/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html new file mode 100644 index 0000000..2e7263e --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html @@ -0,0 +1,265 @@ + + + + + + +StorableInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface StorableInfoCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface StorableInfoCapability
+extends Capability
    +
    Capability that returns information about known storable types in a + repository.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getUserStorableTypeNames() +
      Returns an array of storable type class names for user-level storables + known to the repository.
      +
      booleanisPropertySupported(java.lang.Class<Storable> type, + java.lang.String name) +
      Returns true if the given property exists and is supported.
      +
      booleanisSupported(java.lang.Class<Storable> type) +
      Returns true if the given storable type is supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUserStorableTypeNames

        +
        java.lang.String[] getUserStorableTypeNames()
+                                            throws RepositoryException
        +
        Returns an array of storable type class names for user-level storables + known to the repository. The array might be empty, but it is never + null. The array is a copy, and so it may be safely modified. +

        + This method returns class names instead of class instances because the + repository may not be able to load the classes.

        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported(java.lang.Class<Storable> type)
        +
        Returns true if the given storable type is supported.
        +
        Parameters:
        type - storable type to examine
        +
        • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.Class<Storable> type,
+                          java.lang.String name)
        +
        Returns true if the given property exists and is supported.
        +
        Parameters:
        type - storable type to examine
        name - name of property to examine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3