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 --- .../SyntheticStorableReferenceAccess.html | 346 +++++++++++++++++++++ 1 file changed, 346 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html (limited to 'apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html') diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..9b834f5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html @@ -0,0 +1,346 @@ + + + + + + +SyntheticStorableReferenceAccess (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.synthetic
+

Class SyntheticStorableReferenceAccess<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class SyntheticStorableReferenceAccess<S extends Storable>
+extends java.lang.Object
    +
    Provides access to the generated storable reference class and utility + methods.
    +
    Since:
    +
    1.2.1
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    SyntheticStorableReferenceBuilder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidcopyFromMaster(Storable reference, + S master) +
      Sets all the properties of the given reference, using the applicable + properties of the given master.
      +
      voidcopyToMasterPrimaryKey(Storable reference, + S master) +
      Sets all the primary key properties of the given master, using the + applicable properties of the given reference.
      +
      java.util.Comparator<? extends Storable>getComparator() +
      Returns a comparator for ordering storable reference instances.
      +
      java.lang.Class<S>getMasterClass() +
      Returns the storable class which is referenced.
      +
      java.lang.Class<? extends Storable>getReferenceClass() +
      Returns the generated storable reference class.
      +
      booleanisConsistent(Storable reference, + S master) +
      Returns true if the properties of the given reference match those + contained in the master, excluding any version property.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        getMasterClass

        +
        public java.lang.Class<S> getMasterClass()
        +
        Returns the storable class which is referenced.
        +
        • +
      + + + +
        +
      • +

        getReferenceClass

        +
        public java.lang.Class<? extends Storable> getReferenceClass()
        +
        Returns the generated storable reference class.
        +
        • +
      + + + +
        +
      • +

        getComparator

        +
        public java.util.Comparator<? extends Storable> getComparator()
        +
        Returns a comparator for ordering storable reference instances. This + order matches the primary key of the master storable.
        +
        • +
      + + + + + +
        +
      • +

        copyToMasterPrimaryKey

        +
        public void copyToMasterPrimaryKey(Storable reference,
+                          S master)
+                            throws FetchException
        +
        Sets all the primary key properties of the given master, using the + applicable properties of the given reference.
        +
        Parameters:
        reference - source of property values
        master - master whose primary key properties will be set
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        copyFromMaster

        +
        public void copyFromMaster(Storable reference,
+                  S master)
+                    throws FetchException
        +
        Sets all the properties of the given reference, using the applicable + properties of the given master.
        +
        Parameters:
        reference - reference whose properties will be set
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        isConsistent

        +
        public boolean isConsistent(Storable reference,
+                   S master)
+                     throws FetchException
        +
        Returns true if the properties of the given reference match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.
        +
        Parameters:
        reference - reference whose properties will be tested
        master - source of property values
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3