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/adapter/AdapterDefinition.html | 317 ++++++ .../carbonado/adapter/DateTimeAdapter.Adapter.html | 1052 ++++++++++++++++++++ .../amazon/carbonado/adapter/DateTimeAdapter.html | 231 +++++ .../adapter/PrimitiveArrayAdapter.Adapter.html | 455 +++++++++ .../carbonado/adapter/PrimitiveArrayAdapter.html | 161 +++ .../carbonado/adapter/TextAdapter.Adapter.html | 370 +++++++ .../com/amazon/carbonado/adapter/TextAdapter.html | 253 +++++ .../adapter/TrueFalseAdapter.Adapter.html | 470 +++++++++ .../amazon/carbonado/adapter/TrueFalseAdapter.html | 230 +++++ .../carbonado/adapter/YesNoAdapter.Adapter.html | 470 +++++++++ .../com/amazon/carbonado/adapter/YesNoAdapter.html | 230 +++++ .../adapter/class-use/AdapterDefinition.html | 185 ++++ .../adapter/class-use/DateTimeAdapter.Adapter.html | 117 +++ .../adapter/class-use/DateTimeAdapter.html | 159 +++ .../class-use/PrimitiveArrayAdapter.Adapter.html | 117 +++ .../adapter/class-use/PrimitiveArrayAdapter.html | 159 +++ .../adapter/class-use/TextAdapter.Adapter.html | 117 +++ .../carbonado/adapter/class-use/TextAdapter.html | 159 +++ .../class-use/TrueFalseAdapter.Adapter.html | 117 +++ .../adapter/class-use/TrueFalseAdapter.html | 159 +++ .../adapter/class-use/YesNoAdapter.Adapter.html | 117 +++ .../carbonado/adapter/class-use/YesNoAdapter.html | 159 +++ .../amazon/carbonado/adapter/package-frame.html | 33 + .../amazon/carbonado/adapter/package-summary.html | 219 ++++ .../com/amazon/carbonado/adapter/package-tree.html | 143 +++ .../com/amazon/carbonado/adapter/package-use.html | 180 ++++ 26 files changed, 6379 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html create mode 100644 apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TextAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/adapter/package-use.html (limited to 'apidocs/com/amazon/carbonado/adapter') diff --git a/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html new file mode 100644 index 0000000..6b8dd93 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html @@ -0,0 +1,317 @@ + + + + + + +AdapterDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type AdapterDefinition

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=ANNOTATION_TYPE)
+public @interface AdapterDefinition
    +
    Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer. Repositories must always + attempt to match property types to the best matching native type, but they + may have to rely on an adapter to make a conversion. + +

    The annotation is just a pointer to an adapter implementation class. If + the adapter class is not explicitly provided, it defaults to a static inner + class named "Adapter" in the annotation itself. + +

    The adapter class must have a public constructor that accepts the + annotation that has the AdapterDefinition annotation. It must also define + several adapt methods which convert property values. An adapt method needs + to start with "adapt", accept one parameter and return something. +

    + Example true/false adapter for booleans: + 

    + @Documented
+ @Retention(RetentionPolicy.RUNTIME)
+ @Target(ElementType.METHOD)
+ @AdapterDefinition
+ public @interface TrueFalseAdapter {
+
+     public static class Adapter {
+         private final String propertyName;
+
+         // Constructor may throw a MalformedTypeException if
+         // params supplied by annotation are illegal.
+
+         /**
+          * @param type optional type of object that contains the adapted property
+          * @param propertyName name of property with adapter
+          * @param annotation specific annotation that binds to this adapter class
+          */
+         public Adapter(Class type, String propertyName, TrueFalseAdapter annotation) {
+             this.propertyName = propertyName;
+         }
+
+         // Define at least two adapt methods for each supported property type.
+
+         /**
+          * @param propertyValue value to convert from
+          */
+         public char adaptToChar(boolean propertyValue) {
+             return value ? 'T' : 'F';
+         }
+
+         /**
+          * @param propertyValue value to convert from
+          */
+         public boolean adaptToBoolean(char propertyValue) {
+             if (propertyValue == 'T') { return true; };
+             if (propertyValue == 'F') { return false; };
+             throw new IllegalArgumentException
+                 ("Cannot adapt '" + value + "' into boolean for property \"" +
+                   propertyName + '"');
+         }
+     }
+ }
+
    + + The newly defined adapter can be applied to property accessors. + + 
    + public interface UserInfo extends Storable {
+     @TrueFalseAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.Classimplementation +
      Specify class which will perform property adaptation.
      +
      java.lang.Class[]storageTypePreferences +
      Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        implementation

        +
        public abstract java.lang.Class implementation
        +
        Specify class which will perform property adaptation. Must have a public + constructor with the signature + (Class type, String propertyName, Annotation), + where Annotation refers to the annotation with the + adapter definition. + +

        The implementation class need not be explicitly specified. By + default, the adapter class must be a static inner class of the + annotation, named "Adapter".

        +
        +
        Default:
        +
        void.class
        +
        +
        • +
      + + + +
        +
      • +

        storageTypePreferences

        +
        public abstract java.lang.Class[] storageTypePreferences
        +
        Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred. A type + in the set must be supported by the adapt methods to be considered. + +

        If the repository is independent, it needs help on deciding exactly + how to store the adapted property. A dependent repository will not have + as much flexibility in selecting an appropriate type, but it may still + need a hint.

        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html new file mode 100644 index 0000000..643f670 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html @@ -0,0 +1,1052 @@ + + + + + + +DateTimeAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class DateTimeAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    DateTimeAdapter
    +
    +
    +
    +
    public static class DateTimeAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for DateTimeAdapter.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DateTimeAdapter.Adapter

        +
        public DateTimeAdapter.Adapter(java.lang.Class<?> type,
+                       java.lang.String propertyName,
+                       DateTimeAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        DateTimeAdapter.Adapter

        +
        public DateTimeAdapter.Adapter(java.lang.Class<?> type,
+                       java.lang.String propertyName,
+                       org.joda.time.DateTimeZone zone)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        zone - time zone to apply, or null to use default
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDateTime

        +
        public org.joda.time.DateTime adaptToDateTime(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDateMidnight

        +
        public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDateTime

        +
        public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToLocalDate

        +
        public org.joda.time.LocalDate adaptToLocalDate(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.ReadableInstant instant)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDateTime dateTime)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDate date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.lang.Long instant)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.lang.String isoDateString)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Time time)
        +
        • +
      + + + +
        +
      • +

        adaptToDate

        +
        public java.util.Date adaptToDate(java.sql.Timestamp timestamp)
        +
        • +
      + + + +
        +
      • +

        adaptToLong

        +
        public long adaptToLong(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToLongObj

        +
        public java.lang.Long adaptToLongObj(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlDate

        +
        public java.sql.Date adaptToSqlDate(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTime

        +
        public java.sql.Time adaptToSqlTime(java.util.Date date)
        +
        • +
      + + + +
        +
      • +

        adaptToSqlTimestamp

        +
        public java.sql.Timestamp adaptToSqlTimestamp(java.util.Date date)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + 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.

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html new file mode 100644 index 0000000..ad825fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html @@ -0,0 +1,455 @@ + + + + + + +PrimitiveArrayAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class PrimitiveArrayAdapter.Adapter

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrimitiveArrayAdapter.Adapter

        +
        public PrimitiveArrayAdapter.Adapter(java.lang.Class<?> type,
+                             java.lang.String propertyName,
+                             PrimitiveArrayAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        PrimitiveArrayAdapter.Adapter

        +
        public PrimitiveArrayAdapter.Adapter()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(short[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(char[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(int[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(long[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(float[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(double[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToByteArray

        +
        public byte[] adaptToByteArray(boolean[] src)
        +
        Packs the given boolean array into a byte array, big-endian fashion.
        +
        • +
      + + + +
        +
      • +

        adaptToShortArray

        +
        public short[] adaptToShortArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToCharArray

        +
        public char[] adaptToCharArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToIntArray

        +
        public int[] adaptToIntArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToLongArray

        +
        public long[] adaptToLongArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToFloatArray

        +
        public float[] adaptToFloatArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToDoubleArray

        +
        public double[] adaptToDoubleArray(byte[] src)
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanArray

        +
        public boolean[] adaptToBooleanArray(byte[] src)
        +
        Unpacks a boolean array from a byte array, big-endian fashion.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..04a3a5d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html @@ -0,0 +1,161 @@ + + + + + + +PrimitiveArrayAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type PrimitiveArrayAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences=byte[].class)
+public @interface PrimitiveArrayAdapter
    +
    Allows arrays of primitive types to be encoded (big-endian) as byte arrays.
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html new file mode 100644 index 0000000..7d1ef87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html @@ -0,0 +1,370 @@ + + + + + + +TextAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class TextAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TextAdapter
    +
    +
    +
    +
    public static class TextAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for TextAdapter.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset, + java.nio.charset.Charset[] altCharsets) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String charset) 
      TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + TextAdapter ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      BlobadaptToBlob(java.lang.String text) 
      ClobadaptToClob(java.lang.String text) 
      java.lang.StringadaptToString(Blob blob) 
      java.lang.StringadaptToString(Clob clob) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   TextAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.lang.String charset)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.nio.charset.Charset charset)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        +
        • +
      + + + +
        +
      • +

        TextAdapter.Adapter

        +
        public TextAdapter.Adapter(java.lang.Class<?> type,
+                   java.lang.String propertyName,
+                   java.nio.charset.Charset charset,
+                   java.nio.charset.Charset[] altCharsets)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        charset - character set to use, or null to use default of UTF-8.
        altCharsets - alternate character sets to use, if text cannot be + decoded with primary charset
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html new file mode 100644 index 0000000..71853c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html @@ -0,0 +1,253 @@ + + + + + + +TextAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type TextAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={java.lang.String.class,Clob.class,Blob.class})
+public @interface TextAdapter
    +
    Converts database Blobs and Clobs to Strings. This is suitable for text + values which are expected to fit entirely in memory. The storage layer will + attempt to store the text as a regular string, but will use a blob type if + required to. + +

    Example:

    + public interface UserInfo extends Storable {
+     @TextAdapter(charset="UTF-8")
+     String getWelcomeMessage();
+     void setWelcomeMessage(String message);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Clob, +Blob
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.String[]altCharsets +
      Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
      +
      java.lang.Stringcharset +
      Optionally specify a character set, which is used if the storage type is + a Blob.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        charset

        +
        public abstract java.lang.String charset
        +
        Optionally specify a character set, which is used if the storage type is + a Blob.
        +
        +
        Default:
        +
        "UTF-8"
        +
        +
        • +
      + + + +
        +
      • +

        altCharsets

        +
        public abstract java.lang.String[] altCharsets
        +
        Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html new file mode 100644 index 0000000..0d6ea7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html @@ -0,0 +1,470 @@ + + + + + + +TrueFalseAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class TrueFalseAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TrueFalseAdapter
    +
    +
    +
    +
    public static class TrueFalseAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for TrueFalseAdapter.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadaptToBoolean(char value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      booleanadaptToBoolean(java.lang.Character value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      booleanadaptToBoolean(java.lang.String value) +
      Adapts a character "T" or "F" to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(char value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.Character value) +
      Adapts a character 'T' or 'F' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.String value) +
      Adapts a character "T" or "F" to true or false.
      +
      charadaptToChar(boolean value) +
      Adapts a boolean true or false into 'T' or 'F'.
      +
      charadaptToChar(java.lang.Boolean value) +
      Adapts a boolean true into 'T', and anything else to 'F'.
      +
      java.lang.CharacteradaptToCharacter(boolean value) +
      Adapts a boolean true or false into 'T' or 'F'.
      +
      java.lang.CharacteradaptToCharacter(java.lang.Boolean value) +
      Adapts a boolean true into 'T', and anything else to 'F'.
      +
      java.lang.StringadaptToString(boolean value) +
      Adapts a boolean true or false into "T" or "F".
      +
      java.lang.StringadaptToString(java.lang.Boolean value) +
      Adapts a boolean true into "T", and anything else to "F".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TrueFalseAdapter.Adapter

        +
        public TrueFalseAdapter.Adapter(java.lang.Class<?> type,
+                        java.lang.String propertyName,
+                        TrueFalseAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        TrueFalseAdapter.Adapter

        +
        public TrueFalseAdapter.Adapter(java.lang.Class<?> type,
+                        java.lang.String propertyName,
+                        boolean lenient)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        lenient - lenient when true
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(boolean value)
        +
        Adapts a boolean true or false into 'T' or 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(java.lang.Boolean value)
        +
        Adapts a boolean true into 'T', and anything else to 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(boolean value)
        +
        Adapts a boolean true or false into 'T' or 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(java.lang.Boolean value)
        +
        Adapts a boolean true into 'T', and anything else to 'F'.
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(boolean value)
        +
        Adapts a boolean true or false into "T" or "F".
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.lang.Boolean value)
        +
        Adapts a boolean true into "T", and anything else to "F".
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(char value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.Character value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.String value)
        +
        Adapts a character "T" or "F" to true or false. If leneint, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(char value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)
        +
        Adapts a character 'T' or 'F' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.String value)
        +
        Adapts a character "T" or "F" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html new file mode 100644 index 0000000..d2f770e --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html @@ -0,0 +1,230 @@ + + + + + + +TrueFalseAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type TrueFalseAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={char.class,java.lang.Character.class,java.lang.String.class})
+public @interface TrueFalseAdapter
    +
    Adapter that converts 'T' or 'F' to and from a boolean value. + +

    Example:

    + public interface UserInfo extends Storable {
+     @TrueFalseAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    YesNoAdapter, +AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      booleanlenient +
      Specify that this adapter should be lenient when converting characters + into booleans.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        lenient

        +
        public abstract boolean lenient
        +
        Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'T', 't', 'Y', 'y', '1'. For false: 'F', 'f', 'N', 'n', '0'. When + lenient is false, only 'T' and 'F' are accepted.
        +
        +
        Default:
        +
        true
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html new file mode 100644 index 0000000..1481938 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html @@ -0,0 +1,470 @@ + + + + + + +YesNoAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Class YesNoAdapter.Adapter

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    YesNoAdapter
    +
    +
    +
    +
    public static class YesNoAdapter.Adapter
+extends java.lang.Object
    +
    Adapter implementation for YesNoAdapter.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient) 
      YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + YesNoAdapter ann) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanadaptToBoolean(char value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      booleanadaptToBoolean(java.lang.Character value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      booleanadaptToBoolean(java.lang.String value) +
      Adapts a character "Y" or "N" to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(char value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.Character value) +
      Adapts a character 'Y' or 'N' to true or false.
      +
      java.lang.BooleanadaptToBooleanObj(java.lang.String value) +
      Adapts a character "Y" or "N" to true or false.
      +
      charadaptToChar(boolean value) +
      Adapts a boolean true or false into 'Y' or 'N'.
      +
      charadaptToChar(java.lang.Boolean value) +
      Adapts a boolean true into 'Y', and anything else to 'N'.
      +
      java.lang.CharacteradaptToCharacter(boolean value) +
      Adapts a boolean true or false into 'Y' or 'N'.
      +
      java.lang.CharacteradaptToCharacter(java.lang.Boolean value) +
      Adapts a boolean true into 'Y', and anything else to 'N'.
      +
      java.lang.StringadaptToString(boolean value) +
      Adapts a boolean true or false into "Y" or "N".
      +
      java.lang.StringadaptToString(java.lang.Boolean value) +
      Adapts a boolean true into "Y", and anything else to "N".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        YesNoAdapter.Adapter

        +
        public YesNoAdapter.Adapter(java.lang.Class<?> type,
+                    java.lang.String propertyName,
+                    YesNoAdapter ann)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with adapter
        ann - specific annotation that binds to this adapter class
        +
        • +
      + + + +
        +
      • +

        YesNoAdapter.Adapter

        +
        public YesNoAdapter.Adapter(java.lang.Class<?> type,
+                    java.lang.String propertyName,
+                    boolean lenient)
        +
        Parameters:
        type - type of object that contains the adapted property
        propertyName - name of property with
        lenient - lenient when true
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(boolean value)
        +
        Adapts a boolean true or false into 'Y' or 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToChar

        +
        public char adaptToChar(java.lang.Boolean value)
        +
        Adapts a boolean true into 'Y', and anything else to 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(boolean value)
        +
        Adapts a boolean true or false into 'Y' or 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToCharacter

        +
        public java.lang.Character adaptToCharacter(java.lang.Boolean value)
        +
        Adapts a boolean true into 'Y', and anything else to 'N'.
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(boolean value)
        +
        Adapts a boolean true or false into "Y" or "N".
        +
        • +
      + + + +
        +
      • +

        adaptToString

        +
        public java.lang.String adaptToString(java.lang.Boolean value)
        +
        Adapts a boolean true into "Y", and anything else to "N".
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(char value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.Character value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBoolean

        +
        public boolean adaptToBoolean(java.lang.String value)
        +
        Adapts a character "Y" or "N" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(char value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)
        +
        Adapts a character 'Y' or 'N' to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      + + + +
        +
      • +

        adaptToBooleanObj

        +
        public java.lang.Boolean adaptToBooleanObj(java.lang.String value)
        +
        Adapts a character "Y" or "N" to true or false. If lenient, other characters are accepted as + well.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html new file mode 100644 index 0000000..5022fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html @@ -0,0 +1,230 @@ + + + + + + +YesNoAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.adapter
+

Annotation Type YesNoAdapter

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+@AdapterDefinition(storageTypePreferences={char.class,java.lang.Character.class,java.lang.String.class})
+public @interface YesNoAdapter
    +
    Adapter that converts 'Y' or 'N' to and from a boolean value. + +

    Example:

    + public interface UserInfo extends Storable {
+     @YesNoAdapter
+     boolean isAdministrator();
+     void setAdministrator(boolean admin);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    TrueFalseAdapter, +AdapterDefinition
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      booleanlenient +
      Specify that this adapter should be lenient when converting characters + into booleans.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        lenient

        +
        public abstract boolean lenient
        +
        Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'Y', 'y', 'T', 't', '1'. For false: 'N', 'n', 'F', 'f', '0'. When + lenient is false, only 'Y' and 'N' are accepted.
        +
        +
        Default:
        +
        true
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html b/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html new file mode 100644 index 0000000..0d7254c --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html @@ -0,0 +1,185 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.AdapterDefinition (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.AdapterDefinition

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html new file mode 100644 index 0000000..81ed303 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.DateTimeAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html new file mode 100644 index 0000000..61ceae0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.DateTimeAdapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html new file mode 100644 index 0000000..a294541 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..4f87a6c --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.PrimitiveArrayAdapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html new file mode 100644 index 0000000..1358cde --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.TextAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.TextAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.TextAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html new file mode 100644 index 0000000..498167d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.TextAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.TextAdapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html new file mode 100644 index 0000000..47a502b --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html new file mode 100644 index 0000000..eb1ae0e --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.TrueFalseAdapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html new file mode 100644 index 0000000..f35572f --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.YesNoAdapter.Adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.YesNoAdapter.Adapter

+
+
No usage of com.amazon.carbonado.adapter.YesNoAdapter.Adapter
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html new file mode 100644 index 0000000..bac79d1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html @@ -0,0 +1,159 @@ + + + + + + +Uses of Class com.amazon.carbonado.adapter.YesNoAdapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.adapter.YesNoAdapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-frame.html b/apidocs/com/amazon/carbonado/adapter/package-frame.html new file mode 100644 index 0000000..2bb220a --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-frame.html @@ -0,0 +1,33 @@ + + + + + + +com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.adapter

+
+

Classes

+ +

Annotation Types

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-summary.html b/apidocs/com/amazon/carbonado/adapter/package-summary.html new file mode 100644 index 0000000..1277e21 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-summary.html @@ -0,0 +1,219 @@ + + + + + + +com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.adapter

+
+
Contains annotations and implementations for supporting property adapters.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.adapter Description

+
Contains annotations and implementations for supporting property adapters.
+
See Also:
AdapterDefinition
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-tree.html b/apidocs/com/amazon/carbonado/adapter/package-tree.html new file mode 100644 index 0000000..ae1b8a9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +com.amazon.carbonado.adapter Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.adapter

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Annotation Type Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/adapter/package-use.html b/apidocs/com/amazon/carbonado/adapter/package-use.html new file mode 100644 index 0000000..5cbc4db --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-use.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Package com.amazon.carbonado.adapter (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.adapter

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3