Package com.intellij.util.io

Class PersistentEnumeratorBase<Data>

java.lang.Object

com.intellij.util.io.PersistentEnumeratorBase<Data>

All Implemented Interfaces:

Forceable, DataEnumerator<Data>, DataEnumeratorEx<Data>, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

PersistentBTreeEnumerator, PersistentEnumerator

public abstract class PersistentEnumeratorBase<Data>
extends java.lang.Object
implements DataEnumeratorEx<Data>, Forceable, java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistentEnumeratorBase.CorruptedException
static interface	PersistentEnumeratorBase.DataFilter
static class	PersistentEnumeratorBase.RecordsProcessor
static class	PersistentEnumeratorBase.Version
static class	PersistentEnumeratorBase.VersionUpdatedException

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG
protected java.nio.file.Path	myFile
protected ResizeableMappedFile	myStorage
protected static int	NULL_ID

Constructor Summary

Constructors

Constructor and Description
PersistentEnumeratorBase(java.nio.file.Path file, ResizeableMappedFile storage, KeyDescriptor<Data> dataDescriptor, int initialSize, PersistentEnumeratorBase.Version version, com.intellij.util.io.PersistentEnumeratorBase.RecordBufferHandler<? extends PersistentEnumeratorBase> recordBufferHandler, boolean doCaching)

Method Summary

Modifier and Type	Method and Description
static void	clearCacheForTests()
void	close()
protected void	doClose()
protected void	doFlush()
protected int	doWriteData(Data value)
int	enumerate(Data value)
protected abstract int	enumerateImpl(Data value, boolean onlyCheckForExisting, boolean saveNewValue)
void	force()
java.util.Collection<Data>	getAllDataObjects(PersistentEnumeratorBase.DataFilter filter)
int	getLargestId()
protected long	getMetaData()
Data	getValue(int keyId, int processingKey)
protected abstract int	indexToAddr(int idx)
boolean	isClosed()
boolean	isCorrupted()
boolean	isDirty()
protected boolean	isKeyAtIndex(Data value, int idx)
boolean	iterateData(Processor<? super Data> processor)
protected void	markCorrupted()
protected void	markDirty(boolean dirty)
boolean	processAllDataObject(Processor<? super Data> processor, PersistentEnumeratorBase.DataFilter filter)
protected void	putMetaData(long data)
void	setRecordHandler(com.intellij.util.io.PersistentEnumeratorBase.RecordBufferHandler<PersistentEnumeratorBase> recordHandler)
protected abstract void	setupEmptyFile()
protected int	setupValueId(int hashCode, int dataOff)
abstract boolean	traverseAllRecords(PersistentEnumeratorBase.RecordsProcessor p)
int	tryEnumerate(Data value)
Data	valueOf(int idx)
protected int	writeData(Data value, int hashCode)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

NULL_ID

protected static final int NULL_ID

See Also:

Constant Field Values

myStorage

protected final ResizeableMappedFile myStorage

myFile

protected final java.nio.file.Path myFile

Constructor Detail

PersistentEnumeratorBase

public PersistentEnumeratorBase(java.nio.file.Path file,
                                ResizeableMappedFile storage,
                                KeyDescriptor<Data> dataDescriptor,
                                int initialSize,
                                PersistentEnumeratorBase.Version version,
                                com.intellij.util.io.PersistentEnumeratorBase.RecordBufferHandler<? extends PersistentEnumeratorBase> recordBufferHandler,
                                boolean doCaching)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

clearCacheForTests

public static void clearCacheForTests()

setupEmptyFile

protected abstract void setupEmptyFile()
                                throws java.io.IOException

Throws:

java.io.IOException

setRecordHandler

public void setRecordHandler(com.intellij.util.io.PersistentEnumeratorBase.RecordBufferHandler<PersistentEnumeratorBase> recordHandler)

getValue

public Data getValue(int keyId,
                     int processingKey)
              throws java.io.IOException

Throws:

java.io.IOException

tryEnumerate

public int tryEnumerate(Data value)
                 throws java.io.IOException

Specified by:

tryEnumerate in interface DataEnumeratorEx<Data>

Throws:

java.io.IOException

enumerate

public int enumerate(Data value)
              throws java.io.IOException

Specified by:

enumerate in interface DataEnumerator<Data>

Throws:

java.io.IOException

putMetaData

protected void putMetaData(long data)

getMetaData

protected long getMetaData()

processAllDataObject

public boolean processAllDataObject(Processor<? super Data> processor,
                                    PersistentEnumeratorBase.DataFilter filter)
                             throws java.io.IOException

Throws:

java.io.IOException

getAllDataObjects

public java.util.Collection<Data> getAllDataObjects(PersistentEnumeratorBase.DataFilter filter)
                                             throws java.io.IOException

Throws:

java.io.IOException

traverseAllRecords

public abstract boolean traverseAllRecords(PersistentEnumeratorBase.RecordsProcessor p)
                                    throws java.io.IOException

Throws:

java.io.IOException

enumerateImpl

protected abstract int enumerateImpl(Data value,
                                     boolean onlyCheckForExisting,
                                     boolean saveNewValue)
                              throws java.io.IOException

Throws:

java.io.IOException

isKeyAtIndex

protected boolean isKeyAtIndex(Data value,
                               int idx)
                        throws java.io.IOException

Throws:

java.io.IOException

writeData

protected int writeData(Data value,
                        int hashCode)

getLargestId

public int getLargestId()

doWriteData

protected int doWriteData(Data value)
                   throws java.io.IOException

Throws:

java.io.IOException

setupValueId

protected int setupValueId(int hashCode,
                           int dataOff)

iterateData

public boolean iterateData(Processor<? super Data> processor)
                    throws java.io.IOException

Throws:

java.io.IOException

valueOf

public Data valueOf(int idx)
             throws java.io.IOException

Specified by:

valueOf in interface DataEnumerator<Data>

Throws:

java.io.IOException

indexToAddr

protected abstract int indexToAddr(int idx)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

doClose

protected void doClose()
                throws java.io.IOException

Throws:

java.io.IOException

isClosed

public boolean isClosed()

isDirty

public boolean isDirty()

Specified by:

isDirty in interface Forceable

isCorrupted

public boolean isCorrupted()

doFlush

protected void doFlush()
                throws java.io.IOException

Throws:

java.io.IOException

force

public void force()

Specified by:

force in interface Forceable

markDirty

protected final void markDirty(boolean dirty)
                        throws java.io.IOException

Throws:

java.io.IOException

markCorrupted

protected void markCorrupted()