speiger.src.collections.shorts.utils.maps

Class Short2ObjectMaps.UnmodifyableOrderedMap<V>

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableOrderedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Short,V>, ShortFunction<V>, Short2ObjectMap<V>, Short2ObjectOrderedMap<V>

Enclosing class:

Short2ObjectMaps

public static class Short2ObjectMaps.UnmodifyableOrderedMap<V>
extends Short2ObjectMaps.UnmodifyableMap<V>
implements Short2ObjectOrderedMap<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.shorts.maps.abstracts.AbstractShort2ObjectMap

AbstractShort2ObjectMap.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.shorts.maps.interfaces.Short2ObjectOrderedMap

Short2ObjectOrderedMap.FastOrderedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

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

Method Summary

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

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.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.shorts.maps.abstracts.AbstractShort2ObjectMap

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.shorts.maps.interfaces.Short2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

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

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Short2ObjectOrderedMap

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 Short2ObjectOrderedMap<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(short key)

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Short2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short key)

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

moveToLast in interface Short2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(short key)

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Short2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(short key)

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Short2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstShortKey

public short firstShortKey()

Description copied from interface: Short2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

pollFirstShortKey in interface Short2ObjectOrderedMap<V>

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2ObjectOrderedMap

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

Specified by:

pollLastShortKey in interface Short2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Short2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Short2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Short2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Short2ObjectOrderedMap<V>

Returns:

the last key in the map

copy

public Short2ObjectOrderedMap<V> copy()

Description copied from interface: Short2ObjectMap

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

Specified by:

copy in interface Short2ObjectOrderedMap<V>

Overrides:

copy in class Short2ObjectMaps.UnmodifyableMap<V>

Returns:

a Shallow Copy of the Map

keySet

public ShortOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ObjectMap<V>

Specified by:

keySet in interface Short2ObjectOrderedMap<V>

Overrides:

keySet in class Short2ObjectMaps.UnmodifyableMap<V>

short2ObjectEntrySet

public ObjectOrderedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()

Description copied from interface: Short2ObjectMap

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

Specified by:

short2ObjectEntrySet in interface Short2ObjectMap<V>

Specified by:

short2ObjectEntrySet in interface Short2ObjectOrderedMap<V>

Overrides:

short2ObjectEntrySet in class Short2ObjectMaps.UnmodifyableMap<V>

Returns:

a EntrySet of the collection