org.magicwerk.brownies.collections

Class KeyCollection<E>

java.lang.Object

org.magicwerk.brownies.collections.KeyCollectionImpl<E>

org.magicwerk.brownies.collections.KeyCollection<E>

Type Parameters:

E - type of elements stored in the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>

public class KeyCollection<E>
extends KeyCollectionImpl<E>

KeyCollection implements a collection. It can provide fast access to its elements like a Set. The elements allowed in the list can be constraint (null/duplicate values).

Version:

$Id: KeyCollection.java 2326 2014-06-11 16:29:32Z origo $

Author:

Thomas Mauch

See Also:

Key1List, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyCollection.Builder<E> Builder to construct TableCollection instances.

Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl

KeyCollectionImpl.BuilderImpl<E>

Method Summary

Methods

Modifier and Type	Method and Description
KeyCollection<E>	copy() Returns a copy of this collection with all its elements.
KeyCollection<E>	crop() Returns a copy of this collection but without elements.
GapList<E>	getAll(E elem) Returns all equal elements.
int	getCount(E elem) Returns the number of equal elements.
java.util.Set<E>	getDistinct() Returns all distinct elements in the same order as in the collection.
void	invalidate(E elem) Invalidate element, i.e. all keys of the element are extracted again and stored in the key maps.
E	put(E elem) Adds or replaces element.
GapList<E>	removeAll(E elem) Removes all equal elements.

Methods inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl

add, addAll, asSet, clear, contains, containsAll, equals, getKeyValues, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toList, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

copy

public KeyCollection<E> copy()

Description copied from class: KeyCollectionImpl

Returns a copy of this collection with all its elements. The new collection will use the same comparator, ordering, etc.

Overrides:

copy in class KeyCollectionImpl<E>

Returns:

a copy of this collection

crop

public KeyCollection<E> crop()

Description copied from class: KeyCollectionImpl

Returns a copy of this collection but without elements. The new collection will use the same comparator, ordering, etc.

Overrides:

crop in class KeyCollectionImpl<E>

Returns:

an empty copy of this collection

getAll

public GapList<E> getAll(E elem)

Description copied from class: KeyCollectionImpl

Returns all equal elements.

Parameters:

elem - element

Returns:

all equal elements (never null)

getCount

public int getCount(E elem)

Description copied from class: KeyCollectionImpl

Returns the number of equal elements.

Parameters:

elem - element

Returns:

number of equal elements

removeAll

public GapList<E> removeAll(E elem)

Description copied from class: KeyCollectionImpl

Removes all equal elements.

Parameters:

elem - element

Returns:

removed equal elements (never null)

getDistinct

public java.util.Set<E> getDistinct()

Description copied from class: KeyCollectionImpl

Returns all distinct elements in the same order as in the collection.

Returns:

distinct elements

put

public E put(E elem)

Description copied from class: KeyCollectionImpl

Adds or replaces element. If there is no such element, the element is added. If there is such an element and no duplicates are allowed, the existing element is replaced. If duplicates are allowed, the element is added.

Parameters:

elem - element

Returns:

element which has been replaced or null otherwise

invalidate

public void invalidate(E elem)

Description copied from class: KeyCollectionImpl

Invalidate element, i.e. all keys of the element are extracted again and stored in the key maps. Old key values are removed if needed. You must call an invalidate method if an element's key value has changed after adding it to the collection.

Parameters:

elem - element to invalidate