speiger.src.collections.bytes.utils.maps

Class Byte2IntMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap

speiger.src.collections.bytes.utils.maps.Byte2IntMaps.UnmodifyableMap

speiger.src.collections.bytes.utils.maps.Byte2IntMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Integer>, Byte2IntFunction, Byte2IntMap, Byte2IntOrderedMap

Enclosing class:

Byte2IntMaps

public static class Byte2IntMaps.UnmodifyableOrderedMap
extends Byte2IntMaps.UnmodifyableMap
implements Byte2IntOrderedMap

The Unmodifyable Ordered Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap

AbstractByte2IntMap.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.bytes.maps.interfaces.Byte2IntOrderedMap

Byte2IntOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntMap

Byte2IntMap.BuilderCache, Byte2IntMap.Entry, Byte2IntMap.FastEntrySet, Byte2IntMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
ObjectOrderedSet<Byte2IntMap.Entry>	byte2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
Byte2IntOrderedMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteKey() A method to get the first Key of a Map.
int	firstIntValue() A method to get the first Value of a Map.
int	getAndMoveToFirst(byte key) A Specific get method that allows to move teh given key/value int the first index.
int	getAndMoveToLast(byte key) A Specific get method that allows to move teh given key/value int the last index.
ByteOrderedSet	keySet()
byte	lastByteKey() A method to get the last Key of a Map.
int	lastIntValue() A method to get the last Value of a Map.
boolean	moveToFirst(byte key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(byte key) A specific move method to move a given key/value to the last index.
byte	pollFirstByteKey() A method to get and remove the first Key of a Map.
byte	pollLastByteKey() A method to get and remove the last Key of a Map.
int	putAndMoveToFirst(byte key, int value) A customized put method that allows you to insert into the first index.
int	putAndMoveToLast(byte key, int value) A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2IntMaps.UnmodifyableMap

addTo, clear, computeInt, computeIntIfAbsent, computeIntIfPresent, get, getOrDefault, mergeAllInt, mergeInt, put, putIfAbsent, remove, remove, removeOrDefault, replaceInts, replaceInts, subFrom, supplyIntIfAbsent, values

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2IntMap

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.bytes.maps.interfaces.Byte2IntOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2IntMap

addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, subFrom, supplyIntIfAbsent, values

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public int putAndMoveToFirst(byte key,
                             int value)

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

putAndMoveToFirst in interface Byte2IntOrderedMap

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

Description copied from interface: Byte2IntOrderedMap

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 Byte2IntOrderedMap

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

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

moveToFirst in interface Byte2IntOrderedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(byte key)

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

moveToLast in interface Byte2IntOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public int getAndMoveToFirst(byte key)

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

getAndMoveToFirst in interface Byte2IntOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public int getAndMoveToLast(byte key)

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

getAndMoveToLast in interface Byte2IntOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstByteKey

public byte firstByteKey()

Description copied from interface: Byte2IntOrderedMap

A method to get the first Key of a Map.

Specified by:

firstByteKey in interface Byte2IntOrderedMap

Returns:

the first key in the map

pollFirstByteKey

public byte pollFirstByteKey()

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

pollFirstByteKey in interface Byte2IntOrderedMap

Returns:

the first key in the map

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2IntOrderedMap

A method to get the last Key of a Map.

Specified by:

lastByteKey in interface Byte2IntOrderedMap

Returns:

the last key in the map

pollLastByteKey

public byte pollLastByteKey()

Description copied from interface: Byte2IntOrderedMap

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

Specified by:

pollLastByteKey in interface Byte2IntOrderedMap

Returns:

the last key in the map

firstIntValue

public int firstIntValue()

Description copied from interface: Byte2IntOrderedMap

A method to get the first Value of a Map.

Specified by:

firstIntValue in interface Byte2IntOrderedMap

Returns:

the first key in the map

lastIntValue

public int lastIntValue()

Description copied from interface: Byte2IntOrderedMap

A method to get the last Value of a Map.

Specified by:

lastIntValue in interface Byte2IntOrderedMap

Returns:

the last key in the map

copy

public Byte2IntOrderedMap copy()

Description copied from interface: Byte2IntMap

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 Byte2IntMap

Specified by:

copy in interface Byte2IntOrderedMap

Overrides:

copy in class Byte2IntMaps.UnmodifyableMap

Returns:

a Shallow Copy of the Map

keySet

public ByteOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Byte2IntMap

Specified by:

keySet in interface Byte2IntOrderedMap

Overrides:

keySet in class Byte2IntMaps.UnmodifyableMap

byte2IntEntrySet

public ObjectOrderedSet<Byte2IntMap.Entry> byte2IntEntrySet()

Description copied from interface: Byte2IntMap

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

Specified by:

byte2IntEntrySet in interface Byte2IntMap

Specified by:

byte2IntEntrySet in interface Byte2IntOrderedMap

Overrides:

byte2IntEntrySet in class Byte2IntMaps.UnmodifyableMap

Returns:

a EntrySet of the collection