org.magicwerk.brownies.collections

Class Key1Set<E,K>

java.lang.Object

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

org.magicwerk.brownies.collections.Key1Collection<E,K>

org.magicwerk.brownies.collections.Key1Set<E,K>

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 Key1Set<E,K>
extends Key1Collection<E,K>
implements java.util.Set<E>

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

See Also:

Key1Collection, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Key1Set.Builder<E,K> 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	Key1Set() Protected constructor used by builder or derived collections.

Method Summary

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

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

asMap1, containsKey1, getAllKeys1, getByKey1, getCount, getCountByKey1, getDistinct, getDistinctKeys1, getKey1Mapper, invalidate, invalidateKey1, put, putByKey1, removeAll, removeAllByKey1, removeByKey1

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

Key1Set

protected Key1Set()

Protected constructor used by builder or derived collections.

Method Detail

getBuilder

protected Key1Set.Builder<E,K> getBuilder()

Overrides:

getBuilder in class Key1Collection<E,K>

Returns:

builder to use in extending classes

copy

public Key1Set<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 Key1Collection<E,K>

Returns:

a copy of this collection

crop

public Key1Set<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 Key1Collection<E,K>

Returns:

an empty copy of this collection

getAll

public Key1Set<E,K> getAll(E elem)

Description copied from class: KeyCollectionImpl

Returns all equal elements.

Overrides:

getAll in class Key1Collection<E,K>

Parameters:

elem - element

Returns:

all equal elements (never null)

getAllByKey1

public Key1Set<E,K> getAllByKey1(K key)

Description copied from class: Key1Collection

Returns all elements with specified key.

Overrides:

getAllByKey1 in class Key1Collection<E,K>

Parameters:

key - key

Returns:

all elements with specified key (never null)