ca.odell.glazedlists.io
Class FileList

java.lang.Object
  ca.odell.glazedlists.AbstractEventList<E>
      ca.odell.glazedlists.TransformedList
          ca.odell.glazedlists.io.FileList

All Implemented Interfaces:

ListEventListener, EventList, Iterable, Collection, EventListener, List

public final class FileList
extends TransformedList

An EventList that is persisted to disk.

Warning: This class is a technology preview and is subject to API changes.

EventList Overview

Writable:	yes
Concurrency:	Requires ReadWriteLock for every access, even for single-threaded use
Performance:	N/A
Memory:	O(N)
Unit Tests:	N/A
Issues:	N/A

Author:

Jesse Wilson

Field Summary

Fields inherited from class ca.odell.glazedlists.TransformedList

source

Fields inherited from class ca.odell.glazedlists.AbstractEventList

publisher, readWriteLock, updates

Constructor Summary

FileList(File file, ByteCoder byteCoder)
Create a FileList that stores its data in the specified file.

Method Summary

void	close() Closes this FileList so that it consumes no disc resources.
void	dispose() Releases the resources consumed by this TransformedList so that it may eventually be garbage collected.
boolean	isWritable() Gets whether the source EventList is writable via this API.
void	listChanged(ListEvent listChanges) When the underlying list changes, this notification allows the object to repaint itself or update itself as necessary.

Methods inherited from class ca.odell.glazedlists.TransformedList

add, addAll, clear, get, getSourceIndex, remove, removeAll, retainAll, set, size

Methods inherited from class ca.odell.glazedlists.AbstractEventList

add, addAll, addListEventListener, contains, containsAll, equals, getPublisher, getReadWriteLock, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeListEventListener, subList, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileList

public FileList(File file,
                ByteCoder byteCoder)
         throws IOException

Create a FileList that stores its data in the specified file.

Throws:

IOException

Method Detail

isWritable

public boolean isWritable()

Gets whether the source EventList is writable via this API.

Extending classes must override this method in order to make themselves writable.

Specified by:

isWritable in class TransformedList

listChanged

public void listChanged(ListEvent listChanges)

When the underlying list changes, this notification allows the object to repaint itself or update itself as necessary.

It is mandatory that the calling thread has obtained the write lock on the source list. This is because the calling thread will have written to the source list to cause this event. This condition guarantees that no writes can occur while the listener is handling this event. It is an error to write to the source list while processing an event.

Specified by:

listChanged in interface ListEventListener

Specified by:

listChanged in class TransformedList

Parameters:

listChanges - a ListEvent describing the changes to the list

close

public void close()

Closes this FileList so that it consumes no disc resources. The list may continue to be read until it is disposed.

dispose

public void dispose()

Releases the resources consumed by this TransformedList so that it may eventually be garbage collected.

A TransformedList will be garbage collected without a call to TransformedList.dispose(), but not before its source EventList is garbage collected. By calling TransformedList.dispose(), you allow the TransformedList to be garbage collected before its source EventList. This is necessary for situations where a TransformedList is short-lived but its source EventList is long-lived.

Warning: It is an error to call any method on a TransformedList after it has been disposed.

Specified by:

dispose in interface EventList

Overrides:

dispose in class TransformedList