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/layout/Layout.html | 580 +++++++++++++++++++++ .../amazon/carbonado/layout/LayoutCapability.html | 253 +++++++++ .../com/amazon/carbonado/layout/LayoutFactory.html | 421 +++++++++++++++ .../com/amazon/carbonado/layout/LayoutOptions.html | 307 +++++++++++ .../amazon/carbonado/layout/LayoutProperty.html | 410 +++++++++++++++ .../com/amazon/carbonado/layout/LayoutSync.html | 268 ++++++++++ .../com/amazon/carbonado/layout/StoredLayout.html | 456 ++++++++++++++++ .../carbonado/layout/StoredLayoutEquivalence.html | 354 +++++++++++++ .../carbonado/layout/StoredLayoutProperty.html | 543 +++++++++++++++++++ .../com/amazon/carbonado/layout/Unevolvable.html | 171 ++++++ .../amazon/carbonado/layout/class-use/Layout.html | 317 +++++++++++ .../layout/class-use/LayoutCapability.html | 162 ++++++ .../carbonado/layout/class-use/LayoutFactory.html | 117 +++++ .../carbonado/layout/class-use/LayoutOptions.html | 246 +++++++++ .../carbonado/layout/class-use/LayoutProperty.html | 169 ++++++ .../carbonado/layout/class-use/LayoutSync.html | 117 +++++ .../carbonado/layout/class-use/StoredLayout.html | 117 +++++ .../layout/class-use/StoredLayoutEquivalence.html | 117 +++++ .../layout/class-use/StoredLayoutProperty.html | 117 +++++ .../carbonado/layout/class-use/Unevolvable.html | 230 ++++++++ .../com/amazon/carbonado/layout/package-frame.html | 32 ++ .../amazon/carbonado/layout/package-summary.html | 230 ++++++++ .../com/amazon/carbonado/layout/package-tree.html | 156 ++++++ .../com/amazon/carbonado/layout/package-use.html | 252 +++++++++ 24 files changed, 6142 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/layout/Layout.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutCapability.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutFactory.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutOptions.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/LayoutSync.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayout.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html create mode 100644 apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/Unevolvable.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/Layout.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/layout/package-use.html (limited to 'apidocs/com/amazon/carbonado/layout') diff --git a/apidocs/com/amazon/carbonado/layout/Layout.html b/apidocs/com/amazon/carbonado/layout/Layout.html new file mode 100644 index 0000000..284f919 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Layout.html @@ -0,0 +1,580 @@ + + + + + + +Layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Class Layout

+
+
+ +
+
    +
  • +
    +
    +
    public class Layout
    +extends java.lang.Object
    +
    Describes the layout of a specific generation of a storable.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    LayoutFactory
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequalLayouts(Layout layout) +
      Returns true if the given layout matches this one.
      +
      booleanequals(java.lang.Object obj) 
      java.util.List<LayoutProperty>getAllProperties() +
      Returns all the properties of this layout, in their proper order.
      +
      org.joda.time.DateTimegetCreationDateTime() +
      Returns the date and time for when this layout generation was created.
      +
      java.lang.StringgetCreationHost() +
      Returns the host machine that created this generation.
      +
      java.lang.StringgetCreationUser() +
      Returns the user that created this layout generation.
      +
      java.util.List<LayoutProperty>getDataProperties() +
      Returns all the non-primary key properties of this layout, in their + proper order.
      +
      intgetGeneration() +
      Returns the generation of this layout, where zero represents the first + generation.
      +
      LayoutgetGeneration(int generation) +
      Returns the layout for a particular generation of this layout's type.
      +
      longgetLayoutID() +
      Returns a unique identifier for this layout.
      +
      LayoutOptionsgetOptions() +
      Returns additional options, or null if none.
      +
      java.lang.StringgetStorableTypeName() +
      Storable type name is a fully qualified Java class name.
      +
      inthashCode() 
      LayoutnextGeneration() +
      Returns the next known generation of the storable's layout, or null + if none.
      +
      LayoutpreviousGeneration() +
      Returns the previous known generation of the storable's layout, or null + if none.
      +
      java.lang.Class<? extends Storable>reconstruct() +
      Reconstructs the storable type defined by this layout by returning an + auto-generated class.
      +
      java.lang.Class<? extends Storable>reconstruct(java.lang.ClassLoader loader) +
      Reconstructs the storable type defined by this layout by returning an + auto-generated class.
      +
      java.lang.StringtoString() 
      voidwriteTo(java.io.OutputStream out) + +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        public long getLayoutID()
        +
        Returns a unique identifier for this layout.
        +
      • +
      + + + +
        +
      • +

        getStorableTypeName

        +
        public java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
      • +
      + + + +
        +
      • +

        getGeneration

        +
        public int getGeneration()
        +
        Returns the generation of this layout, where zero represents the first + generation.
        +
      • +
      + + + +
        +
      • +

        getDataProperties

        +
        public java.util.List<LayoutProperty> getDataProperties()
        +                                                 throws FetchException
        +
        Returns all the non-primary key properties of this layout, in their + proper order.
        +
        Throws:
        +
        FetchException
        +
      • +
      + + + + + + + +
        +
      • +

        getCreationDateTime

        +
        public org.joda.time.DateTime getCreationDateTime()
        +
        Returns the date and time for when this layout generation was created.
        +
      • +
      + + + +
        +
      • +

        getCreationUser

        +
        public java.lang.String getCreationUser()
        +
        Returns the user that created this layout generation.
        +
      • +
      + + + +
        +
      • +

        getCreationHost

        +
        public java.lang.String getCreationHost()
        +
        Returns the host machine that created this generation.
        +
      • +
      + + + +
        +
      • +

        getOptions

        +
        public LayoutOptions getOptions()
        +
        Returns additional options, or null if none.
        +
        Returns:
        read-only object or null
        +
      • +
      + + + + + + + +
        +
      • +

        previousGeneration

        +
        public Layout previousGeneration()
        +                          throws FetchException
        +
        Returns the previous known generation of the storable's layout, or null + if none.
        +
        Returns:
        a layout with a lower generation, or null if none
        +
        Throws:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        nextGeneration

        +
        public Layout nextGeneration()
        +                      throws FetchException
        +
        Returns the next known generation of the storable's layout, or null + if none.
        +
        Returns:
        a layout with a higher generation, or null if none
        +
        Throws:
        +
        FetchException
        +
      • +
      + + + +
        +
      • +

        reconstruct

        +
        public java.lang.Class<? extends Storable> reconstruct()
        +                                                throws FetchException,
        +                                                       SupportException
        +
        Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.
        +
        Throws:
        +
        FetchException
        +
        SupportException
        +
      • +
      + + + +
        +
      • +

        reconstruct

        +
        public java.lang.Class<? extends Storable> reconstruct(java.lang.ClassLoader loader)
        +                                                throws FetchException,
        +                                                       SupportException
        +
        Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.
        +
        Parameters:
        loader - optional ClassLoader to load reconstruct class into, if it + has not been loaded yet
        +
        Throws:
        +
        FetchException
        +
        SupportException
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equalLayouts

        +
        public boolean equalLayouts(Layout layout)
        +                     throws FetchException
        +
        Returns true if the given layout matches this one. Layout ID, + generation, and creation info is not considered in the comparison.
        +
        Throws:
        +
        FetchException
        +
      • +
      + + + + +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html new file mode 100644 index 0000000..ba50e1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html @@ -0,0 +1,253 @@ + + + + + + +LayoutCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Interface LayoutCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    LayoutFactory
    +
    +
    +
    +
    public interface LayoutCapability
    +extends Capability
    +
    Capability to get layout information on any storable generation.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LayoutlayoutFor(java.lang.Class<? extends Storable> type) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + int generation) +
      Returns the layout for a particular generation of the given type.
      +
      +
    • +
    +
  • +
+
+
+ +
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html new file mode 100644 index 0000000..ea086bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html @@ -0,0 +1,421 @@ + + + + + + +LayoutFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Class LayoutFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Capability, LayoutCapability
    +
    +
    +
    +
    public class LayoutFactory
    +extends java.lang.Object
    +implements LayoutCapability
    +
    Factory for obtaining references to storable layouts.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intVERSION 
      +
    • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      LayoutlayoutFor(boolean readOnly, + java.lang.Class<? extends Storable> type, + LayoutOptions options) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + int generation) +
      Returns the layout for a particular generation of the given type.
      +
      LayoutlayoutFor(java.lang.Class<? extends Storable> type, + LayoutOptions options) +
      Returns the layout matching the current definition of the given type.
      +
      LayoutreadLayoutFrom(java.io.InputStream in) +
      Read a layout as written by Layout.writeTo(java.io.OutputStream).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html new file mode 100644 index 0000000..f6e36c3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html @@ -0,0 +1,307 @@ + + + + + + +LayoutOptions (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Class LayoutOptions

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutOptions
    +extends java.lang.Object
    +
    Extra options encoded with a Storable layout.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LayoutOptions() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(byte[] source) 
      byte[]encode() 
      java.lang.StringgetCompressionType() 
      voidsetCompressionType(java.lang.String type) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LayoutOptions

        +
        public LayoutOptions()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCompressionType

        +
        public java.lang.String getCompressionType()
        +
        Returns:
        null if not compressed
        +
      • +
      + + + +
        +
      • +

        setCompressionType

        +
        public void setCompressionType(java.lang.String type)
        +
        Parameters:
        type - null if not compressed
        +
      • +
      + + + +
        +
      • +

        encode

        +
        public byte[] encode()
        +
        Returns:
        null if empty
        +
      • +
      + + + +
        +
      • +

        decode

        +
        public void decode(byte[] source)
        +            throws java.io.IOException
        +
        Parameters:
        source - can be null if empty
        +
        Throws:
        +
        java.io.IOException
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html new file mode 100644 index 0000000..0acb8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html @@ -0,0 +1,410 @@ + + + + + + +LayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Class LayoutProperty

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutProperty
    +extends java.lang.Object
    +
    Describes how a property is defined in a specific generation of a storable.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    Layout
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object obj) 
      java.lang.StringgetAdapterParams() +
      Parameters for adapter, or null if property has no explicit adapter.
      +
      java.lang.StringgetAdapterTypeName() +
      Adapter type name is a fully qualified Java class name.
      +
      java.lang.StringgetPropertyName() 
      java.lang.ClassgetPropertyType() 
      java.lang.ClassgetPropertyType(java.lang.ClassLoader loader) 
      java.lang.StringgetPropertyTypeDescriptor() +
      Property type descriptor is a Java type descriptor.
      +
      inthashCode() 
      booleanisNullable() +
      Returns true of property can be set to null.
      +
      booleanisPrimaryKeyMember() +
      Returns true if property is a member of the primary key.
      +
      booleanisVersion() +
      Returns true if this property is the designated version number for the + Storable.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPropertyName

        +
        public java.lang.String getPropertyName()
        +
      • +
      + + + +
        +
      • +

        getPropertyTypeDescriptor

        +
        public java.lang.String getPropertyTypeDescriptor()
        +
        Property type descriptor is a Java type descriptor.
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        isNullable

        +
        public boolean isNullable()
        +
        Returns true of property can be set to null.
        +
      • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        public boolean isPrimaryKeyMember()
        +
        Returns true if property is a member of the primary key.
        +
      • +
      + + + +
        +
      • +

        isVersion

        +
        public boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
      • +
      + + + +
        +
      • +

        getAdapterTypeName

        +
        public java.lang.String getAdapterTypeName()
        +
        Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.
        +
      • +
      + + + +
        +
      • +

        getAdapterParams

        +
        public java.lang.String getAdapterParams()
        +
        Parameters for adapter, or null if property has no explicit adapter.
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
      • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/LayoutSync.html new file mode 100644 index 0000000..c9b784b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutSync.html @@ -0,0 +1,268 @@ + + + + + + +LayoutSync (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Class LayoutSync

+
+
+ +
+
    +
  • +
    +
    +
    public class LayoutSync
    +extends java.lang.Object
    +
    Synchronizes layout metadata between two repositories. Both source and + destination might be updated.
    +
    Author:
    +
    Brian S O'Neill
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/StoredLayout.html new file mode 100644 index 0000000..6652179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayout.html @@ -0,0 +1,456 @@ + + + + + + +StoredLayout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Interface StoredLayout

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        long getLayoutID()
        +
      • +
      + + + +
        +
      • +

        setLayoutID

        +
        void setLayoutID(long typeID)
        +
      • +
      + + + +
        +
      • +

        getStorableTypeName

        +
        java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
      • +
      + + + +
        +
      • +

        setStorableTypeName

        +
        void setStorableTypeName(java.lang.String typeName)
        +
      • +
      + + + +
        +
      • +

        getGeneration

        +
        int getGeneration()
        +
        Generation of storable, where 0 represents the first generation.
        +
      • +
      + + + +
        +
      • +

        setGeneration

        +
        void setGeneration(int generation)
        +
      • +
      + + + +
        +
      • +

        getCreationTimestamp

        +
        long getCreationTimestamp()
        +
        Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.
        +
      • +
      + + + +
        +
      • +

        setCreationTimestamp

        +
        void setCreationTimestamp(long timestamp)
        +
      • +
      + + + +
        +
      • +

        getCreationUser

        +
        @Nullable
        +java.lang.String getCreationUser()
        +
        Returns the user that created this generation.
        +
      • +
      + + + +
        +
      • +

        setCreationUser

        +
        void setCreationUser(java.lang.String user)
        +
      • +
      + + + +
        +
      • +

        getCreationHost

        +
        @Nullable
        +java.lang.String getCreationHost()
        +
        Returns the host machine that created this generation.
        +
      • +
      + + + +
        +
      • +

        setCreationHost

        +
        void setCreationHost(java.lang.String host)
        +
      • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
        +int getVersionNumber()
        +
        Record version number for this StoredTypeLayout instance. Some encoding + strategies require a version number.
        +
      • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
      • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
        +byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
      • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html new file mode 100644 index 0000000..e95aa3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html @@ -0,0 +1,354 @@ + + + + + + +StoredLayoutEquivalence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Interface StoredLayoutEquivalence

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableTypeName

        +
        java.lang.String getStorableTypeName()
        +
        Storable type name is a fully qualified Java class name.
        +
      • +
      + + + +
        +
      • +

        setStorableTypeName

        +
        void setStorableTypeName(java.lang.String typeName)
        +
      • +
      + + + +
        +
      • +

        getGeneration

        +
        int getGeneration()
        +
        Generation of storable, where 0 represents the first generation.
        +
      • +
      + + + +
        +
      • +

        setGeneration

        +
        void setGeneration(int generation)
        +
      • +
      + + + +
        +
      • +

        getMatchedGeneration

        +
        int getMatchedGeneration()
        +
        Generation of matched layout.
        +
      • +
      + + + +
        +
      • +

        setMatchedGeneration

        +
        void setMatchedGeneration(int generation)
        +
      • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
        +int getVersionNumber()
        +
      • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
      • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
        +byte[] getExtraData()
        +
      • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html new file mode 100644 index 0000000..404f05a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html @@ -0,0 +1,543 @@ + + + + + + +StoredLayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Interface StoredLayoutProperty

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getLayoutID

        +
        long getLayoutID()
        +
      • +
      + + + +
        +
      • +

        setLayoutID

        +
        void setLayoutID(long typeID)
        +
      • +
      + + + +
        +
      • +

        getOrdinal

        +
        int getOrdinal()
        +
        Ordinal defines the order in which this property appears in it enclosing + layout.
        +
      • +
      + + + +
        +
      • +

        setOrdinal

        +
        void setOrdinal(int ordinal)
        +
      • +
      + + + +
        +
      • +

        getPropertyName

        +
        java.lang.String getPropertyName()
        +
      • +
      + + + +
        +
      • +

        setPropertyName

        +
        void setPropertyName(java.lang.String name)
        +
      • +
      + + + +
        +
      • +

        getPropertyTypeDescriptor

        +
        java.lang.String getPropertyTypeDescriptor()
        +
        Property type descriptor is a Java type descriptor.
        +
      • +
      + + + +
        +
      • +

        setPropertyTypeDescriptor

        +
        void setPropertyTypeDescriptor(java.lang.String type)
        +
      • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        Returns true of property value can be set to null.
        +
      • +
      + + + +
        +
      • +

        setNullable

        +
        void setNullable(boolean nullable)
        +
      • +
      + + + +
        +
      • +

        isPrimaryKeyMember

        +
        boolean isPrimaryKeyMember()
        +
        Returns true if property is a member of the primary key.
        +
      • +
      + + + +
        +
      • +

        setPrimaryKeyMember

        +
        void setPrimaryKeyMember(boolean pk)
        +
      • +
      + + + +
        +
      • +

        isVersion

        +
        boolean isVersion()
        +
        Returns true if this property is the designated version number for the + Storable.
        +
      • +
      + + + +
        +
      • +

        setVersion

        +
        void setVersion(boolean version)
        +
      • +
      + + + +
        +
      • +

        getAdapterTypeName

        +
        @Nullable
        +java.lang.String getAdapterTypeName()
        +
        Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.
        +
      • +
      + + + +
        +
      • +

        setAdapterTypeName

        +
        void setAdapterTypeName(java.lang.String name)
        +
      • +
      + + + +
        +
      • +

        getAdapterParams

        +
        @Nullable
        +java.lang.String getAdapterParams()
        +
        Parameters for adapter, or null if property has no explicit adapter.
        +
      • +
      + + + +
        +
      • +

        setAdapterParams

        +
        void setAdapterParams(java.lang.String params)
        +
      • +
      + + + +
        +
      • +

        getVersionNumber

        +
        @Version
        +int getVersionNumber()
        +
        Record version number for this StoredPropertyLayout instance. Some + encoding strategies require a version number.
        +
      • +
      + + + +
        +
      • +

        setVersionNumber

        +
        void setVersionNumber(int version)
        +
      • +
      + + + +
        +
      • +

        getExtraData

        +
        @Nullable
        +byte[] getExtraData()
        +
        Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.
        +
      • +
      + + + +
        +
      • +

        setExtraData

        +
        void setExtraData(byte[] data)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/Unevolvable.html new file mode 100644 index 0000000..f09728d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Unevolvable.html @@ -0,0 +1,171 @@ + + + + + + +Unevolvable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + + +
+
com.amazon.carbonado.layout
+

Interface Unevolvable

+
+
+
+ +
+
+ + +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Layout.html b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html new file mode 100644 index 0000000..0e91eec --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html @@ -0,0 +1,317 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.Layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.layout.Layout

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html new file mode 100644 index 0000000..0ec261c --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.LayoutCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.layout.LayoutCapability

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html new file mode 100644 index 0000000..ffc230f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.layout.LayoutFactory

+
+
No usage of com.amazon.carbonado.layout.LayoutFactory
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html new file mode 100644 index 0000000..0a48447 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html @@ -0,0 +1,246 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutOptions (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.layout.LayoutOptions

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html new file mode 100644 index 0000000..c088c4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html @@ -0,0 +1,169 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.layout.LayoutProperty

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html new file mode 100644 index 0000000..28ca812 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutSync (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Class
com.amazon.carbonado.layout.LayoutSync

+
+
No usage of com.amazon.carbonado.layout.LayoutSync
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html new file mode 100644 index 0000000..15fc3f1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayout

+
+
No usage of com.amazon.carbonado.layout.StoredLayout
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html new file mode 100644 index 0000000..26c05dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayoutEquivalence

+
+
No usage of com.amazon.carbonado.layout.StoredLayoutEquivalence
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html new file mode 100644 index 0000000..a344a31 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.layout.StoredLayoutProperty

+
+
No usage of com.amazon.carbonado.layout.StoredLayoutProperty
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html new file mode 100644 index 0000000..afa80a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html @@ -0,0 +1,230 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.Unevolvable (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Interface
com.amazon.carbonado.layout.Unevolvable

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-frame.html b/apidocs/com/amazon/carbonado/layout/package-frame.html new file mode 100644 index 0000000..58eea25 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.layout

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-summary.html b/apidocs/com/amazon/carbonado/layout/package-summary.html new file mode 100644 index 0000000..c5bca9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-summary.html @@ -0,0 +1,230 @@ + + + + + + +com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Package com.amazon.carbonado.layout

+
+
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.layout Description

+
Support for recording the evolution of a storable's layout, used internally + by some repositories. This allows storable's to evolve. Enough information + is recorded in the layout such + that an older generation can be reconstructed, allowing it to be decoded + from persistent storage. + +

A storable generation is different than a storable version. The version increases with each + update of an instance, whereas the generation increases when the + storable type definition changes. The version number is stored with each + instance, and the generation is stored via the classes in this package. + +

Whenever a property is added or removed from a storable, the storable + layout is assigned a new generation value. If the storable layout reverts to + a previous generation's layout, no new generation value is created. Instead, + the generation value of the current storable will match the previous + generation.

+
See Also:
LayoutFactory
+
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-tree.html b/apidocs/com/amazon/carbonado/layout/package-tree.html new file mode 100644 index 0000000..3255207 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +com.amazon.carbonado.layout Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Hierarchy For Package com.amazon.carbonado.layout

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+ + +

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

+ + diff --git a/apidocs/com/amazon/carbonado/layout/package-use.html b/apidocs/com/amazon/carbonado/layout/package-use.html new file mode 100644 index 0000000..a42c9f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-use.html @@ -0,0 +1,252 @@ + + + + + + +Uses of Package com.amazon.carbonado.layout (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
+

Uses of Package
com.amazon.carbonado.layout

+
+
+ +
+ +
+ + + + + +
+ + +

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

+ + -- cgit v1.2.3