speiger.src.collections.ints.utils.maps

Class Int2CharMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

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

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

All Implemented Interfaces:

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

Enclosing class:

Int2CharMaps

public static class Int2CharMaps.UnmodifyableOrderedMap
extends Int2CharMaps.UnmodifyableMap
implements Int2CharOrderedMap

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

AbstractInt2CharMap.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.Int2CharOrderedMap

Int2CharOrderedMap.FastOrderedSet

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.

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

addTo, clear, computeChar, computeCharIfAbsent, computeCharIfPresent, get, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remove, remove, removeOrDefault, replaceChars, replaceChars, subFrom, supplyCharIfAbsent, values

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

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

synchronize, synchronize, 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

public char putAndMoveToFirst(int key,
                              char value)

Description copied from interface: Int2CharOrderedMap

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

Specified by:

putAndMoveToFirst in interface Int2CharOrderedMap

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

Description copied from interface: Int2CharOrderedMap

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 Int2CharOrderedMap

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

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

Specified by:

moveToFirst in interface Int2CharOrderedMap

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

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

Specified by:

moveToLast in interface Int2CharOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(int key)

Description copied from interface: Int2CharOrderedMap

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

Specified by:

getAndMoveToFirst in interface Int2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(int key)

Description copied from interface: Int2CharOrderedMap

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

Specified by:

getAndMoveToLast in interface Int2CharOrderedMap

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

A method to get the first Key of a Map.

Specified by:

firstIntKey in interface Int2CharOrderedMap

Returns:

the first key in the map

pollFirstIntKey

public int pollFirstIntKey()

Description copied from interface: Int2CharOrderedMap

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

Specified by:

pollFirstIntKey in interface Int2CharOrderedMap

Returns:

the first key in the map

lastIntKey

public int lastIntKey()

Description copied from interface: Int2CharOrderedMap

A method to get the last Key of a Map.

Specified by:

lastIntKey in interface Int2CharOrderedMap

Returns:

the last key in the map

pollLastIntKey

public int pollLastIntKey()

Description copied from interface: Int2CharOrderedMap

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

Specified by:

pollLastIntKey in interface Int2CharOrderedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Int2CharOrderedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Int2CharOrderedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Int2CharOrderedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Int2CharOrderedMap

Returns:

the last key in the map

copy

public 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

Specified by:

copy in interface Int2CharOrderedMap

Overrides:

copy in class Int2CharMaps.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.Character>

Specified by:

keySet in interface Int2CharMap

Specified by:

keySet in interface Int2CharOrderedMap

Overrides:

keySet in class Int2CharMaps.UnmodifyableMap

int2CharEntrySet

public 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

Specified by:

int2CharEntrySet in interface Int2CharOrderedMap

Overrides:

int2CharEntrySet in class Int2CharMaps.UnmodifyableMap

Returns:

a EntrySet of the collection