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

Class SyntheticStorableBuilder

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    SyntheticBuilder
    +
    +
    +
    +
    public class SyntheticStorableBuilder
+extends java.lang.Object
+implements SyntheticBuilder
    +
    Allows the definition of very simple synthetic storables. Only a primary key + index can be defined; at least one property must be a primary key property. A + property can be nullable and can be specified as the version property. + + This class acts both as builder factory and as builder.
    +
    Author:
    +
    Don Schneider, Brian S O'Neill, David Rosenstrauch
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SyntheticStorableBuilder

        +
        public SyntheticStorableBuilder(java.lang.String name,
+                        java.lang.ClassLoader loader)
        +
        Parameters:
        name - base name for the generated class. This is usually a fully qualified + name, a la "com.amazon.carbonado.storables.happy.synthetic.storable"
        loader - ClassLoader to use for the generated class
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getStorableClass

        +
        public java.lang.Class<? extends Storable> getStorableClass()
        +
        +
        Specified by:
        +
        getStorableClass in interface SyntheticBuilder
        +
        Returns:
        the generated class file for this builder. Note that + proper operation requires that SyntheticBuilder.prepare() already have been called + prior to calling this method.
        +
        • +
      + + + + + + + +
        +
      • +

        addProperty

        +
        public SyntheticProperty addProperty(java.lang.String name,
+                            java.lang.Class type)
        +
        Description copied from interface: SyntheticBuilder
        +
        Add a property to the set managed by this builder.
        +
        +
        Specified by:
        +
        addProperty in interface SyntheticBuilder
        +
        Parameters:
        name - of the property
        type - of the property
        +
        Returns:
        property specification which can be further refined
        +
        • +
      + + + + + + + +
        +
      • +

        hasProperty

        +
        public boolean hasProperty(java.lang.String name)
        +
        Description copied from interface: SyntheticBuilder
        +
        Check to see if a particular property has already been added to the list of + properties to generate
        +
        +
        Specified by:
        +
        hasProperty in interface SyntheticBuilder
        +
        +
        • +
      + + + +
        +
      • +

        addPrimaryKey

        +
        public SyntheticKey addPrimaryKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add a primary key to be built.
        +
        +
        Specified by:
        +
        addPrimaryKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the primary key
        +
        • +
      + + + +
        +
      • +

        addAlternateKey

        +
        public SyntheticKey addAlternateKey()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an alternate key to be built.
        +
        +
        Specified by:
        +
        addAlternateKey in interface SyntheticBuilder
        +
        Returns:
        key to be decorated with property values defining the alternate key
        +
        • +
      + + + +
        +
      • +

        addIndex

        +
        public SyntheticIndex addIndex()
        +
        Description copied from interface: SyntheticBuilder
        +
        Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.
        +
        +
        Specified by:
        +
        addIndex in interface SyntheticBuilder
        +
        Returns:
        index to be decorated with property values defining the index
        +
        • +
      + + + +
        +
      • +

        isVersioned

        +
        public boolean isVersioned()
        +
        Description copied from interface: SyntheticBuilder
        +
        Returns true if a property with the version attribute has been addded
        +
        +
        Specified by:
        +
        isVersioned in interface SyntheticBuilder
        +
        +
        • +
      + + + + + + + +
        +
      • +

        setClassNameProvider

        +
        public void setClassNameProvider(SyntheticBuilder.ClassNameProvider classNameProvider)
        +
        Parameters:
        classNameProvider - The classNameProvider to set.
        +
        • +
      + + + +
        +
      • +

        setEvolvable

        +
        public void setEvolvable(boolean evolvable)
        +
        By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded. It usually does not make + sense to support storable evolution new versions can be (and often will + be) given different names. + +

        Pass in true to change from the default behavior, and not implement + Unevolvable. When doing so, a ClassNameProvider should also be provided + to ensure consistent naming which does not include property names.

        +
        • +
      + + + +
        +
      • +

        definePropertyBeanMethods

        +
        protected boolean definePropertyBeanMethods(org.cojen.classfile.ClassFile cf,
+                                SyntheticProperty property)
        +
        Add the get & set methods for this property
        +
        Returns:
        true if version property was added
        +
        • +
      + + + +
        +
      • +

        getName

        +
        protected java.lang.String getName()
        +
        Frequently used by the SyntheticBuilder.ClassNameProvider as a + basis for the generated classname
        +
        Returns:
        builder name
        +
        • +
      + + + + + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3