speiger.src.collections.bytes.maps.interfaces

Interface Byte2IntOrderedMap

All Superinterfaces:

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

All Known Implementing Classes:

Byte2IntArrayMap, Byte2IntLinkedOpenCustomHashMap, Byte2IntLinkedOpenHashMap, Byte2IntMaps.SynchronizedOrderedMap, Byte2IntMaps.UnmodifyableOrderedMap, ImmutableByte2IntOpenHashMap

public interface Byte2IntOrderedMap
extends Byte2IntMap

A Special Map Interface giving Access to some really usefull functions The Idea behind this interface is to allow access to functions that give control to the Order of elements. Since Linked implementations as examples can be reordered outside of the Insertion Order. This interface provides basic access to such functions while also providing some Sorted/NaivgableMap implementations that still fit into here.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Byte2IntOrderedMap.FastOrderedSet Fast Ordered Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

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.
default Byte2IntOrderedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Byte2IntOrderedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
default Byte2IntOrderedMap	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable

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

addTo, addToAll, applyAsInt, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, 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

int putAndMoveToFirst(byte key,
                      int value)

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

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

int putAndMoveToLast(byte key,
                     int value)

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

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

boolean moveToFirst(byte key)

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

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place

moveToLast

boolean moveToLast(byte key)

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

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place

getAndMoveToFirst

int getAndMoveToFirst(byte key)

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

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

int getAndMoveToLast(byte key)

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

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstByteKey

byte firstByteKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstByteKey

byte pollFirstByteKey()

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

Returns:

the first key in the map

lastByteKey

byte lastByteKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastByteKey

byte pollLastByteKey()

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

Returns:

the last key in the map

firstIntValue

int firstIntValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastIntValue

int lastIntValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

copy

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

Returns:

a Shallow Copy of the Map

keySet

ByteOrderedSet keySet()

Specified by:

keySet in interface Byte2IntMap

Specified by:

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

byte2IntEntrySet

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

Returns:

a EntrySet of the collection

synchronize

default Byte2IntOrderedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2IntMap

Returns:

a new SortedMap that is synchronized

See Also:

Byte2IntMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)

synchronize

default Byte2IntOrderedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2IntMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Byte2IntMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)

unmodifiable

default Byte2IntOrderedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Byte2IntMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Byte2IntMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2IntMap)