speiger.src.collections.shorts.utils.maps

Class Short2ObjectMaps.UnmodifyableSortedMap<V>

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Short,V>, java.util.SortedMap<java.lang.Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>, Short2ObjectSortedMap<V>

Direct Known Subclasses:

Short2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Short2ObjectMaps

public static class Short2ObjectMaps.UnmodifyableSortedMap<V>
extends Short2ObjectMaps.UnmodifyableMap<V>
implements Short2ObjectSortedMap<V>

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

Nested Class Summary

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

AbstractShort2ObjectMap.BasicEntry<V>

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

Short2ObjectSortedMap.FastSortedSet<V>

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

Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>

Method Summary

Modifier and Type	Method and Description
ShortComparator	comparator()
short	firstShortKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
Short2ObjectSortedMap<V>	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
short	lastShortKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value 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.
V	putAndMoveToFirst(short key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(short key, V value) A customized put method that allows you to insert into the last index.
Short2ObjectSortedMap<V>	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
Short2ObjectSortedMap<V>	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2ObjectMaps.UnmodifyableMap

getObject, getOrDefault, keySet, put, putIfAbsent, remove, remShort, remShortOrDefault, short2ObjectEntrySet, values

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ObjectMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, merge, mergeAll, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsKey, isEmpty, put, remove, 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.Short2ObjectSortedMap

firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.SortedMap

entrySet

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remShort, remShortOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, short2ObjectEntrySet

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(short key,
                           V value)

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

putAndMoveToFirst in interface Short2ObjectSortedMap<V>

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

Description copied from interface: Short2ObjectSortedMap

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 Short2ObjectSortedMap<V>

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

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

Specified by:

moveToFirst in interface Short2ObjectSortedMap<V>

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

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

Specified by:

moveToLast in interface Short2ObjectSortedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(short key)

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

getAndMoveToFirst in interface Short2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(short key)

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

getAndMoveToLast in interface Short2ObjectSortedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public ShortComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Short,V>

Specified by:

comparator in interface Short2ObjectSortedMap<V>

subMap

public Short2ObjectSortedMap<V> subMap(short fromKey,
                                       short toKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2ObjectSortedMap<V>

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

public Short2ObjectSortedMap<V> headMap(short toKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Short2ObjectSortedMap<V> tailMap(short fromKey)

Description copied from interface: Short2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstShortKey

public short firstShortKey()

Description copied from interface: Short2ObjectSortedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2ObjectSortedMap<V>

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

pollFirstShortKey in interface Short2ObjectSortedMap<V>

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2ObjectSortedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2ObjectSortedMap<V>

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2ObjectSortedMap

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

Specified by:

pollLastShortKey in interface Short2ObjectSortedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Short2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Short2ObjectSortedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Short2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Short2ObjectSortedMap<V>

Returns:

the last key in the map