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

Annotation Type DateTimeAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={long.class,java.lang.Long.class,java.lang.String.class})
+public @interface DateTimeAdapter
    +
    Converts Joda-Time datetime objects to and from other forms. This adapter is + applied automatically for all storable properties of type DateTime, + DateMidnight, LocalDateTime, LocalDate and also + Date. Explicit use allows a different time zone to be + used, but this only works for Joda-Time objects. + +

    Example:

    + public interface UserInfo extends Storable {
+     @DateTimeAdapter(timeZone="UTC")
+     DateTime getModifyDateTime();
+     void setModifyDateTime(DateTime dt);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill, Justin Rudd
    +
    See Also:
    AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.StringtimeZone +
      Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        timeZone

        +
        public abstract java.lang.String timeZone
        +
        Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + -- cgit v1.2.3