org.magicwerk.brownies.collections

Class Key2Set.Builder<E,K1,K2>

java.lang.Object

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

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

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

Enclosing class:

Key2Set<E,K1,K2>

public static class Key2Set.Builder<E,K1,K2>
extends Key2Collection.Builder<E,K1,K2>

Builder to construct Key2Set instances.

Nested Class Summary

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

KeyCollectionImpl.BuilderImpl.KeyMapBuilder<E,K>

Constructor Summary

Constructors

Constructor and Description
Builder() Default constructor.

Method Summary

Modifier and Type	Method and Description
Key2Set<E,K1,K2>	build()
Key2Set.Builder<E,K1,K2>	withAfterDeleteTrigger(java.util.function.Consumer<E> trigger) Specify delete trigger.
Key2Set.Builder<E,K1,K2>	withAfterInsertTrigger(java.util.function.Consumer<E> trigger) Specify insert trigger.
Key2Set.Builder<E,K1,K2>	withBeforeDeleteTrigger(java.util.function.Consumer<E> trigger) Specify delete trigger.
Key2Set.Builder<E,K1,K2>	withBeforeInsertTrigger(java.util.function.Consumer<E> trigger) Specify insert trigger.
Key2Set.Builder<E,K1,K2>	withCapacity(int capacity) Specify initial capacity.
Key2Set.Builder<E,K1,K2>	withConstraint(java.util.function.Predicate<E> constraint) Specify element constraint.
Key2Set.Builder<E,K1,K2>	withContent(java.util.Collection<? extends E> elements) Specify elements added to the collection upon creation.
Key2Set.Builder<E,K1,K2>	withContent(E... elements) Specify elements added to the collection upon creation.
Key2Set.Builder<E,K1,K2>	withElemCount(boolean count) Specifies that the collection only counts the number of occurrences of equal elements, but does not store the elements themselves.
Key2Set.Builder<E,K1,K2>	withElemDuplicates(boolean allowDuplicates) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withElemDuplicates(boolean allowDuplicates, boolean allowDuplicatesNull) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withElemNull(boolean allowNull) Specifies whether null elements are allowed or not.
Key2Set.Builder<E,K1,K2>	withElemSet() Add element map (with ident mapper).
Key2Set.Builder<E,K1,K2>	withElemSort(boolean sort) Specify that the element set should be sorted using the natural comparator.
Key2Set.Builder<E,K1,K2>	withElemSort(java.util.Comparator<? super E> comparator) Set comparator to use for sorting the element set.
Key2Set.Builder<E,K1,K2>	withElemSort(java.util.Comparator<? super E> comparator, boolean sortNullsFirst) Set comparator to use for sorting the element set.
Key2Set.Builder<E,K1,K2>	withKey1Duplicates(boolean allowDuplicates) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey1Duplicates(boolean allowDuplicates, boolean allowDuplicatesNull) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey1Map(java.util.function.Function<? super E,K1> mapper) Add key map.
Key2Set.Builder<E,K1,K2>	withKey1Null(boolean allowNull) Specify whether null elements are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey1Sort(boolean sort) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withKey1Sort(java.util.Comparator<? super K1> comparator) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withKey1Sort(java.util.Comparator<? super K1> comparator, boolean sortNullsFirst) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withKey2Duplicates(boolean allowDuplicates) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey2Duplicates(boolean allowDuplicates, boolean allowDuplicatesNull) Specify whether duplicates are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey2Map(java.util.function.Function<? super E,K2> mapper) Add key map.
Key2Set.Builder<E,K1,K2>	withKey2Null(boolean allowNull) Specify whether null elements are allowed or not.
Key2Set.Builder<E,K1,K2>	withKey2Sort(boolean sort) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withKey2Sort(java.util.Comparator<? super K2> comparator) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withKey2Sort(java.util.Comparator<? super K2> comparator, boolean sortNullsFirst) Set comparator to use for sorting the key map.
Key2Set.Builder<E,K1,K2>	withMaxSize(int maxSize) Specify maximum size of collection.
Key2Set.Builder<E,K1,K2>	withNull(boolean allowNull) Specifies whether null elements are allowed or not.
Key2Set.Builder<E,K1,K2>	withOrderByElem(boolean orderBy) Specifies that the collection will have the order of the element set.
Key2Set.Builder<E,K1,K2>	withOrderByKey1(boolean orderBy) Specifies that the collection will have the order of the key map.
Key2Set.Builder<E,K1,K2>	withOrderByKey2(boolean orderBy) Specifies that the collection will have the order of the key map.
Key2Set.Builder<E,K1,K2>	withPrimaryElem() Specify the element to be a primary key.
Key2Set.Builder<E,K1,K2>	withPrimaryKey1Map(java.util.function.Function<? super E,K1> mapper) Specify this key to be a primary key.
Key2Set.Builder<E,K1,K2>	withPrimaryKey2Map(java.util.function.Function<? super E,K2> mapper) Specify this key to be a primary key.
Key2Set.Builder<E,K1,K2>	withSetBehavior(boolean setBehavior) Specifies that the collection behaves like a Set on adding elements, i.e.
Key2Set.Builder<E,K1,K2>	withUniqueElem() Specify the element to be a unique key.
Key2Set.Builder<E,K1,K2>	withUniqueKey1Map(java.util.function.Function<? super E,K1> mapper) Specify this key to be a unique key.
Key2Set.Builder<E,K1,K2>	withUniqueKey2Map(java.util.function.Function<? super E,K2> mapper) Specify this key to be a unique key.

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

withKeyDuplicates, withKeyMap, withKeyNull, withKeySort, withKeySort, withKeySort, withListBig, withListType, withOrderByElem, withOrderByKey, withOrderByKey, withOrderByKey1, withOrderByKey2, withPrimaryKeyMap, withUniqueKeyMap, withWindowSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Default constructor.

Method Detail

build

public Key2Set<E,K1,K2> build()

Overrides:

build in class Key2Collection.Builder<E,K1,K2>

Returns:

created collection

withSetBehavior

public Key2Set.Builder<E,K1,K2> withSetBehavior(boolean setBehavior)

Specifies that the collection behaves like a Set on adding elements, i.e. if an element cannot be added due to duplicate or other constraints, no exception is thrown.

Note that Key2Set only supports set behavior, so an exception is thrown if the argument is false.

Overrides:

withSetBehavior in class Key2Collection.Builder<E,K1,K2>

Parameters:

setBehavior - true to define set behavior (default is false)

Returns:

this (fluent interface)

withElemDuplicates

public Key2Set.Builder<E,K1,K2> withElemDuplicates(boolean allowDuplicates)

Specify whether duplicates are allowed or not. This method does implicitly create an element set.

Note that Key2Set does not support duplicates, so an exception is thrown if the argument is true.

Overrides:

withElemDuplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates (default is true)

Returns:

this (fluent interfaces)

withElemDuplicates

public Key2Set.Builder<E,K1,K2> withElemDuplicates(boolean allowDuplicates,
                                                   boolean allowDuplicatesNull)

Specify whether duplicates are allowed or not. This method does implicitly create an element set.

Note that Key2Set does not support duplicates, so an exception is thrown if any argument is true.

Overrides:

withElemDuplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates (default is true)

allowDuplicatesNull - true to allow duplicate null values (default is true)

Returns:

this (fluent interfaces)

withNull

public Key2Set.Builder<E,K1,K2> withNull(boolean allowNull)

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 as KeyCollectionImpl.BuilderImpl.withElemNull(boolean) does.

Overrides:

withNull in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowNull - true to allow null elements (default), false to disallow

Returns:

this (fluent interfaces)

withConstraint

public Key2Set.Builder<E,K1,K2> withConstraint(java.util.function.Predicate<E> constraint)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify element constraint.

Overrides:

withConstraint in class Key2Collection.Builder<E,K1,K2>

Parameters:

constraint - constraint element must satisfy, null for none (default)

Returns:

this (fluent interface)

withBeforeInsertTrigger

public Key2Set.Builder<E,K1,K2> withBeforeInsertTrigger(java.util.function.Consumer<E> trigger)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify insert trigger.

Overrides:

withBeforeInsertTrigger in class Key2Collection.Builder<E,K1,K2>

Parameters:

trigger - insert trigger method, null for none (default)

Returns:

this (fluent interface)

withAfterInsertTrigger

public Key2Set.Builder<E,K1,K2> withAfterInsertTrigger(java.util.function.Consumer<E> trigger)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify insert trigger.

Overrides:

withAfterInsertTrigger in class Key2Collection.Builder<E,K1,K2>

Parameters:

trigger - insert trigger method, null for none (default)

Returns:

this (fluent interface)

withBeforeDeleteTrigger

public Key2Set.Builder<E,K1,K2> withBeforeDeleteTrigger(java.util.function.Consumer<E> trigger)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify delete trigger.

Overrides:

withBeforeDeleteTrigger in class Key2Collection.Builder<E,K1,K2>

Parameters:

trigger - delete trigger method, null for none (default)

Returns:

this (fluent interface)

withAfterDeleteTrigger

public Key2Set.Builder<E,K1,K2> withAfterDeleteTrigger(java.util.function.Consumer<E> trigger)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify delete trigger.

Overrides:

withAfterDeleteTrigger in class Key2Collection.Builder<E,K1,K2>

Parameters:

trigger - delete trigger method, null for none (default)

Returns:

this (fluent interface)

withCapacity

public Key2Set.Builder<E,K1,K2> withCapacity(int capacity)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify initial capacity.

Overrides:

withCapacity in class Key2Collection.Builder<E,K1,K2>

Parameters:

capacity - initial capacity

Returns:

this (fluent interface)

withContent

public Key2Set.Builder<E,K1,K2> withContent(java.util.Collection<? extends E> elements)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify elements added to the collection upon creation.

Overrides:

withContent in class Key2Collection.Builder<E,K1,K2>

Parameters:

elements - initial elements

Returns:

this (fluent interface)

withContent

public Key2Set.Builder<E,K1,K2> withContent(E... elements)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify elements added to the collection upon creation.

Overrides:

withContent in class Key2Collection.Builder<E,K1,K2>

Parameters:

elements - initial elements

Returns:

this (fluent interface)

withMaxSize

public Key2Set.Builder<E,K1,K2> withMaxSize(int maxSize)

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 class Key2Collection.Builder<E,K1,K2>

Parameters:

maxSize - maximum size

Returns:

this (fluent interface)

withElemCount

public Key2Set.Builder<E,K1,K2> withElemCount(boolean count)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specifies that the collection only counts the number of occurrences of equal elements, but does not store the elements themselves.

Overrides:

withElemCount in class KeyCollectionImpl.BuilderImpl<E>

Parameters:

count - true to count only number of occurrences (default is false)

Returns:

this (fluent interface)

withElemSet

public Key2Set.Builder<E,K1,K2> withElemSet()

Add element map (with ident mapper).

Note that a Key2Set always has an element set, so this call is not necessary.

Overrides:

withElemSet in class Key2Collection.Builder<E,K1,K2>

Returns:

this (fluent interface)

withOrderByElem

public Key2Set.Builder<E,K1,K2> withOrderByElem(boolean orderBy)

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 class Key2Collection.Builder<E,K1,K2>

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

public Key2Set.Builder<E,K1,K2> withElemNull(boolean allowNull)

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 as KeyCollectionImpl.BuilderImpl.withNull(boolean) does not.

Overrides:

withElemNull in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowNull - true to allow null elements, false to disallow (default is true)

Returns:

this (fluent interfaces)

withElemSort

public Key2Set.Builder<E,K1,K2> withElemSort(boolean sort)

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 class Key2Collection.Builder<E,K1,K2>

Parameters:

sort - true to sorted, false for unsorted (default is false)

Returns:

this (fluent interface)

withElemSort

public Key2Set.Builder<E,K1,K2> withElemSort(java.util.Comparator<? super E> comparator)

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 class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting (null for natural comparator)

Returns:

this (fluent interface)

withElemSort

public Key2Set.Builder<E,K1,K2> withElemSort(java.util.Comparator<? super E> comparator,
                                             boolean sortNullsFirst)

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 class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting

sortNullsFirst - true to sort null values first, false for last

Returns:

this (fluent interface)

withPrimaryElem

public Key2Set.Builder<E,K1,K2> withPrimaryElem()

Specify the element to be a primary key. This is identical to calling withElemNull(false) and withElemDuplicates(false).

Note that a Key2Set always has an element set, so this call is not necessary.

Overrides:

withPrimaryElem in class Key2Collection.Builder<E,K1,K2>

Returns:

this (fluent interface)

withUniqueElem

public Key2Set.Builder<E,K1,K2> withUniqueElem()

Specify the element to be a unique key. This is identical to calling withElemNull(true) and withElemDuplicates(false, true).

Note that a Key2Set always has an element set, so an exception is thrown.

Overrides:

withUniqueElem in class Key2Collection.Builder<E,K1,K2>

Returns:

this (fluent interface)

withKey1Map

public Key2Set.Builder<E,K1,K2> withKey1Map(java.util.function.Function<? super E,K1> mapper)

Add key map.

Overrides:

withKey1Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withPrimaryKey1Map

public Key2Set.Builder<E,K1,K2> withPrimaryKey1Map(java.util.function.Function<? super E,K1> mapper)

Specify this key to be a primary key. This is identical to calling withKey1Map(mapper), withKey1Null(false), and withKey1Duplicates(false).

Overrides:

withPrimaryKey1Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withUniqueKey1Map

public Key2Set.Builder<E,K1,K2> withUniqueKey1Map(java.util.function.Function<? super E,K1> mapper)

Specify this key to be a unique key. This is identical to calling withKey1Map(mapper), withKey1Null(true), and withKey1Duplicates(false, true).

Overrides:

withUniqueKey1Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withOrderByKey1

public Key2Set.Builder<E,K1,K2> withOrderByKey1(boolean orderBy)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specifies that the collection will have the order of the key map. The key map must be sorted, if no sort order has been defined, the natural comparator will be used. If the map allows null values, the used comparator will sort them last.

Overrides:

withOrderByKey1 in class Key2Collection.Builder<E,K1,K2>

Parameters:

orderBy - if true the collection will have the order of the key map (default is false, only one key map or the element set can have the order by option set)

Returns:

this (fluent interface)

withKey1Null

public Key2Set.Builder<E,K1,K2> withKey1Null(boolean allowNull)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether null elements are allowed or not. A null element will have a null key.

Overrides:

withKey1Null in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowNull - true to allow null elements, false to disallow

Returns:

this (fluent interfaces)

withKey1Duplicates

public Key2Set.Builder<E,K1,K2> withKey1Duplicates(boolean allowDuplicates)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether duplicates are allowed or not.

Overrides:

withKey1Duplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates

Returns:

this (fluent interfaces)

withKey1Duplicates

public Key2Set.Builder<E,K1,K2> withKey1Duplicates(boolean allowDuplicates,
                                                   boolean allowDuplicatesNull)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether duplicates are allowed or not.

Overrides:

withKey1Duplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates

allowDuplicatesNull - true to allow duplicate null values

Returns:

this (fluent interfaces)

withKey1Sort

public Key2Set.Builder<E,K1,K2> withKey1Sort(boolean sort)

Description copied from class: KeyCollectionImpl.BuilderImpl

Set comparator to use for sorting the key map. Note that this does not automatically sort the list itself, call a withOrderBy method for this.

Overrides:

withKey1Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

sort - true to sort key map

Returns:

this (fluent interface)

withKey1Sort

public Key2Set.Builder<E,K1,K2> withKey1Sort(java.util.Comparator<? super K1> comparator)

Set comparator to use for sorting the key map. Note that this does not automatically sort the list collection, call a withOrderBy method for this.

Overrides:

withKey1Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting

Returns:

this (fluent interface)

withKey1Sort

public Key2Set.Builder<E,K1,K2> withKey1Sort(java.util.Comparator<? super K1> comparator,
                                             boolean sortNullsFirst)

Set comparator to use for sorting the key map. Note that this does not automatically sort the list collection, call a withOrderBy method for this.

Overrides:

withKey1Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting

sortNullsFirst - true if null will be sorted first, false for last

Returns:

this (fluent interface)

withKey2Map

public Key2Set.Builder<E,K1,K2> withKey2Map(java.util.function.Function<? super E,K2> mapper)

Add key map.

Overrides:

withKey2Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withPrimaryKey2Map

public Key2Set.Builder<E,K1,K2> withPrimaryKey2Map(java.util.function.Function<? super E,K2> mapper)

Specify this key to be a primary key. This is identical to calling withKey2Map(mapper), withKey2Null(false), and withKey2Duplicates(false).

Overrides:

withPrimaryKey2Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withUniqueKey2Map

public Key2Set.Builder<E,K1,K2> withUniqueKey2Map(java.util.function.Function<? super E,K2> mapper)

Specify this key to be a unique key. This is identical to calling withKey2Map(mapper), withKey2Null(true), and withKey2Duplicates(false, true).

Overrides:

withUniqueKey2Map in class Key2Collection.Builder<E,K1,K2>

Parameters:

mapper - mapper to use

Returns:

this (fluent interface)

withOrderByKey2

public Key2Set.Builder<E,K1,K2> withOrderByKey2(boolean orderBy)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specifies that the collection will have the order of the key map. The key map must be sorted, if no sort order has been defined, the natural comparator will be used. If the map allows null values, the used comparator will sort them last.

Overrides:

withOrderByKey2 in class Key2Collection.Builder<E,K1,K2>

Parameters:

orderBy - if true the collection will have the order of the key map (default is false, only one key map or the element set can have the order by option set)

Returns:

this (fluent interface)

withKey2Null

public Key2Set.Builder<E,K1,K2> withKey2Null(boolean allowNull)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether null elements are allowed or not. A null element will have a null key.

Overrides:

withKey2Null in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowNull - true to allow null elements, false to disallow

Returns:

this (fluent interfaces)

withKey2Duplicates

public Key2Set.Builder<E,K1,K2> withKey2Duplicates(boolean allowDuplicates)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether duplicates are allowed or not.

Overrides:

withKey2Duplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates

Returns:

this (fluent interfaces)

withKey2Duplicates

public Key2Set.Builder<E,K1,K2> withKey2Duplicates(boolean allowDuplicates,
                                                   boolean allowDuplicatesNull)

Description copied from class: KeyCollectionImpl.BuilderImpl

Specify whether duplicates are allowed or not.

Overrides:

withKey2Duplicates in class Key2Collection.Builder<E,K1,K2>

Parameters:

allowDuplicates - true to allow duplicates

allowDuplicatesNull - true to allow duplicate null values

Returns:

this (fluent interfaces)

withKey2Sort

public Key2Set.Builder<E,K1,K2> withKey2Sort(boolean sort)

Description copied from class: KeyCollectionImpl.BuilderImpl

Set comparator to use for sorting the key map. Note that this does not automatically sort the list itself, call a withOrderBy method for this.

Overrides:

withKey2Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

sort - true to sort key map

Returns:

this (fluent interface)

withKey2Sort

public Key2Set.Builder<E,K1,K2> withKey2Sort(java.util.Comparator<? super K2> comparator)

Set comparator to use for sorting the key map. Note that this does not automatically sort the collection itself, call a withOrderBy method for this.

Overrides:

withKey2Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting

Returns:

this (fluent interface)

withKey2Sort

public Key2Set.Builder<E,K1,K2> withKey2Sort(java.util.Comparator<? super K2> comparator,
                                             boolean sortNullsFirst)

Set comparator to use for sorting the key map. Note that this does not automatically sort the collection itself, call a withOrderBy method for this.

Overrides:

withKey2Sort in class Key2Collection.Builder<E,K1,K2>

Parameters:

comparator - comparator to use for sorting

sortNullsFirst - true if null will be sorted first, false for last

Returns:

this (fluent interface)