Class KeySet.Builder<E>
java.lang.Object
org.magicwerk.brownies.collections.KeyCollectionImpl.BuilderImpl<E>
org.magicwerk.brownies.collections.KeyCollection.Builder<E>
org.magicwerk.brownies.collections.KeySet.Builder<E>
Builder to construct KeySet instances.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl.BuilderImpl
KeyCollectionImpl.BuilderImpl.KeyMapBuilder<E,
K> -
Field Summary
Fields inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl.BuilderImpl
afterDeleteTrigger, afterInsertTrigger, allowNullElem, array, beforeDeleteTrigger, beforeInsertTrigger, capacity, collection, constraint, count, keyColl, keyList, keyMapBuilders, maxSize, movingWindow, setBehavior, useBigList
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
withAfterDeleteTrigger
(Consumer<E> trigger) Specify delete trigger.withAfterInsertTrigger
(Consumer<E> trigger) Specify insert trigger.withBeforeDeleteTrigger
(Consumer<E> trigger) Specify delete trigger.withBeforeInsertTrigger
(Consumer<E> trigger) Specify insert trigger.withCapacity
(int capacity) Specify initial capacity.withConstraint
(Predicate<E> constraint) Specify element constraint.withContent
(E... elements) Specify elements added to the collection upon creation.withContent
(Collection<? extends E> elements) Specify elements added to the collection upon creation.withElemCount
(boolean count) Specifies that the collection only counts the number of occurrences of equal elements, but does not store the elements themselves.withElemDuplicates
(boolean allowDuplicates) Specify whether duplicates are allowed or not.withElemDuplicates
(boolean allowDuplicates, boolean allowDuplicatesNull) Specify whether duplicates are allowed or not.withElemNull
(boolean allowNull) Specifies whether null elements are allowed or not.Add element map (with ident mapper).withElemSort
(boolean sort) Specify that the element set should be sorted using the natural comparator.withElemSort
(Comparator<? super E> comparator) Set comparator to use for sorting the element set.withElemSort
(Comparator<? super E> comparator, boolean sortNullsFirst) Set comparator to use for sorting the element set.withMaxSize
(int maxSize) Specify maximum size of collection.withNull
(boolean allowNull) Specifies whether null elements are allowed or not.withOrderByElem
(boolean orderBy) Specifies that the collection will have the order of the element set.Specify the element to be a primary key.withSetBehavior
(boolean setBehavior) Specifies that the collection behaves like aSet
on adding elements, i.e.Specify the element to be a unique key.Methods inherited from class org.magicwerk.brownies.collections.KeyCollectionImpl.BuilderImpl
build, buildKeyMap, getKeyMapBuilder, hasElemMapBuilder, init, init, initKeyMapBuilder, initList, isFalse, isTrue, withKey1Duplicates, withKey1Duplicates, withKey1Null, withKey1Sort, withKey2Duplicates, withKey2Duplicates, withKey2Null, withKey2Sort, withKeyDuplicates, withKeyMap, withKeyNull, withKeySort, withKeySort, withKeySort, withListBig, withListType, withOrderByElem, withOrderByKey, withOrderByKey, withOrderByKey1, withOrderByKey1, withOrderByKey2, withOrderByKey2, withPrimaryKeyMap, withUniqueKeyMap, withWindowSize
-
Constructor Details
-
Builder
public Builder()Default constructor. -
Builder
Private constructor used if extending KeySet.- Parameters:
keySet
- key set
-
-
Method Details
-
build
- Overrides:
build
in classKeyCollection.Builder<E>
- Returns:
- created collection
-
withSetBehavior
Specifies that the collection behaves like aSet
on adding elements, i.e. if an element cannot be added due to duplicate or other constraints, no exception is thrown.Note that
KeySet
only supports set behavior, so an exception is thrown if the argument is false.- Overrides:
withSetBehavior
in classKeyCollection.Builder<E>
- Parameters:
setBehavior
- true to define set behavior (default is false)- Returns:
- this (fluent interface)
-
withElemDuplicates
Specify whether duplicates are allowed or not. This method does implicitly create an element set.Note that
KeySet
does not support duplicates, so an exception is thrown if the argument is true.- Overrides:
withElemDuplicates
in classKeyCollection.Builder<E>
- Parameters:
allowDuplicates
- true to allow duplicates (default is true)- Returns:
- this (fluent interfaces)
-
withElemDuplicates
Specify whether duplicates are allowed or not. This method does implicitly create an element set.Note that
KeySet
does not support duplicates, so an exception is thrown if any argument is true.- Overrides:
withElemDuplicates
in classKeyCollection.Builder<E>
- Parameters:
allowDuplicates
- true to allow duplicates (default is true)allowDuplicatesNull
- true to allow duplicate null values (default is true)- Returns:
- this (fluent interfaces)
-
withNull
Description copied from class:KeyCollectionImpl.BuilderImpl
Specifies whether null elements are allowed or not. A null element will have null keys. This method does not implicitly create an element set, where asKeyCollectionImpl.BuilderImpl.withElemNull(boolean)
does.- Overrides:
withNull
in classKeyCollection.Builder<E>
- Parameters:
allowNull
- true to allow null elements (default), false to disallow- Returns:
- this (fluent interfaces)
-
withConstraint
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify element constraint.- Overrides:
withConstraint
in classKeyCollection.Builder<E>
- Parameters:
constraint
- constraint element must satisfy, null for none (default)- Returns:
- this (fluent interface)
-
withBeforeInsertTrigger
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify insert trigger.- Overrides:
withBeforeInsertTrigger
in classKeyCollection.Builder<E>
- Parameters:
trigger
- insert trigger method, null for none (default)- Returns:
- this (fluent interface)
-
withAfterInsertTrigger
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify insert trigger.- Overrides:
withAfterInsertTrigger
in classKeyCollection.Builder<E>
- Parameters:
trigger
- insert trigger method, null for none (default)- Returns:
- this (fluent interface)
-
withBeforeDeleteTrigger
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify delete trigger.- Overrides:
withBeforeDeleteTrigger
in classKeyCollection.Builder<E>
- Parameters:
trigger
- delete trigger method, null for none (default)- Returns:
- this (fluent interface)
-
withAfterDeleteTrigger
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify delete trigger.- Overrides:
withAfterDeleteTrigger
in classKeyCollection.Builder<E>
- Parameters:
trigger
- delete trigger method, null for none (default)- Returns:
- this (fluent interface)
-
withCapacity
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify initial capacity.- Overrides:
withCapacity
in classKeyCollection.Builder<E>
- Parameters:
capacity
- initial capacity- Returns:
- this (fluent interface)
-
withContent
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify elements added to the collection upon creation.- Overrides:
withContent
in classKeyCollection.Builder<E>
- Parameters:
elements
- initial elements- Returns:
- this (fluent interface)
-
withContent
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify elements added to the collection upon creation.- Overrides:
withContent
in classKeyCollection.Builder<E>
- Parameters:
elements
- initial elements- Returns:
- this (fluent interface)
-
withMaxSize
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify maximum size of collection. If an attempt is made to add more elements, an exception is thrown.- Overrides:
withMaxSize
in classKeyCollection.Builder<E>
- Parameters:
maxSize
- maximum size- Returns:
- this (fluent interface)
-
withElemCount
Specifies that the collection only counts the number of occurrences of equal elements, but does not store the elements themselves.Note that
KeySet
does not support duplicates, so an exception is thrown if the argument is true.- Overrides:
withElemCount
in classKeyCollection.Builder<E>
- Parameters:
count
- true to count only number of occurrences (default is false)- Returns:
- this (fluent interface)
-
withElemSet
Add element map (with ident mapper).Note that a
KeyCollection
always has an element set, so this call is not necessary.Note that a
KeySet
always has an element set, so this call is not necessary.- Overrides:
withElemSet
in classKeyCollection.Builder<E>
- Returns:
- this (fluent interface)
-
withOrderByElem
Description copied from class:KeyCollectionImpl.BuilderImpl
Specifies that the collection will have the order of the element set. The element set must be sorted, if no sort order has been defined, the natural comparator will be used. If the set allows null values, the used comparator will sort them last.- Overrides:
withOrderByElem
in classKeyCollection.Builder<E>
- Parameters:
orderBy
- if true the collection will have the order of the element set (default is false, only one key map or the element set can have the order by option set)- Returns:
- this (fluent interface)
-
withElemNull
Description copied from class:KeyCollectionImpl.BuilderImpl
Specifies whether null elements are allowed or not. A null element will have null keys. This method does implicitly create an element set, where asKeyCollectionImpl.BuilderImpl.withNull(boolean)
does not.- Overrides:
withElemNull
in classKeyCollection.Builder<E>
- Parameters:
allowNull
- true to allow null elements, false to disallow (default is true)- Returns:
- this (fluent interfaces)
-
withElemSort
Description copied from class:KeyCollectionImpl.BuilderImpl
Specify that the element set should be sorted using the natural comparator. If the collection supports null values, they are sorted last. This method does implicitly create an element set. Note that this does not automatically sort the collection itself, call a withOrderBy method for this.- Overrides:
withElemSort
in classKeyCollection.Builder<E>
- Parameters:
sort
- true to sorted, false for unsorted (default is false)- Returns:
- this (fluent interface)
-
withElemSort
Description copied from class:KeyCollectionImpl.BuilderImpl
Set comparator to use for sorting the element set. If the collection allows null values, the comparator must be able to compare null values. If the comparator does not support null values, use withElemSort(Comparator, boolean) to explicitly specify how null values should be sorted. This method does implicitly create an element set. Note that this does not automatically sort the collection itself, call a withOrderBy method for this.- Overrides:
withElemSort
in classKeyCollection.Builder<E>
- Parameters:
comparator
- comparator to use for sorting (null for natural comparator)- Returns:
- this (fluent interface)
-
withElemSort
Description copied from class:KeyCollectionImpl.BuilderImpl
Set comparator to use for sorting the element set. This method should be used if the collection can contain null values, but the comparator is not able to handle them. The parameter sortNullsFirst determine how the null values should be sorted. This method does implicitly create an element set.- Overrides:
withElemSort
in classKeyCollection.Builder<E>
- Parameters:
comparator
- comparator to use for sortingsortNullsFirst
- true to sort null values first, false for last- Returns:
- this (fluent interface)
-
withPrimaryElem
Specify the element to be a primary key. This is identical to callingwithElemNull(false) and withElemDuplicates(false)
.Note that a
Key2Set
always has an element set, so this call is not necessary.- Overrides:
withPrimaryElem
in classKeyCollection.Builder<E>
- Returns:
- this (fluent interface)
-
withUniqueElem
Specify the element to be a unique key. This is identical to callingwithElemNull(true) and withElemDuplicates(false, true)
.Note that a
KeySet
always has an element set, so an exception is thrown.- Overrides:
withUniqueElem
in classKeyCollection.Builder<E>
- Returns:
- this (fluent interface)
-