01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.shared;
34:
35: import java.io.Serializable;
36:
37: /**
38: * A user defined sequencer
39: *
40: * @author Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
41: */
42: public class CustomSequencer implements Serializable {
43:
44: private static final long serialVersionUID = 4821229397499448319L;
45:
46: private String name;
47: private boolean allowRollover;
48: private long currentNumber;
49:
50: /**
51: * Constructor
52: *
53: * @param name unique name
54: * @param allowRollover rollover when Long.MAX_VALUE is reached?
55: * @param currentNumber the current number of the sequence (last delivered)
56: */
57: public CustomSequencer(String name, boolean allowRollover,
58: long currentNumber) {
59: this .name = name;
60: this .allowRollover = allowRollover;
61: this .currentNumber = currentNumber;
62: }
63:
64: /**
65: * Get the unique name of this sequencer
66: *
67: * @return unique name of this sequencer
68: */
69: public String getName() {
70: return name;
71: }
72:
73: /**
74: * Does this sequencer support rollover?
75: * If the current number gets close to Long.MAX_VALUE it will be reset to zero if rollover is allowed, else
76: * an exception will be thrown
77: *
78: * @return rollover allowed
79: */
80: public boolean isAllowRollover() {
81: return allowRollover;
82: }
83:
84: /**
85: * Get the current number of this sequencer, however no guarantee can be made that the next number requested
86: * will be this current number + 1
87: *
88: * @return current number of this sequencer
89: */
90: public long getCurrentNumber() {
91: return currentNumber;
92: }
93: }
|