speiger.src.collections.longs.utils.maps

Class Long2ObjectMaps.UnmodifyableOrderedMap<V>

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableOrderedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, Long2ObjectMap<V>, Long2ObjectOrderedMap<V>

Enclosing class:

Long2ObjectMaps

public static class Long2ObjectMaps.UnmodifyableOrderedMap<V>
extends Long2ObjectMaps.UnmodifyableMap<V>
implements Long2ObjectOrderedMap<V>

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

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

Long2ObjectOrderedMap.FastOrderedSet<V>

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

Long2ObjectMap.BuilderCache<V>, Long2ObjectMap.Entry<V>, Long2ObjectMap.FastEntrySet<V>, Long2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Long2ObjectOrderedMap<V>	copy() A Function that does a shallow clone of the Map itself.
long	firstLongKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
V	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.
V	lastValue() A method to get the last Value of a Map.
ObjectOrderedSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() 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.
V	putAndMoveToFirst(long key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(long key, V value) A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableMap

clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

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, 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.Long2ObjectOrderedMap

synchronize, synchronize, unmodifiable

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

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent, values

Methods inherited from interface java.util.Map

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

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(long key,
                           V value)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Long2ObjectOrderedMap

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

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Long2ObjectOrderedMap<V>

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

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

Specified by:

moveToLast in interface Long2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Long2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Long2ObjectOrderedMap<V>

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

A method to get the first Key of a Map.

Specified by:

firstLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstLongKey

public long pollFirstLongKey()

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

pollFirstLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

lastLongKey

public long lastLongKey()

Description copied from interface: Long2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastLongKey

public long pollLastLongKey()

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

pollLastLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Long2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Long2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

copy

public Long2ObjectOrderedMap<V> copy()

Description copied from interface: Long2ObjectMap

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 Long2ObjectMap<V>

Specified by:

copy in interface Long2ObjectOrderedMap<V>

Overrides:

copy in class Long2ObjectMaps.UnmodifyableMap<V>

Returns:

a Shallow Copy of the Map

keySet

public LongOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectOrderedMap<V>

Overrides:

keySet in class Long2ObjectMaps.UnmodifyableMap<V>

long2ObjectEntrySet

public ObjectOrderedSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()

Description copied from interface: Long2ObjectMap

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

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Specified by:

long2ObjectEntrySet in interface Long2ObjectOrderedMap<V>

Overrides:

long2ObjectEntrySet in class Long2ObjectMaps.UnmodifyableMap<V>

Returns:

a EntrySet of the collection