Package com.luciad.util.collections

Class TLcdArrayList<T>

java.lang.Object

com.luciad.util.collections.TLcdArrayList<T>

All Implemented Interfaces:

ILcdCollection<T>, ILcdList<T>, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess, SequencedCollection<T>

public class TLcdArrayList<T>
extends Object
implements ILcdList<T>, Cloneable, RandomAccess

An implementation of ILcdList that behaves similar to ArrayList.

Since:

9.1

Constructor Summary

Constructors

Constructor	Description
TLcdArrayList()	Constructs an empty list with an initial capacity of ten.
TLcdArrayList(int aInitialCapacity)	Constructs an empty list with the specified initial capacity.

Method Summary

Modifier and Type	Method	Description
void	add(int aIndex, T aElement, int aFireEventMode)	This method behaves the same as ILcdList.add(int, Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
boolean	add(T aElement, int aFireEventMode)	This method behaves the same as ILcdCollection.add(Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
boolean	addAll(int aIndex, Collection<? extends T> aCollection, int aFireEventMode)	This method behaves the same as ILcdList.addAll(int, Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
boolean	addAll(Collection<? extends T> aCollection, int aFireEventMode)	This method behaves the same as ILcdCollection.addAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
void	addCollectionListener(ILcdCollectionListener<T> aCollectionListener)	Register the listener aCollectionListener to be informed about changes in this collection.
void	addListListener(ILcdListListener<T> aListListener)	Register the listener aListListener to be informed about changes in this list.
void	clear(int aFireEventMode)	This method behaves the same as ILcdCollection.clear(), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
Object	clone()	Returns a shallow copy of this TLcdArrayList instance.
boolean	contains(Object aObject)
boolean	containsAll(Collection<?> aCollection)
boolean	equals(Object aObject)
void	fireCollectedChanges()	Fires all the collected change events from modifications performed with the ILcdFireEventMode.FIRE_LATER fire event mode.
T	get(int aIndex)
int	hashCode()
int	indexOf(Object aObject)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object aObject)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int aIndex)
T	remove(int aIndex, int aFireEventMode)	This method behaves the same as ILcdList.remove(int), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
boolean	remove(Object aObject, int aFireEventMode)	This method behaves the same as ILcdCollection.remove(Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
boolean	removeAll(Collection<?> aCollection, int aFireEventMode)	This method behaves the same as ILcdCollection.removeAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
void	removeCollectionListener(ILcdCollectionListener<T> aCollectionListener)	Unregister the listener aCollectionListener so it will no longer be informed about changes in this collection.
void	removeListListener(ILcdListListener<T> aListListener)	Unregister the listener aListListener so it will no longer be informed about changes in this collection.
boolean	retainAll(Collection<?> aCollection, int aFireEventMode)	This method behaves the same as ILcdCollection.retainAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
T	set(int aIndex, T aElement, int aFireEventMode)	This method behaves the same as ILcdList.set(int, Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call.
int	size()
List<T>	subList(int aFromIndex, int aToIndex)
Object[]	toArray()
<U> U[]	toArray(U[] aArray)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface com.luciad.util.collections.ILcdList

add, add, addAll, addAll, clear, remove, remove, removeAll, retainAll, set

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, getFirst, getLast, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Constructor Details

TLcdArrayList

public TLcdArrayList()

Constructs an empty list with an initial capacity of ten.

TLcdArrayList

public TLcdArrayList(int aInitialCapacity)

Constructs an empty list with the specified initial capacity.

Parameters:

aInitialCapacity - the initial capacity of the list

Throws:

IllegalArgumentException - if the specified initial capacity is negative

Method Details

set

public T set(int aIndex,
 T aElement,
 int aFireEventMode)

Description copied from interface: ILcdList

This method behaves the same as ILcdList.set(int, Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the list is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

set in interface ILcdList<T>

Parameters:

aIndex - index of the element to replace.

aElement - element to be stored at the specified position.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

the element previously at the specified position

See Also:

• ILcdList.set(int, Object)

add

public boolean add(T aElement,
 int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.add(Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

add in interface ILcdCollection<T>

Parameters:

aElement - element whose presence in this collection is to be ensured.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if this collection changed as a result of the call

See Also:

• ILcdCollection.add(Object)

add

public void add(int aIndex,
 T aElement,
 int aFireEventMode)

Description copied from interface: ILcdList

This method behaves the same as ILcdList.add(int, Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the list is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

add in interface ILcdList<T>

Parameters:

aIndex - index at which the specified element is to be inserted.

aElement - element to be inserted.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

See Also:

• ILcdList.add(int, Object)

remove

public T remove(int aIndex,
 int aFireEventMode)

Description copied from interface: ILcdList

This method behaves the same as ILcdList.remove(int), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the list is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

remove in interface ILcdList<T>

Parameters:

aIndex - the index of the element to be removed.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

the element previously at the specified position

See Also:

• ILcdList.remove(int)

remove

public boolean remove(Object aObject,
 int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.remove(Object), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

remove in interface ILcdCollection<T>

Parameters:

aObject - element to be removed from this collection, if present.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if an element was removed as a result of this call

See Also:

• ILcdCollection.remove(Object)

clear

public void clear(int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.clear(), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

clear in interface ILcdCollection<T>

Parameters:

aFireEventMode - the ILcdFireEventMode for sending out the change event.

See Also:

• ILcdCollection.clear()

addAll

public boolean addAll(Collection<? extends T> aCollection,
 int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.addAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

addAll in interface ILcdCollection<T>

Parameters:

aCollection - collection containing elements to be added to this collection.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if this collection changed as a result of the call

See Also:

• ILcdCollection.addAll(Collection)

addAll

public boolean addAll(int aIndex,
 Collection<? extends T> aCollection,
 int aFireEventMode)

Description copied from interface: ILcdList

This method behaves the same as ILcdList.addAll(int, Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the list is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

addAll in interface ILcdList<T>

Parameters:

aIndex - index at which to insert the first element from the specified collection.

aCollection - collection containing elements to be added to this list.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if this list changed as a result of the call

See Also:

• ILcdList.addAll(int, Collection)

removeAll

public boolean removeAll(Collection<?> aCollection,
 int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.removeAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

removeAll in interface ILcdCollection<T>

Parameters:

aCollection - collection containing elements to be removed from this collection.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if this collection changed as a result of the call

See Also:

• ILcdCollection.removeAll(Collection)

retainAll

public boolean retainAll(Collection<?> aCollection,
 int aFireEventMode)

Description copied from interface: ILcdCollection

This method behaves the same as ILcdCollection.retainAll(Collection), but additionally accepts an ILcdFireEventMode parameter that allows to postpone firing change events resulting from this method call. When ILcdFireEventMode.FIRE_LATER is passed, any change events are temporarily stored and only fired once ILcdCollection.fireCollectedChanges() is called. This is useful for example when the collection is protected by a read/write lock, in order to avoid potential deadlocks down the line. See the class javadoc for an example code snippet.

Specified by:

retainAll in interface ILcdCollection<T>

Parameters:

aCollection - collection containing elements to be retained in this collection.

aFireEventMode - the ILcdFireEventMode for sending out the change event.

Returns:

true if this collection changed as a result of the call

See Also:

• ILcdCollection.retainAll(Collection)

fireCollectedChanges

public void fireCollectedChanges()

Description copied from interface: ILcdCollection

Fires all the collected change events from modifications performed with the ILcdFireEventMode.FIRE_LATER fire event mode.

Specified by:

fireCollectedChanges in interface ILcdCollection<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object aObject)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

indexOf

public int indexOf(Object aObject)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object aObject)

Specified by:

lastIndexOf in interface List<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

public <U> U[] toArray(U[] aArray)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

get

public T get(int aIndex)

Specified by:

get in interface List<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int aIndex)

Specified by:

listIterator in interface List<T>

subList

public List<T> subList(int aFromIndex,
 int aToIndex)

Specified by:

subList in interface List<T>

equals

public boolean equals(Object aObject)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class Object

containsAll

public boolean containsAll(Collection<?> aCollection)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

toString

public String toString()

Overrides:

toString in class Object

addListListener

public void addListListener(ILcdListListener<T> aListListener)

Description copied from interface: ILcdList

Register the listener aListListener to be informed about changes in this list.

Specified by:

addListListener in interface ILcdList<T>

Parameters:

aListListener - the listener

See Also:

• ILcdList.removeListListener(ILcdListListener)

removeListListener

public void removeListListener(ILcdListListener<T> aListListener)

Description copied from interface: ILcdList

Unregister the listener aListListener so it will no longer be informed about changes in this collection.

This method should do nothing when aListListener was not registered previously.

Specified by:

removeListListener in interface ILcdList<T>

Parameters:

aListListener - the listener

See Also:

• ILcdList.addListListener(ILcdListListener)

addCollectionListener

public void addCollectionListener(ILcdCollectionListener<T> aCollectionListener)

Description copied from interface: ILcdCollection

Register the listener aCollectionListener to be informed about changes in this collection.

Specified by:

addCollectionListener in interface ILcdCollection<T>

Parameters:

aCollectionListener - the listener

See Also:

• ILcdCollection.removeCollectionListener(ILcdCollectionListener)

removeCollectionListener

public void removeCollectionListener(ILcdCollectionListener<T> aCollectionListener)

Description copied from interface: ILcdCollection

Unregister the listener aCollectionListener so it will no longer be informed about changes in this collection.

This method should do nothing when aCollectionListener was not registered previously.

Specified by:

removeCollectionListener in interface ILcdCollection<T>

Parameters:

aCollectionListener - the listener

See Also:

• ILcdCollection.addCollectionListener(ILcdCollectionListener)

clone

public Object clone()

Returns a shallow copy of this TLcdArrayList instance. (The elements themselves are not copied.). The returned list will have no listeners attached to it.

Overrides:

clone in class Object

Returns:

a clone of this TLcdArrayList instance