speiger.src.collections.ints.utils.maps

Class Int2ByteMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ByteMap

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

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

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Byte>, Int2ByteFunction, Int2ByteMap, Int2ByteOrderedMap

Enclosing class:

Int2ByteMaps

public static class Int2ByteMaps.UnmodifyableOrderedMap
extends Int2ByteMaps.UnmodifyableMap
implements Int2ByteOrderedMap

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

AbstractInt2ByteMap.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.Int2ByteOrderedMap

Int2ByteOrderedMap.FastOrderedSet

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

Int2ByteMap.BuilderCache, Int2ByteMap.Entry, Int2ByteMap.FastEntrySet, Int2ByteMap.MapBuilder

Method Summary

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

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

addTo, clear, computeByte, computeByteIfAbsent, computeByteIfPresent, get, getOrDefault, mergeAllByte, mergeByte, put, putIfAbsent, remove, remove, removeOrDefault, replaceBytes, replaceBytes, subFrom, supplyByteIfAbsent, values

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

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

synchronize, synchronize, unmodifiable

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

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

Description copied from interface: Int2ByteOrderedMap

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

Specified by:

putAndMoveToFirst in interface Int2ByteOrderedMap

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

Description copied from interface: Int2ByteOrderedMap

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 Int2ByteOrderedMap

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

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

Specified by:

moveToFirst in interface Int2ByteOrderedMap

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

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

Specified by:

moveToLast in interface Int2ByteOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public byte getAndMoveToFirst(int key)

Description copied from interface: Int2ByteOrderedMap

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

Specified by:

getAndMoveToFirst in interface Int2ByteOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public byte getAndMoveToLast(int key)

Description copied from interface: Int2ByteOrderedMap

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

Specified by:

getAndMoveToLast in interface Int2ByteOrderedMap

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

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2ByteOrderedMap

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2ByteOrderedMap

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

Specified by:

pollFirstIntKey in interface Int2ByteOrderedMap

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2ByteOrderedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2ByteOrderedMap

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2ByteOrderedMap

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

Specified by:

pollLastIntKey in interface Int2ByteOrderedMap

Returns:

the last key in the map

firstByteValue

public byte firstByteValue()

Description copied from interface: Int2ByteOrderedMap

A method to get the first Value of a Map.

Specified by:

firstByteValue in interface Int2ByteOrderedMap

Returns:

the first key in the map

lastByteValue

public byte lastByteValue()

Description copied from interface: Int2ByteOrderedMap

A method to get the last Value of a Map.

Specified by:

lastByteValue in interface Int2ByteOrderedMap

Returns:

the last key in the map

copy

public Int2ByteOrderedMap copy()

Description copied from interface: Int2ByteMap

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 Int2ByteMap

Specified by:

copy in interface Int2ByteOrderedMap

Overrides:

copy in class Int2ByteMaps.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.Byte>

Specified by:

keySet in interface Int2ByteMap

Specified by:

keySet in interface Int2ByteOrderedMap

Overrides:

keySet in class Int2ByteMaps.UnmodifyableMap

int2ByteEntrySet

public ObjectOrderedSet<Int2ByteMap.Entry> int2ByteEntrySet()

Description copied from interface: Int2ByteMap

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

Specified by:

int2ByteEntrySet in interface Int2ByteMap

Specified by:

int2ByteEntrySet in interface Int2ByteOrderedMap

Overrides:

int2ByteEntrySet in class Int2ByteMaps.UnmodifyableMap

Returns:

a EntrySet of the collection