speiger.src.collections.ints.maps.interfaces

Interface Int2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Int2ObjectFunction<V>, Int2ObjectMap<V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>

All Known Subinterfaces:

Int2ObjectNavigableMap<V>

All Known Implementing Classes:

Int2ObjectArrayMap, Int2ObjectAVLTreeMap, Int2ObjectLinkedOpenCustomHashMap, Int2ObjectLinkedOpenHashMap, Int2ObjectMaps.SynchronizedNavigableMap, Int2ObjectMaps.SynchronizedSortedMap, Int2ObjectMaps.UnmodifyableNavigableMap, Int2ObjectMaps.UnmodifyableSortedMap, Int2ObjectRBTreeMap

public interface Int2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Integer,V>, Int2ObjectMap<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	Int2ObjectSortedMap.FastSortedSet<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.ints.maps.interfaces.Int2ObjectMap

Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>

Method Summary

Modifier and Type	Method and Description
IntComparator	comparator()
int	firstIntKey() A method to get the first Key of a Map.
default java.lang.Integer	firstKey() Deprecated.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(int key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(int key) A Specific get method that allows to move teh given key/value int the last index.
Int2ObjectSortedMap<V>	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Int2ObjectSortedMap<V>	headMap(java.lang.Integer toKey) Deprecated.
IntSet	keySet()
int	lastIntKey() A method to get the last Key of a Map.
default java.lang.Integer	lastKey() Deprecated.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(int key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(int key) A specific move method to move a given key/value to the last index.
int	pollFirstIntKey() A method to get and remove the first Key of a Map.
int	pollLastIntKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(int key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(int key, V value) A customized put method that allows you to insert into the last index.
default Int2ObjectSortedMap<V>	subMap(java.lang.Integer fromKey, java.lang.Integer toKey) Deprecated.
Int2ObjectSortedMap<V>	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
Int2ObjectSortedMap<V>	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Int2ObjectSortedMap<V>	tailMap(java.lang.Integer fromKey) Deprecated.
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, int2ObjectEntrySet, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction

apply

Method Detail

putAndMoveToFirst

V putAndMoveToFirst(int 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(int 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(int 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(int 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(int 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(int 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

IntComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Integer,V>

keySet

IntSet keySet()

Specified by:

keySet in interface Int2ObjectMap<V>

Specified by:

keySet in interface java.util.Map<java.lang.Integer,V>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Integer,V>

values

ObjectCollection<V> values()

Specified by:

values in interface Int2ObjectMap<V>

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

Specified by:

values in interface java.util.SortedMap<java.lang.Integer,V>

subMap

Int2ObjectSortedMap<V> subMap(int fromKey,
                              int toKey)

A Type Specific SubMap method to reduce boxing/unboxing

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headMap

Int2ObjectSortedMap<V> headMap(int toKey)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailMap

Int2ObjectSortedMap<V> tailMap(int fromKey)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

firstIntKey

int firstIntKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstIntKey

int pollFirstIntKey()

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

Returns:

the first key in the map

lastIntKey

int lastIntKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastIntKey

int pollLastIntKey()

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

firstKey

@Deprecated
default java.lang.Integer firstKey()

Deprecated.

Specified by:

firstKey in interface java.util.SortedMap<java.lang.Integer,V>

lastKey

@Deprecated
default java.lang.Integer lastKey()

Deprecated.

Specified by:

lastKey in interface java.util.SortedMap<java.lang.Integer,V>

subMap

@Deprecated
default Int2ObjectSortedMap<V> subMap(java.lang.Integer fromKey,
                                                   java.lang.Integer toKey)

Deprecated.

Specified by:

subMap in interface java.util.SortedMap<java.lang.Integer,V>

headMap

@Deprecated
default Int2ObjectSortedMap<V> headMap(java.lang.Integer toKey)

Deprecated.

Specified by:

headMap in interface java.util.SortedMap<java.lang.Integer,V>

tailMap

@Deprecated
default Int2ObjectSortedMap<V> tailMap(java.lang.Integer fromKey)

Deprecated.

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Integer,V>