Class SortedList<E>

public SortedList(EventList source)

Creates a SortedList that sorts the specified EventList. Because this constructor takes no Comparator argument, all elements in the specified EventList must implement Comparable or a ClassCastException will be thrown.

public SortedList(EventList source,
                  E> comparator)

Creates a SortedList that sorts the specified EventList using the specified Comparator to determine sort order. If the specified Comparator is null, then this List will be unsorted.

public boolean contains(Object object)

Overrides:

contains in interface AbstractEventList<E>

public int getMode()

Get the behaviour mode for this SortedList.

Returns:

one of STRICT_SORT_ORDER (default) or AVOID_MOVING_ELEMENTS.

protected int getSourceIndex(int mutationIndex)

Overrides:

getSourceIndex in interface TransformedList<S,E>

public int indexOf(Object object)

Overrides:

indexOf in interface AbstractEventList<E>

public int indexOfSimulated(Object object)

Deprecated. Deprecated as of 12/11/2005. Replaced with sortIndex(Object) which has cleaner semantics.

Returns the index in this list of the first occurrence of the specified element, or the index where that element would be in the list if it were inserted.

Returns:

the index in this list of the first occurrence of the specified element, or the index where that element would be in the list if it were inserted. This will return a value in [0, size()], inclusive.

protected boolean isWritable()

Overrides:

isWritable in interface TransformedList<S,E>

public Iterator iterator()

Overrides:

iterator in interface AbstractEventList<E>

public int lastIndexOf(Object object)

Overrides:

lastIndexOf in interface AbstractEventList<E>

public int lastSortIndex(Object object)

Returns the last index of the object's sort location or the last index at which the object could be positioned if inserted.

Unlike lastIndexOf(Object) this method does not guarantee the given object equals the element at the returned index. Instead, they are indistinguishable according to the sorting Comparator.

Returns:

a value in [0, size()] inclusive

public void listChanged(ListEvent listChanges)

Specified by:

listChanged in interface ListEventListener<E>

public void setComparator(E> comparator)

Set the Comparator in use in this EventList. This will sort the EventList into a new order.

Performance Note: sorting will take O(N * Log N) time.

Warning: This method is thread ready but not thread safe. See EventList for an example of thread safe code.

Parameters:

comparator - the Comparator to specify how to sort the list. If the source EventList elements implement Comparable, you may use a GlazedLists.comparableComparator() to sort them in their natural order. You may also specify null to put this SortedList in unsorted order.

public void setMode(int mode)

Modify the behaviour of this SortedList to one of the predefined modes.

Parameters:

mode - either STRICT_SORT_ORDER or AVOID_MOVING_ELEMENTS.

public int sortIndex(Object object)

Returns the first index of the object's sort location or the first index at which the object could be positioned if inserted.

Unlike indexOf(Object) this method does not guarantee the given object equals the element at the returned index. Instead, they are indistinguishable according to the sorting Comparator.

Returns:

a value in [0, size()] inclusive

public Comparator getComparator()

Gets the Comparator that is being used to sort this list.

Returns:

the Comparator in use, or null if this list is currently unsorted. If this is an EventList of Comparable elements in natural order, then a ComparableComparator} will be returned.