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 --- apidocs/com/amazon/carbonado/Indexes.html | 239 ++++++++++++++++++++++++++++++ 1 file changed, 239 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/Indexes.html (limited to 'apidocs/com/amazon/carbonado/Indexes.html') diff --git a/apidocs/com/amazon/carbonado/Indexes.html b/apidocs/com/amazon/carbonado/Indexes.html new file mode 100644 index 0000000..c70fbda --- /dev/null +++ b/apidocs/com/amazon/carbonado/Indexes.html @@ -0,0 +1,239 @@ + + + + + + +Indexes (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Indexes

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Indexes
    +
    The Indexes annotation is applied to a Storable for specifying all + the indexes it should have. + +

    Example:

    + @Indexes({
+     @Index("name"),
+     @Index("-lastModified"),
+     @Index({"length", "lastModified"})
+ })
+ @PrimaryKey("ID")
+ public interface FileInfo extends Storable<FileInfo> {
+     long getID();
+     void setID(long id);
+
+     String getName();
+     void setName(String name);
+
+     long getLength();
+     void setLength(long length);
+
+     long getLastModified();
+     void getLastModified(long datetime);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Index
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      Index[]value +
      A list of Index annotations.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        public abstract Index[] value
        +
        A list of Index annotations.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3