speiger.src.collections.objects.utils.maps

Class Object2ObjectMaps.UnmodifyableSortedMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableMap<T,V>

speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableSortedMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, java.util.SortedMap<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>, Object2ObjectSortedMap<T,V>

Direct Known Subclasses:

Object2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Object2ObjectMaps

public static class Object2ObjectMaps.UnmodifyableSortedMap<T,V>
extends Object2ObjectMaps.UnmodifyableMap<T,V>
implements Object2ObjectSortedMap<T,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.objects.maps.abstracts.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<T,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.objects.maps.interfaces.Object2ObjectSortedMap

Object2ObjectSortedMap.FastSortedSet<T,V>

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<T>	comparator()
Object2ObjectSortedMap<T,V>	copy() A Function that does a shallow clone of the Map itself.
T	firstKey()
V	firstValue() A method to get the first Value of a Map.
Object2ObjectSortedMap<T,V>	headMap(T toKey)
ObjectSortedSet<T>	keySet()
T	lastKey()
V	lastValue() A method to get the last Value of a Map.
T	pollFirstKey() A method to get and remove the first Key of a Map.
T	pollLastKey() A method to get and remove the last Key of a Map.
Object2ObjectSortedMap<T,V>	subMap(T fromKey, T toKey)
Object2ObjectSortedMap<T,V>	tailMap(T fromKey)

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2ObjectMaps.UnmodifyableMap

clear, compute, computeIfAbsent, computeIfPresent, getObject, merge, mergeAll, object2ObjectEntrySet, put, putIfAbsent, rem, remOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap

containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectSortedMap

synchronize, synchronize, unmodifiable, values

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, merge, merge, mergeAll, object2ObjectEntrySet, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2ObjectFunction

apply, getObject

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

comparator

public java.util.Comparator<T> comparator()

Specified by:

comparator in interface java.util.SortedMap<T,V>

Specified by:

comparator in interface Object2ObjectSortedMap<T,V>

subMap

public Object2ObjectSortedMap<T,V> subMap(T fromKey,
                                          T toKey)

Specified by:

subMap in interface java.util.SortedMap<T,V>

Specified by:

subMap in interface Object2ObjectSortedMap<T,V>

headMap

public Object2ObjectSortedMap<T,V> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T,V>

Specified by:

headMap in interface Object2ObjectSortedMap<T,V>

tailMap

public Object2ObjectSortedMap<T,V> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T,V>

Specified by:

tailMap in interface Object2ObjectSortedMap<T,V>

keySet

public ObjectSortedSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface java.util.SortedMap<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Specified by:

keySet in interface Object2ObjectSortedMap<T,V>

Overrides:

keySet in class Object2ObjectMaps.UnmodifyableMap<T,V>

firstKey

public T firstKey()

Specified by:

firstKey in interface java.util.SortedMap<T,V>

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

pollFirstKey in interface Object2ObjectSortedMap<T,V>

Returns:

the first key in the map

lastKey

public T lastKey()

Specified by:

lastKey in interface java.util.SortedMap<T,V>

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

pollLastKey in interface Object2ObjectSortedMap<T,V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Object2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Object2ObjectSortedMap<T,V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Object2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Object2ObjectSortedMap<T,V>

Returns:

the last key in the map

copy

public Object2ObjectSortedMap<T,V> copy()

Description copied from interface: Object2ObjectMap

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 Object2ObjectMap<T,V>

Specified by:

copy in interface Object2ObjectSortedMap<T,V>

Overrides:

copy in class Object2ObjectMaps.UnmodifyableMap<T,V>

Returns:

a Shallow Copy of the Map