speiger.src.collections.longs.utils.maps

Class Long2ShortMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2ShortMap

speiger.src.collections.longs.utils.maps.Long2ShortMaps.UnmodifyableMap

speiger.src.collections.longs.utils.maps.Long2ShortMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Long,java.lang.Short>, Long2ShortFunction, Long2ShortMap, Long2ShortOrderedMap

Enclosing class:

Long2ShortMaps

public static class Long2ShortMaps.UnmodifyableOrderedMap
extends Long2ShortMaps.UnmodifyableMap
implements Long2ShortOrderedMap

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

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ShortMap

AbstractLong2ShortMap.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.longs.maps.interfaces.Long2ShortOrderedMap

Long2ShortOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ShortMap

Long2ShortMap.BuilderCache, Long2ShortMap.Entry, Long2ShortMap.FastEntrySet, Long2ShortMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Long2ShortOrderedMap	copy() A Function that does a shallow clone of the Map itself.
long	firstLongKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(long key) A Specific get method that allows to move teh given key/value int the last index.
LongOrderedSet	keySet()
long	lastLongKey() A method to get the last Key of a Map.
short	lastShortValue() A method to get the last Value of a Map.
ObjectOrderedSet<Long2ShortMap.Entry>	long2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
boolean	moveToFirst(long key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(long key) A specific move method to move a given key/value to the last index.
long	pollFirstLongKey() A method to get and remove the first Key of a Map.
long	pollLastLongKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(long key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(long key, short value) A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.longs.utils.maps.Long2ShortMaps.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.longs.maps.abstracts.AbstractLong2ShortMap

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.longs.maps.interfaces.Long2ShortOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ShortMap

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

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Long2ShortOrderedMap

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

Description copied from interface: Long2ShortOrderedMap

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 Long2ShortOrderedMap

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(long key)

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

moveToFirst in interface Long2ShortOrderedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(long key)

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

moveToLast in interface Long2ShortOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(long key)

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Long2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(long key)

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Long2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstLongKey

public long firstLongKey()

Description copied from interface: Long2ShortOrderedMap

A method to get the first Key of a Map.

Specified by:

firstLongKey in interface Long2ShortOrderedMap

Returns:

the first key in the map

pollFirstLongKey

public long pollFirstLongKey()

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

pollFirstLongKey in interface Long2ShortOrderedMap

Returns:

the first key in the map

lastLongKey

public long lastLongKey()

Description copied from interface: Long2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastLongKey in interface Long2ShortOrderedMap

Returns:

the last key in the map

pollLastLongKey

public long pollLastLongKey()

Description copied from interface: Long2ShortOrderedMap

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

Specified by:

pollLastLongKey in interface Long2ShortOrderedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Long2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Long2ShortOrderedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Long2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Long2ShortOrderedMap

Returns:

the last key in the map

copy

public Long2ShortOrderedMap copy()

Description copied from interface: Long2ShortMap

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 Long2ShortMap

Specified by:

copy in interface Long2ShortOrderedMap

Overrides:

copy in class Long2ShortMaps.UnmodifyableMap

Returns:

a Shallow Copy of the Map

keySet

public LongOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Long2ShortMap

Specified by:

keySet in interface Long2ShortOrderedMap

Overrides:

keySet in class Long2ShortMaps.UnmodifyableMap

long2ShortEntrySet

public ObjectOrderedSet<Long2ShortMap.Entry> long2ShortEntrySet()

Description copied from interface: Long2ShortMap

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

Specified by:

long2ShortEntrySet in interface Long2ShortMap

Specified by:

long2ShortEntrySet in interface Long2ShortOrderedMap

Overrides:

long2ShortEntrySet in class Long2ShortMaps.UnmodifyableMap

Returns:

a EntrySet of the collection