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

Annotation Type Authoritative

+
+
+
+
    +
  • +
    +
    +
    @Documented
+@Retention(value=RUNTIME)
+@Target(value=TYPE)
+public @interface Authoritative
    +
    Indicates that all accesses to this Storable must come from an + authoritative source. When reading or writing the Storable, the Repository must guarantee that it is operating on the latest, correct + version of the Storable. + +

    Repositories that cache potentially stale Storables are required to + ensure the cache is always up-to-date or bypass the cache + altogether. Replicating repositories which may have a propagation delay must + always access the master repository. + +

    Repositories which provide eventual consistency but don't rely on a + master must throw UnsupportedTypeException, as there is no + authoritative source. + +

    Example:

    + @Authoritative
+ @PrimaryKey("sequenceName")
+ public interface SequenceValue extends Storable<SequenceValue> {
+     String getSequenceName();
+     void setSequenceName(String name);
+
+     long getNextValue();
+     void setNextValue(long value);
+
+     ...
+ }
+
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Required | 
    • +
  • Optional
    • +
+
    +
  • Detail: 
    • +
  • Element
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3