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

Interface StoredSequence

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Storable<StoredSequence>
    +
    +
    +
    +
    @PrimaryKey(value="name")
+@Authoritative
+@Independent
+@Alias(value={"CARBONADO_SEQUENCE","Carbonado_Sequence","carbonado_sequence","CarbonadoSequence","carbonadoSequence"})
+public interface StoredSequence
+extends Storable<StoredSequence>
    +
    Stores data for SequenceValueGenerator. To use with JDBC repository, + create a table like so: + + 
    + CREATE TABLE CARBONADO_SEQUENCE (
+     NAME           VARCHAR(100) PRIMARY KEY,
+     INITIAL_VALUE  BIGINT       NOT NULL,
+     NEXT_VALUE     BIGINT       NOT NULL,
+     VERSION        INT          NOT NULL
+ )
+
    +
    Since:
    +
    1.2
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        @Alias(value={"NAME","Name","name"})
+java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        setName

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

        getInitialValue

        +
        @Alias(value={"INITIAL_VALUE","Initial_Value","initial_value","InitialValue","initialValue"})
+long getInitialValue()
        +
        Returns the initial value for the sequence.
        +
        • +
      + + + +
        +
      • +

        setInitialValue

        +
        void setInitialValue(long value)
        +
        • +
      + + + +
        +
      • +

        getNextValue

        +
        @Alias(value={"NEXT_VALUE","Next_Value","next_value","NextValue","nextValue"})
+long getNextValue()
        +
        Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).
        +
        • +
      + + + +
        +
      • +

        setNextValue

        +
        void setNextValue(long value)
        +
        • +
      + + + + + + + +
        +
      • +

        setVersion

        +
        void setVersion(int version)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

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

+ + -- cgit v1.2.3