speiger.src.collections.ints.utils.maps

Class Int2ObjectMaps.UnmodifyableSortedMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Integer,V>

speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>

speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

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

Direct Known Subclasses:

Int2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Int2ObjectMaps

public static class Int2ObjectMaps.UnmodifyableSortedMap<V>
extends Int2ObjectMaps.UnmodifyableMap<V>
implements Int2ObjectSortedMap<V>

The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

AbstractInt2ObjectMap.BasicEntry<V>

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectSortedMap

Int2ObjectSortedMap.FastSortedSet<V>

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.
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
int	lastIntKey() A method to get the last Key of a Map.
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.
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

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap

getObject, getOrDefault, int2ObjectEntrySet, keySet, put, putIfAbsent, remInt, remIntOrDefault, remove, values

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, merge, mergeAll, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

firstKey, headMap, keySet, lastKey, subMap, tailMap, 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

public V putAndMoveToFirst(int key,
                           V value)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

putAndMoveToFirst in interface Int2ObjectSortedMap<V>

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)

putAndMoveToLast

public V putAndMoveToLast(int key,
                          V value)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

putAndMoveToLast in interface Int2ObjectSortedMap<V>

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)

moveToFirst

public boolean moveToFirst(int key)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

moveToFirst in interface Int2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(int key)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

moveToLast in interface Int2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(int key)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

getAndMoveToFirst in interface Int2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(int key)

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

getAndMoveToLast in interface Int2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public IntComparator comparator()

Specified by:

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

Specified by:

comparator in interface Int2ObjectSortedMap<V>

subMap

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

Description copied from interface: Int2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Int2ObjectSortedMap<V>

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

headMap

public Int2ObjectSortedMap<V> headMap(int toKey)

Description copied from interface: Int2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Int2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Int2ObjectSortedMap<V> tailMap(int fromKey)

Description copied from interface: Int2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Int2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstIntKey

public int firstIntKey()

Description copied from interface: Int2ObjectSortedMap

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ObjectSortedMap<V>

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

pollFirstIntKey in interface Int2ObjectSortedMap<V>

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ObjectSortedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ObjectSortedMap<V>

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ObjectSortedMap

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

Specified by:

pollLastIntKey in interface Int2ObjectSortedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Int2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Int2ObjectSortedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Int2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Int2ObjectSortedMap<V>

Returns:

the last key in the map