Package com.helger.io.id.factory

Class FileLongIDFactory

java.lang.Object

com.helger.base.id.factory.AbstractPersistingLongIDFactory

com.helger.io.id.factory.FileLongIDFactory

All Implemented Interfaces:

com.helger.base.id.factory.IBaseIDFactory, com.helger.base.id.factory.ILongIDFactory

@ThreadSafe
public class FileLongIDFactory
extends com.helger.base.id.factory.AbstractPersistingLongIDFactory

File based persisting ILongIDFactory implementation.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final Charset	CHARSET_TO_USE	The charset to use for writing the file
static final int	DEFAULT_RESERVE_COUNT	The default number of values to reserve with a single IO action

Fields inherited from class com.helger.base.id.factory.AbstractPersistingLongIDFactory

m_aLock

Constructor Summary

Constructors

Constructor	Description
FileLongIDFactory(@NonNull File aFile)	Constructor using the DEFAULT_RESERVE_COUNT.
FileLongIDFactory(@NonNull File aFile, int nReserveCount)	Constructor with explicit reserve count.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
final @NonNull File	getFile()
int	hashCode()
protected final long	readAndUpdateIDCounter(int nReserveCount)
String	toString()

Methods inherited from class com.helger.base.id.factory.AbstractPersistingLongIDFactory

getNewID, getReserveCount, internalGetReserveCountUnlocked, setReserveCount

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CHARSET_TO_USE

public static final Charset CHARSET_TO_USE

The charset to use for writing the file

DEFAULT_RESERVE_COUNT

public static final int DEFAULT_RESERVE_COUNT

The default number of values to reserve with a single IO action

See Also:

• Constant Field Values

Constructor Details

FileLongIDFactory

public FileLongIDFactory(@NonNull File aFile)

Constructor using the DEFAULT_RESERVE_COUNT.

Parameters:

aFile - The file to persist the ID counter to. May not be null. Must be readable and writable.

FileLongIDFactory

public FileLongIDFactory(@NonNull File aFile,
 @Nonnegative
 int nReserveCount)

Constructor with explicit reserve count.

Parameters:

aFile - The file to persist the ID counter to. May not be null. Must be readable and writable.

nReserveCount - The number of IDs to reserve with a single IO action. Must be > 0.

Method Details

getFile

public final @NonNull File getFile()

Returns:

The File to write to, as provided in the constructor. Never null.

readAndUpdateIDCounter

@MustBeLocked(WRITE)
protected final long readAndUpdateIDCounter(@Nonnegative
 int nReserveCount)

Specified by:

readAndUpdateIDCounter in class com.helger.base.id.factory.AbstractPersistingLongIDFactory

equals

public boolean equals(Object o)

Overrides:

equals in class com.helger.base.id.factory.AbstractPersistingLongIDFactory

hashCode

public int hashCode()

Overrides:

hashCode in class com.helger.base.id.factory.AbstractPersistingLongIDFactory

toString

public String toString()

Overrides:

toString in class com.helger.base.id.factory.AbstractPersistingLongIDFactory