1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* Copyright 2006 Amazon Technologies, Inc. or its affiliates.
* Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
* of Amazon Technologies, Inc. or its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazon.carbonado.sequence;
import com.amazon.carbonado.FetchException;
import com.amazon.carbonado.PersistException;
/**
* Produces values for sequences.
*
* @author Brian S O'Neill
* @author bcastill
* @see com.amazon.carbonado.Sequence
* @since 1.2
*/
public 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.
*
* <p>Note: this method throws PersistException even for fetch failures
* since this method is called by insert operations. Insert operations can
* only throw a PersistException.
*
* @throws PersistException for fetch/persist failure or if sequence is exhausted.
*/
public long nextLongValue() throws PersistException;
/**
* 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.
*
* <p>Note: this method throws PersistException even for fetch failures
* since this method is called by insert operations. Insert operations can
* only throw a PersistException.
*
* @throws PersistException for fetch/persist failure or if sequence is
* exhausted for int values.
*/
public int nextIntValue() throws PersistException;
/**
* 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.
*
* <p>Note: this method throws PersistException even for fetch failures
* since this method is called by insert operations. Insert operations can
* only throw a PersistException.
*
* @throws PersistException for fetch/persist failure or if sequence is exhausted.
*/
public String nextDecimalValue() throws PersistException;
/**
* 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.
*
* <p>Note: this method throws PersistException even for fetch failures
* since this method is called by insert operations. Insert operations can
* only throw a PersistException.
*
* @param radix use 2 for binary, 10 for decimal, 16 for hex. Max is 36.
* @param 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.
*/
public String nextNumericalValue(int radix, int minLength) throws PersistException;
/**
* Allow any unused reserved values to be returned for re-use. If the
* repository is shared by other processes, then reserved values might not
* be returnable.
*
* <p>This method should be called during the shutdown process of a
* repository, although calling it does not invalidate this
* SequenceValueGenerator. If getNextValue is called again, it will reserve
* values again.
*
* @return true if reserved values were returned
*/
public boolean returnReservedValues() throws FetchException, PersistException;
}
|
