speiger.src.collections.ints.utils.maps

Class Int2ShortMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ShortMap

speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableMap

speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Short>, Int2ShortFunction, Int2ShortMap, Int2ShortOrderedMap

Enclosing class:

Int2ShortMaps

public static class Int2ShortMaps.UnmodifyableOrderedMap
extends Int2ShortMaps.UnmodifyableMap
implements Int2ShortOrderedMap

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

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

Int2ShortOrderedMap.FastOrderedSet

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

Int2ShortMap.BuilderCache, Int2ShortMap.Entry, Int2ShortMap.FastEntrySet, Int2ShortMap.MapBuilder

Method Summary

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

Methods inherited from class speiger.src.collections.ints.utils.maps.Int2ShortMaps.UnmodifyableMap

addTo, clear, computeShort, computeShortIfAbsent, computeShortIfPresent, get, getOrDefault, mergeAllShort, mergeShort, put, putIfAbsent, remove, remove, removeOrDefault, replaceShorts, replaceShorts, subFrom, supplyShortIfAbsent, values

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2ShortMap

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

containsKey, containsValue, 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.Int2ShortOrderedMap

synchronize, synchronize, unmodifiable

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

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

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public short putAndMoveToFirst(int key,
                               short value)

Description copied from interface: Int2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Int2ShortOrderedMap

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

Description copied from interface: Int2ShortOrderedMap

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 Int2ShortOrderedMap

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

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

Specified by:

moveToFirst in interface Int2ShortOrderedMap

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

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

Specified by:

moveToLast in interface Int2ShortOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(int key)

Description copied from interface: Int2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Int2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(int key)

Description copied from interface: Int2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Int2ShortOrderedMap

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

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ShortOrderedMap

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ShortOrderedMap

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

Specified by:

pollFirstIntKey in interface Int2ShortOrderedMap

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ShortOrderedMap

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ShortOrderedMap

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

Specified by:

pollLastIntKey in interface Int2ShortOrderedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Int2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Int2ShortOrderedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Int2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Int2ShortOrderedMap

Returns:

the last key in the map

copy

public Int2ShortOrderedMap copy()

Description copied from interface: Int2ShortMap

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 Int2ShortMap

Specified by:

copy in interface Int2ShortOrderedMap

Overrides:

copy in class Int2ShortMaps.UnmodifyableMap

Returns:

a Shallow Copy of the Map

keySet

public IntOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2ShortMap

Specified by:

keySet in interface Int2ShortOrderedMap

Overrides:

keySet in class Int2ShortMaps.UnmodifyableMap

int2ShortEntrySet

public ObjectOrderedSet<Int2ShortMap.Entry> int2ShortEntrySet()

Description copied from interface: Int2ShortMap

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

Specified by:

int2ShortEntrySet in interface Int2ShortMap

Specified by:

int2ShortEntrySet in interface Int2ShortOrderedMap

Overrides:

int2ShortEntrySet in class Int2ShortMaps.UnmodifyableMap

Returns:

a EntrySet of the collection