Package de.renebergelt.quiterables.grouping

Interface GroupedList<T>

All Superinterfaces:

Collection<Group<T>>, Iterable<Group<T>>, List<Group<T>>

public interface GroupedList<T>
extends List<Group<T>>

A list which has been grouped and therefore contains groups of a given element type

Method Summary

Modifier and Type	Method	Description
Group<T>	elementAt(int index)	Return the element at the given position in the list
Group<T>	get(int index)	GroupedList.get(int) is ambiguous.
Group<T>	get(GroupKey key)	Return the group with the given group key or null if no such group exists
Group<T>	get(Object... keyElements)	Return the group with the group key composed of the given elements or null if no such group exists In order to use this function with a single key element of type int, call it like get(new Integer(value))

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Details

get

Group<T> get(GroupKey key)

Return the group with the given group key or null if no such group exists

Parameters:

key - the key to search for

Returns:

The corresponding group

get

Group<T> get(Object... keyElements)

Return the group with the group key composed of the given elements or null if no such group exists In order to use this function with a single key element of type int, call it like get(new Integer(value))

Parameters:

keyElements - The elements of the key

Returns:

The corresponding group

get

Group<T> get(int index)

GroupedList.get(int) is ambiguous. To avoid confusion use either get(new GroupKey(int)) or elementAt(int) To conform to the java.util.List interface this method returns the element at the given position and _not_ the group with the given integer key If you want to get the group with a specific numerical index use get(new Integer(value))

Specified by:

get in interface List<T>

Parameters:

index - The group index

Returns:

The corresponding group

elementAt

Group<T> elementAt(int index)

Return the element at the given position in the list

Parameters:

index - The group index

Returns:

The corresponding group