speiger.src.collections.objects.utils.maps

Class Object2IntMaps.UnmodifyableOrderedMap<T>

java.lang.Object

java.util.AbstractMap<T,java.lang.Integer>

speiger.src.collections.objects.maps.abstracts.AbstractObject2IntMap<T>

speiger.src.collections.objects.utils.maps.Object2IntMaps.UnmodifyableMap<T>

speiger.src.collections.objects.utils.maps.Object2IntMaps.UnmodifyableOrderedMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToIntFunction<T>, java.util.Map<T,java.lang.Integer>, Object2IntMap<T>, Object2IntOrderedMap<T>

Enclosing class:

Object2IntMaps

public static class Object2IntMaps.UnmodifyableOrderedMap<T>
extends Object2IntMaps.UnmodifyableMap<T>
implements Object2IntOrderedMap<T>

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

AbstractObject2IntMap.BasicEntry<T>

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

Object2IntOrderedMap.FastOrderedSet<T>

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

Object2IntMap.BuilderCache<T>, Object2IntMap.Entry<T>, Object2IntMap.FastEntrySet<T>, Object2IntMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Object2IntOrderedMap<T>	copy() A Function that does a shallow clone of the Map itself.
int	firstIntValue() A method to get the first Value of a Map.
T	firstKey() A method to get the first Key of a Map.
int	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
int	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
ObjectOrderedSet<T>	keySet()
int	lastIntValue() A method to get the last Value of a Map.
T	lastKey() A method to get the last Key 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<Object2IntMap.Entry<T>>	object2IntEntrySet() 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.
int	putAndMoveToFirst(T key, int value) A customized put method that allows you to insert into the first index.
int	putAndMoveToLast(T key, int value) A customized put method that allows you to insert into the last index.

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

addTo, clear, computeInt, computeIntIfAbsent, computeIntIfPresent, getInt, getOrDefault, mergeAllInt, mergeInt, put, putIfAbsent, rem, remOrDefault, remove, replaceInts, replaceInts, subFrom, supplyIntIfAbsent, values

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

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

containsValue, 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.Object2IntOrderedMap

synchronize, synchronize, unmodifiable

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

addTo, addToAll, applyAsInt, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getInt, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, subFrom, supplyIntIfAbsent, values

Methods inherited from interface java.util.Map

clear, containsKey, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public int putAndMoveToFirst(T key,
                             int value)

Description copied from interface: Object2IntOrderedMap

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

Specified by:

putAndMoveToFirst in interface Object2IntOrderedMap<T>

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 int putAndMoveToLast(T key,
                            int value)

Description copied from interface: Object2IntOrderedMap

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 Object2IntOrderedMap<T>

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

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

Specified by:

moveToFirst in interface Object2IntOrderedMap<T>

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

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

Specified by:

moveToLast in interface Object2IntOrderedMap<T>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public int getAndMoveToFirst(T key)

Description copied from interface: Object2IntOrderedMap

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

Specified by:

getAndMoveToFirst in interface Object2IntOrderedMap<T>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public int getAndMoveToLast(T key)

Description copied from interface: Object2IntOrderedMap

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

Specified by:

getAndMoveToLast in interface Object2IntOrderedMap<T>

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

A method to get the first Key of a Map.

Specified by:

firstKey in interface Object2IntOrderedMap<T>

Returns:

the first key in the map

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2IntOrderedMap

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

Specified by:

pollFirstKey in interface Object2IntOrderedMap<T>

Returns:

the first key in the map

lastKey

public T lastKey()

Description copied from interface: Object2IntOrderedMap

A method to get the last Key of a Map.

Specified by:

lastKey in interface Object2IntOrderedMap<T>

Returns:

the last key in the map

pollLastKey

public T pollLastKey()

Description copied from interface: Object2IntOrderedMap

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

Specified by:

pollLastKey in interface Object2IntOrderedMap<T>

Returns:

the last key in the map

firstIntValue

public int firstIntValue()

Description copied from interface: Object2IntOrderedMap

A method to get the first Value of a Map.

Specified by:

firstIntValue in interface Object2IntOrderedMap<T>

Returns:

the first key in the map

lastIntValue

public int lastIntValue()

Description copied from interface: Object2IntOrderedMap

A method to get the last Value of a Map.

Specified by:

lastIntValue in interface Object2IntOrderedMap<T>

Returns:

the last key in the map

copy

public Object2IntOrderedMap<T> copy()

Description copied from interface: Object2IntMap

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 Object2IntMap<T>

Specified by:

copy in interface Object2IntOrderedMap<T>

Overrides:

copy in class Object2IntMaps.UnmodifyableMap<T>

Returns:

a Shallow Copy of the Map

keySet

public ObjectOrderedSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,java.lang.Integer>

Specified by:

keySet in interface Object2IntMap<T>

Specified by:

keySet in interface Object2IntOrderedMap<T>

Overrides:

keySet in class Object2IntMaps.UnmodifyableMap<T>

object2IntEntrySet

public ObjectOrderedSet<Object2IntMap.Entry<T>> object2IntEntrySet()

Description copied from interface: Object2IntMap

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

Specified by:

object2IntEntrySet in interface Object2IntMap<T>

Specified by:

object2IntEntrySet in interface Object2IntOrderedMap<T>

Overrides:

object2IntEntrySet in class Object2IntMaps.UnmodifyableMap<T>

Returns:

a EntrySet of the collection