speiger.src.collections.objects.utils.maps

Class Object2ObjectMaps.UnmodifyableOrderedMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableMap<T,V>

speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableOrderedMap<T,V>

Type Parameters:

T - the keyType of elements maintained by this Collection

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, UnaryOperator<T,V>, Object2ObjectMap<T,V>, Object2ObjectOrderedMap<T,V>

Enclosing class:

Object2ObjectMaps

public static class Object2ObjectMaps.UnmodifyableOrderedMap<T,V>
extends Object2ObjectMaps.UnmodifyableMap<T,V>
implements Object2ObjectOrderedMap<T,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.objects.maps.abstracts.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<T,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.objects.maps.interfaces.Object2ObjectOrderedMap

Object2ObjectOrderedMap.FastOrderedSet<T,V>

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Object2ObjectOrderedMap<T,V>	copy() A Function that does a shallow clone of the Map itself.
T	firstKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
ObjectOrderedSet<T>	keySet()
T	lastKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(T key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(T key) A specific move method to move a given key/value to the last index.
ObjectOrderedSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
T	pollFirstKey() A method to get and remove the first Key of a Map.
T	pollLastKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(T key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(T key, V value) A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableMap

clear, compute, computeIfAbsent, computeIfPresent, getObject, merge, mergeAll, put, putIfAbsent, rem, remOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap

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

Methods inherited from class java.util.AbstractMap

isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, getObject, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent, values

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

Methods inherited from interface speiger.src.collections.objects.functions.function.UnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.function.Function

andThen, compose

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(T key,
                           V value)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Object2ObjectOrderedMap

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 Object2ObjectOrderedMap<T,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(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

moveToLast in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(T key)

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Object2ObjectOrderedMap<T,V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstKey

public T firstKey()

Description copied from interface: Object2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

pollFirstKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

lastKey

public T lastKey()

Description copied from interface: Object2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ObjectOrderedMap

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

Specified by:

pollLastKey in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Object2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Object2ObjectOrderedMap<T,V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Object2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Object2ObjectOrderedMap<T,V>

Returns:

the last key in the map

copy

public Object2ObjectOrderedMap<T,V> copy()

Description copied from interface: Object2ObjectMap

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 Object2ObjectMap<T,V>

Specified by:

copy in interface Object2ObjectOrderedMap<T,V>

Overrides:

copy in class Object2ObjectMaps.UnmodifyableMap<T,V>

Returns:

a Shallow Copy of the Map

keySet

public ObjectOrderedSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Specified by:

keySet in interface Object2ObjectOrderedMap<T,V>

Overrides:

keySet in class Object2ObjectMaps.UnmodifyableMap<T,V>

object2ObjectEntrySet

public ObjectOrderedSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

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

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<T,V>

Specified by:

object2ObjectEntrySet in interface Object2ObjectOrderedMap<T,V>

Overrides:

object2ObjectEntrySet in class Object2ObjectMaps.UnmodifyableMap<T,V>

Returns:

a EntrySet of the collection