org.magicwerk.brownies.collections

Class MapList.Builder<E,K>

java.lang.Object

org.magicwerk.brownies.collections.MapList.Builder<E,K>

Enclosing class:

MapList<E,K>

public static class MapList.Builder<E,K>
extends java.lang.Object

Builder to construct MapList instances.

Constructor Summary

Constructors

Constructor and Description
MapList.Builder() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
MapList<E,K>	build() Build MapList with specified options.
MapList.Builder<E,K>	withAttachHandler(org.magicwerk.brownies.collections.KeyList.Handler<E> handler)
MapList.Builder<E,K>	withComparator(java.util.Comparator<K> comparator)
MapList.Builder<E,K>	withComparator(java.util.Comparator<K> comparator, boolean comparatorSortsNull)
MapList.Builder<E,K>	withDetachHandler(org.magicwerk.brownies.collections.KeyList.Handler<E> handler)
MapList.Builder<E,K>	withDuplicates(org.magicwerk.brownies.collections.KeyList.DuplicateMode duplicateMode)
MapList.Builder<E,K>	withMapper(Mapper<E,K> mapper) Note that a mapper must be set to construct a MapList.
MapList.Builder<E,K>	withNullElem() Determines that null elements are allowed.
MapList.Builder<E,K>	withNullElem(boolean nullElem) Determines whether null elements are allowed or not.
MapList.Builder<E,K>	withNullKey()
MapList.Builder<E,K>	withNullKey(boolean nullKey) Determines whether null keys are allowed or not.
MapList.Builder<E,K>	withNullsFirst() Nulls will be sorted first.
MapList.Builder<E,K>	withNullsFirst(boolean nullsFirst) Specifies whether nulls will be sorted first.
MapList.Builder<E,K>	withSort()
MapList.Builder<E,K>	withSort(boolean sort)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapList.Builder

public MapList.Builder()

Default constructor

Method Detail

withMapper

public MapList.Builder<E,K> withMapper(Mapper<E,K> mapper)

Note that a mapper must be set to construct a MapList.

Parameters:

mapper - mapper to use for MapList

Returns:

this (fluent interface)

withNullElem

public MapList.Builder<E,K> withNullElem()

Determines that null elements are allowed. A null element will have a null key.

Returns:

this (fluent interface)

withNullElem

public MapList.Builder<E,K> withNullElem(boolean nullElem)

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

Parameters:

nullElem - true to allow null elements, false otherwise

Returns:

this (fluent interface)

withNullKey

public MapList.Builder<E,K> withNullKey()

Returns:

this (fluent interface)

withNullKey

public MapList.Builder<E,K> withNullKey(boolean nullKey)

Determines whether null keys are allowed or not. Setting this option to true sets also elemNotNull to true.

Parameters:

nullKey - true to allow null keys, false otherwise

Returns:

this (fluent interface)

withDuplicates

public MapList.Builder<E,K> withDuplicates(org.magicwerk.brownies.collections.KeyList.DuplicateMode duplicateMode)

Parameters:

duplicateMode - duplicate mode

Returns:

this (fluent interface)

withSort

public MapList.Builder<E,K> withSort()

Returns:

this (fluent interface)

withSort

public MapList.Builder<E,K> withSort(boolean sort)

Parameters:

sort - true to sort list

Returns:

this (fluent interface)

withComparator

public MapList.Builder<E,K> withComparator(java.util.Comparator<K> comparator)

Parameters:

comparator - comparator

Returns:

this (fluent interface)

withComparator

public MapList.Builder<E,K> withComparator(java.util.Comparator<K> comparator,
                                  boolean comparatorSortsNull)

Parameters:

comparator - comparator

comparatorSortsNull - true if comparator also sorts null values

Returns:

this (fluent interface)

withNullsFirst

public MapList.Builder<E,K> withNullsFirst()

Nulls will be sorted first.

Returns:

this (fluent interface)

withNullsFirst

public MapList.Builder<E,K> withNullsFirst(boolean nullsFirst)

Specifies whether nulls will be sorted first.

Parameters:

nullsFirst - true to sort nulls first

Returns:

this (fluent interface)

withAttachHandler

public MapList.Builder<E,K> withAttachHandler(org.magicwerk.brownies.collections.KeyList.Handler<E> handler)

withDetachHandler

public MapList.Builder<E,K> withDetachHandler(org.magicwerk.brownies.collections.KeyList.Handler<E> handler)

build

public MapList<E,K> build()

Build MapList with specified options.

Returns:

MapList with specified options