speiger.src.collections.objects.maps.interfaces

Interface Object2ObjectSortedMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>, java.util.SortedMap<T,V>

All Known Subinterfaces:

Object2ObjectNavigableMap<T,V>

All Known Implementing Classes:

LinkedEnum2ObjectMap, Object2ObjectArrayMap, Object2ObjectAVLTreeMap, Object2ObjectLinkedOpenCustomHashMap, Object2ObjectLinkedOpenHashMap, Object2ObjectMaps.SynchronizedNavigableMap, Object2ObjectMaps.SynchronizedSortedMap, Object2ObjectMaps.UnmodifyableNavigableMap, Object2ObjectMaps.UnmodifyableSortedMap, Object2ObjectRBTreeMap

public interface Object2ObjectSortedMap<T,V>
extends java.util.SortedMap<T,V>, Object2ObjectMap<T,V>

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	Object2ObjectSortedMap.FastSortedSet<T,V> 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.Object2ObjectMap

Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<T>	comparator()
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
default Object2ObjectSortedMap<T,V>	headMap(T toKey)
ObjectSet<T>	keySet()
V	lastValue() 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.
V	putAndMoveToFirst(T key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(T key, V value) A customized put method that allows you to insert into the last index.
default Object2ObjectSortedMap<T,V>	subMap(T fromKey, T toKey)
default Object2ObjectSortedMap<T,V>	tailMap(T fromKey)
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet, firstKey, lastKey

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, merge, merge, mergeAll, object2ObjectEntrySet, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

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

apply, getObject

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

putAndMoveToFirst

V putAndMoveToFirst(T key,
                    V 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

V putAndMoveToLast(T key,
                   V 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

V 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

V 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,V>

keySet

ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Specified by:

keySet in interface java.util.SortedMap<T,V>

values

ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<T,V>

Specified by:

values in interface Object2ObjectMap<T,V>

Specified by:

values in interface java.util.SortedMap<T,V>

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

firstValue

V firstValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastValue

V lastValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

subMap

default Object2ObjectSortedMap<T,V> subMap(T fromKey,
                                           T toKey)

Specified by:

subMap in interface java.util.SortedMap<T,V>

headMap

default Object2ObjectSortedMap<T,V> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T,V>

tailMap

default Object2ObjectSortedMap<T,V> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T,V>