speiger.src.collections.doubles.utils.maps

Class Double2ShortMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ShortMap

speiger.src.collections.doubles.utils.maps.Double2ShortMaps.UnmodifyableMap

speiger.src.collections.doubles.utils.maps.Double2ShortMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Double,java.lang.Short>, Double2ShortFunction, Double2ShortMap, Double2ShortOrderedMap

Enclosing class:

Double2ShortMaps

public static class Double2ShortMaps.UnmodifyableOrderedMap
extends Double2ShortMaps.UnmodifyableMap
implements Double2ShortOrderedMap

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

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ShortMap

AbstractDouble2ShortMap.BasicEntry

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.Double2ShortOrderedMap

Double2ShortOrderedMap.FastOrderedSet

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

Double2ShortMap.BuilderCache, Double2ShortMap.Entry, Double2ShortMap.FastEntrySet, Double2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Double2ShortOrderedMap	copy() A Function that does a shallow clone of the Map itself.
ObjectOrderedSet<Double2ShortMap.Entry>	double2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
double	firstDoubleKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(double key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(double key) A Specific get method that allows to move teh given key/value int the last index.
DoubleOrderedSet	keySet()
double	lastDoubleKey() A method to get the last Key of a Map.
short	lastShortValue() 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.
short	putAndMoveToFirst(double key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(double key, short value) A customized put method that allows you to insert into the last index.

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

addTo, clear, computeShort, computeShortIfAbsent, computeShortIfPresent, get, getOrDefault, mergeAllShort, mergeShort, put, putIfAbsent, remove, remove, removeOrDefault, replaceShorts, replaceShorts, subFrom, supplyShortIfAbsent, values

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

addToAll, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsKey, containsValue, isEmpty, 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.Double2ShortOrderedMap

synchronize, synchronize, unmodifiable

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

addTo, addToAll, applyAsShort, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent, values

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public short putAndMoveToFirst(double key,
                               short value)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Double2ShortOrderedMap

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 short putAndMoveToLast(double key,
                              short value)

Description copied from interface: Double2ShortOrderedMap

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 Double2ShortOrderedMap

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: Double2ShortOrderedMap

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

Specified by:

moveToFirst in interface Double2ShortOrderedMap

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: Double2ShortOrderedMap

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

Specified by:

moveToLast in interface Double2ShortOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(double key)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Double2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(double key)

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Double2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstDoubleKey

public double firstDoubleKey()

Description copied from interface: Double2ShortOrderedMap

A method to get the first Key of a Map.

Specified by:

firstDoubleKey in interface Double2ShortOrderedMap

Returns:

the first key in the map

pollFirstDoubleKey

public double pollFirstDoubleKey()

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

pollFirstDoubleKey in interface Double2ShortOrderedMap

Returns:

the first key in the map

lastDoubleKey

public double lastDoubleKey()

Description copied from interface: Double2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastDoubleKey in interface Double2ShortOrderedMap

Returns:

the last key in the map

pollLastDoubleKey

public double pollLastDoubleKey()

Description copied from interface: Double2ShortOrderedMap

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

Specified by:

pollLastDoubleKey in interface Double2ShortOrderedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Double2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Double2ShortOrderedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Double2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Double2ShortOrderedMap

Returns:

the last key in the map

copy

public Double2ShortOrderedMap copy()

Description copied from interface: Double2ShortMap

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface Double2ShortMap

Specified by:

copy in interface Double2ShortOrderedMap

Overrides:

copy in class Double2ShortMaps.UnmodifyableMap

Returns:

a Shallow Copy of the Map

keySet

public DoubleOrderedSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Double,java.lang.Short>

Specified by:

keySet in interface Double2ShortMap

Specified by:

keySet in interface Double2ShortOrderedMap

Overrides:

keySet in class Double2ShortMaps.UnmodifyableMap

double2ShortEntrySet

public ObjectOrderedSet<Double2ShortMap.Entry> double2ShortEntrySet()

Description copied from interface: Double2ShortMap

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Specified by:

double2ShortEntrySet in interface Double2ShortMap

Specified by:

double2ShortEntrySet in interface Double2ShortOrderedMap

Overrides:

double2ShortEntrySet in class Double2ShortMaps.UnmodifyableMap

Returns:

a EntrySet of the collection