speiger.src.collections.shorts.utils.maps

Class Short2CharMaps.UnmodifyableOrderedMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableMap

speiger.src.collections.shorts.utils.maps.Short2CharMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap, Short2CharOrderedMap

Enclosing class:

Short2CharMaps

public static class Short2CharMaps.UnmodifyableOrderedMap
extends Short2CharMaps.UnmodifyableMap
implements Short2CharOrderedMap

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

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

AbstractShort2CharMap.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.shorts.maps.interfaces.Short2CharOrderedMap

Short2CharOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

Short2CharMap.BuilderCache, Short2CharMap.Entry, Short2CharMap.FastEntrySet, Short2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Short2CharOrderedMap	copy() A Function that does a shallow clone of the Map itself.
char	firstCharValue() A method to get the first Value of a Map.
short	firstShortKey() A method to get the first Key of a Map.
char	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
ShortOrderedSet	keySet()
char	lastCharValue() A method to get the last Value of a Map.
short	lastShortKey() A method to get the last Key of a Map.
boolean	moveToFirst(short key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(short key) A specific move method to move a given key/value to the last index.
short	pollFirstShortKey() A method to get and remove the first Key of a Map.
short	pollLastShortKey() A method to get and remove the last Key of a Map.
char	putAndMoveToFirst(short key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(short key, char value) A customized put method that allows you to insert into the last index.
ObjectOrderedSet<Short2CharMap.Entry>	short2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2CharMaps.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.shorts.maps.abstracts.AbstractShort2CharMap

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.shorts.maps.interfaces.Short2CharOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

addTo, addToAll, applyAsChar, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, 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(short key,
                              char value)

Description copied from interface: Short2CharOrderedMap

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

Specified by:

putAndMoveToFirst in interface Short2CharOrderedMap

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

Description copied from interface: Short2CharOrderedMap

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 Short2CharOrderedMap

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

Description copied from interface: Short2CharOrderedMap

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

Specified by:

moveToFirst in interface Short2CharOrderedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short key)

Description copied from interface: Short2CharOrderedMap

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

Specified by:

moveToLast in interface Short2CharOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(short key)

Description copied from interface: Short2CharOrderedMap

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

Specified by:

getAndMoveToFirst in interface Short2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(short key)

Description copied from interface: Short2CharOrderedMap

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

Specified by:

getAndMoveToLast in interface Short2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstShortKey

public short firstShortKey()

Description copied from interface: Short2CharOrderedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2CharOrderedMap

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2CharOrderedMap

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

Specified by:

pollFirstShortKey in interface Short2CharOrderedMap

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2CharOrderedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2CharOrderedMap

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2CharOrderedMap

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

Specified by:

pollLastShortKey in interface Short2CharOrderedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Short2CharOrderedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Short2CharOrderedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Short2CharOrderedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Short2CharOrderedMap

Returns:

the last key in the map

copy

public Short2CharOrderedMap copy()

Description copied from interface: Short2CharMap

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 Short2CharMap

Specified by:

copy in interface Short2CharOrderedMap

Overrides:

copy in class Short2CharMaps.UnmodifyableMap

Returns:

a Shallow Copy of the Map

keySet

public ShortOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Specified by:

keySet in interface Short2CharOrderedMap

Overrides:

keySet in class Short2CharMaps.UnmodifyableMap

short2CharEntrySet

public ObjectOrderedSet<Short2CharMap.Entry> short2CharEntrySet()

Description copied from interface: Short2CharMap

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

Specified by:

short2CharEntrySet in interface Short2CharMap

Specified by:

short2CharEntrySet in interface Short2CharOrderedMap

Overrides:

short2CharEntrySet in class Short2CharMaps.UnmodifyableMap

Returns:

a EntrySet of the collection