speiger.src.collections.objects.utils.maps

Class Object2ShortMaps.SynchronizedOrderedMap<T>

java.lang.Object

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

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

speiger.src.collections.objects.utils.maps.Object2ShortMaps.SynchronizedMap<T>

speiger.src.collections.objects.utils.maps.Object2ShortMaps.SynchronizedOrderedMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Short>, ToShortFunction<T>, Object2ShortMap<T>, Object2ShortOrderedMap<T>

Enclosing class:

Object2ShortMaps

public static class Object2ShortMaps.SynchronizedOrderedMap<T>
extends Object2ShortMaps.SynchronizedMap<T>
implements Object2ShortOrderedMap<T>

The Synchronized Ordered Map implementation used by the synchronizedMap helper function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap

AbstractObject2ShortMap.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.Object2ShortOrderedMap

Object2ShortOrderedMap.FastOrderedSet<T>

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

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

Method Summary

Modifier and Type	Method and Description
Object2ShortOrderedMap<T>	copy() A Function that does a shallow clone of the Map itself.
T	firstKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
short	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
short	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.
short	lastShortValue() 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<Object2ShortMap.Entry<T>>	object2ShortEntrySet() 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.
short	putAndMoveToFirst(T key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(T key, short value) A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2ShortMaps.SynchronizedMap

addTo, addToAll, computeShort, computeShortIfAbsent, computeShortIfPresent, containsValue, forEach, getDefaultReturnValue, getOrDefault, getShort, mergeAllShort, mergeShort, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceShorts, replaceShorts, setDefaultReturnValue, size, subFrom, supplyShortIfAbsent, values

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

containsKey, entrySet, equals, get, getOrDefault, hashCode, put, putAll, remove

Methods inherited from class java.util.AbstractMap

clear, containsValue, isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

synchronize, synchronize, unmodifiable

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

addTo, addToAll, applyAsShort, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent, values

Methods inherited from interface java.util.Map

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

Method Detail

putAndMoveToFirst

public short putAndMoveToFirst(T key,
                               short value)

Description copied from interface: Object2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Object2ShortOrderedMap<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 short putAndMoveToLast(T key,
                              short value)

Description copied from interface: Object2ShortOrderedMap

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

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

Specified by:

moveToFirst in interface Object2ShortOrderedMap<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: Object2ShortOrderedMap

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

Specified by:

moveToLast in interface Object2ShortOrderedMap<T>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(T key)

Description copied from interface: Object2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Object2ShortOrderedMap<T>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(T key)

Description copied from interface: Object2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Object2ShortOrderedMap<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: Object2ShortOrderedMap

A method to get the first Key of a Map.

Specified by:

firstKey in interface Object2ShortOrderedMap<T>

Returns:

the first key in the map

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ShortOrderedMap

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

Specified by:

pollFirstKey in interface Object2ShortOrderedMap<T>

Returns:

the first key in the map

lastKey

public T lastKey()

Description copied from interface: Object2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastKey in interface Object2ShortOrderedMap<T>

Returns:

the last key in the map

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ShortOrderedMap

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

Specified by:

pollLastKey in interface Object2ShortOrderedMap<T>

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Object2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Object2ShortOrderedMap<T>

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Object2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Object2ShortOrderedMap<T>

Returns:

the last key in the map

copy

public Object2ShortOrderedMap<T> copy()

Description copied from interface: Object2ShortMap

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

Specified by:

copy in interface Object2ShortOrderedMap<T>

Overrides:

copy in class Object2ShortMaps.SynchronizedMap<T>

Returns:

a Shallow Copy of the Map

keySet

public ObjectOrderedSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2ShortMap<T>

Specified by:

keySet in interface Object2ShortOrderedMap<T>

Overrides:

keySet in class Object2ShortMaps.SynchronizedMap<T>

object2ShortEntrySet

public ObjectOrderedSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()

Description copied from interface: Object2ShortMap

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

Specified by:

object2ShortEntrySet in interface Object2ShortMap<T>

Specified by:

object2ShortEntrySet in interface Object2ShortOrderedMap<T>

Overrides:

object2ShortEntrySet in class Object2ShortMaps.SynchronizedMap<T>

Returns:

a EntrySet of the collection