Key1Collection

java.lang.Object
- org.magicwerk.brownies.collections.KeyCollectionImpl<E>
- - org.magicwerk.brownies.collections.Key1Collection<E,K>

Type Parameters:
E - type of elements stored in the list
K - type of key

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>
```
public class Key1Collection<E,K>
extends KeyCollectionImpl<E>
```
Key1Collection implements a collection with 1 key. This key 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: Key1Collection.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 Key1Collection.Builder<E,K>
Builder to construct Key1Collection instances.
- Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl
  KeyCollectionImpl.BuilderImpl<E>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Key1Collection.Builder<E,K>` Builder to construct Key1Collection instances.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Map<K,E>`	`asMap1()` Returns a map view to the key map.
`boolean`	`containsKey1(K key)` Checks whether an element with specified key exists.
`Key1Collection<E,K>`	`copy()` Returns a copy of this collection with all its elements.
`Key1Collection<E,K>`	`crop()` Returns a copy of this collection but without elements.
`GapList<E>`	`getAll(E elem)` Returns all equal elements.
`GapList<E>`	`getAllByKey1(K key)` Returns all elements with specified key.
`E`	`getByKey1(K key)` Returns element with specified key.
`int`	`getCount(E elem)` Returns the number of equal elements.
`int`	`getCountByKey1(K 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<K>`	`getDistinctKeys1()` Returns all distinct keys in the same order as in the key map.
`Mapper<E,K>`	`getKey1Mapper()` 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(K oldKey, K newKey, E elem)` Invalidate key value of element.
`E`	`puByKey1(E elem)` Adds or replaces element with specified key.
`E`	`put(E elem)` Adds or replaces element.
`GapList<E>`	`removeAll(E elem)` Removes all equal elements.
`GapList<E>`	`removeAllByKey1(K key)` Removes all elements with specified key.
`E`	`removeByKey1(K key)` Removes element with specified key.

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 Key1Collection<E,K> 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 Key1Collection<E,K> 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 Mapper<E,K> getKey1Mapper()
```
    Returns mapper for key map.
    
    Returns:
    mapper for key map
  - asMap1
```
public java.util.Map<K,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(K 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(K 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
  - getAllByKey1
```
public GapList<E> getAllByKey1(K key)
```
    Returns all elements with specified key.
    
    Parameters:
    key - key
    
    Returns:
    all elements with specified key (never null)
  - getCountByKey1
```
public int getCountByKey1(K key)
```
    Returns the number of elements with specified key.
    
    Parameters:
    key - key
    
    Returns:
    number of elements with specified key
  - removeByKey1
```
public E removeByKey1(K 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(K key)
```
    Removes all elements with specified key.
    
    Parameters:
    key - key
    
    Returns:
    removed elements with specified key (never null)
  - getDistinctKeys1
```
public java.util.Set<K> getDistinctKeys1()
```
    Returns all distinct keys in the same order as in the key map.
    
    Returns:
    distinct keys
  - puByKey1
```
public E puByKey1(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(K oldKey,
                  K 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)

Class Key1Collection<E,K>

Nested Class Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

copy

crop

getAll

getCount

removeAll

getDistinct

put

invalidate

getKey1Mapper

asMap1

containsKey1

getByKey1

getAllByKey1

getCountByKey1

removeByKey1

removeAllByKey1

getDistinctKeys1

puByKey1

invalidateKey1