de.espirit.or

Interface EntityList

All Superinterfaces:

Collection<Entity>, Iterable<Entity>, List<Entity>

public interface EntityList
extends List<Entity>

A list containing Entity instances. This list also offers the option to get the KeyValue of an element at a specific index.

Since:

4.0.17

Method Summary

Methods

Modifier and Type	Method and Description
KeyValue	getKeyValue(int index) Returns the KeyValue of the element at the specified position in this list.
int	indexOfId(KeyValue id) Return the index of the entity in the list with the given id or -1 if there is no such entity in the list.

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, retainAll, set, size, subList, toArray, toArray

Method Detail

indexOfId

int indexOfId(KeyValue id)

Return the index of the entity in the list with the given id or -1 if there is no such entity in the list. This method is faster then iterating through the elements of the list.

Parameters:

id - the key value to look for.

Returns:

-1 or the index of the entity with the given id.

Since:

4.0.17

getKeyValue

KeyValue getKeyValue(int index)

Returns the KeyValue of the element at the specified position in this list.

Parameters:

index - index of the element to return

Returns:

KeyValue of the the element at the specified position in this list

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= List.size())

Since:

4.0.17