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

+ + -- cgit v1.2.3