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

Class AbstractSequenceValueProducer

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

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringnextDecimalValue() +
      Returns the next decimal string value from the sequence, which remains + positive.
      +
      intnextIntValue() +
      Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.
      +
      java.lang.StringnextNumericalValue(int radix, + int minLength) +
      Returns the next numerical string value from the sequence, which remains + positive.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        AbstractSequenceValueProducer

        +
        protected AbstractSequenceValueProducer()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        nextIntValue

        +
        public int nextIntValue()
+                 throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextIntValue in interface SequenceValueProducer
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is + exhausted for int values.
        +
        • +
      + + + +
        +
      • +

        nextDecimalValue

        +
        public java.lang.String nextDecimalValue()
+                                  throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next decimal string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextDecimalValue in interface SequenceValueProducer
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      + + + +
        +
      • +

        nextNumericalValue

        +
        public java.lang.String nextNumericalValue(int radix,
+                                  int minLength)
+                                    throws PersistException
        +
        Description copied from interface: SequenceValueProducer
        +
        Returns the next numerical string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + +

        Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.

        +
        +
        Specified by:
        +
        nextNumericalValue in interface SequenceValueProducer
        +
        Parameters:
        radix - use 2 for binary, 10 for decimal, 16 for hex. Max is 36.
        minLength - ensure string is at least this long (padded with zeros if + necessary) to ensure proper string sort
        +
        Throws:
        +
        PersistException - for fetch/persist failure or if sequence is exhausted.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

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

+ + -- cgit v1.2.3