org.magicwerk.brownies.collections

Class Key2Collection<E,K1,K2>

java.lang.Object

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

org.magicwerk.brownies.collections.Key2Collection<E,K1,K2>

Type Parameters:

E - type of elements stored in the list

K1 - type of first key

K2 - type of second key

All Implemented Interfaces:

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

public class Key2Collection<E,K1,K2>
extends KeyCollectionImpl<E>

Key2Collection implements a collection with 2 keys. These keys can be accessed fast. 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: Key2Collection.java 2745 2015-03-03 23:14:34Z origo $

Author:

Thomas Mauch

See Also:

Key1List, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key2Collection.Builder<E,K1,K2> Builder to construct Key2Collection instances.

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

KeyCollectionImpl.BuilderImpl<E>

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<K1,E>	asMap1() Returns a map view to the key map.
java.util.Map<K2,E>	asMap2() Returns a map view to the key map.
boolean	containsKey1(K1 key) Checks whether an element with specified key exists.
boolean	containsKey2(K2 key) Checks whether an element with specified key exists.
Key2Collection<E,K1,K2>	copy() Returns a copy of this collection with all its elements.
Key2Collection<E,K1,K2>	crop() Returns a copy of this collection but without elements.
GapList<E>	getAll(E elem) Returns all equal elements.
GapList<E>	getAllByKey1(K1 key) Returns all elements with specified key.
GapList<E>	getAllByKey2(K2 key) Returns all elements with specified key.
E	getByKey1(K1 key) Returns all elements with specified key.
E	getByKey2(K2 key) Returns element with specified key.
int	getCount(E elem) Returns the number of equal elements.
int	getCountByKey1(K1 key) Returns the number of elements with specified key.
int	getCountByKey2(K2 key) Returns the number of elements with specified key.
java.util.Set<E>	getDistinct() Returns all distinct elements in the same order as in the collection.
java.util.Set<K1>	getDistinctKeys1() Returns all distinct keys in the same order as in the key map.
java.util.Set<K2>	getDistinctKeys2() Returns all distinct keys in the same order as in the key map.
IFunction<E,K1>	getKey1Mapper() Returns mapper for key map.
IFunction<E,K2>	getKey2Mapper() Returns mapper for key map.
void	invalidate(E elem) Invalidate element, i.e. all keys of the element are extracted again and stored in the key maps.
void	invalidateKey1(K1 oldKey, K1 newKey, E elem) Invalidate key value of element.
void	invalidateKey2(K2 oldKey, K2 newKey, E elem) Invalidate key value of element.
E	put(E elem) Adds or replaces element.
E	putByKey1(E elem) Adds or replaces element with specified key.
E	putByKey2(E elem) Adds or replaces element with specified key.
GapList<E>	removeAll(E elem) Removes all equal elements.
GapList<E>	removeAllByKey1(K1 key) Removes all elements with specified key.
GapList<E>	removeAllByKey2(K2 key) Removes all elements with specified key.
E	removeByKey1(K1 key) Removes element with specified key.
E	removeByKey2(K2 key) Removes element with specified key.

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

add, addAll, asSet, clear, contains, containsAll, equals, 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 Key2Collection<E,K1,K2> 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 Key2Collection<E,K1,K2> 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

getKey1Mapper

public IFunction<E,K1> getKey1Mapper()

Returns mapper for key map.

Returns:

mapper for key map

asMap1

public java.util.Map<K1,E> asMap1()

Returns a map view to the key map. The collection can be modified through the map as long as the constraint are not violated. The collections returned by the methods entrySet(), keySet(), and values() are immutable however.

Returns:

map view to key map

containsKey1

public boolean containsKey1(K1 key)

Checks whether an element with specified key exists.

Parameters:

key - key

Returns:

true if element with specified key exists, otherwise false

getByKey1

public E getByKey1(K1 key)

Returns all elements with specified key. The returned list is immutable.

Parameters:

key - key

Returns:

all elements with specified key (never null)

getAllByKey1

public GapList<E> getAllByKey1(K1 key)

Returns all elements with specified key.

Parameters:

key - key

Returns:

all elements with specified key (never null)

getCountByKey1

public int getCountByKey1(K1 key)

Returns the number of elements with specified key.

Parameters:

key - key

Returns:

number of elements with specified key

removeByKey1

public E removeByKey1(K1 key)

Removes element with specified key. If there are several elements with the same key, the one added first will be removed.

Parameters:

key - key

Returns:

element with specified key or null

removeAllByKey1

public GapList<E> removeAllByKey1(K1 key)

Removes all elements with specified key.

Parameters:

key - key

Returns:

removed elements with specified key (never null)

getDistinctKeys1

public java.util.Set<K1> getDistinctKeys1()

Returns all distinct keys in the same order as in the key map.

Returns:

distinct keys

putByKey1

public E putByKey1(E elem)

Adds or replaces element with specified key. If there is no element with specified key, the element is added. If there is an element with specified key 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

invalidateKey1

public void invalidateKey1(K1 oldKey,
                  K1 newKey,
                  E elem)

Invalidate key value of element. You must call an invalidate method if an element's key value has changed after adding it to the collection.

Parameters:

oldKey - old key value

newKey - new key value

elem - element to invalidate (can be null if there are no duplicates with this key)

getKey2Mapper

public IFunction<E,K2> getKey2Mapper()

Returns mapper for key map.

Returns:

mapper for key map

asMap2

public java.util.Map<K2,E> asMap2()

Returns a map view to the key map. The collection can be modified through the map as long as the constraint are not violated. The collections returned by the methods entrySet(), keySet(), and values() are immutable however.

Returns:

map view to key map

containsKey2

public boolean containsKey2(K2 key)

Checks whether an element with specified key exists.

Parameters:

key - key

Returns:

true if element with specified key exists, otherwise false

getByKey2

public E getByKey2(K2 key)

Returns element with specified key. If there are several elements with the same key, the one added first will be returned.

Parameters:

key - key

Returns:

element with specified key or null

getAllByKey2

public GapList<E> getAllByKey2(K2 key)

Returns all elements with specified key.

Parameters:

key - key

Returns:

all elements with specified key (never null)

getCountByKey2

public int getCountByKey2(K2 key)

Returns the number of elements with specified key.

Parameters:

key - key

Returns:

number of elements with specified key

removeByKey2

public E removeByKey2(K2 key)

Removes element with specified key. If there are several elements with the same key, the one added first will be removed.

Parameters:

key - key

Returns:

element with specified key or null

removeAllByKey2

public GapList<E> removeAllByKey2(K2 key)

Removes all elements with specified key.

Parameters:

key - key

Returns:

removed elements with specified key (never null)

getDistinctKeys2

public java.util.Set<K2> getDistinctKeys2()

Returns all distinct keys in the same order as in the key map.

Returns:

distinct keys

putByKey2

public E putByKey2(E elem)

Adds or replaces element with specified key. If there is no element with specified key, the element is added. If there is an element with specified key 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

invalidateKey2

public void invalidateKey2(K2 oldKey,
                  K2 newKey,
                  E elem)

Invalidate key value of element. You must call an invalidate method if an element's key value has changed after adding it to the collection.

Parameters:

oldKey - old key value

newKey - new key value

elem - element to invalidate (can be null if there are no duplicates with this key)