org.fujion.model

Interface IListModel<M>

Type Parameters:

M - The type of the model object.

All Superinterfaces:

Collection<M>, Iterable<M>, List<M>

All Known Subinterfaces:

INestedModel<M>

All Known Implementing Classes:

ListModel, NestedModel

public interface IListModel<M>
extends List<M>

Describes a tracked list used to hold model objects.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IListModel.IListModelListener Interface for listeners receiving events when the list is modified.
static class	IListModel.ListEventType Types of list mutation operations.

Method Summary

Modifier and Type	Method and Description
boolean	addEventListener(IListModel.IListModelListener listener) Register a listener to receive events when the list is modified.
void	removeAllListeners() Removes all listeners.
boolean	removeEventListener(IListModel.IListModelListener listener) Removes a single event listener.
boolean	removeRange(int start, int end) Removes a range of elements by index.
default void	sort(Comparator<? super M> comparator) Sorts the list in ascending order given the comparator.
void	sort(Comparator<? super M> comparator, boolean ascending) Sorts the list given the comparator and the sort direction.
void	swap(int index1, int index2) Swap two list entries by index.
void	swap(M value1, M value2) Swap two list entries.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

addEventListener

boolean addEventListener(IListModel.IListModelListener listener)

Register a listener to receive events when the list is modified.

Parameters:

listener - The listener to add.

Returns:

True if the listener was registered. False if already registered.

removeAllListeners

void removeAllListeners()

Removes all listeners.

removeEventListener

boolean removeEventListener(IListModel.IListModelListener listener)

Removes a single event listener.

Parameters:

listener - The listener to remove.

Returns:

True if the listener was removed. False if it was not registered.

removeRange

boolean removeRange(int start,
                    int end)

Removes a range of elements by index.

Parameters:

start - Start of range (inclusive).

end - End of range (inclusive).

Returns:

True if the model changed as a result of the operation.

swap

void swap(int index1,
          int index2)

Swap two list entries by index.

Parameters:

index1 - Index of first entry.

index2 - Index of second entry.

swap

void swap(M value1,
          M value2)

Swap two list entries.

Parameters:

value1 - The first entry.

value2 - The second entry.

sort

void sort(Comparator<? super M> comparator,
          boolean ascending)

Sorts the list given the comparator and the sort direction.

Parameters:

comparator - The comparator to use in sorting. If null, a comparator using the model objects' native sort order will be applied.

ascending - If true, sort list in ascending order; otherwise, in descending order.

sort

default void sort(Comparator<? super M> comparator)

Sorts the list in ascending order given the comparator.

Specified by:

sort in interface List<M>

Parameters:

comparator - The comparator to use in sorting. If null, a comparator using the model objects' native sort order will be applied.