dsto.dfc.swing.list
Class AbstractDfcListModel

java.lang.Object
  javax.swing.AbstractListModel
      dsto.dfc.swing.list.AbstractDfcListModel

All Implemented Interfaces:

DfcListModel, Serializable, ListModel

public abstract class AbstractDfcListModel
extends AbstractListModel
implements DfcListModel

An abstract implementation of an immutable DfcListModel. All mutator methods throw UnsupportedOperationException. Clients need to implement getSize () and getElementAt ().

Version:

$Revision$

Author:

Matthew Phillips

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractListModel

listenerList

Constructor Summary

protected

AbstractDfcListModel()

Method Summary

void	addEntry(Object entry, int row) Add an entry can at a given row.
boolean	canAddEntry(Object entry, int row) Test if an entry can be added at a given row.
boolean	canRemoveEntry(int row) Test if an entry can be removed.
boolean	canReplaceEntry(Object entry, int row) Test if an entry can be replaced.
abstract Object	getElementAt(int index)
abstract int	getSize()
int	indexOf(Object entry) Find the first occurrence of an entry and return its index.
boolean	isMutable() Test if this model is mutable (can be changed).
Object	removeEntry(int row) Remove an entry at a given row.
Object	replaceEntry(Object entry, int row) Replace an entry can at a given row.

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.ListModel

addListDataListener, removeListDataListener

Constructor Detail

AbstractDfcListModel

protected AbstractDfcListModel()

Method Detail

getSize

public abstract int getSize()

Specified by:

getSize in interface ListModel

getElementAt

public abstract Object getElementAt(int index)

Specified by:

getElementAt in interface ListModel

isMutable

public boolean isMutable()

Description copied from interface: DfcListModel

Test if this model is mutable (can be changed).

Specified by:

isMutable in interface DfcListModel

Returns:

True if the list can be changed.

indexOf

public int indexOf(Object entry)

Description copied from interface: DfcListModel

Find the first occurrence of an entry and return its index.

Specified by:

indexOf in interface DfcListModel

Returns:

The index of entry or -1 if not found.

canReplaceEntry

public boolean canReplaceEntry(Object entry,
                               int row)

Description copied from interface: DfcListModel

Test if an entry can be replaced.

Specified by:

canReplaceEntry in interface DfcListModel

Parameters:

entry - The entry to add.

row - The row to overwrite.

Returns:

True if entry can be replaced.

See Also:

DfcListModel.replaceEntry(java.lang.Object, int)

replaceEntry

public Object replaceEntry(Object entry,
                           int row)
                    throws IndexOutOfBoundsException,
                           UnsupportedOperationException

Description copied from interface: DfcListModel

Replace an entry can at a given row.

Specified by:

replaceEntry in interface DfcListModel

Parameters:

entry - The entry to add.

row - The row to overwrite.

Returns:

The old value at row.

Throws:

IndexOutOfBoundsException - if row is out of bounds.

UnsupportedOperationException - if entry is not allowed to be replaced.

See Also:

DfcListModel.canReplaceEntry(java.lang.Object, int)

canAddEntry

public boolean canAddEntry(Object entry,
                           int row)

Description copied from interface: DfcListModel

Test if an entry can be added at a given row.

Specified by:

canAddEntry in interface DfcListModel

Parameters:

entry - The entry to add.

row - The row to add the new entry.

Returns:

True if entry can be added at row.

See Also:

DfcListModel.addEntry(java.lang.Object, int)

addEntry

public void addEntry(Object entry,
                     int row)
              throws IndexOutOfBoundsException,
                     UnsupportedOperationException

Description copied from interface: DfcListModel

Add an entry can at a given row.

Specified by:

addEntry in interface DfcListModel

Parameters:

entry - The entry to add.

row - The row to add the new entry.

Throws:

IndexOutOfBoundsException - if row is out of bounds.

UnsupportedOperationException - if entry is not allowed to be added.

See Also:

DfcListModel.canAddEntry(java.lang.Object, int)

canRemoveEntry

public boolean canRemoveEntry(int row)

Description copied from interface: DfcListModel

Test if an entry can be removed.

Specified by:

canRemoveEntry in interface DfcListModel

Parameters:

row - The row to be removed.

Returns:

True if row can be removed.

See Also:

DfcListModel.removeEntry(int)

removeEntry

public Object removeEntry(int row)
                   throws IndexOutOfBoundsException,
                          UnsupportedOperationException

Description copied from interface: DfcListModel

Remove an entry at a given row.

Specified by:

removeEntry in interface DfcListModel

Parameters:

row - The row to remove.

Returns:

The entry that was removed.

Throws:

IndexOutOfBoundsException - if row is out of bounds.

UnsupportedOperationException - if entry is not allowed to be removed.

See Also:

DfcListModel.canRemoveEntry(int)