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 --- .../carbonado/raw/CompressedEncodingStrategy.html | 352 +++++++ .../raw/CompressedStorableCodecFactory.html | 329 ++++++ .../com/amazon/carbonado/raw/CompressionType.html | 332 ++++++ .../raw/CustomStorableCodec.InstanceFactory.html | 236 +++++ .../amazon/carbonado/raw/CustomStorableCodec.html | 603 +++++++++++ .../carbonado/raw/CustomStorableCodecFactory.html | 386 +++++++ apidocs/com/amazon/carbonado/raw/DataDecoder.html | 879 ++++++++++++++++ apidocs/com/amazon/carbonado/raw/DataEncoder.html | 920 +++++++++++++++++ .../carbonado/raw/GenericEncodingStrategy.html | 1000 ++++++++++++++++++ .../carbonado/raw/GenericInstanceFactory.html | 250 +++++ .../amazon/carbonado/raw/GenericPropertyInfo.html | 324 ++++++ .../raw/GenericStorableCodec.Decoder.html | 222 ++++ .../raw/GenericStorableCodec.SearchKeyFactory.html | 313 ++++++ .../amazon/carbonado/raw/GenericStorableCodec.html | 702 +++++++++++++ .../carbonado/raw/GenericStorableCodecFactory.html | 406 ++++++++ .../com/amazon/carbonado/raw/GzipCompressor.html | 294 ++++++ apidocs/com/amazon/carbonado/raw/KeyDecoder.html | 936 +++++++++++++++++ apidocs/com/amazon/carbonado/raw/KeyEncoder.html | 1086 ++++++++++++++++++++ apidocs/com/amazon/carbonado/raw/RawCursor.html | 854 +++++++++++++++ .../amazon/carbonado/raw/RawStorableGenerator.html | 365 +++++++ apidocs/com/amazon/carbonado/raw/RawSupport.html | 452 ++++++++ apidocs/com/amazon/carbonado/raw/RawUtil.html | 286 ++++++ .../com/amazon/carbonado/raw/StorableCodec.html | 529 ++++++++++ .../amazon/carbonado/raw/StorableCodecFactory.html | 291 ++++++ .../amazon/carbonado/raw/StorablePropertyInfo.html | 474 +++++++++ .../raw/class-use/CompressedEncodingStrategy.html | 117 +++ .../class-use/CompressedStorableCodecFactory.html | 117 +++ .../carbonado/raw/class-use/CompressionType.html | 197 ++++ .../CustomStorableCodec.InstanceFactory.html | 117 +++ .../raw/class-use/CustomStorableCodec.html | 205 ++++ .../raw/class-use/CustomStorableCodecFactory.html | 117 +++ .../carbonado/raw/class-use/DataDecoder.html | 117 +++ .../carbonado/raw/class-use/DataEncoder.html | 117 +++ .../raw/class-use/GenericEncodingStrategy.html | 192 ++++ .../raw/class-use/GenericInstanceFactory.html | 117 +++ .../raw/class-use/GenericPropertyInfo.html | 160 +++ .../class-use/GenericStorableCodec.Decoder.html | 164 +++ .../GenericStorableCodec.SearchKeyFactory.html | 163 +++ .../raw/class-use/GenericStorableCodec.html | 171 +++ .../raw/class-use/GenericStorableCodecFactory.html | 162 +++ .../carbonado/raw/class-use/GzipCompressor.html | 117 +++ .../amazon/carbonado/raw/class-use/KeyDecoder.html | 117 +++ .../amazon/carbonado/raw/class-use/KeyEncoder.html | 117 +++ .../amazon/carbonado/raw/class-use/RawCursor.html | 117 +++ .../raw/class-use/RawStorableGenerator.html | 117 +++ .../amazon/carbonado/raw/class-use/RawSupport.html | 289 ++++++ .../amazon/carbonado/raw/class-use/RawUtil.html | 117 +++ .../carbonado/raw/class-use/StorableCodec.html | 193 ++++ .../raw/class-use/StorableCodecFactory.html | 217 ++++ .../raw/class-use/StorablePropertyInfo.html | 210 ++++ .../com/amazon/carbonado/raw/package-frame.html | 50 + .../com/amazon/carbonado/raw/package-summary.html | 319 ++++++ apidocs/com/amazon/carbonado/raw/package-tree.html | 190 ++++ apidocs/com/amazon/carbonado/raw/package-use.html | 236 +++++ 54 files changed, 17460 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/CompressionType.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/DataDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/DataEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/GzipCompressor.html create mode 100644 apidocs/com/amazon/carbonado/raw/KeyDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/KeyEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawCursor.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawSupport.html create mode 100644 apidocs/com/amazon/carbonado/raw/RawUtil.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CompressionType.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/DataDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/DataEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html create mode 100644 apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/raw/package-use.html (limited to 'apidocs/com/amazon/carbonado/raw') diff --git a/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html new file mode 100644 index 0000000..93dedfd --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html @@ -0,0 +1,352 @@ + + + + + + +CompressedEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CompressedEncodingStrategy<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    +
    public class CompressedEncodingStrategy<S extends Storable>
+extends GenericEncodingStrategy<S>
    +
    Extension of GenericEncodingStrategy that allows for compression.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CompressedEncodingStrategy

        +
        public CompressedEncodingStrategy(java.lang.Class<S> type,
+                          StorableIndex<S> pkIndex,
+                          CompressionType compressionType)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        extraDataEncoding

        +
        protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Description copied from class: GenericEncodingStrategy
        +
        Second phase encoding, which does nothing by default.
        +
        +
        Overrides:
        +
        extraDataEncoding in class GenericEncodingStrategy<S extends Storable>
        +
        dataVar - local variable referencing a byte array with data
        prefix - prefix of byte array to preserve
        suffix - suffix of byte array to preserve
        +
        • +
      + + + +
        +
      • +

        extraDataDecoding

        +
        protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Description copied from class: GenericEncodingStrategy
        +
        Second phase decoding, which does nothing by default.
        +
        +
        Overrides:
        +
        extraDataDecoding in class GenericEncodingStrategy<S extends Storable>
        +
        dataVar - local variable referencing a byte array with data
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html new file mode 100644 index 0000000..f456422 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html @@ -0,0 +1,329 @@ + + + + + + +CompressedStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CompressedStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    +
    public class CompressedStorableCodecFactory
+extends GenericStorableCodecFactory
    +
    Extension of GenericStorableCodecFactory that allows for compression.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CompressionType.html b/apidocs/com/amazon/carbonado/raw/CompressionType.html new file mode 100644 index 0000000..2c5c5f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressionType.html @@ -0,0 +1,332 @@ + + + + + + +CompressionType (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Enum CompressionType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<CompressionType>
    +
    +
    +
    +
    public enum CompressionType
+extends java.lang.Enum<CompressionType>
    +
    Available compression types for any particular storable.
    +
    Author:
    +
    Olga Kuznetsova
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      GZIP +
      Gzip compression.
      +
      NONE +
      No compression.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static CompressionTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static CompressionType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static CompressionType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (CompressionType c : CompressionType.values())
+    System.out.println(c);
+
        +
        Returns:
        an array containing the constants of this enum type, in +the order they are declared
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static CompressionType valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        Parameters:
        name - the name of the enum constant to be returned.
        +
        Returns:
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html new file mode 100644 index 0000000..14fe739 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html @@ -0,0 +1,236 @@ + + + + + + +CustomStorableCodec.InstanceFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface CustomStorableCodec.InstanceFactory

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html new file mode 100644 index 0000000..ee55d20 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html @@ -0,0 +1,603 @@ + + + + + + +CustomStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CustomStorableCodec<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodec<S>
    +
    +
    +
    +
    public abstract class CustomStorableCodec<S extends Storable>
+extends java.lang.Object
+implements StorableCodec<S>
    +
    Allows codecs to be defined for storables that have a custom encoding.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    CustomStorableCodecFactory
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      StorableIndex<S>buildPkIndex(java.lang.String... propertyNames) +
      Convenient way to define the clustered primary key index + descriptor.
      +
      abstract voiddecodeData(S storable, + byte[] bytes) +
      Decode the data into properties of the storable.
      +
      abstract voiddecodePrimaryKey(S storable, + byte[] bytes) +
      Decode the primary key into properties of the storable.
      +
      abstract byte[]encodeData(S storable) +
      Encode all properties of the storable excluding the primary key.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      java.util.Map<java.lang.String,? extends StorableProperty<S>>getAllProperties() +
      Convenient access to all the storable properties.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable produced by this codec.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CustomStorableCodec

        +
        public CustomStorableCodec(java.lang.Class<S> type,
+                   boolean isMaster)
+                    throws SupportException
        +
        Parameters:
        isMaster - when true, version properties and sequences are managed
        +
        Throws:
        +
        SupportException - if Storable is not supported
        +
        • +
      + + + +
        +
      • +

        CustomStorableCodec

        +
        public CustomStorableCodec(java.lang.Class<S> type,
+                   boolean isMaster,
+                   RawSupport<S> support)
+                    throws SupportException
        +
        Parameters:
        isMaster - when true, version properties and sequences are managed
        +
        Throws:
        +
        SupportException - if Storable is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public java.lang.Class<S> getStorableType()
        +
        Description copied from interface: StorableCodec
        +
        Returns the type of Storable produced by this codec.
        +
        +
        Specified by:
        +
        getStorableType in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate()
        +
        Description copied from interface: StorableCodec
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Since:
        +
        1.2
        +
        • +
      + + + + + + + +
        +
      • +

        instantiate

        +
        public S instantiate(RawSupport<S> support)
        +
        Description copied from interface: StorableCodec
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + + + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + + + + + +
        +
      • +

        getAllProperties

        +
        public java.util.Map<java.lang.String,? extends StorableProperty<S>> getAllProperties()
        +
        Convenient access to all the storable properties.
        +
        • +
      + + + +
        +
      • +

        buildPkIndex

        +
        public StorableIndex<S> buildPkIndex(java.lang.String... propertyNames)
        +
        Convenient way to define the clustered primary key index + descriptor. Direction can be specified by prefixing the property name + with a '+' or '-'. If unspecified, direction is assumed to be ascending.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        encodeData

        +
        public abstract byte[] encodeData(S storable)
        +
        Encode all properties of the storable excluding the primary key.
        +
        • +
      + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html new file mode 100644 index 0000000..a5a6d9b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html @@ -0,0 +1,386 @@ + + + + + + +CustomStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class CustomStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    +
    public abstract class CustomStorableCodecFactory
+extends java.lang.Object
+implements StorableCodecFactory
    +
    Factory for custom storable codecs.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CustomStorableCodecFactory

        +
        public CustomStorableCodecFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      StorableIndex pkIndex,
+                                                      boolean isMaster,
+                                                      Layout layout)
+                                                    throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - ignored
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      StorableIndex pkIndex,
+                                                      boolean isMaster,
+                                                      Layout layout,
+                                                      RawSupport support)
+                                                    throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - ignored
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        protected abstract <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      boolean isMaster,
+                                                      Layout layout)
+                                                                throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        protected <S extends Storable> CustomStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                      boolean isMaster,
+                                                      Layout layout,
+                                                      RawSupport support)
+                                                       throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/DataDecoder.html b/apidocs/com/amazon/carbonado/raw/DataDecoder.html new file mode 100644 index 0000000..d9c7e29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataDecoder.html @@ -0,0 +1,879 @@ + + + + + + +DataDecoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class DataDecoder

+
+
+ +
+
    +
  • +
    +
    +
    public class DataDecoder
+extends java.lang.Object
    +
    A very low-level class that decodes key components encoded by methods of + DataEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    KeyDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intdecode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes a BigDecimal.
      +
      static intdecode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes a BigInteger.
      +
      static intdecode(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array.
      +
      static booleandecodeBoolean(byte[] src, + int srcOffset) +
      Decodes a boolean from exactly 1 byte.
      +
      static java.lang.BooleandecodeBooleanObj(byte[] src, + int srcOffset) +
      Decodes a Boolean object from exactly 1 byte.
      +
      static bytedecodeByte(byte[] src, + int srcOffset) +
      Decodes a signed byte from exactly 1 byte.
      +
      static java.lang.BytedecodeByteObj(byte[] src, + int srcOffset) +
      Decodes a signed Byte object from exactly 1 or 2 bytes.
      +
      static chardecodeChar(byte[] src, + int srcOffset) +
      Decodes a char from exactly 2 bytes.
      +
      static java.lang.CharacterdecodeCharacterObj(byte[] src, + int srcOffset) +
      Decodes a Character object from exactly 1 or 3 bytes.
      +
      static doubledecodeDouble(byte[] src, + int srcOffset) +
      Decodes a double from exactly 8 bytes.
      +
      protected static longdecodeDoubleBits(byte[] src, + int srcOffset) 
      static java.lang.DoubledecodeDoubleObj(byte[] src, + int srcOffset) +
      Decodes a Double object from exactly 8 bytes.
      +
      static floatdecodeFloat(byte[] src, + int srcOffset) +
      Decodes a float from exactly 4 bytes.
      +
      protected static intdecodeFloatBits(byte[] src, + int srcOffset) 
      static java.lang.FloatdecodeFloatObj(byte[] src, + int srcOffset) +
      Decodes a Float object from exactly 4 bytes.
      +
      static intdecodeInt(byte[] src, + int srcOffset) +
      Decodes a signed integer from exactly 4 bytes.
      +
      static java.lang.IntegerdecodeIntegerObj(byte[] src, + int srcOffset) +
      Decodes a signed Integer object from exactly 1 or 5 bytes.
      +
      static longdecodeLong(byte[] src, + int srcOffset) +
      Decodes a signed long from exactly 8 bytes.
      +
      static java.lang.LongdecodeLongObj(byte[] src, + int srcOffset) +
      Decodes a signed Long object from exactly 1 or 9 bytes.
      +
      static shortdecodeShort(byte[] src, + int srcOffset) +
      Decodes a signed short from exactly 2 bytes.
      +
      static java.lang.ShortdecodeShortObj(byte[] src, + int srcOffset) +
      Decodes a signed Short object from exactly 1 or 3 bytes.
      +
      static byte[]decodeSingle(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int).
      +
      static byte[]decodeSingleNullable(byte[] src) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
      +
      static byte[]decodeSingleNullable(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
      +
      static intdecodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array.
      +
      static voidreadFully(java.io.InputStream in, + byte[] b) +
      Reads as many bytes from the stream as is necessary to fill the given + byte array.
      +
      static intreadLength(java.io.InputStream in) +
      Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DataDecoder

        +
        public DataDecoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        decodeInt

        +
        public static int decodeInt(byte[] src,
+            int srcOffset)
+                     throws CorruptEncodingException
        +
        Decodes a signed integer from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed integer value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeIntegerObj

        +
        public static java.lang.Integer decodeIntegerObj(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a signed Integer object from exactly 1 or 5 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Integer object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLong

        +
        public static long decodeLong(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a signed long from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed long value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongObj

        +
        public static java.lang.Long decodeLongObj(byte[] src,
+                           int srcOffset)
+                                    throws CorruptEncodingException
        +
        Decodes a signed Long object from exactly 1 or 9 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Long object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByte

        +
        public static byte decodeByte(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a signed byte from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed byte value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteObj

        +
        public static java.lang.Byte decodeByteObj(byte[] src,
+                           int srcOffset)
+                                    throws CorruptEncodingException
        +
        Decodes a signed Byte object from exactly 1 or 2 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Byte object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShort

        +
        public static short decodeShort(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a signed short from exactly 2 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed short value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortObj

        +
        public static java.lang.Short decodeShortObj(byte[] src,
+                             int srcOffset)
+                                      throws CorruptEncodingException
        +
        Decodes a signed Short object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Short object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeChar

        +
        public static char decodeChar(byte[] src,
+              int srcOffset)
+                       throws CorruptEncodingException
        +
        Decodes a char from exactly 2 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        char value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharacterObj

        +
        public static java.lang.Character decodeCharacterObj(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a Character object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Character object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBoolean

        +
        public static boolean decodeBoolean(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a boolean from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        boolean value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanObj

        +
        public static java.lang.Boolean decodeBooleanObj(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a Boolean object from exactly 1 byte.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Boolean object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloat

        +
        public static float decodeFloat(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a float from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        float value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatObj

        +
        public static java.lang.Float decodeFloatObj(byte[] src,
+                             int srcOffset)
+                                      throws CorruptEncodingException
        +
        Decodes a Float object from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Float object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeDouble

        +
        public static double decodeDouble(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a double from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        double value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleObj

        +
        public static java.lang.Double decodeDoubleObj(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a Double object from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Double object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigInteger[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes a BigInteger.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigDecimal[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes a BigDecimal.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         byte[][] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeString

        +
        public static int decodeString(byte[] src,
+               int srcOffset,
+               java.lang.String[] valueRef)
+                        throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        readLength

        +
        public static int readLength(java.io.InputStream in)
+                      throws java.io.IOException,
+                             java.io.EOFException
        +
        Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
        +
        Returns:
        length value
        +
        Throws:
        +
        java.io.IOException
        +
        java.io.EOFException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        readFully

        +
        public static void readFully(java.io.InputStream in,
+             byte[] b)
+                      throws java.io.IOException,
+                             java.io.EOFException
        +
        Reads as many bytes from the stream as is necessary to fill the given + byte array. An EOFException is thrown if the stream end is encountered.
        +
        Throws:
        +
        java.io.IOException
        +
        java.io.EOFException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeSingle

        +
        public static byte[] decodeSingle(byte[] src,
+                  int prefixPadding,
+                  int suffixPadding)
+                           throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int). Always returns a new byte array instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleNullable

        +
        public static byte[] decodeSingleNullable(byte[] src,
+                          int prefixPadding,
+                          int suffixPadding)
+                                   throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]). Always returns a new byte array + instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/DataEncoder.html b/apidocs/com/amazon/carbonado/raw/DataEncoder.html new file mode 100644 index 0000000..553433e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataEncoder.html @@ -0,0 +1,920 @@ + + + + + + +DataEncoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class DataEncoder

+
+
+ +
+
    +
  • +
    +
    +
    public class DataEncoder
+extends java.lang.Object
    +
    A very low-level class that supports encoding of primitive data. For + encoding data into keys, see KeyEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    DataDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intcalculateEncodedLength(java.math.BigDecimal value) +
      Returns the amount of bytes required to encode the given BigDecimal.
      +
      static intcalculateEncodedLength(java.math.BigInteger value) +
      Returns the amount of bytes required to encode the given BigInteger.
      +
      static intcalculateEncodedLength(byte[] value) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedLength(byte[] value, + int valueOffset, + int valueLength) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedStringLength(java.lang.String value) +
      Returns the amount of bytes required to encode the given String.
      +
      static intencode(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of + bytes.
      +
      static intencode(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of + bytes.
      +
      static voidencode(boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given boolean into exactly 1 byte.
      +
      static voidencode(java.lang.Boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given Boolean object into exactly 1 byte.
      +
      static intencode(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional byte array into a variable amount of + bytes.
      +
      static intencode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional byte array into a variable amount of + bytes.
      +
      static voidencode(byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed byte into exactly 1 byte.
      +
      static intencode(java.lang.Byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Byte object into exactly 1 or 2 bytes.
      +
      static intencode(java.lang.Character value, + byte[] dst, + int dstOffset) +
      Encodes the given Character object into exactly 1 or 3 bytes.
      +
      static voidencode(char value, + byte[] dst, + int dstOffset) +
      Encodes the given character into exactly 2 bytes.
      +
      static voidencode(double value, + byte[] dst, + int dstOffset) +
      Encodes the given double into exactly 8 bytes.
      +
      static voidencode(java.lang.Double value, + byte[] dst, + int dstOffset) +
      Encodes the given Double object into exactly 8 bytes.
      +
      static voidencode(float value, + byte[] dst, + int dstOffset) +
      Encodes the given float into exactly 4 bytes.
      +
      static voidencode(java.lang.Float value, + byte[] dst, + int dstOffset) +
      Encodes the given Float object into exactly 4 bytes.
      +
      static voidencode(int value, + byte[] dst, + int dstOffset) +
      Encodes the given signed integer into exactly 4 bytes.
      +
      static intencode(java.lang.Integer value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Integer object into exactly 1 or 5 bytes.
      +
      static voidencode(long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed long into exactly 8 bytes.
      +
      static intencode(java.lang.Long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Long object into exactly 1 or 9 bytes.
      +
      static voidencode(short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed short into exactly 2 bytes.
      +
      static intencode(java.lang.Short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Short object into exactly 1 or 3 bytes.
      +
      static intencode(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes.
      +
      static byte[]encodeSingle(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + property, whose type is a byte array.
      +
      static byte[]encodeSingleNullable(byte[] value) +
      Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
      +
      static byte[]encodeSingleNullable(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
      +
      static intwriteLength(int valueLength, + java.io.OutputStream out) +
      Writes a positive length value in up to five bytes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DataEncoder

        +
        public DataEncoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public static void encode(int value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed integer into exactly 4 bytes.
        +
        Parameters:
        value - signed integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Integer value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Integer object into exactly 1 or 5 bytes. If + the Integer object is never expected to be null, consider encoding as an + int primitive.
        +
        Parameters:
        value - optional signed Integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(long value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed long into exactly 8 bytes.
        +
        Parameters:
        value - signed long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Long value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Long object into exactly 1 or 9 bytes. If the + Long object is never expected to be null, consider encoding as a long + primitive.
        +
        Parameters:
        value - optional signed Long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(byte value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed byte into exactly 1 byte.
        +
        Parameters:
        value - signed byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Byte value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Byte object into exactly 1 or 2 bytes. If the + Byte object is never expected to be null, consider encoding as a byte + primitive.
        +
        Parameters:
        value - optional signed Byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(short value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given signed short into exactly 2 bytes.
        +
        Parameters:
        value - signed short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Short value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given signed Short object into exactly 1 or 3 bytes. If the + Short object is never expected to be null, consider encoding as a short + primitive.
        +
        Parameters:
        value - optional signed Short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(char value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given character into exactly 2 bytes.
        +
        Parameters:
        value - character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.Character value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given Character object into exactly 1 or 3 bytes. If the + Character object is never expected to be null, consider encoding as a + char primitive.
        +
        Parameters:
        value - optional Character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(boolean value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given boolean into exactly 1 byte.
        +
        Parameters:
        value - boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Boolean value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Boolean object into exactly 1 byte.
        +
        Parameters:
        value - optional Boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(float value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given float into exactly 4 bytes.
        +
        Parameters:
        value - float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Float value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Float object into exactly 4 bytes. A non-canonical NaN + value is used to represent null.
        +
        Parameters:
        value - optional Float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(double value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given double into exactly 8 bytes.
        +
        Parameters:
        value - double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static void encode(java.lang.Double value,
+          byte[] dst,
+          int dstOffset)
        +
        Encodes the given Double object into exactly 8 bytes. A non-canonical + NaN value is used to represent null.
        +
        Parameters:
        value - optional Double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigInteger value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigInteger value)
        +
        Returns the amount of bytes required to encode the given BigInteger.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigDecimal value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigDecimal value)
        +
        Returns the amount of bytes required to encode the given BigDecimal.
        +
        Parameters:
        value - BigDecimal value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         int valueOffset,
+         int valueLength,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value,
+                         int valueOffset,
+                         int valueLength)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.String value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are written in one byte. This encoding is more efficient than + UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedStringLength

        +
        public static int calculateEncodedStringLength(java.lang.String value)
        +
        Returns the amount of bytes required to encode the given String.
        +
        Parameters:
        value - String to encode, may be null
        +
        • +
      + + + +
        +
      • +

        writeLength

        +
        public static int writeLength(int valueLength,
+              java.io.OutputStream out)
+                       throws java.io.IOException
        +
        Writes a positive length value in up to five bytes.
        +
        Returns:
        number of bytes written
        +
        Throws:
        +
        java.io.IOException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeSingle

        +
        public static byte[] encodeSingle(byte[] value,
+                  int prefixPadding,
+                  int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + property, whose type is a byte array. The original byte array is + returned if the padding lengths are zero.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullable

        +
        public static byte[] encodeSingleNullable(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullable

        +
        public static byte[] encodeSingleNullable(byte[] value,
+                          int prefixPadding,
+                          int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html new file mode 100644 index 0000000..9e13630 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html @@ -0,0 +1,1000 @@ + + + + + + +GenericEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericEncodingStrategy<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    CompressedEncodingStrategy
    +
    +
    +
    +
    public class GenericEncodingStrategy<S extends Storable>
+extends java.lang.Object
    +
    Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes. + +

    Note: subclasses must override and specialize the hashCode and equals + methods. Failure to do so interferes with StorableCodecFactory's + generated code cache.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidbuildDataDecoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar) +
      Generates bytecode instructions to decode properties.
      +
      org.cojen.classfile.LocalVariablebuildDataEncoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation) +
      Generates bytecode instructions to encode properties.
      +
      voidbuildKeyDecoding(org.cojen.classfile.CodeAssembler assembler, + OrderedProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar) +
      Generates bytecode instructions to decode properties.
      +
      org.cojen.classfile.LocalVariablebuildKeyEncoding(org.cojen.classfile.CodeAssembler assembler, + OrderedProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar) +
      Generates bytecode instructions to encode properties.
      +
      voidbuildSerialDecoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable encodedVar) +
      Generates bytecode instructions to decode properties and their states.
      +
      org.cojen.classfile.LocalVariablebuildSerialEncoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties) +
      Generates bytecode instructions to encode properties and their + states.
      +
      protected StorablePropertyInfocheckSupport(StorableProperty<S> property) 
      protected StorablePropertyInfo[]checkSupport(StorableProperty<S>[] properties) 
      booleanequals(java.lang.Object obj) 
      protected voidextraDataDecoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix) +
      Second phase decoding, which does nothing by default.
      +
      protected voidextraDataEncoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix) +
      Second phase encoding, which does nothing by default.
      +
      protected StorableProperty<S>[]gatherAllDataProperties() +
      Returns all non-derived data properties for storable.
      +
      protected OrderedProperty<S>[]gatherAllKeyProperties() +
      Returns all key properties as ordered properties, possibly with + unspecified directions.
      +
      protected StorableProperty<S>[]gatherAllProperties() +
      Returns all non-join, non-derived properties for storable.
      +
      intgetConstantKeyPrefixLength() +
      Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.
      +
      intgetDataPrefixPadding() 
      intgetDataSuffixPadding() 
      intgetKeyPrefixPadding() 
      intgetKeySuffixPadding() 
      protected StorableIndex<S>getPrimaryKeyIndex() +
      Returns all key properties in the form of an index.
      +
      java.lang.Class<S>getType() +
      Returns the type of Storable that code is generated for.
      +
      inthashCode() 
      booleanisSupported(java.lang.Class<?> propertyType) +
      Returns true if the type of the given property type is supported.
      +
      booleanisSupported(org.cojen.classfile.TypeDesc propertyType) +
      Returns true if the type of the given property type is supported.
      +
      protected booleanloadPropertyValue(org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar) +
      Generates code to load a property value onto the operand stack.
      +
      protected booleanloadPropertyValue(org.cojen.classfile.LocalVariable[] stashedProperties, + java.lang.Boolean[] stashedFromInstances, + org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar) +
      Generates code to load a property value onto the operand stack.
      +
      protected voidpushDecodingInstanceVar(org.cojen.classfile.CodeAssembler a, + int ordinal, + org.cojen.classfile.LocalVariable instanceVar) +
      Push decoding instanceVar to stack in preparation to calling + storePropertyValue.
      +
      protected voidpushRawSupport(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable instanceVar) +
      Generates code to push RawSupport instance to the stack.
      +
      protected voidstorePropertyValue(org.cojen.classfile.CodeAssembler a, + StorablePropertyInfo info, + boolean useWriteMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass) +
      Generates code to store a property value into an instance which is + already on the operand stack.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GenericEncodingStrategy

        +
        public GenericEncodingStrategy(java.lang.Class<S> type,
+                       StorableIndex<S> pkIndex)
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        +
        • +
      + + + +
        +
      • +

        GenericEncodingStrategy

        +
        public GenericEncodingStrategy(java.lang.Class<S> type,
+                       StorableIndex<S> pkIndex,
+                       int keyPrefixPadding,
+                       int keySuffixPadding,
+                       int dataPrefixPadding,
+                       int dataSuffixPadding)
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        keyPrefixPadding - amount of padding bytes at start of keys
        keySuffixPadding - amount of padding bytes at end of keys
        dataPrefixPadding - amount of padding bytes at start of data values
        dataSuffixPadding - amount of padding bytes at end of data values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        buildKeyEncoding

        +
        public org.cojen.classfile.LocalVariable buildKeyEncoding(org.cojen.classfile.CodeAssembler assembler,
+                                                 OrderedProperty<S>[] properties,
+                                                 org.cojen.classfile.LocalVariable instanceVar,
+                                                 java.lang.Class<?> adapterInstanceClass,
+                                                 boolean useReadMethods,
+                                                 org.cojen.classfile.LocalVariable partialStartVar,
+                                                 org.cojen.classfile.LocalVariable partialEndVar)
+                                                   throws SupportException
        +
        Generates bytecode instructions to encode properties. The encoding is + suitable for "key" encoding, which means it is correctly comparable. + +

        Note: if a partialStartVar is provided and this strategy has a key + prefix, the prefix is allocated only if the runtime value of + partialStartVar is zero. Likewise, if a partialEndVar is provided and + this strategy has a key suffix, the suffix is allocated only of the + runtime value of partialEndVar is one less than the property count.

        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to encode, defaults to all key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useReadMethods - when true, access properties by public read + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        partialEndVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than or + equal to the properties array length. It marks the range end (exclusive) + of the partial property range.
        +
        Returns:
        local variable referencing a byte array with encoded key
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if partial variable types are not + ints
        +
        • +
      + + + +
        +
      • +

        buildKeyDecoding

        +
        public void buildKeyDecoding(org.cojen.classfile.CodeAssembler assembler,
+                    OrderedProperty<S>[] properties,
+                    org.cojen.classfile.LocalVariable instanceVar,
+                    java.lang.Class<?> adapterInstanceClass,
+                    boolean useWriteMethods,
+                    org.cojen.classfile.LocalVariable encodedVar)
+                      throws SupportException
        +
        Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useWriteMethods - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        encodedVar - required variable, which must be a byte array. At + runtime, it references an encoded key.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array
        +
        • +
      + + + +
        +
      • +

        buildDataEncoding

        +
        public org.cojen.classfile.LocalVariable buildDataEncoding(org.cojen.classfile.CodeAssembler assembler,
+                                                  StorableProperty<S>[] properties,
+                                                  org.cojen.classfile.LocalVariable instanceVar,
+                                                  java.lang.Class<?> adapterInstanceClass,
+                                                  boolean useReadMethods,
+                                                  int generation)
+                                                    throws SupportException
        +
        Generates bytecode instructions to encode properties. The encoding is + suitable for "data" encoding, which means it is not correctly + comparable, but it is more efficient than key encoding. Partial encoding + is not supported.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to encode, defaults to all non-key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useReadMethods - when true, access properties by public read + methods instead of protected fields
        generation - when non-negative, write a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        +
        Returns:
        local variable referencing a byte array with encoded data
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type
        +
        • +
      + + + +
        +
      • +

        buildDataDecoding

        +
        public void buildDataDecoding(org.cojen.classfile.CodeAssembler assembler,
+                     StorableProperty<S>[] properties,
+                     org.cojen.classfile.LocalVariable instanceVar,
+                     java.lang.Class<?> adapterInstanceClass,
+                     boolean useWriteMethods,
+                     int generation,
+                     org.cojen.classfile.Label altGenerationHandler,
+                     org.cojen.classfile.LocalVariable encodedVar)
+                       throws SupportException
        +
        Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all non-key + properties if null
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        useWriteMethods - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields
        generation - when non-negative, decoder expects a storable layout + generation value to match this value. Otherwise, it throws a + CorruptEncodingException.
        altGenerationHandler - if non-null and a generation is provided, + this label defines an alternate generation handler. It is executed + instead of throwing a CorruptEncodingException if the generation doesn't + match. The actual generation is available on the top of the stack for + the handler to consume.
        encodedVar - required variable, which must be a byte array. At + runtime, it references encoded data.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array
        +
        • +
      + + + +
        +
      • +

        buildSerialEncoding

        +
        public org.cojen.classfile.LocalVariable buildSerialEncoding(org.cojen.classfile.CodeAssembler assembler,
+                                                    StorableProperty<S>[] properties)
+                                                      throws SupportException
        +
        Generates bytecode instructions to encode properties and their + states. This encoding is suitable for short-term serialization only.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all + properties if null
        +
        Returns:
        local variable referencing a byte array with encoded data
        +
        Throws:
        +
        SupportException - if any property type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        buildSerialDecoding

        +
        public void buildSerialDecoding(org.cojen.classfile.CodeAssembler assembler,
+                       StorableProperty<S>[] properties,
+                       org.cojen.classfile.LocalVariable encodedVar)
+                         throws SupportException
        +
        Generates bytecode instructions to decode properties and their states. A + CorruptEncodingException may be thrown from generated code.
        +
        Parameters:
        assembler - code assembler to receive bytecode instructions
        properties - specific properties to decode, defaults to all + properties if null
        encodedVar - required variable, which must be a byte array. At + runtime, it references encoded data.
        +
        Throws:
        +
        SupportException - if any property type is not supported
        +
        java.lang.IllegalArgumentException - if encodedVar is not a byte array
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getType

        +
        public final java.lang.Class<S> getType()
        +
        Returns the type of Storable that code is generated for.
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        public boolean isSupported(java.lang.Class<?> propertyType)
        +
        Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, and byte arrays.
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        public boolean isSupported(org.cojen.classfile.TypeDesc propertyType)
        +
        Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, byte arrays and Lobs.
        +
        • +
      + + + +
        +
      • +

        getKeyPrefixPadding

        +
        public int getKeyPrefixPadding()
        +
        • +
      + + + +
        +
      • +

        getKeySuffixPadding

        +
        public int getKeySuffixPadding()
        +
        • +
      + + + +
        +
      • +

        getDataPrefixPadding

        +
        public int getDataPrefixPadding()
        +
        • +
      + + + +
        +
      • +

        getDataSuffixPadding

        +
        public int getDataSuffixPadding()
        +
        • +
      + + + +
        +
      • +

        getConstantKeyPrefixLength

        +
        public int getConstantKeyPrefixLength()
        +
        Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same. Default implementation returns 0.
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyIndex

        +
        protected StorableIndex<S> getPrimaryKeyIndex()
        +
        Returns all key properties in the form of an index.
        +
        • +
      + + + +
        +
      • +

        gatherAllKeyProperties

        +
        protected OrderedProperty<S>[] gatherAllKeyProperties()
        +
        Returns all key properties as ordered properties, possibly with + unspecified directions.
        +
        • +
      + + + +
        +
      • +

        gatherAllDataProperties

        +
        protected StorableProperty<S>[] gatherAllDataProperties()
        +
        Returns all non-derived data properties for storable.
        +
        • +
      + + + +
        +
      • +

        gatherAllProperties

        +
        protected StorableProperty<S>[] gatherAllProperties()
        +
        Returns all non-join, non-derived properties for storable.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        extraDataEncoding

        +
        protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Second phase encoding, which does nothing by default.
        +
        Parameters:
        dataVar - local variable referencing a byte array with data
        prefix - prefix of byte array to preserve
        suffix - suffix of byte array to preserve
        +
        • +
      + + + +
        +
      • +

        extraDataDecoding

        +
        protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a,
+                     org.cojen.classfile.LocalVariable dataVar,
+                     int prefix,
+                     int suffix)
        +
        Second phase decoding, which does nothing by default.
        +
        Parameters:
        dataVar - local variable referencing a byte array with data
        +
        • +
      + + + +
        +
      • +

        loadPropertyValue

        +
        protected boolean loadPropertyValue(org.cojen.classfile.LocalVariable[] stashedProperties,
+                        java.lang.Boolean[] stashedFromInstances,
+                        org.cojen.classfile.CodeAssembler a,
+                        StorablePropertyInfo info,
+                        int ordinal,
+                        boolean useReadMethod,
+                        org.cojen.classfile.LocalVariable instanceVar,
+                        java.lang.Class<?> adapterInstanceClass,
+                        org.cojen.classfile.LocalVariable partialStartVar)
        +
        Generates code to load a property value onto the operand stack.
        +
        Parameters:
        info - info for property to load
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        useReadMethod - when true, access property by public read method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        +
        Returns:
        true if property was loaded from instance, false if loaded from + value array
        +
        • +
      + + + +
        +
      • +

        loadPropertyValue

        +
        protected boolean loadPropertyValue(org.cojen.classfile.CodeAssembler a,
+                        StorablePropertyInfo info,
+                        int ordinal,
+                        boolean useReadMethod,
+                        org.cojen.classfile.LocalVariable instanceVar,
+                        java.lang.Class<?> adapterInstanceClass,
+                        org.cojen.classfile.LocalVariable partialStartVar)
        +
        Generates code to load a property value onto the operand stack.
        +
        Parameters:
        info - info for property to load
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        useReadMethod - when true, access property by public read method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        partialStartVar - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.
        +
        Returns:
        true if property was loaded from instance, false if loaded from + value array
        +
        • +
      + + + +
        +
      • +

        pushRawSupport

        +
        protected void pushRawSupport(org.cojen.classfile.CodeAssembler a,
+                  org.cojen.classfile.LocalVariable instanceVar)
+                       throws SupportException
        +
        Generates code to push RawSupport instance to the stack. RawSupport is + available only in Storable instances. If instanceVar is an Object[], a + SupportException is thrown.
        +
        Parameters:
        instanceVar - Storable instance or array of property values. Null + is storable instance of "this".
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        pushDecodingInstanceVar

        +
        protected void pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler a,
+                           int ordinal,
+                           org.cojen.classfile.LocalVariable instanceVar)
        +
        Push decoding instanceVar to stack in preparation to calling + storePropertyValue.
        +
        Parameters:
        ordinal - zero-based property ordinal, used only if instanceVar + refers to an object array.
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.
        See Also:
        storePropertyValue
        +
        • +
      + + + +
        +
      • +

        storePropertyValue

        +
        protected void storePropertyValue(org.cojen.classfile.CodeAssembler a,
+                      StorablePropertyInfo info,
+                      boolean useWriteMethod,
+                      org.cojen.classfile.LocalVariable instanceVar,
+                      java.lang.Class<?> adapterInstanceClass)
        +
        Generates code to store a property value into an instance which is + already on the operand stack. If instance is an Object array, index into + array must also be on the operand stack.
        +
        Parameters:
        info - info for property to store to
        useWriteMethod - when true, set property by public write method + instead of protected field
        instanceVar - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.
        adapterInstanceClass - class containing static references to + adapter instances - defaults to instanceVar
        See Also:
        pushDecodingInstanceVar
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html new file mode 100644 index 0000000..c4a26ad --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html @@ -0,0 +1,250 @@ + + + + + + +GenericInstanceFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericInstanceFactory

+
+
+
+
    +
  • +
    +
    +
    public interface GenericInstanceFactory
    +
    Can be used with QuickConstructorGenerator + for instantiating generic storable instances.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html new file mode 100644 index 0000000..7250771 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html @@ -0,0 +1,324 @@ + + + + + + +GenericPropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericPropertyInfo

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    StorablePropertyInfo
    +
    +
    +
    +
    public interface GenericPropertyInfo
    +
    Minimal information required by GenericEncodingStrategy to encode + and decode a storable property.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.reflect.MethodgetFromStorageAdapter() +
      Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
      +
      java.lang.StringgetPropertyName() 
      org.cojen.classfile.TypeDescgetPropertyType() +
      Returns the user specified property type.
      +
      org.cojen.classfile.TypeDescgetStorageType() +
      Returns the storage supported type.
      +
      java.lang.reflect.MethodgetToStorageAdapter() +
      Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
      +
      booleanisDerived() 
      booleanisLob() 
      booleanisNullable() 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPropertyName

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

        getPropertyType

        +
        org.cojen.classfile.TypeDesc getPropertyType()
        +
        Returns the user specified property type.
        +
        • +
      + + + +
        +
      • +

        getStorageType

        +
        org.cojen.classfile.TypeDesc getStorageType()
        +
        Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.
        +
        • +
      + + + +
        +
      • +

        isNullable

        +
        boolean isNullable()
        +
        • +
      + + + +
        +
      • +

        isLob

        +
        boolean isLob()
        +
        • +
      + + + +
        +
      • +

        isDerived

        +
        boolean isDerived()
        +
        • +
      + + + +
        +
      • +

        getFromStorageAdapter

        +
        java.lang.reflect.Method getFromStorageAdapter()
        +
        Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
        +
        • +
      + + + +
        +
      • +

        getToStorageAdapter

        +
        java.lang.reflect.Method getToStorageAdapter()
        +
        Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..b765c1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html @@ -0,0 +1,222 @@ + + + + + + +GenericStorableCodec.Decoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericStorableCodec.Decoder<S extends Storable>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GenericStorableCodec<S extends Storable>
    +
    +
    +
    +
    public static interface GenericStorableCodec.Decoder<S extends Storable>
    +
    Used for decoding different generations of Storable.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + byte[] data) 
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Parameters:
        dest - storable to receive decoded properties
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..9201b11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,313 @@ + + + + + + +GenericStorableCodec.SearchKeyFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface GenericStorableCodec.SearchKeyFactory<S extends Storable>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GenericStorableCodec<S extends Storable>
    +
    +
    +
    +
    public static interface GenericStorableCodec.SearchKeyFactory<S extends Storable>
    +
    Creates custom raw search keys for Storable types. It is + intended for supporting queries and indexes.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      byte[]encodeSearchKey(java.lang.Object[] values) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Build a search key by supplying property values without a storable.
      +
      byte[]encodeSearchKey(S storable) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKey(S storable, + int rangeStart, + int rangeEnd) +
      Build a search key by extracting all the desired properties from the + given storable.
      +
      byte[]encodeSearchKeyPrefix() +
      Returns the search key for when there are no values.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(S storable,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by extracting all the desired properties from the + given storable.
        +
        Parameters:
        storable - extract a subset of properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKey

        +
        byte[] encodeSearchKey(java.lang.Object[] values,
+                     int rangeStart,
+                     int rangeEnd)
        +
        Build a search key by supplying property values without a storable.
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of properties used by this factory. It must not be less than the + difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of properties used by this factory.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodeSearchKeyPrefix

        +
        byte[] encodeSearchKeyPrefix()
        +
        Returns the search key for when there are no values. Returned value + may be null.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html new file mode 100644 index 0000000..77cb1f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html @@ -0,0 +1,702 @@ + + + + + + +GenericStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericStorableCodec<S extends Storable>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodec<S>
    +
    +
    +
    +
    public class GenericStorableCodec<S extends Storable>
+extends java.lang.Object
+implements StorableCodec<S>
    +
    Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    GenericStorableCodecFactory
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKeyPrefix() +
      Encode the primary key for when there are no values, but there may be a + prefix.
      +
      GenericStorableCodec.Decoder<S>getDecoder(int generation) +
      Deprecated.  +
      use direct decode method
      +
      +
      StorableIndex<S>getPrimaryKeyIndex() +
      Returns the sequence and directions of properties that make up the + primary key.
      +
      intgetPrimaryKeyPrefixLength() +
      Returns the number of prefix bytes in the primary key, which may be + zero.
      +
      GenericStorableCodec.SearchKeyFactory<S>getSearchKeyFactory(OrderedProperty<S>[] properties) +
      Returns a search key factory, which is useful for implementing indexes + and queries.
      +
      java.lang.Class<? extends S>getStorableClass() +
      Returns a concrete Storable implementation, which is fully + thread-safe.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable that code is generated for.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key) +
      Instantiate a Storable with no value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        public final java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable that code is generated for.
        +
        +
        Specified by:
        +
        getStorableType in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate()
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(byte[] key)
+                               throws FetchException
        +
        Instantiate a Storable with no value defined yet. The default RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. The default + RawSupport is supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        public S instantiate(RawSupport<S> support)
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        +
        Specified by:
        +
        instantiate in interface StorableCodec<S extends Storable>
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + + + + + + + + + + + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(S storable,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        storable - extract primary key properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        public byte[] encodePrimaryKey(java.lang.Object[] values,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Description copied from interface: StorableCodec
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        +
        Specified by:
        +
        encodePrimaryKey in interface StorableCodec<S extends Storable>
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKeyPrefix

        +
        public byte[] encodePrimaryKeyPrefix()
        +
        Description copied from interface: StorableCodec
        +
        Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.
        +
        +
        Specified by:
        +
        encodePrimaryKeyPrefix in interface StorableCodec<S extends Storable>
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getStorableClass

        +
        public java.lang.Class<? extends S> getStorableClass()
        +
        Returns a concrete Storable implementation, which is fully + thread-safe. It has two constructors defined: + + 
        + public <init>(Storage, RawSupport);
+
+ public <init>(Storage, RawSupport, byte[] key, byte[] value);
+
        + + Convenience methods are provided in this class to instantiate the + generated Storable.
        +
        • +
      + + + +
        +
      • +

        getSearchKeyFactory

        +
        public GenericStorableCodec.SearchKeyFactory<S> getSearchKeyFactory(OrderedProperty<S>[] properties)
        +
        Returns a search key factory, which is useful for implementing indexes + and queries.
        +
        Parameters:
        properties - properties to build the search key from
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        public void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Description copied from interface: StorableCodec
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        +
        Specified by:
        +
        decode in interface StorableCodec<S extends Storable>
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html new file mode 100644 index 0000000..4e2076c --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html @@ -0,0 +1,406 @@ + + + + + + +GenericStorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GenericStorableCodecFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    StorableCodecFactory
    +
    +
    +
    Direct Known Subclasses:
    +
    CompressedStorableCodecFactory
    +
    +
    +
    +
    public class GenericStorableCodecFactory
+extends java.lang.Object
+implements StorableCodecFactory
    +
    Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GenericStorableCodecFactory

        +
        public GenericStorableCodecFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

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

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        public <S extends Storable> GenericStorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                       StorableIndex pkIndex,
+                                                       boolean isMaster,
+                                                       Layout layout,
+                                                       RawSupport support)
+                                                     throws SupportException
        +
        +
        Specified by:
        +
        createCodec in interface StorableCodecFactory
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        +
        Throws:
        +
        SupportException
        +
        • +
      + + + +
        +
      • +

        createStrategy

        +
        protected <S extends Storable> GenericEncodingStrategy<S> createStrategy(java.lang.Class<S> type,
+                                                             StorableIndex<S> pkIndex,
+                                                             LayoutOptions options)
+                                                              throws SupportException
        +
        Override to return a different EncodingStrategy.
        +
        Parameters:
        type - type of Storable to generate code for
        pkIndex - specifies sequence and ordering of key properties (optional)
        options - additional layout options (optional)
        +
        Throws:
        +
        SupportException
        Since:
        +
        1.2.1
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html new file mode 100644 index 0000000..c00b111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html @@ -0,0 +1,294 @@ + + + + + + +GzipCompressor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GzipCompressor

+
+
+ +
+
    +
  • +
    +
    +
    public class GzipCompressor
+extends java.lang.Object
    +
    Raw-level data compression using gzip.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static byte[]compress(byte[] value, + int prefix) +
      Encodes into compressed form.
      +
      static byte[]decompress(byte[] value, + int prefix) +
      Decodes from compressed form.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        GzipCompressor

        +
        public GzipCompressor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compress

        +
        public static byte[] compress(byte[] value,
+              int prefix)
+                       throws SupportException
        +
        Encodes into compressed form.
        +
        Parameters:
        value - value to compress
        prefix - prefix of byte array to preserve
        +
        Returns:
        compressed value
        +
        Throws:
        +
        SupportException - thrown if compression failed
        +
        • +
      + + + +
        +
      • +

        decompress

        +
        public static byte[] decompress(byte[] value,
+                int prefix)
+                         throws CorruptEncodingException
        +
        Decodes from compressed form.
        +
        Parameters:
        value - value to decompress
        prefix - prefix of byte array to preserve
        +
        Returns:
        decompressed value
        +
        Throws:
        +
        CorruptEncodingException - thrown if value cannot be decompressed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/KeyDecoder.html b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html new file mode 100644 index 0000000..d46933a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html @@ -0,0 +1,936 @@ + + + + + + +KeyDecoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class KeyDecoder

+
+
+ +
+
    +
  • +
    +
    +
    public class KeyDecoder
+extends java.lang.Object
    +
    A very low-level class that decodes key components encoded by methods of + KeyEncoder.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    DataDecoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intdecode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes the given BigDecimal as originally encoded for ascending order.
      +
      static intdecode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes the given BigInteger as originally encoded for ascending order.
      +
      static intdecode(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array as originally encoded for ascending order.
      +
      static booleandecodeBooleanDesc(byte[] src, + int srcOffset) +
      Decodes a boolean from exactly 1 byte, as encoded for descending order.
      +
      static java.lang.BooleandecodeBooleanObjDesc(byte[] src, + int srcOffset) +
      Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
      +
      static bytedecodeByteDesc(byte[] src, + int srcOffset) +
      Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
      +
      static java.lang.BytedecodeByteObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.
      +
      static java.lang.CharacterdecodeCharacterObjDesc(byte[] src, + int srcOffset) +
      Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.
      +
      static chardecodeCharDesc(byte[] src, + int srcOffset) +
      Decodes a char from exactly 2 bytes, as encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) +
      Decodes the given BigDecimal as originally encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) +
      Decodes the given BigInteger as originally encoded for descending order.
      +
      static intdecodeDesc(byte[] src, + int srcOffset, + byte[][] valueRef) +
      Decodes the given byte array as originally encoded for descending order.
      +
      static doubledecodeDoubleDesc(byte[] src, + int srcOffset) +
      Decodes a double from exactly 8 bytes, as encoded for descending order.
      +
      static java.lang.DoubledecodeDoubleObjDesc(byte[] src, + int srcOffset) +
      Decodes a Double object from exactly 8 bytes.
      +
      static floatdecodeFloatDesc(byte[] src, + int srcOffset) +
      Decodes a float from exactly 4 bytes, as encoded for descending order.
      +
      static java.lang.FloatdecodeFloatObjDesc(byte[] src, + int srcOffset) +
      Decodes a Float object from exactly 4 bytes.
      +
      static intdecodeIntDesc(byte[] src, + int srcOffset) +
      Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
      +
      static java.lang.IntegerdecodeIntegerObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.
      +
      static longdecodeLongDesc(byte[] src, + int srcOffset) +
      Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
      +
      static java.lang.LongdecodeLongObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.
      +
      static shortdecodeShortDesc(byte[] src, + int srcOffset) +
      Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
      +
      static java.lang.ShortdecodeShortObjDesc(byte[] src, + int srcOffset) +
      Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.
      +
      static byte[]decodeSingleDesc(byte[] src) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
      +
      static byte[]decodeSingleDesc(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
      +
      static byte[]decodeSingleNullableDesc(byte[] src) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
      +
      static byte[]decodeSingleNullableDesc(byte[] src, + int prefixPadding, + int suffixPadding) +
      Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
      +
      static intdecodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array.
      +
      static intdecodeStringDesc(byte[] src, + int srcOffset, + java.lang.String[] valueRef) +
      Decodes an encoded string from the given byte array as originally + encoded for descending order.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        KeyDecoder

        +
        public KeyDecoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        decodeIntDesc

        +
        public static int decodeIntDesc(byte[] src,
+                int srcOffset)
+                         throws CorruptEncodingException
        +
        Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed integer value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeIntegerObjDesc

        +
        public static java.lang.Integer decodeIntegerObjDesc(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Integer object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongDesc

        +
        public static long decodeLongDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed long value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeLongObjDesc

        +
        public static java.lang.Long decodeLongObjDesc(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Long object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteDesc

        +
        public static byte decodeByteDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed byte value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeByteObjDesc

        +
        public static java.lang.Byte decodeByteObjDesc(byte[] src,
+                               int srcOffset)
+                                        throws CorruptEncodingException
        +
        Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Byte object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortDesc

        +
        public static short decodeShortDesc(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed short value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeShortObjDesc

        +
        public static java.lang.Short decodeShortObjDesc(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        signed Short object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharDesc

        +
        public static char decodeCharDesc(byte[] src,
+                  int srcOffset)
+                           throws CorruptEncodingException
        +
        Decodes a char from exactly 2 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        char value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeCharacterObjDesc

        +
        public static java.lang.Character decodeCharacterObjDesc(byte[] src,
+                                         int srcOffset)
+                                                  throws CorruptEncodingException
        +
        Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Character object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanDesc

        +
        public static boolean decodeBooleanDesc(byte[] src,
+                        int srcOffset)
+                                 throws CorruptEncodingException
        +
        Decodes a boolean from exactly 1 byte, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        boolean value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeBooleanObjDesc

        +
        public static java.lang.Boolean decodeBooleanObjDesc(byte[] src,
+                                     int srcOffset)
+                                              throws CorruptEncodingException
        +
        Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Boolean object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatDesc

        +
        public static float decodeFloatDesc(byte[] src,
+                    int srcOffset)
+                             throws CorruptEncodingException
        +
        Decodes a float from exactly 4 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        float value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeFloatObjDesc

        +
        public static java.lang.Float decodeFloatObjDesc(byte[] src,
+                                 int srcOffset)
+                                          throws CorruptEncodingException
        +
        Decodes a Float object from exactly 4 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Float object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleDesc

        +
        public static double decodeDoubleDesc(byte[] src,
+                      int srcOffset)
+                               throws CorruptEncodingException
        +
        Decodes a double from exactly 8 bytes, as encoded for descending order.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        double value
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decodeDoubleObjDesc

        +
        public static java.lang.Double decodeDoubleObjDesc(byte[] src,
+                                   int srcOffset)
+                                            throws CorruptEncodingException
        +
        Decodes a Double object from exactly 8 bytes.
        +
        Parameters:
        src - source of encoded bytes
        srcOffset - offset into source array
        +
        Returns:
        Double object or null
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigInteger[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given BigInteger as originally encoded for ascending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             java.math.BigInteger[] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given BigInteger as originally encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigInteger is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         java.math.BigDecimal[] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given BigDecimal as originally encoded for ascending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             java.math.BigDecimal[] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given BigDecimal as originally encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded BigDecimal is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        decode

        +
        public static int decode(byte[] src,
+         int srcOffset,
+         byte[][] valueRef)
+                  throws CorruptEncodingException
        +
        Decodes the given byte array as originally encoded for ascending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeDesc

        +
        public static int decodeDesc(byte[] src,
+             int srcOffset,
+             byte[][] valueRef)
+                      throws CorruptEncodingException
        +
        Decodes the given byte array as originally encoded for descending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded byte array is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeString

        +
        public static int decodeString(byte[] src,
+               int srcOffset,
+               java.lang.String[] valueRef)
+                        throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + +
        +
      • +

        decodeStringDesc

        +
        public static int decodeStringDesc(byte[] src,
+                   int srcOffset,
+                   java.lang.String[] valueRef)
+                            throws CorruptEncodingException
        +
        Decodes an encoded string from the given byte array as originally + encoded for descending order.
        +
        Parameters:
        src - source of encoded data
        srcOffset - offset into encoded data
        valueRef - decoded string is stored in element 0, which may be null
        +
        Returns:
        amount of bytes read from source
        +
        Throws:
        +
        CorruptEncodingException - if source data is corrupt
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleDesc

        +
        public static byte[] decodeSingleDesc(byte[] src,
+                      int prefixPadding,
+                      int suffixPadding)
+                               throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]). Always returns a new byte array instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      + + + + + + + +
        +
      • +

        decodeSingleNullableDesc

        +
        public static byte[] decodeSingleNullableDesc(byte[] src,
+                              int prefixPadding,
+                              int suffixPadding)
+                                       throws CorruptEncodingException
        +
        Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]). Always returns a new byte array + instance.
        +
        Parameters:
        prefixPadding - amount of extra bytes to skip from start of encoded byte array
        suffixPadding - amount of extra bytes to skip at end of encoded byte array
        +
        Throws:
        +
        CorruptEncodingException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/KeyEncoder.html b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html new file mode 100644 index 0000000..12b1a29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html @@ -0,0 +1,1086 @@ + + + + + + +KeyEncoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class KeyEncoder

+
+
+ +
+
    +
  • +
    +
    +
    public class KeyEncoder
+extends java.lang.Object
    +
    A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys. If the data to encode is of a variable size, then + it is written in base-32768, using only byte values 32..223. This allows + special values such as nulls and terminators to be unambiguously + encoded. Terminators for variable data can be encoded using 1 for ascending + order and 254 for descending order. Nulls can be encoded as 255 for high + ordering and 0 for low ordering.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    KeyDecoder, +DataEncoder
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static intcalculateEncodedLength(java.math.BigDecimal value) +
      Returns the amount of bytes required to encode a BigDecimal.
      +
      static intcalculateEncodedLength(java.math.BigInteger value) +
      Returns the amount of bytes required to encode a BigInteger.
      +
      static intcalculateEncodedLength(byte[] value) +
      Returns the amount of bytes required to encode a byte array of the given + length.
      +
      static intcalculateEncodedLength(byte[] value, + int valueOffset, + int valueLength) +
      Returns the amount of bytes required to encode the given byte array.
      +
      static intcalculateEncodedStringLength(java.lang.String value) +
      Returns the amount of bytes required to encode the given String.
      +
      static intencode(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of + bytes.
      +
      static intencode(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of + bytes.
      +
      static intencode(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes.
      +
      static intencode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes.
      +
      static intencode(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes.
      +
      static intencodeDesc(java.math.BigDecimal value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigDecimal into a variable amount of bytes + for descending order.
      +
      static intencodeDesc(java.math.BigInteger value, + byte[] dst, + int dstOffset) +
      Encodes the given optional BigInteger into a variable amount of bytes + for descending order.
      +
      static voidencodeDesc(boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given boolean into exactly 1 byte for descending order.
      +
      static voidencodeDesc(java.lang.Boolean value, + byte[] dst, + int dstOffset) +
      Encodes the given Boolean object into exactly 1 byte for descending + order.
      +
      static intencodeDesc(byte[] value, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
      +
      static intencodeDesc(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset) +
      Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.
      +
      static voidencodeDesc(byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed byte into exactly 1 byte for descending order.
      +
      static intencodeDesc(java.lang.Byte value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order.
      +
      static intencodeDesc(java.lang.Character value, + byte[] dst, + int dstOffset) +
      Encodes the given Character object into exactly 1 or 3 bytes for + descending order.
      +
      static voidencodeDesc(char value, + byte[] dst, + int dstOffset) +
      Encodes the given character into exactly 2 bytes for descending order.
      +
      static voidencodeDesc(double value, + byte[] dst, + int dstOffset) +
      Encodes the given double into exactly 8 bytes for descending order.
      +
      static voidencodeDesc(java.lang.Double value, + byte[] dst, + int dstOffset) +
      Encodes the given Double object into exactly 8 bytes for descending + order.
      +
      static voidencodeDesc(float value, + byte[] dst, + int dstOffset) +
      Encodes the given float into exactly 4 bytes for descending order.
      +
      static voidencodeDesc(java.lang.Float value, + byte[] dst, + int dstOffset) +
      Encodes the given Float object into exactly 4 bytes for descending + order.
      +
      static voidencodeDesc(int value, + byte[] dst, + int dstOffset) +
      Encodes the given signed integer into exactly 4 bytes for descending + order.
      +
      static intencodeDesc(java.lang.Integer value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order.
      +
      static voidencodeDesc(long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed long into exactly 8 bytes for descending order.
      +
      static intencodeDesc(java.lang.Long value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order.
      +
      static voidencodeDesc(short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed short into exactly 2 bytes for descending + order.
      +
      static intencodeDesc(java.lang.Short value, + byte[] dst, + int dstOffset) +
      Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order.
      +
      static intencodeDesc(java.lang.String value, + byte[] dst, + int dstOffset) +
      Encodes the given optional String into a variable amount of bytes for + descending order.
      +
      static byte[]encodeSingleDesc(byte[] value) +
      Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleDesc(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleNullableDesc(byte[] value) +
      Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
      +
      static byte[]encodeSingleNullableDesc(byte[] value, + int prefixPadding, + int suffixPadding) +
      Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        KeyEncoder

        +
        public KeyEncoder()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(int value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed integer into exactly 4 bytes for descending + order.
        +
        Parameters:
        value - signed integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Integer value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order. If the Integer object is never expected to be null, + consider encoding as an int primitive.
        +
        Parameters:
        value - optional signed Integer value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(long value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed long into exactly 8 bytes for descending order.
        +
        Parameters:
        value - signed long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Long value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order. If the Long object is never expected to be null, + consider encoding as a long primitive.
        +
        Parameters:
        value - optional signed Long value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(byte value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed byte into exactly 1 byte for descending order.
        +
        Parameters:
        value - signed byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Byte value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order. If the Byte object is never expected to be null, + consider encoding as a byte primitive.
        +
        Parameters:
        value - optional signed Byte value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(short value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given signed short into exactly 2 bytes for descending + order.
        +
        Parameters:
        value - signed short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Short value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order. If the Short object is never expected to be null, + consider encoding as a short primitive.
        +
        Parameters:
        value - optional signed Short value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(char value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given character into exactly 2 bytes for descending order.
        +
        Parameters:
        value - character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.Character value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given Character object into exactly 1 or 3 bytes for + descending order. If the Character object is never expected to be null, + consider encoding as a char primitive.
        +
        Parameters:
        value - optional Character value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(boolean value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given boolean into exactly 1 byte for descending order.
        +
        Parameters:
        value - boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Boolean value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Boolean object into exactly 1 byte for descending + order.
        +
        Parameters:
        value - optional Boolean value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(float value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given float into exactly 4 bytes for descending order.
        +
        Parameters:
        value - float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Float value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Float object into exactly 4 bytes for descending + order. A non-canonical NaN value is used to represent null.
        +
        Parameters:
        value - optional Float value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(double value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given double into exactly 8 bytes for descending order.
        +
        Parameters:
        value - double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static void encodeDesc(java.lang.Double value,
+              byte[] dst,
+              int dstOffset)
        +
        Encodes the given Double object into exactly 8 bytes for descending + order. A non-canonical NaN value is used to represent null.
        +
        Parameters:
        value - optional Double value to encode
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigInteger value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.math.BigInteger value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional BigInteger into a variable amount of bytes + for descending order. If the BigInteger is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigInteger value)
        +
        Returns the amount of bytes required to encode a BigInteger.
        +
        Parameters:
        value - BigInteger value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.math.BigDecimal value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.math.BigDecimal value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional BigDecimal into a variable amount of bytes + for descending order. If the BigDecimal is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(java.math.BigDecimal value)
        +
        Returns the amount of bytes required to encode a BigDecimal. + +

        Note: It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.

        +
        Parameters:
        value - BigDecimal value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(byte[] value,
+         int valueOffset,
+         int valueLength,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(byte[] value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(byte[] value,
+             int valueOffset,
+             int valueLength,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value)
        +
        Returns the amount of bytes required to encode a byte array of the given + length.
        +
        Parameters:
        value - byte array value to encode, may be null
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        calculateEncodedLength

        +
        public static int calculateEncodedLength(byte[] value,
+                         int valueOffset,
+                         int valueLength)
        +
        Returns the amount of bytes required to encode the given byte array.
        +
        Parameters:
        value - byte array value to encode, may be null
        valueOffset - offset into byte array
        valueLength - length of data in byte array
        +
        Returns:
        amount of bytes needed to encode
        +
        • +
      + + + +
        +
      • +

        encode

        +
        public static int encode(java.lang.String value,
+         byte[] dst,
+         int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        encodeDesc

        +
        public static int encodeDesc(java.lang.String value,
+             byte[] dst,
+             int dstOffset)
        +
        Encodes the given optional String into a variable amount of bytes for + descending order. The amount written can be determined by calling + calculateEncodedStringLength. +

        + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.

        +
        Parameters:
        value - String value to encode, may be null
        dst - destination for encoded bytes
        dstOffset - offset into destination array
        +
        Returns:
        amount of bytes written
        +
        • +
      + + + +
        +
      • +

        calculateEncodedStringLength

        +
        public static int calculateEncodedStringLength(java.lang.String value)
        +
        Returns the amount of bytes required to encode the given String.
        +
        Parameters:
        value - String to encode, may be null
        +
        • +
      + + + +
        +
      • +

        encodeSingleDesc

        +
        public static byte[] encodeSingleDesc(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length is zero.
        +
        • +
      + + + +
        +
      • +

        encodeSingleDesc

        +
        public static byte[] encodeSingleDesc(byte[] value,
+                      int prefixPadding,
+                      int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length and padding lengths are + zero.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullableDesc

        +
        public static byte[] encodeSingleNullableDesc(byte[] value)
        +
        Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
        +
        • +
      + + + +
        +
      • +

        encodeSingleNullableDesc

        +
        public static byte[] encodeSingleNullableDesc(byte[] value,
+                              int prefixPadding,
+                              int suffixPadding)
        +
        Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.
        +
        Parameters:
        prefixPadding - amount of extra bytes to allocate at start of encoded byte array
        suffixPadding - amount of extra bytes to allocate at end of encoded byte array
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawCursor.html b/apidocs/com/amazon/carbonado/raw/RawCursor.html new file mode 100644 index 0000000..b11229d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawCursor.html @@ -0,0 +1,854 @@ + + + + + + +RawCursor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawCursor<S>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Cursor<S>
    +
    +
    +
    +
    public abstract class RawCursor<S>
+extends AbstractCursor<S>
    +
    Abstract Cursor implementation for a repository that manipulates raw bytes.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected java.util.concurrent.locks.LockmLock +
      Lock object, as passed into the constructor
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected RawCursor(java.util.concurrent.locks.Lock lock, + byte[] startBound, + boolean inclusiveStart, + byte[] endBound, + boolean inclusiveEnd, + int maxPrefix, + boolean reverse) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Call close to release any resources being held by this cursor.
      +
      protected intcompareKeysPartially(byte[] key1, + byte[] key2) +
      Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.
      +
      protected voiddisableKeyAndValue() +
      An optimization hint which disables key and value acquisition.
      +
      protected voiddisableValue() +
      An optimization hint which disables just value acquisition.
      +
      protected voidenableKeyAndValue() +
      Enable key and value acquisition again, after they have been + disabled.
      +
      protected abstract byte[]getCurrentKey() +
      Returns the contents of the current key being referenced, or null + otherwise.
      +
      protected abstract byte[]getCurrentValue() +
      Returns the contents of the current value being referenced, or null + otherwise.
      +
      protected voidhandleNoSuchElement() +
      Called right before throwing NoSuchElementException.
      +
      booleanhasNext() +
      Returns true if this cursor has more elements.
      +
      protected abstract SinstantiateCurrent() +
      Returns a new Storable instance for the currently referenced entry.
      +
      Snext() +
      Returns the next element from this cursor.
      +
      protected abstract voidrelease() +
      Release any internal resources, called when closed.
      +
      intskipNext(int amount) +
      Skips forward by the specified amount of elements, returning the actual + amount skipped.
      +
      protected abstract booleantoFirst() +
      Move the cursor to the first available entry.
      +
      protected abstract booleantoFirst(byte[] key) +
      Move the cursor to the first available entry at or after the given + key.
      +
      protected abstract booleantoLast() +
      Move the cursor to the last available entry.
      +
      protected abstract booleantoLast(byte[] key) +
      Move the cursor to the last available entry at or before the given + key.
      +
      protected abstract booleantoNext() +
      Move the cursor to the next available entry, returning false if none.
      +
      protected inttoNext(int amount) +
      Move the cursor to the next available entry, incrementing by the amount + given.
      +
      protected booleantoNextKey() +
      Move the cursor to the next unique key, returning false if none.
      +
      protected abstract booleantoPrevious() +
      Move the cursor to the previous available entry, returning false if + none.
      +
      protected inttoPrevious(int amount) +
      Move the cursor to the previous available entry, decrementing by the + amount given.
      +
      protected booleantoPreviousKey() +
      Move the cursor to the previous unique key, returning false if none.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        mLock

        +
        protected final java.util.concurrent.locks.Lock mLock
        +
        Lock object, as passed into the constructor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RawCursor

        +
        protected RawCursor(java.util.concurrent.locks.Lock lock,
+         byte[] startBound,
+         boolean inclusiveStart,
+         byte[] endBound,
+         boolean inclusiveEnd,
+         int maxPrefix,
+         boolean reverse)
        +
        Parameters:
        lock - operations lock on this object
        startBound - specify the starting key for the cursor, or null if first
        inclusiveStart - true if start bound is inclusive
        endBound - specify the ending key for the cursor, or null if last
        inclusiveEnd - true if end bound is inclusive
        maxPrefix - maximum expected common initial bytes in start and end bound
        reverse - when true, iteration is reversed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if any bound is null but is not inclusive
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws FetchException
        +
        Description copied from interface: Cursor
        +
        Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
+                throws FetchException
        +
        Description copied from interface: Cursor
        +
        Returns true if this cursor has more elements. In other words, returns + true if next would return an element rather than throwing + an exception.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        next

        +
        public S next()
+       throws FetchException,
+              java.util.NoSuchElementException
        +
        Description copied from interface: Cursor
        +
        Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        java.util.NoSuchElementException - if the cursor has no next element.
        +
        • +
      + + + +
        +
      • +

        skipNext

        +
        public int skipNext(int amount)
+             throws FetchException
        +
        Description copied from interface: Cursor
        +
        Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.
        +
        +
        Specified by:
        +
        skipNext in interface Cursor<S>
        +
        Overrides:
        +
        skipNext in class AbstractCursor<S>
        +
        Parameters:
        amount - maximum amount of elements to skip
        +
        Returns:
        actual amount skipped
        +
        Throws:
        +
        FetchException - if storage layer throws an exception
        +
        • +
      + + + +
        +
      • +

        release

        +
        protected abstract void release()
+                         throws FetchException
        +
        Release any internal resources, called when closed.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getCurrentKey

        +
        protected abstract byte[] getCurrentKey()
+                                 throws FetchException
        +
        Returns the contents of the current key being referenced, or null + otherwise. Caller is responsible for making a copy of the key. The array + must not be modified concurrently. + +

        If cursor is not opened, null must be returned.

        +
        Returns:
        currently referenced key bytes or null if no current
        +
        Throws:
        +
        java.lang.IllegalStateException - if key is disabled
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getCurrentValue

        +
        protected abstract byte[] getCurrentValue()
+                                   throws FetchException
        +
        Returns the contents of the current value being referenced, or null + otherwise. Caller is responsible for making a copy of the value. The + array must not be modified concurrently. + +

        If cursor is not opened, null must be returned.

        +
        Returns:
        currently referenced value bytes or null if no current
        +
        Throws:
        +
        java.lang.IllegalStateException - if value is disabled
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        disableKeyAndValue

        +
        protected void disableKeyAndValue()
        +
        An optimization hint which disables key and value acquisition. The + default implementation of this method does nothing.
        +
        • +
      + + + +
        +
      • +

        disableValue

        +
        protected void disableValue()
        +
        An optimization hint which disables just value acquisition. The default + implementation of this method does nothing.
        +
        • +
      + + + +
        +
      • +

        enableKeyAndValue

        +
        protected void enableKeyAndValue()
+                          throws FetchException
        +
        Enable key and value acquisition again, after they have been + disabled. Calling this method forces the key and value to be + re-acquired, if they had been disabled. Key and value acquisition must + be enabled by default. The default implementation of this method does + nothing.
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        instantiateCurrent

        +
        protected abstract S instantiateCurrent()
+                                 throws FetchException
        +
        Returns a new Storable instance for the currently referenced entry.
        +
        Returns:
        new Storable instance, never null
        +
        Throws:
        +
        java.lang.IllegalStateException - if no current entry to instantiate
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFirst

        +
        protected abstract boolean toFirst()
+                            throws FetchException
        +
        Move the cursor to the first available entry. If false is returned, the + cursor must be positioned before the first available entry.
        +
        Returns:
        true if first entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toFirst

        +
        protected abstract boolean toFirst(byte[] key)
+                            throws FetchException
        +
        Move the cursor to the first available entry at or after the given + key. If false is returned, the cursor must be positioned before the + first available entry. Caller is responsible for preserving contents of + array.
        +
        Parameters:
        key - key to search for
        +
        Returns:
        true if first entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toLast

        +
        protected abstract boolean toLast()
+                           throws FetchException
        +
        Move the cursor to the last available entry. If false is returned, the + cursor must be positioned after the last available entry.
        +
        Returns:
        true if last entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toLast

        +
        protected abstract boolean toLast(byte[] key)
+                           throws FetchException
        +
        Move the cursor to the last available entry at or before the given + key. If false is returned, the cursor must be positioned after the last + available entry. Caller is responsible for preserving contents of array.
        +
        Parameters:
        key - key to search for
        +
        Returns:
        true if last entry exists and is now current
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNext

        +
        protected abstract boolean toNext()
+                           throws FetchException
        +
        Move the cursor to the next available entry, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry.
        +
        Returns:
        true if moved to next entry
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNext

        +
        protected int toNext(int amount)
+              throws FetchException
        +
        Move the cursor to the next available entry, incrementing by the amount + given. The actual amount incremented is returned. If the amount is less + then requested, the cursor must be positioned after the last available + entry. Subclasses may wish to override this method with a faster + implementation. + +

        Calling to toNext(1) is equivalent to calling toNext().

        +
        Parameters:
        amount - positive amount to advance
        +
        Returns:
        actual amount advanced
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toNextKey

        +
        protected boolean toNextKey()
+                     throws FetchException
        +
        Move the cursor to the next unique key, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry. Subclasses may wish to override this method with a + faster implementation.
        +
        Returns:
        true if moved to next unique key
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPrevious

        +
        protected abstract boolean toPrevious()
+                               throws FetchException
        +
        Move the cursor to the previous available entry, returning false if + none. If false is returned, the cursor must be positioned before the + first available entry.
        +
        Returns:
        true if moved to previous entry
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPrevious

        +
        protected int toPrevious(int amount)
+                  throws FetchException
        +
        Move the cursor to the previous available entry, decrementing by the + amount given. The actual amount decremented is returned. If the amount + is less then requested, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation. + +

        Calling to toPrevious(1) is equivalent to calling toPrevious().

        +
        Parameters:
        amount - positive amount to retreat
        +
        Returns:
        actual amount retreated
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        toPreviousKey

        +
        protected boolean toPreviousKey()
+                         throws FetchException
        +
        Move the cursor to the previous unique key, returning false if none. If + false is returned, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation.
        +
        Returns:
        true if moved to previous unique key
        +
        Throws:
        +
        java.lang.IllegalStateException - if cursor is not opened
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        compareKeysPartially

        +
        protected int compareKeysPartially(byte[] key1,
+                       byte[] key2)
        +
        Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.
        +
        • +
      + + + +
        +
      • +

        handleNoSuchElement

        +
        protected void handleNoSuchElement()
+                            throws FetchException
        +
        Called right before throwing NoSuchElementException. Subclasses may + override to do special checks or throw a different exception.
        +
        Throws:
        +
        FetchException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html new file mode 100644 index 0000000..f4fe114 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html @@ -0,0 +1,365 @@ + + + + + + +RawStorableGenerator (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawStorableGenerator

+
+
+ +
+
    +
  • +
    +
    +
    public class RawStorableGenerator
+extends java.lang.Object
    +
    Generates and caches abstract implementations of Storable types + which are encoded and decoded in a raw format. The generated abstract + classes extend those created by MasterStorableGenerator.
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    GenericStorableCodec, +RawSupport
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringDECODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringDECODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_DATA_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      static java.lang.StringENCODE_KEY_METHOD_NAME +
      Name of protected abstract method in generated storable
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static <S extends Storable> 
      java.lang.Class<? extends S>      		getAbstractClass(java.lang.Class<S> type, + boolean isMaster) +
      Returns an abstract implementation of the given Storable type, which is + fully thread-safe.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        ENCODE_KEY_METHOD_NAME

        +
        public static final java.lang.String ENCODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_KEY_METHOD_NAME

        +
        public static final java.lang.String DECODE_KEY_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        ENCODE_DATA_METHOD_NAME

        +
        public static final java.lang.String ENCODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      + + + +
        +
      • +

        DECODE_DATA_METHOD_NAME

        +
        public static final java.lang.String DECODE_DATA_METHOD_NAME
        +
        Name of protected abstract method in generated storable
        +
        See Also:
        Constant Field Values
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbstractClass

        +
        public static <S extends Storable> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type,
+                                                                 boolean isMaster)
+                                                                      throws SupportException,
+                                                                             java.lang.IllegalArgumentException
        +
        Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. Three constructors are defined for the + abstract implementation: + + 
        + public <init>(RawSupport);
+
+ public <init>(RawSupport, byte[] key);
+
+ public <init>(RawSupport, byte[] key, byte[] value);
+
        + +

        Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + 

        + // Encode the primary key of this storable.
+ protected abstract byte[] encodeKey();
+
+ // Encode all properties of this storable excluding the primary key.
+ protected abstract byte[] encodeData();
+
+ // Decode the primary key into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeKey(byte[]);
+
+ // Decode the data into properties of this storable.
+ // Note: this method is also invoked by the three argument constructor.
+ protected abstract void decodeData(byte[]);
+
        +
        Parameters:
        isMaster - when true, version properties, sequences, and triggers are managed
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if type is null
        +
        SupportException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawSupport.html b/apidocs/com/amazon/carbonado/raw/RawSupport.html new file mode 100644 index 0000000..b8aa31a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawSupport.html @@ -0,0 +1,452 @@ + + + + + + +RawSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface RawSupport<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      BlobgetBlob(S storable, + java.lang.String name, + long locator) +
      Returns the Blob for the given locator, returning null if not found.
      +
      ClobgetClob(S storable, + java.lang.String name, + long locator) +
      Returns the Clob for the given locator, returning null if not found.
      +
      longgetLocator(Blob blob) +
      Returns the locator for the given Blob, returning zero if null.
      +
      longgetLocator(Clob clob) +
      Returns the locator for the given Clob, returning zero if null.
      +
      voidstore(S storable, + byte[] key, + byte[] value) +
      Try to store the entry referenced by the given key with the given + value.
      +
      booleantryDelete(S storable, + byte[] key) +
      Try to delete the entry referenced by the given key.
      +
      booleantryInsert(S storable, + byte[] key, + byte[] value) +
      Try to insert the entry referenced by the given key with the given + value.
      +
      byte[]tryLoad(S storable, + byte[] key) +
      Try to load the entry referenced by the given key, but return null + if not found.
      +
      + + + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        tryLoad

        +
        byte[] tryLoad(S storable,
+             byte[] key)
+               throws FetchException
        +
        Try to load the entry referenced by the given key, but return null + if not found.
        +
        Parameters:
        storable - user storable which will have its properties set
        key - non-null key to search for
        +
        Returns:
        non-null value that was found, or null if not found
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + + + +
        +
      • +

        tryInsert

        +
        boolean tryInsert(S storable,
+                byte[] key,
+                byte[] value)
+                  throws PersistException
        +
        Try to insert the entry referenced by the given key with the given + value.
        +
        Parameters:
        storable - user storable that key and value were derived from
        key - non-null key to insert
        value - non-null value to insert
        +
        Returns:
        false if unique constraint prevents insert
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        store

        +
        void store(S storable,
+         byte[] key,
+         byte[] value)
+           throws PersistException
        +
        Try to store the entry referenced by the given key with the given + value. If the entry does not exist, insert it. Otherwise, update it.
        +
        Parameters:
        storable - user storable that key and value were derived from
        key - non-null key to store
        value - non-null value to store
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        tryDelete

        +
        boolean tryDelete(S storable,
+                byte[] key)
+                  throws PersistException
        +
        Try to delete the entry referenced by the given key.
        +
        Parameters:
        storable - user supplied storable object
        key - non-null key to delete
        +
        Returns:
        true if entry existed and is now deleted
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        getBlob

        +
        Blob getBlob(S storable,
+           java.lang.String name,
+           long locator)
+             throws FetchException
        +
        Returns the Blob for the given locator, returning null if not found.
        +
        Parameters:
        storable - storable that contains Blob
        name - name of Blob property
        locator - Blob locator
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        long getLocator(Blob blob)
+                throws PersistException
        +
        Returns the locator for the given Blob, returning zero if null.
        +
        Throws:
        +
        PersistException - if blob is unrecognized
        +
        • +
      + + + + + +
        +
      • +

        getClob

        +
        Clob getClob(S storable,
+           java.lang.String name,
+           long locator)
+             throws FetchException
        +
        Returns the Clob for the given locator, returning null if not found.
        +
        Parameters:
        storable - storable that contains Blob
        name - name of Clob property
        locator - Clob locator
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getLocator

        +
        long getLocator(Clob clob)
+                throws PersistException
        +
        Returns the locator for the given Clob, returning zero if null.
        +
        Throws:
        +
        PersistException - if blob is unrecognized
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        Since:
        +
        1.2.1
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/RawUtil.html b/apidocs/com/amazon/carbonado/raw/RawUtil.html new file mode 100644 index 0000000..2ff4fd1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawUtil.html @@ -0,0 +1,286 @@ + + + + + + +RawUtil (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class RawUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class RawUtil
+extends java.lang.Object
    +
    Utilities for manipulating binary data.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static booleandecrement(byte[] value) +
      Subtracts one from an unsigned integer, represented as a byte array.
      +
      static booleanincrement(byte[] value) +
      Adds one to an unsigned integer, represented as a byte array.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        RawUtil

        +
        public RawUtil()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        increment

        +
        public static boolean increment(byte[] value)
        +
        Adds one to an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0x00, 0x00, 0x00...
        +
        Parameters:
        value - unsigned integer to increment
        +
        Returns:
        false if overflowed
        +
        • +
      + + + +
        +
      • +

        decrement

        +
        public static boolean decrement(byte[] value)
        +
        Subtracts one from an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0xff, 0xff, 0xff...
        +
        Parameters:
        value - unsigned integer to decrement
        +
        Returns:
        false if overflowed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/StorableCodec.html new file mode 100644 index 0000000..f647b5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodec.html @@ -0,0 +1,529 @@ + + + + + + +StorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface StorableCodec<S extends Storable>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddecode(S dest, + int generation, + byte[] data) +
      Used for decoding different generations of Storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKey(S storable, + int rangeStart, + int rangeEnd) +
      Encode a key by extracting all the primary key properties from the given + storable.
      +
      byte[]encodePrimaryKeyPrefix() +
      Encode the primary key for when there are no values, but there may be a + prefix.
      +
      StorableIndex<S>getPrimaryKeyIndex() +
      Returns the sequence and directions of properties that make up the + primary key.
      +
      intgetPrimaryKeyPrefixLength() +
      Returns the number of prefix bytes in the primary key, which may be + zero.
      +
      java.lang.Class<S>getStorableType() +
      Returns the type of Storable produced by this codec.
      +
      RawSupport<S>getSupport() +
      Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
      +
      Sinstantiate() +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(byte[] key) +
      Instantiate a Storable with no value defined yet.
      +
      Sinstantiate(byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      Sinstantiate(RawSupport<S> support) +
      Instantiate a Storable with no key or value defined yet.
      +
      Sinstantiate(RawSupport<S> support, + byte[] key, + byte[] value) +
      Instantiate a Storable with a specific key and value.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStorableType

        +
        java.lang.Class<S> getStorableType()
        +
        Returns the type of Storable produced by this codec.
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate()
        +
        Instantiate a Storable with no key or value defined yet. The default + RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(byte[] key)
+                               throws FetchException
        +
        Instantiate a Storable with no value defined yet. The default RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. The default + RawSupport is supplied to the instance.
        +
        Throws:
        +
        java.lang.IllegalStateException - if no default support exists
        +
        FetchException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(RawSupport<S> support)
        +
        Instantiate a Storable with no key or value defined yet. Any + RawSupport can be supplied to the instance.
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        • +
      + + + +
        +
      • +

        instantiate

        +
        S instantiate(RawSupport<S> support,
+            byte[] key,
+            byte[] value)
+                               throws FetchException
        +
        Instantiate a Storable with a specific key and value. Any + RawSupport can be supplied to the instance.
        +
        Parameters:
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        FetchException
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyIndex

        +
        StorableIndex<S> getPrimaryKeyIndex()
        +
        Returns the sequence and directions of properties that make up the + primary key.
        +
        • +
      + + + +
        +
      • +

        getPrimaryKeyPrefixLength

        +
        int getPrimaryKeyPrefixLength()
        +
        Returns the number of prefix bytes in the primary key, which may be + zero.
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(S storable)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        storable - extract primary key properties from this instance
        +
        Returns:
        raw search key
        +
        • +
      + + + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(S storable,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        storable - extract primary key properties from this instance
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(java.lang.Object[] values)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        values - values to build into a key. It must be long enough to + accommodate all primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKey

        +
        byte[] encodePrimaryKey(java.lang.Object[] values,
+                      int rangeStart,
+                      int rangeEnd)
        +
        Encode a key by extracting all the primary key properties from the given + storable.
        +
        Parameters:
        values - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.
        rangeStart - index of first property to use. Its value must be less + than the count of primary key properties.
        rangeEnd - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.
        +
        Returns:
        raw search key
        +
        • +
      + + + +
        +
      • +

        encodePrimaryKeyPrefix

        +
        byte[] encodePrimaryKeyPrefix()
        +
        Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.
        +
        • +
      + + + + + +
        +
      • +

        decode

        +
        void decode(S dest,
+          int generation,
+          byte[] data)
+            throws CorruptEncodingException
        +
        Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.
        +
        Parameters:
        dest - storable to receive decoded properties
        generation - storable layout generation number
        data - decoded into properties, some of which may be dropped if + destination storable doesn't have it
        +
        Throws:
        +
        CorruptEncodingException - if generation is unknown or if data cannot be decoded
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        getSupport

        +
        RawSupport<S> getSupport()
        +
        Returns the default RawSupport object that is supplied to + Storable instances produced by this codec.
        +
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html new file mode 100644 index 0000000..9a19a87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html @@ -0,0 +1,291 @@ + + + + + + +StorableCodecFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Interface StorableCodecFactory

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

      Method Detail

      + + + +
        +
      • +

        getStorageName

        +
        java.lang.String getStorageName(java.lang.Class<? extends Storable> type)
+                                throws SupportException
        +
        Returns the preferred storage/database name for the given type. Return + null to let repository decide.
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        getLayoutOptions

        +
        LayoutOptions getLayoutOptions(java.lang.Class<? extends Storable> type)
        +
        Optionally return additional information regarding storable encoding.
        +
        Since:
        +
        1.2.1
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        +
        Throws:
        +
        SupportException - if type is not supported
        +
        • +
      + + + +
        +
      • +

        createCodec

        +
        <S extends Storable> StorableCodec<S> createCodec(java.lang.Class<S> type,
+                                                StorableIndex pkIndex,
+                                                boolean isMaster,
+                                                Layout layout,
+                                                RawSupport support)
+                                              throws SupportException
        +
        Parameters:
        type - type of storable to create codec for
        pkIndex - suggested index for primary key (optional)
        isMaster - when true, version properties and sequences are managed
        layout - when non-null, attempt to encode a storable layout + generation value in each storable
        support - binds generated storable with a storage layer
        +
        Throws:
        +
        SupportException - if type is not supported
        Since:
        +
        1.2
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html new file mode 100644 index 0000000..02749bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html @@ -0,0 +1,474 @@ + + + + + + +StorablePropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class StorablePropertyInfo

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddInvokeReadMethod(org.cojen.classfile.CodeAssembler a) 
      voidaddInvokeReadMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType) 
      voidaddInvokeWriteMethod(org.cojen.classfile.CodeAssembler a) 
      voidaddInvokeWriteMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType) 
      java.lang.reflect.MethodgetFromStorageAdapter() +
      Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
      +
      java.lang.StringgetPropertyName() 
      org.cojen.classfile.TypeDescgetPropertyType() +
      Returns the user specified property type.
      +
      java.lang.StringgetReadMethodName() 
      org.cojen.classfile.TypeDescgetStorageType() +
      Returns the storage supported type.
      +
      java.lang.reflect.MethodgetToStorageAdapter() +
      Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
      +
      java.lang.StringgetWriteMethodName() 
      booleanisDerived() 
      booleanisLob() 
      booleanisNullable() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

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

        getStorageType

        +
        public org.cojen.classfile.TypeDesc getStorageType()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.
        +
        +
        Specified by:
        +
        getStorageType in interface GenericPropertyInfo
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getFromStorageAdapter

        +
        public java.lang.reflect.Method getFromStorageAdapter()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the optional method used to adapt the property from the + storage supported type to the user visible type.
        +
        +
        Specified by:
        +
        getFromStorageAdapter in interface GenericPropertyInfo
        +
        +
        • +
      + + + +
        +
      • +

        getToStorageAdapter

        +
        public java.lang.reflect.Method getToStorageAdapter()
        +
        Description copied from interface: GenericPropertyInfo
        +
        Returns the optional method used to adapt the property from the user + visible type to the storage supported type.
        +
        +
        Specified by:
        +
        getToStorageAdapter in interface GenericPropertyInfo
        +
        +
        • +
      + + + +
        +
      • +

        getReadMethodName

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

        addInvokeReadMethod

        +
        public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a)
        +
        • +
      + + + +
        +
      • +

        addInvokeReadMethod

        +
        public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a,
+                       org.cojen.classfile.TypeDesc instanceType)
        +
        • +
      + + + +
        +
      • +

        getWriteMethodName

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

        addInvokeWriteMethod

        +
        public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a)
        +
        • +
      + + + +
        +
      • +

        addInvokeWriteMethod

        +
        public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a,
+                        org.cojen.classfile.TypeDesc instanceType)
        +
        • +
      + + + +
        +
      • +

        toString

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

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

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

Uses of Class
com.amazon.carbonado.raw.CompressedEncodingStrategy

+
+
No usage of com.amazon.carbonado.raw.CompressedEncodingStrategy
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CompressedStorableCodecFactory

+
+
No usage of com.amazon.carbonado.raw.CompressedStorableCodecFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CompressionType

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

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

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

Uses of Interface
com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory

+
+
No usage of com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.CustomStorableCodec

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

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

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

Uses of Class
com.amazon.carbonado.raw.CustomStorableCodecFactory

+
+
No usage of com.amazon.carbonado.raw.CustomStorableCodecFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.DataDecoder

+
+
No usage of com.amazon.carbonado.raw.DataDecoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.DataEncoder

+
+
No usage of com.amazon.carbonado.raw.DataEncoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html new file mode 100644 index 0000000..68d3703 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html @@ -0,0 +1,192 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.GenericEncodingStrategy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.GenericEncodingStrategy

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

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

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

Uses of Interface
com.amazon.carbonado.raw.GenericInstanceFactory

+
+
No usage of com.amazon.carbonado.raw.GenericInstanceFactory
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html new file mode 100644 index 0000000..1670e50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html @@ -0,0 +1,160 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericPropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericPropertyInfo

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..1b7b1c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html @@ -0,0 +1,164 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericStorableCodec.Decoder

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..0b6e280 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,163 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html new file mode 100644 index 0000000..44d6215 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html @@ -0,0 +1,171 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.GenericStorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.GenericStorableCodec

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

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

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

Uses of Class
com.amazon.carbonado.raw.GenericStorableCodecFactory

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

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

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

Uses of Class
com.amazon.carbonado.raw.GzipCompressor

+
+
No usage of com.amazon.carbonado.raw.GzipCompressor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.KeyDecoder

+
+
No usage of com.amazon.carbonado.raw.KeyDecoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.KeyEncoder

+
+
No usage of com.amazon.carbonado.raw.KeyEncoder
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.RawCursor

+
+
No usage of com.amazon.carbonado.raw.RawCursor
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Uses of Class
com.amazon.carbonado.raw.RawStorableGenerator

+
+
No usage of com.amazon.carbonado.raw.RawStorableGenerator
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html new file mode 100644 index 0000000..3ca6b5e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html @@ -0,0 +1,289 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.RawSupport (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.RawSupport

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

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

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

Uses of Class
com.amazon.carbonado.raw.RawUtil

+
+
No usage of com.amazon.carbonado.raw.RawUtil
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html new file mode 100644 index 0000000..852c901 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html @@ -0,0 +1,193 @@ + + + + + + +Uses of Interface com.amazon.carbonado.raw.StorableCodec (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.raw.StorableCodec

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

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

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

Uses of Interface
com.amazon.carbonado.raw.StorableCodecFactory

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

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

+ + diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html new file mode 100644 index 0000000..01b893b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html @@ -0,0 +1,210 @@ + + + + + + +Uses of Class com.amazon.carbonado.raw.StorablePropertyInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.raw.StorablePropertyInfo

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

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

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

com.amazon.carbonado.raw

+
+

Interfaces

+ +

Classes

+ +

Enums

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

Package com.amazon.carbonado.raw

+
+
Provides support for repositories that encode/decode storables in a raw + binary format.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.raw Description

+
Provides support for repositories that encode/decode storables in a raw + binary format.
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

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

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

Hierarchy For Package com.amazon.carbonado.raw

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

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

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

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

Uses of Package
com.amazon.carbonado.raw

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

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

+ + -- cgit v1.2.3