tripleplay.util

Class DestroyableList<E extends Destroyable>

java.lang.Object

tripleplay.util.DestroyableList<E>

All Implemented Interfaces:

Iterable<E>

public class DestroyableList<E extends Destroyable>
extends Object
implements Iterable<E>

Maintains a list of Destroyables. When an object is removed from the list or the list is cleared, it is Destroyable.destroy()ed.

Note that this is not a proper java.util.List because that interface exposes a ton of different ways to manipulate the list, all of which make it very hard to reason about when or whether your destroyables are destroyed. This list supports addition, removal, iteration and random access. That's about it.

Method Summary

Modifier and Type	Method and Description
E	add(E elem) Adds (non-null) elem to the end of the list.
E	add(int index, E elem) Inserts (non-null) elem into the list at index.
void	clear() Removes and destroys all elements in this list.
static <E extends Destroyable> DestroyableList<E>	create() Constructs an empty list with an initial capacity of eight.
static <E extends Destroyable> DestroyableList<E>	createWithCapacity(int initCap) Constructs an empty list with the specified initial capacity.
E	get(int index) Returns the element at index.
boolean	isEmpty() Returns true if the list is empty, false if it contains elements.
Iterator<E>	iterator()
boolean	remove(E elem) Removes and destroys (non-null) elem.
E	remove(int index) Removes and destroys the element at index.
int	size() Returns the size of the list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

create

public static <E extends Destroyable> DestroyableList<E> create()

Constructs an empty list with an initial capacity of eight.

createWithCapacity

public static <E extends Destroyable> DestroyableList<E> createWithCapacity(int initCap)

Constructs an empty list with the specified initial capacity.

size

public int size()

Returns the size of the list.

isEmpty

public boolean isEmpty()

Returns true if the list is empty, false if it contains elements.

get

public E get(int index)

Returns the element at index.

add

public E add(E elem)

Adds (non-null) elem to the end of the list.

Returns:

elem for convenience.

add

public E add(int index,
             E elem)

Inserts (non-null) elem into the list at index.

Returns:

elem for convenience.

remove

public E remove(int index)

Removes and destroys the element at index.

Returns:

the removed and destroyed element.

remove

public boolean remove(E elem)

Removes and destroys (non-null) elem.

Returns:

true if the element was found and destroyed, false otherwise.

clear

public void clear()

Removes and destroys all elements in this list.

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends Destroyable>