org.nuxeo.ecm.core.uidgen

Class AbstractUIDSequencer

java.lang.Object

org.nuxeo.ecm.core.uidgen.AbstractUIDSequencer

All Implemented Interfaces:

UIDSequencer

Direct Known Subclasses:

ESUIDSequencer, JPAUIDSequencerImpl, RedisUIDSequencer

public abstract class AbstractUIDSequencer
extends Object
implements UIDSequencer

Since:

7.4

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
AbstractUIDSequencer()

Method Summary

Modifier and Type	Method and Description
abstract void	dispose() Cleanup callback
String	getName() Gets the sequencer name.
abstract int	getNext(String key) For the given key returns the incremented UID which is also stored in the same sequence entry.
long	getNextLong(String key) Extends UIDSequencer.getNext(java.lang.String) to return a long value.
abstract void	init() Init Sequencer
void	initSequence(String key, int id) Initializes the sequencer with the given key to at least the given id.
void	setName(String name) Sets the sequencer name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

Constructor Detail

AbstractUIDSequencer

public AbstractUIDSequencer()

Method Detail

init

public abstract void init()

Description copied from interface: UIDSequencer

Init Sequencer

Specified by:

init in interface UIDSequencer

getNext

public abstract int getNext(String key)

Description copied from interface: UIDSequencer

For the given key returns the incremented UID which is also stored in the same sequence entry. This is a "one time use" function for a document.

Specified by:

getNext in interface UIDSequencer

Returns:

getNextLong

public long getNextLong(String key)

Description copied from interface: UIDSequencer

Extends UIDSequencer.getNext(java.lang.String) to return a long value. This method is compatible with getNext in the integer range.

Specified by:

getNextLong in interface UIDSequencer

dispose

public abstract void dispose()

Description copied from interface: UIDSequencer

Cleanup callback

Specified by:

dispose in interface UIDSequencer

getName

public String getName()

Description copied from interface: UIDSequencer

Gets the sequencer name.

Specified by:

getName in interface UIDSequencer

setName

public void setName(String name)

Description copied from interface: UIDSequencer

Sets the sequencer name.

Specified by:

setName in interface UIDSequencer

initSequence

public void initSequence(String key,
                         int id)

Description copied from interface: UIDSequencer

Initializes the sequencer with the given key to at least the given id.

A sequence can only be incremented, so if its current id is greater than the given id the sequence won't be decremented to reach the given id.

Specified by:

initSequence in interface UIDSequencer