Class Key1Collection<E,K>
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 collectionK
- type of key
- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<E>
,Collection<E>
,ICollection<E>
- Direct Known Subclasses:
Key1Set
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 collection can be constraint (null/duplicate values).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder to construct Key1Collection instances.Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl
KeyCollectionImpl.BuilderImpl<E>, KeyCollectionImpl.KeyMap<E,
K>, KeyCollectionImpl.KeyMapList<E> -
Field Summary
Fields inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl
afterDeleteTrigger, afterInsertTrigger, allowNullElem, beforeDeleteTrigger, beforeInsertTrigger, constraint, keyList, keyMaps, maxSize, movingWindow, orderByKey, setBehavior, size, SYMBOL_ADDED, SYMBOL_ERROR_NULL_KEY, SYMBOL_NOT_ADDED
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Protected constructor used by builder or derived collections. -
Method Summary
Modifier and TypeMethodDescriptionasMap1()
Returns a map view to the key map.boolean
containsKey1
(K key) Checks whether an element with specified key exists.copy()
Returns a copy of this collection with all its elements.crop()
Returns a copy of this collection but without elements.Create a new collection by applying the specified filter to all elements.Returns all equal elements.getAllByKey1
(K key) Returns all elements with specified key.Returns list containing all keys in element order.protected Key1Collection.Builder
<E, K> Returns element with specified key.int
getCountByKey1
(K key) Returns the number of elements with specified key.Returns all distinct keys in the same order as in the key map.Returns mapper for key map.void
invalidate
(E elem) Invalidate element, i.e.void
invalidateKey1
(K oldKey, K newKey, E elem) Invalidate key value of element.Adds or replaces element.Adds element by key.Removes all equal elements.removeAllByKey1
(K key) Removes all elements with specified key.removeByKey1
(K key) Removes element with specified key.Methods inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl
add, addAll, addSorted, addUnsorted, asSet, binarySearchSorted, checkAddElem, checkAsMap, checkAsSet, checkElemAllowed, checkIndex, checkKeyMap, clear, clone, contains, containsAll, containsKey, debugCheck, doAdd, doAdd, doAddThrow, doInvalidateKey, doRemove, doRemoveByKey, equals, errorConstraintElement, errorDuplicateKey, errorInvalidateNotSupported, errorInvalidData, errorInvalidIndex, errorInvalidSetBehavior, errorInvaliDuplicates, errorMaxSize, errorNullElement, errorNullKey, filterMap, flatMap, getAllByKey, getAllByKey, getAllKeys, getByKey, getCount, getCountByKey, getDistinct, getDistinctKeys, getElemSortComparator, getKey, getKeyMap, getKeyMapper, hasElemSet, hashCode, indexOfSorted, initClone, initCopy, initCrop, invalidateKey, isContainsFast, isEmpty, isSorted, isSortedByElem, iterator, map, mapFilter, putByKey, remove, remove, removeAll, removeAllByKey, removeAllByKey, removeByKey, retainAll, setSorted, size, toArray, toArray, toList, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream, toArray
Methods inherited from interface org.magicwerk.brownies.collections.ICollection
containsIf, countIf, getFirst, getFirstOrNull, getIf, getSingle, getSingleOrNull
-
Constructor Details
-
Key1Collection
protected Key1Collection()Protected constructor used by builder or derived collections.
-
-
Method Details
-
getBuilder
- Returns:
- builder to use in extending classes
-
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.- Specified by:
copy
in interfaceICollection<E>
- Overrides:
copy
in classKeyCollectionImpl<E>
- Returns:
- a copy of this collection
-
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.- Specified by:
crop
in interfaceICollection<E>
- Overrides:
crop
in classKeyCollectionImpl<E>
- Returns:
- an empty copy of this collection
-
getAll
Description copied from class:KeyCollectionImpl
Returns all equal elements.- Overrides:
getAll
in classKeyCollectionImpl<E>
- Parameters:
elem
- element- Returns:
- all equal elements (never null)
-
removeAll
Description copied from class:KeyCollectionImpl
Removes all equal elements.- Overrides:
removeAll
in classKeyCollectionImpl<E>
- Parameters:
elem
- element- Returns:
- removed equal elements (never null)
-
put
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, the element is replaced. So said simply, it is a shortcut for the following code:remove(elem); add(elem);
However the method is atomic in the sense that all or none operations are executed. So if there is already such an element, but adding the new one fails due to a constraint violation, the old element remains in the list.- Overrides:
put
in classKeyCollectionImpl<E>
- Parameters:
elem
- element- Returns:
- element which has been replaced or null otherwise
-
invalidate
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.- Overrides:
invalidate
in classKeyCollectionImpl<E>
- Parameters:
elem
- element to invalidate
-
getKey1Mapper
Returns mapper for key map.- Returns:
- mapper for key map
-
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
- Throws:
IllegalArgumentException
- if the key map cannot be viewed as Map
-
containsKey1
Checks whether an element with specified key exists.- Parameters:
key
- key- Returns:
- true if element with specified key exists, otherwise false
-
getByKey1
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
Returns all elements with specified key.- Parameters:
key
- key- Returns:
- all elements with specified key (never null)
-
getCountByKey1
Returns the number of elements with specified key.- Parameters:
key
- key- Returns:
- number of elements with specified key
-
removeByKey1
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
Removes all elements with specified key.- Parameters:
key
- key- Returns:
- removed elements with specified key (never null)
-
getAllKeys1
Returns list containing all keys in element order.- Returns:
- list containing all keys
-
getDistinctKeys1
Returns all distinct keys in the same order as in the key map.- Returns:
- distinct keys
-
putByKey1
Adds element by key. If there is no such element, the element is added. If there is such an element, the element is replaced. So said simply, it is a shortcut for the following code:removeByKey1(elem.getKey1()); add(elem);
However the method is atomic in the sense that all or none operations are executed. So if there is already such an element, but adding the new one fails due to a constraint violation, the old element remains in the list.- Parameters:
elem
- element- Returns:
- element with the same key which has been replaced or null otherwise
-
invalidateKey1
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 valuenewKey
- new key valueelem
- element to invalidate (can be null if there are no duplicates with this key)
-
filter
Description copied from interface:ICollection
Create a new collection by applying the specified filter to all elements. The returned collection has the same type as the original one.- Specified by:
filter
in interfaceICollection<E>
- Overrides:
filter
in classKeyCollectionImpl<E>
- Parameters:
filter
- filter predicate- Returns:
- created list
-