org.fujion.model

Class ListModel<M>

java.lang.Object

org.fujion.model.ListModel<M>

Type Parameters:

M - The class of the model object.

All Implemented Interfaces:

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

Direct Known Subclasses:

NestedModel

public class ListModel<M>
extends Object
implements IListModel<M>

Implementation of a list model.

Nested Class Summary

Nested classes/interfaces inherited from interface org.fujion.model.IListModel

IListModel.IListModelListener, IListModel.ListEventType

Constructor Summary

Constructors

Constructor and Description
ListModel()
ListModel(Collection<M> list)

Method Summary

Modifier and Type	Method and Description
void	add(int index, M value)
boolean	add(M value)
boolean	addAll(Collection<? extends M> c)
boolean	addAll(int index, Collection<? extends M> c)
boolean	addEventListener(IListModel.IListModelListener listener) Register a listener to receive events when the list is modified.
void	clear()
boolean	contains(Object value)
boolean	containsAll(Collection<?> c)
M	get(int index)
int	indexOf(Object value)
boolean	isEmpty()
Iterator<M>	iterator()
int	lastIndexOf(Object value)
ListIterator<M>	listIterator()
ListIterator<M>	listIterator(int index)
M	remove(int index)
boolean	remove(Object value)
boolean	removeAll(Collection<?> c)
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.
boolean	retainAll(Collection<?> c)
M	set(int index, M value)
int	size()
void	sort(Comparator<? super M> comparator, boolean ascending) Sorts the list given the comparator and the sort direction.
List<M>	subList(int fromIndex, int toIndex)
void	swap(int index1, int index2) Swap two list entries by index.
void	swap(M item1, M item2) Swap two list entries.
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fujion.model.IListModel

sort

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ListModel

public ListModel()

ListModel

public ListModel(Collection<M> list)

Method Detail

add

public void add(int index,
                M value)

Specified by:

add in interface List<M>

add

public boolean add(M value)

Specified by:

add in interface Collection<M>

Specified by:

add in interface List<M>

addAll

public boolean addAll(Collection<? extends M> c)

Specified by:

addAll in interface Collection<M>

Specified by:

addAll in interface List<M>

addAll

public boolean addAll(int index,
                      Collection<? extends M> c)

Specified by:

addAll in interface List<M>

addEventListener

public boolean addEventListener(IListModel.IListModelListener listener)

Description copied from interface: IListModel

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

Specified by:

addEventListener in interface IListModel<M>

Parameters:

listener - The listener to add.

Returns:

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

clear

public void clear()

Specified by:

clear in interface Collection<M>

Specified by:

clear in interface List<M>

contains

public boolean contains(Object value)

Specified by:

contains in interface Collection<M>

Specified by:

contains in interface List<M>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<M>

Specified by:

containsAll in interface List<M>

get

public M get(int index)

Specified by:

get in interface List<M>

indexOf

public int indexOf(Object value)

Specified by:

indexOf in interface List<M>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<M>

Specified by:

isEmpty in interface List<M>

iterator

public Iterator<M> iterator()

Specified by:

iterator in interface Iterable<M>

Specified by:

iterator in interface Collection<M>

Specified by:

iterator in interface List<M>

lastIndexOf

public int lastIndexOf(Object value)

Specified by:

lastIndexOf in interface List<M>

listIterator

public ListIterator<M> listIterator()

Specified by:

listIterator in interface List<M>

listIterator

public ListIterator<M> listIterator(int index)

Specified by:

listIterator in interface List<M>

remove

public M remove(int index)

Specified by:

remove in interface List<M>

remove

public boolean remove(Object value)

Specified by:

remove in interface Collection<M>

Specified by:

remove in interface List<M>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<M>

Specified by:

removeAll in interface List<M>

removeRange

public boolean removeRange(int start,
                           int end)

Description copied from interface: IListModel

Removes a range of elements by index.

Specified by:

removeRange in interface IListModel<M>

Parameters:

start - Start of range (inclusive).

end - End of range (inclusive).

Returns:

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

removeAllListeners

public void removeAllListeners()

Description copied from interface: IListModel

Removes all listeners.

Specified by:

removeAllListeners in interface IListModel<M>

removeEventListener

public boolean removeEventListener(IListModel.IListModelListener listener)

Description copied from interface: IListModel

Removes a single event listener.

Specified by:

removeEventListener in interface IListModel<M>

Parameters:

listener - The listener to remove.

Returns:

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

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<M>

Specified by:

retainAll in interface List<M>

set

public M set(int index,
             M value)

Specified by:

set in interface List<M>

size

public int size()

Specified by:

size in interface Collection<M>

Specified by:

size in interface List<M>

sort

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

Description copied from interface: IListModel

Sorts the list given the comparator and the sort direction.

Specified by:

sort in interface IListModel<M>

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.

subList

public List<M> subList(int fromIndex,
                       int toIndex)

Specified by:

subList in interface List<M>

swap

public void swap(int index1,
                 int index2)

Description copied from interface: IListModel

Swap two list entries by index.

Specified by:

swap in interface IListModel<M>

Parameters:

index1 - Index of first entry.

index2 - Index of second entry.

swap

public void swap(M item1,
                 M item2)

Description copied from interface: IListModel

Swap two list entries.

Specified by:

swap in interface IListModel<M>

Parameters:

item1 - The first entry.

item2 - The second entry.

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<M>

Specified by:

toArray in interface List<M>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<M>

Specified by:

toArray in interface List<M>