org.magicwerk.brownies.collections

Class KeySet<E>

java.lang.Object

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

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

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

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 KeySet<E>
extends KeyCollection<E>
implements java.util.Set<E>

KeySet 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	KeySet.Builder<E> 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	KeySet() Protected constructor used by builder or derived collections.

Method Summary

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

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

getCount, getDistinct, invalidate, put, removeAll

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

KeySet

protected KeySet()

Protected constructor used by builder or derived collections.

Method Detail

getBuilder

protected KeySet.Builder<E> getBuilder()

Overrides:

getBuilder in class KeyCollection<E>

Returns:

builder to use in extending classes

copy

public KeySet<E> 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 KeyCollection<E>

Returns:

a copy of this collection

crop

public KeySet<E> 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 KeyCollection<E>

Returns:

an empty copy of this collection

getAll

public KeySet<E> getAll(E elem)

Description copied from class: KeyCollectionImpl

Returns all equal elements.

Overrides:

getAll in class KeyCollection<E>

Parameters:

elem - element

Returns:

all equal elements (never null)