speiger.src.collections.ints.maps.interfaces

Interface Int2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Int2ObjectFunction<V>, Int2ObjectMap<V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, java.util.SortedMap<java.lang.Integer,V>

All Known Subinterfaces:

Int2ObjectNavigableMap<V>

All Known Implementing Classes:

Int2ObjectAVLTreeMap, Int2ObjectMaps.SynchronizedNavigableMap, Int2ObjectMaps.SynchronizedSortedMap, Int2ObjectMaps.UnmodifyableNavigableMap, Int2ObjectMaps.UnmodifyableSortedMap, Int2ObjectRBTreeMap

public interface Int2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Integer,V>, Int2ObjectMap<V>

A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Note:

Int2ObjectOrderedMap is only extended until 0.6.0 for Compat reasons. The supported classes already implement Int2ObjectOrderedMap directly and will remove Int2ObjectSortedMap implementations in favor of Int2ObjectOrderedMap instead

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Int2ObjectSortedMap.FastSortedSet<V> Fast Sorted 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.Int2ObjectMap

Int2ObjectMap.BuilderCache<V>, Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>, Int2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
IntComparator	comparator()
Int2ObjectSortedMap<V>	copy() A Function that does a shallow clone of the Map itself.
int	firstIntKey() A method to get the first Key of a Map.
default java.lang.Integer	firstKey() Deprecated.
V	firstValue() A method to get the first Value of a Map.
Int2ObjectSortedMap<V>	headMap(int toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Int2ObjectSortedMap<V>	headMap(java.lang.Integer toKey) Deprecated.
IntSortedSet	keySet()
int	lastIntKey() A method to get the last Key of a Map.
default java.lang.Integer	lastKey() Deprecated.
V	lastValue() A method to get the last Value of a Map.
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.
default Int2ObjectSortedMap<V>	subMap(java.lang.Integer fromKey, java.lang.Integer toKey) Deprecated.
Int2ObjectSortedMap<V>	subMap(int fromKey, int toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Int2ObjectSortedMap<V>	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Int2ObjectSortedMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Int2ObjectSortedMap<V>	tailMap(int fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Int2ObjectSortedMap<V>	tailMap(java.lang.Integer fromKey) Deprecated.
default Int2ObjectSortedMap<V>	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, int2ObjectEntrySet, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

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

Methods inherited from interface speiger.src.collections.ints.functions.function.Int2ObjectFunction

apply

Method Detail

comparator

IntComparator comparator()

Specified by:

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

copy

Int2ObjectSortedMap<V> copy()

Description copied from interface: Int2ObjectMap

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

Returns:

a Shallow Copy of the Map

keySet

IntSortedSet keySet()

Specified by:

keySet in interface Int2ObjectMap<V>

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<java.lang.Integer,V>

values

ObjectCollection<V> values()

Specified by:

values in interface Int2ObjectMap<V>

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

Specified by:

values in interface java.util.SortedMap<java.lang.Integer,V>

synchronize

default Int2ObjectSortedMap<V> synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Int2ObjectMap<V>

Returns:

a new SortedMap that is synchronized

See Also:

Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

synchronize

default Int2ObjectSortedMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Int2ObjectMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Int2ObjectMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

unmodifiable

default Int2ObjectSortedMap<V> unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Int2ObjectMap<V>

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Int2ObjectMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2ObjectMap<V>)

subMap

Int2ObjectSortedMap<V> subMap(int fromKey,
                              int toKey)

A Type Specific SubMap method to reduce boxing/unboxing

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

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headMap

Int2ObjectSortedMap<V> headMap(int toKey)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailMap

Int2ObjectSortedMap<V> tailMap(int fromKey)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

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

firstValue

V firstValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastValue

V lastValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

firstKey

@Deprecated
default java.lang.Integer firstKey()

Deprecated.

Specified by:

firstKey in interface java.util.SortedMap<java.lang.Integer,V>

lastKey

@Deprecated
default java.lang.Integer lastKey()

Deprecated.

Specified by:

lastKey in interface java.util.SortedMap<java.lang.Integer,V>

subMap

@Deprecated
default Int2ObjectSortedMap<V> subMap(java.lang.Integer fromKey,
                                                   java.lang.Integer toKey)

Deprecated.

Specified by:

subMap in interface java.util.SortedMap<java.lang.Integer,V>

headMap

@Deprecated
default Int2ObjectSortedMap<V> headMap(java.lang.Integer toKey)

Deprecated.

Specified by:

headMap in interface java.util.SortedMap<java.lang.Integer,V>

tailMap

@Deprecated
default Int2ObjectSortedMap<V> tailMap(java.lang.Integer fromKey)

Deprecated.

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Integer,V>