KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > datasource > ids > IdGenerator


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14  * implied.
15  *
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19
20 package org.apache.avalon.excalibur.datasource.ids;
21
22 import java.math.BigDecimal JavaDoc;
23
24 import org.apache.avalon.framework.component.Component;
25
26 /**
27  *
28  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
29  * @version CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:17 $
30  * @since 4.1
31  */
32 public interface IdGenerator
33     extends Component
34 {
35     /**
36      * The name of the role for convenience
37      */
38     String JavaDoc ROLE = IdGenerator.class.getName();
39
40     /**
41      * Returns the next Id from the pool.
42      *
43      * @return the next Id.
44      */
45     BigDecimal JavaDoc getNextBigDecimalId()
46         throws IdException;
47
48     /**
49      * Returns the next Id from the pool.
50      *
51      * @return the next Id.
52      *
53      * @throws IllegalStateException if the next id is outside of the range of valid longs.
54      */
55     long getNextLongId()
56         throws IdException;
57
58     /**
59      * Returns the next Id from the pool.
60      *
61      * @return the next Id.
62      *
63      * @throws IllegalStateException if the next id is outside of the range of valid integers.
64      */
65     int getNextIntegerId()
66         throws IdException;
67
68     /**
69      * Returns the next Id from the pool.
70      *
71      * @return the next Id.
72      *
73      * @throws IllegalStateException if the next id is outside of the range of valid shorts.
74      */
75     short getNextShortId()
76         throws IdException;
77
78     /**
79      * Returns the next Id from the pool.
80      *
81      * @return the next Id.
82      *
83      * @throws IllegalStateException if the next id is outside of the range of valid bytes.
84      */
85     byte getNextByteId()
86         throws IdException;
87 }
88
89
Popular Tags