Package com.inductiveautomation.ignition.common.util

Class RAFCircularBuffer<T extends Serializable>

java.lang.Object

com.inductiveautomation.ignition.common.util.RAFCircularBuffer<T>

public class RAFCircularBuffer<T extends Serializable>
extends Object

A persistent circular buffer system that uses a RandomAccessFile as the backing store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RAFCircularBuffer.Filter<K>

Constructor Summary

Constructors

Constructor	Description
RAFCircularBuffer(File file, int sizeInKB, boolean gzip)

Method Summary

Modifier and Type	Method	Description
Iterator<T>	_backwardIter()	Deprecated.
Iterator<T>	_forwardIter()	Deprecated.
void	close()
protected T	deserializeObject(InputStream stream)
void	exportBuffer(OutputStream outputStream)
long	getFileSize()
List<T>	iterateBackward(RAFCircularBuffer.Filter<? super T> filter)
List<T>	iterateForward(RAFCircularBuffer.Filter<T> filter)
static void	main(String[] args)
void	reset()
protected void	serializeObject(T object, OutputStream stream)	Gives subclasses the chance to affect how data is written.
void	write(T object)

Methods inherited from class java.lang.Object

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

Constructor Details

RAFCircularBuffer

public RAFCircularBuffer(File file,
 int sizeInKB,
 boolean gzip)
                  throws IOException

Parameters:

file - The file to use as the buffer

sizeInKB - must be at least 1

gzip - A flag for whether or not new records should be stored with Gzip compression

Throws:

IOException

Method Details

reset

public void reset()

getFileSize

public long getFileSize()
                 throws IOException

Throws:

IOException

exportBuffer

public void exportBuffer(OutputStream outputStream)
                  throws IOException

Throws:

IOException

serializeObject

protected void serializeObject(T object,
 OutputStream stream)
                        throws IOException

Gives subclasses the chance to affect how data is written. The provided stream will already be a GZIPOuputStream, if appropriate, and should not be closed in this function.

Throws:

IOException

deserializeObject

protected T deserializeObject(InputStream stream)
                       throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

write

public void write(T object)
           throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

iterateForward

public List<T> iterateForward(RAFCircularBuffer.Filter<T> filter)

iterateBackward

public List<T> iterateBackward(RAFCircularBuffer.Filter<? super T> filter)

_forwardIter

@Deprecated
public Iterator<T> _forwardIter()

Deprecated.

Do not use directly, not thread safe. Used for junit testing

_backwardIter

@Deprecated
public Iterator<T> _backwardIter()

Deprecated.

Do not use directly, not thread safe. Used for junit testing

main

public static void main(String[] args)