speiger.src.collections.shorts.utils.maps

Class Short2ByteMaps.SynchronizedOrderedMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

speiger.src.collections.shorts.utils.maps.Short2ByteMaps.SynchronizedMap

speiger.src.collections.shorts.utils.maps.Short2ByteMaps.SynchronizedOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Byte>, Short2ByteFunction, Short2ByteMap, Short2ByteOrderedMap

Enclosing class:

Short2ByteMaps

public static class Short2ByteMaps.SynchronizedOrderedMap
extends Short2ByteMaps.SynchronizedMap
implements Short2ByteOrderedMap

The Synchronized Ordered Map implementation used by the synchronizedMap helper function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

AbstractShort2ByteMap.BasicEntry

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

Short2ByteOrderedMap.FastOrderedSet

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

Short2ByteMap.BuilderCache, Short2ByteMap.Entry, Short2ByteMap.FastEntrySet, Short2ByteMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Short2ByteOrderedMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteValue() A method to get the first Value of a Map.
short	firstShortKey() A method to get the first Key of a Map.
byte	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
byte	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
ShortOrderedSet	keySet()
byte	lastByteValue() A method to get the last Value of a Map.
short	lastShortKey() A method to get the last Key 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.
byte	putAndMoveToFirst(short key, byte value) A customized put method that allows you to insert into the first index.
byte	putAndMoveToLast(short key, byte value) A customized put method that allows you to insert into the last index.
ObjectOrderedSet<Short2ByteMap.Entry>	short2ByteEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2ByteMaps.SynchronizedMap

addTo, addToAll, clear, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue, size, subFrom, supplyByteIfAbsent, values

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

entrySet, equals, hashCode, putAll

Methods inherited from class java.util.AbstractMap

isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

synchronize, synchronize, unmodifiable

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

addTo, addToAll, builder, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue, subFrom, supplyByteIfAbsent, values

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public byte putAndMoveToFirst(short key,
                              byte value)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

putAndMoveToFirst in interface Short2ByteOrderedMap

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

Description copied from interface: Short2ByteOrderedMap

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 Short2ByteOrderedMap

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

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

Specified by:

moveToFirst in interface Short2ByteOrderedMap

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

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

Specified by:

moveToLast in interface Short2ByteOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public byte getAndMoveToFirst(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

getAndMoveToFirst in interface Short2ByteOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public byte getAndMoveToLast(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

getAndMoveToLast in interface Short2ByteOrderedMap

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

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2ByteOrderedMap

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

pollFirstShortKey in interface Short2ByteOrderedMap

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2ByteOrderedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2ByteOrderedMap

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

pollLastShortKey in interface Short2ByteOrderedMap

Returns:

the last key in the map

firstByteValue

public byte firstByteValue()

Description copied from interface: Short2ByteOrderedMap

A method to get the first Value of a Map.

Specified by:

firstByteValue in interface Short2ByteOrderedMap

Returns:

the first key in the map

lastByteValue

public byte lastByteValue()

Description copied from interface: Short2ByteOrderedMap

A method to get the last Value of a Map.

Specified by:

lastByteValue in interface Short2ByteOrderedMap

Returns:

the last key in the map

copy

public Short2ByteOrderedMap copy()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Specified by:

copy in interface Short2ByteOrderedMap

Overrides:

copy in class Short2ByteMaps.SynchronizedMap

Returns:

a Shallow Copy of the Map

keySet

public ShortOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ByteMap

Specified by:

keySet in interface Short2ByteOrderedMap

Overrides:

keySet in class Short2ByteMaps.SynchronizedMap

short2ByteEntrySet

public ObjectOrderedSet<Short2ByteMap.Entry> short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Specified by:

short2ByteEntrySet in interface Short2ByteOrderedMap

Overrides:

short2ByteEntrySet in class Short2ByteMaps.SynchronizedMap

Returns:

a EntrySet of the collection