org.magicwerk.brownies.collections

Class Key2Set<E,K1,K2>

java.lang.Object

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

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

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

Type Parameters:

E - type of elements stored in the set

All Implemented Interfaces:

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

public class Key2Set<E,K1,K2>
extends Key2Collection<E,K1,K2>
implements java.util.Set<E>

Key2Set implements a set. The elements allowed in the set can be constraint (null/duplicate values).

See Also:

Key2Collection, Serialized Form

Nested Class Summary

Nested Classes

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

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

KeyCollectionImpl.BuilderImpl<E>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Key2Set() Protected constructor used by builder or derived collections.

Method Summary

Modifier and Type	Method and Description
Key2Set<E,K1,K2>	copy() Returns a copy of this collection with all its elements.
Key2Set<E,K1,K2>	crop() Returns a copy of this collection but without elements.
Key2Set<E,K1,K2>	getAll(E elem) Returns all equal elements.
Key2Set<E,K1,K2>	getAllByKey1(K1 key) Returns all elements with specified key.
Key2Set<E,K1,K2>	getAllByKey2(K2 key) Returns all elements with specified key.
protected Key2Set.Builder<E,K1,K2>	getBuilder()

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

asMap1, asMap2, containsKey1, containsKey2, getAllKeys1, getAllKeys2, getByKey1, getByKey2, getCount, getCountByKey1, getCountByKey2, getDistinct, getDistinctKeys1, getDistinctKeys2, getKey1Mapper, getKey2Mapper, invalidate, invalidateKey1, invalidateKey2, put, putByKey1, putByKey2, removeAll, removeAllByKey1, removeAllByKey2, removeByKey1, removeByKey2

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

add, addAll, asSet, clear, clone, contains, containsAll, containsKey, doRemoveByKey, equals, getAllByKey, getAllByKey, getAllKeys, getByKey, getCountByKey, getDistinctKeys, getKeyMapper, hashCode, initClone, invalidateKey, isEmpty, isSorted, iterator, putByKey, remove, removeAll, removeAllByKey, removeAllByKey, removeByKey, retainAll, 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.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Key2Set

protected Key2Set()

Protected constructor used by builder or derived collections.

Method Detail

getBuilder

protected Key2Set.Builder<E,K1,K2> getBuilder()

Overrides:

getBuilder in class Key2Collection<E,K1,K2>

Returns:

builder to use in extending classes

copy

public Key2Set<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 Key2Collection<E,K1,K2>

Returns:

a copy of this collection

crop

public Key2Set<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 Key2Collection<E,K1,K2>

Returns:

an empty copy of this collection

getAll

public Key2Set<E,K1,K2> getAll(E elem)

Description copied from class: KeyCollectionImpl

Returns all equal elements.

Overrides:

getAll in class Key2Collection<E,K1,K2>

Parameters:

elem - element

Returns:

all equal elements (never null)

getAllByKey1

public Key2Set<E,K1,K2> getAllByKey1(K1 key)

Description copied from class: Key2Collection

Returns all elements with specified key.

Overrides:

getAllByKey1 in class Key2Collection<E,K1,K2>

Parameters:

key - key

Returns:

all elements with specified key (never null)

getAllByKey2

public Key2Set<E,K1,K2> getAllByKey2(K2 key)

Description copied from class: Key2Collection

Returns all elements with specified key.

Overrides:

getAllByKey2 in class Key2Collection<E,K1,K2>

Parameters:

key - key

Returns:

all elements with specified key (never null)