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/Nullable.html | 177 +++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/Nullable.html (limited to 'apidocs/com/amazon/carbonado/Nullable.html') diff --git a/apidocs/com/amazon/carbonado/Nullable.html b/apidocs/com/amazon/carbonado/Nullable.html new file mode 100644 index 0000000..e79f407 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Nullable.html @@ -0,0 +1,177 @@ + + + + + + +Nullable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ + +
+
com.amazon.carbonado
+

Annotation Type Nullable

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=METHOD)
+public @interface Nullable
    +
    Identifies that a Storable property can have a null value. By + default, all Storable properties are required to have a non-null value. It + is illegal to declare a property as nullable whose type is a primitive + non-object. + +

    Example:

    + public interface UserInfo extends Storable<UserInfo> {
+     @Nullable
+     String getName();
+     void setName(String name);
+
+     ...
+ }
+
    + +

    If the repository does not allow a property to be declared as nullable + because the underlying schema differs, it can be also annotated as Independent. This makes it easier for a common set of Storables to interact + with schemas which are slightly different. Attempting to persist null into a + property for which null is not allowed will likely result in a constraint + exception.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3