speiger.src.collections.ints.maps.interfaces

Interface Int2CharOrderedMap

All Superinterfaces:

Int2CharFunction, Int2CharMap, java.util.Map<java.lang.Integer,java.lang.Character>

All Known Implementing Classes:

ImmutableInt2CharOpenHashMap, Int2CharArrayMap, Int2CharLinkedOpenCustomHashMap, Int2CharLinkedOpenHashMap, Int2CharMaps.SynchronizedOrderedMap, Int2CharMaps.UnmodifyableOrderedMap

public interface Int2CharOrderedMap
extends Int2CharMap

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	Int2CharOrderedMap.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.ints.maps.interfaces.Int2CharMap

Int2CharMap.BuilderCache, Int2CharMap.Entry, Int2CharMap.FastEntrySet, Int2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Int2CharOrderedMap	copy() A Function that does a shallow clone of the Map itself.
char	firstCharValue() A method to get the first Value of a Map.
int	firstIntKey() A method to get the first Key of a Map.
char	getAndMoveToFirst(int key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(int key) A Specific get method that allows to move teh given key/value int the last index.
ObjectOrderedSet<Int2CharMap.Entry>	int2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntOrderedSet	keySet()
char	lastCharValue() 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.
char	putAndMoveToFirst(int key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(int key, char value) A customized put method that allows you to insert into the last index.
default Int2CharOrderedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Int2CharOrderedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
default Int2CharOrderedMap	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable

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

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent, values

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

char putAndMoveToFirst(int key,
                       char 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

char putAndMoveToLast(int key,
                      char 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(int 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(int 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

char getAndMoveToFirst(int 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

char getAndMoveToLast(int 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

firstIntKey

int firstIntKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstIntKey

int pollFirstIntKey()

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

Returns:

the first key in the map

lastIntKey

int lastIntKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastIntKey

int pollLastIntKey()

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

Returns:

the last key in the map

firstCharValue

char firstCharValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastCharValue

char lastCharValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

copy

Int2CharOrderedMap copy()

Description copied from interface: Int2CharMap

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 Int2CharMap

Returns:

a Shallow Copy of the Map

keySet

IntOrderedSet keySet()

Specified by:

keySet in interface Int2CharMap

Specified by:

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

int2CharEntrySet

ObjectOrderedSet<Int2CharMap.Entry> int2CharEntrySet()

Description copied from interface: Int2CharMap

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

Specified by:

int2CharEntrySet in interface Int2CharMap

Returns:

a EntrySet of the collection

synchronize

default Int2CharOrderedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Int2CharMap

Returns:

a new SortedMap that is synchronized

See Also:

Int2CharMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2CharMap)

synchronize

default Int2CharOrderedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Int2CharMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Int2CharMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2CharMap)

unmodifiable

default Int2CharOrderedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Int2CharMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Int2CharMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2CharMap)