speiger.src.collections.doubles.utils.maps

Class Double2ObjectMaps.UnmodifyableSortedMap<V>

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ObjectMap<V>

speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.DoubleFunction<V>, java.util.Map<java.lang.Double,V>, java.util.SortedMap<java.lang.Double,V>, Double2ObjectFunction<V>, Double2ObjectMap<V>, Double2ObjectSortedMap<V>

Direct Known Subclasses:

Double2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Double2ObjectMaps

public static class Double2ObjectMaps.UnmodifyableSortedMap<V>
extends Double2ObjectMaps.UnmodifyableMap<V>
implements Double2ObjectSortedMap<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.doubles.maps.abstracts.AbstractDouble2ObjectMap

AbstractDouble2ObjectMap.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.doubles.maps.interfaces.Double2ObjectSortedMap

Double2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap

Double2ObjectMap.Entry<V>, Double2ObjectMap.FastEntrySet<V>

Method Summary

Modifier and Type	Method and Description
DoubleComparator	comparator()
double	firstDoubleKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(double key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(double key) A Specific get method that allows to move teh given key/value int the last index.
Double2ObjectSortedMap<V>	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
double	lastDoubleKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(double key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(double key) A specific move method to move a given key/value to the last index.
double	pollFirstDoubleKey() A method to get and remove the first Key of a Map.
double	pollLastDoubleKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(double key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(double key, V value) A customized put method that allows you to insert into the last index.
Double2ObjectSortedMap<V>	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
Double2ObjectSortedMap<V>	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableMap

double2ObjectEntrySet, getObject, getOrDefault, keySet, put, putIfAbsent, remDouble, remDoubleOrDefault, remove, values

Methods inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ObjectMap

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.doubles.maps.interfaces.Double2ObjectSortedMap

firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, double2ObjectEntrySet, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remDouble, remDoubleOrDefault, 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.doubles.functions.function.Double2ObjectFunction

apply

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(double key,
                           V value)

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

putAndMoveToFirst in interface Double2ObjectSortedMap<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(double key,
                          V value)

Description copied from interface: Double2ObjectSortedMap

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 Double2ObjectSortedMap<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(double key)

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

moveToFirst in interface Double2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(double key)

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

moveToLast in interface Double2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(double key)

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

getAndMoveToFirst in interface Double2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(double key)

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

getAndMoveToLast in interface Double2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public DoubleComparator comparator()

Specified by:

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

Specified by:

comparator in interface Double2ObjectSortedMap<V>

subMap

public Double2ObjectSortedMap<V> subMap(double fromKey,
                                        double toKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Double2ObjectSortedMap<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 Double2ObjectSortedMap<V> headMap(double toKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Double2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Double2ObjectSortedMap<V> tailMap(double fromKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Double2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstDoubleKey

public double firstDoubleKey()

Description copied from interface: Double2ObjectSortedMap

A method to get the first Key of a Map.

Specified by:

firstDoubleKey in interface Double2ObjectSortedMap<V>

Returns:

the first key in the map

pollFirstDoubleKey

public double pollFirstDoubleKey()

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

pollFirstDoubleKey in interface Double2ObjectSortedMap<V>

Returns:

the first key in the map

lastDoubleKey

public double lastDoubleKey()

Description copied from interface: Double2ObjectSortedMap

A method to get the last Key of a Map.

Specified by:

lastDoubleKey in interface Double2ObjectSortedMap<V>

Returns:

the last key in the map

pollLastDoubleKey

public double pollLastDoubleKey()

Description copied from interface: Double2ObjectSortedMap

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

Specified by:

pollLastDoubleKey in interface Double2ObjectSortedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Double2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Double2ObjectSortedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Double2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Double2ObjectSortedMap<V>

Returns:

the last key in the map