Package toxi.util.datatypes

Class UniqueItemIndex<T>

java.lang.Object

toxi.util.datatypes.UniqueItemIndex<T>

All Implemented Interfaces:

ItemIndex<T>

Direct Known Subclasses:

SpatialIndex

public class UniqueItemIndex<T>
extends Object
implements ItemIndex<T>

This class is used to build an unique set of items and offers a bi-directional mapping between items and their associated ID values. Items are added via the index(Object) method and removed via unindex(Object). The item's Object.hashCode() is used as unique identifier, so you MUST ensure the item class satisfies the contract of Object.hashCode() and Object.equals(Object).

Constructor Summary

Constructors

Constructor	Description
UniqueItemIndex()
UniqueItemIndex(Collection<T> items)

Method Summary

Modifier and Type	Method	Description
void	clear()
T	forID(int id)
int	getID(T item)
List<T>	getItems()
int	index(T item)
boolean	isIndexed(T item)
int	reindex(T item, T newItem)
int	size()
int	unindex(T item)

Methods inherited from class java.lang.Object

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

Constructor Details

UniqueItemIndex

public UniqueItemIndex()

UniqueItemIndex

public UniqueItemIndex(Collection<T> items)

Method Details

clear

public void clear()

Specified by:

clear in interface ItemIndex<T>

forID

public T forID(int id)

Specified by:

forID in interface ItemIndex<T>

getID

public int getID(T item)

Specified by:

getID in interface ItemIndex<T>

getItems

public List<T> getItems()

Specified by:

getItems in interface ItemIndex<T>

index

public int index(T item)

Specified by:

index in interface ItemIndex<T>

isIndexed

public boolean isIndexed(T item)

Specified by:

isIndexed in interface ItemIndex<T>

reindex

public int reindex(T item,
 T newItem)

Specified by:

reindex in interface ItemIndex<T>

size

public int size()

Specified by:

size in interface ItemIndex<T>

unindex

public int unindex(T item)

Specified by:

unindex in interface ItemIndex<T>