speiger.src.collections.ints.utils.maps

Class Int2ObjectMaps.UnmodifyableOrderedMap<V>

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>

speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.ints.utils.maps.Int2ObjectMaps.UnmodifyableOrderedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, Int2ObjectMap<V>, Int2ObjectOrderedMap<V>

Enclosing class:

Int2ObjectMaps

public static class Int2ObjectMaps.UnmodifyableOrderedMap<V>
extends Int2ObjectMaps.UnmodifyableMap<V>
implements Int2ObjectOrderedMap<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.ints.maps.abstracts.AbstractInt2ObjectMap

AbstractInt2ObjectMap.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.ints.maps.interfaces.Int2ObjectOrderedMap

Int2ObjectOrderedMap.FastOrderedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

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

Method Summary

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

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ObjectMaps.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.ints.maps.abstracts.AbstractInt2ObjectMap

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.ints.maps.interfaces.Int2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ObjectMap

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

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Int2ObjectOrderedMap

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 Int2ObjectOrderedMap<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(int key)

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Int2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(int key)

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

moveToLast in interface Int2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(int key)

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Int2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(int key)

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Int2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstIntKey

public int firstIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

pollFirstIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ObjectOrderedMap

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

Specified by:

pollLastIntKey in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Int2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Int2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Int2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Int2ObjectOrderedMap<V>

Returns:

the last key in the map

copy

public Int2ObjectOrderedMap<V> copy()

Description copied from interface: Int2ObjectMap

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

Specified by:

copy in interface Int2ObjectOrderedMap<V>

Overrides:

copy in class Int2ObjectMaps.UnmodifyableMap<V>

Returns:

a Shallow Copy of the Map

keySet

public IntOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2ObjectMap<V>

Specified by:

keySet in interface Int2ObjectOrderedMap<V>

Overrides:

keySet in class Int2ObjectMaps.UnmodifyableMap<V>

int2ObjectEntrySet

public ObjectOrderedSet<Int2ObjectMap.Entry<V>> int2ObjectEntrySet()

Description copied from interface: Int2ObjectMap

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

Specified by:

int2ObjectEntrySet in interface Int2ObjectMap<V>

Specified by:

int2ObjectEntrySet in interface Int2ObjectOrderedMap<V>

Overrides:

int2ObjectEntrySet in class Int2ObjectMaps.UnmodifyableMap<V>

Returns:

a EntrySet of the collection