01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19: package org.apache.openjpa.persistence;
20:
21: /**
22: * Represents a store sequence.
23: *
24: * @author Abe White
25: * @since 0.4.1
26: * @published
27: */
28: public interface Generator {
29:
30: public static final String UUID_HEX = "uuid-hex";
31: public static final String UUID_STRING = "uuid-string";
32:
33: /**
34: * The sequence name.
35: */
36: public String getName();
37:
38: /**
39: * The next sequence value.
40: */
41: public Object next();
42:
43: /**
44: * The current sequence value, or null if the sequence does not
45: * support current values.
46: */
47: public Object current();
48:
49: /**
50: * Hint to the sequence to allocate additional values up-front for
51: * efficiency.
52: */
53: public void allocate(int additional);
54:
55: /**
56: * @deprecated cast to {@link GeneratorImpl} instead. This
57: * method pierces the published-API boundary, as does the SPI cast.
58: */
59: public org.apache.openjpa.kernel.Seq getDelegate();
60: }
|