speiger.src.collections.objects.maps.interfaces

Interface Object2BooleanSortedMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Boolean>, Object2BooleanFunction<T>, Object2BooleanMap<T>, java.util.function.Predicate<T>, java.util.SortedMap<T,java.lang.Boolean>

All Known Subinterfaces:

Object2BooleanNavigableMap<T>

All Known Implementing Classes:

LinkedEnum2BooleanMap, Object2BooleanArrayMap, Object2BooleanAVLTreeMap, Object2BooleanLinkedOpenCustomHashMap, Object2BooleanLinkedOpenHashMap, Object2BooleanMaps.SynchronizedNavigableMap, Object2BooleanMaps.SynchronizedSortedMap, Object2BooleanMaps.UnmodifyableNavigableMap, Object2BooleanMaps.UnmodifyableSortedMap, Object2BooleanRBTreeMap

public interface Object2BooleanSortedMap<T>
extends java.util.SortedMap<T,java.lang.Boolean>, Object2BooleanMap<T>

A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Object2BooleanSortedMap.FastSortedSet<T> Fast Sorted Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap

Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<T>	comparator()
boolean	firstBooleanValue() A method to get the first Value of a Map.
boolean	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
boolean	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
default Object2BooleanSortedMap<T>	headMap(T toKey)
ObjectSet<T>	keySet()
boolean	lastBooleanValue() A method to get the last Value of a Map.
boolean	moveToFirst(T key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(T key) A specific move method to move a given key/value to the last index.
T	pollFirstKey() A method to get and remove the first Key of a Map.
T	pollLastKey() A method to get and remove the last Key of a Map.
boolean	putAndMoveToFirst(T key, boolean value) A customized put method that allows you to insert into the first index.
boolean	putAndMoveToLast(T key, boolean value) A customized put method that allows you to insert into the last index.
default Object2BooleanSortedMap<T>	subMap(T fromKey, T toKey)
default Object2BooleanSortedMap<T>	tailMap(T fromKey)
BooleanCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet, firstKey, lastKey

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap

compute, computeBoolean, computeBooleanIfAbsent, computeBooleanIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getBoolean, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllBoolean, mergeBoolean, object2BooleanEntrySet, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceBooleans, replaceBooleans, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, containsKey, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2BooleanFunction

and, andType, negate, or, orType, test

Methods inherited from interface java.util.function.Predicate

isEqual

Method Detail

putAndMoveToFirst

boolean putAndMoveToFirst(T key,
                          boolean value)

A customized put method that allows you to insert into the first index.

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

putAndMoveToLast

boolean putAndMoveToLast(T key,
                         boolean value)

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(T key)

A specific move method to move a given key/value to the first index.

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(T key)

A specific move method to move a given key/value to the last index.

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

getAndMoveToFirst

boolean getAndMoveToFirst(T key)

A Specific get method that allows to move teh given key/value int the first index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

getAndMoveToLast

boolean getAndMoveToLast(T key)

A Specific get method that allows to move teh given key/value int the last index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

comparator

java.util.Comparator<T> comparator()

Specified by:

comparator in interface java.util.SortedMap<T,java.lang.Boolean>

keySet

ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,java.lang.Boolean>

Specified by:

keySet in interface Object2BooleanMap<T>

Specified by:

keySet in interface java.util.SortedMap<T,java.lang.Boolean>

values

BooleanCollection values()

Specified by:

values in interface java.util.Map<T,java.lang.Boolean>

Specified by:

values in interface Object2BooleanMap<T>

Specified by:

values in interface java.util.SortedMap<T,java.lang.Boolean>

pollFirstKey

T pollFirstKey()

A method to get and remove the first Key of a Map.

Returns:

the first key in the map

pollLastKey

T pollLastKey()

A method to get and remove the last Key of a Map.

Returns:

the last key in the map

firstBooleanValue

boolean firstBooleanValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastBooleanValue

boolean lastBooleanValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

subMap

default Object2BooleanSortedMap<T> subMap(T fromKey,
                                          T toKey)

Specified by:

subMap in interface java.util.SortedMap<T,java.lang.Boolean>

headMap

default Object2BooleanSortedMap<T> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T,java.lang.Boolean>

tailMap

default Object2BooleanSortedMap<T> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T,java.lang.Boolean>