speiger.src.collections.bytes.maps.interfaces

Interface Byte2CharSortedMap

All Superinterfaces:

Byte2CharFunction, Byte2CharMap, java.util.Map<java.lang.Byte,java.lang.Character>, java.util.SortedMap<java.lang.Byte,java.lang.Character>

All Known Subinterfaces:

Byte2CharNavigableMap

All Known Implementing Classes:

Byte2CharAVLTreeMap, Byte2CharMaps.SynchronizedNavigableMap, Byte2CharMaps.SynchronizedSortedMap, Byte2CharMaps.UnmodifyableNavigableMap, Byte2CharMaps.UnmodifyableSortedMap, Byte2CharRBTreeMap

public interface Byte2CharSortedMap
extends java.util.SortedMap<java.lang.Byte,java.lang.Character>, Byte2CharMap

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Byte2CharSortedMap.FastSortedSet 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.bytes.maps.interfaces.Byte2CharMap

Byte2CharMap.BuilderCache, Byte2CharMap.Entry, Byte2CharMap.FastEntrySet, Byte2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
ByteComparator	comparator()
Byte2CharSortedMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteKey() A method to get the first Key of a Map.
char	firstCharValue() A method to get the first Value of a Map.
default java.lang.Byte	firstKey() Deprecated.
Byte2CharSortedMap	headMap(byte toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Byte2CharSortedMap	headMap(java.lang.Byte toKey) Deprecated.
ByteSortedSet	keySet()
byte	lastByteKey() A method to get the last Key of a Map.
char	lastCharValue() A method to get the last Value of a Map.
default java.lang.Byte	lastKey() Deprecated.
byte	pollFirstByteKey() A method to get and remove the first Key of a Map.
byte	pollLastByteKey() A method to get and remove the last Key of a Map.
Byte2CharSortedMap	subMap(byte fromKey, byte toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Byte2CharSortedMap	subMap(java.lang.Byte fromKey, java.lang.Byte toKey) Deprecated.
default Byte2CharSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Byte2CharSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Byte2CharSortedMap	tailMap(byte fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Byte2CharSortedMap	tailMap(java.lang.Byte fromKey) Deprecated.
default Byte2CharSortedMap	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
CharCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2CharMap

addTo, addToAll, applyAsChar, builder, byte2CharEntrySet, 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

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

comparator

ByteComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

copy

Byte2CharSortedMap copy()

Description copied from interface: Byte2CharMap

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 Byte2CharMap

Returns:

a Shallow Copy of the Map

keySet

ByteSortedSet keySet()

Specified by:

keySet in interface Byte2CharMap

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

values

CharCollection values()

Specified by:

values in interface Byte2CharMap

Specified by:

values in interface java.util.Map<java.lang.Byte,java.lang.Character>

Specified by:

values in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

synchronize

default Byte2CharSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2CharMap

Returns:

a new SortedMap that is synchronized

See Also:

Byte2CharMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2CharMap)

synchronize

default Byte2CharSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Byte2CharMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Byte2CharMaps.synchronize(speiger.src.collections.bytes.maps.interfaces.Byte2CharMap)

unmodifiable

default Byte2CharSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Byte2CharMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Byte2CharMaps.unmodifiable(speiger.src.collections.bytes.maps.interfaces.Byte2CharMap)

subMap

Byte2CharSortedMap subMap(byte fromKey,
                          byte 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

Byte2CharSortedMap headMap(byte 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

Byte2CharSortedMap tailMap(byte 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.

firstByteKey

byte firstByteKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstByteKey

byte pollFirstByteKey()

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

Returns:

the first key in the map

lastByteKey

byte lastByteKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastByteKey

byte pollLastByteKey()

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

Returns:

the last key in the map

firstCharValue

char firstCharValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastCharValue

char lastCharValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

firstKey

@Deprecated
default java.lang.Byte firstKey()

Deprecated.

Specified by:

firstKey in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

lastKey

@Deprecated
default java.lang.Byte lastKey()

Deprecated.

Specified by:

lastKey in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

subMap

@Deprecated
default Byte2CharSortedMap subMap(java.lang.Byte fromKey,
                                               java.lang.Byte toKey)

Deprecated.

Specified by:

subMap in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

headMap

@Deprecated
default Byte2CharSortedMap headMap(java.lang.Byte toKey)

Deprecated.

Specified by:

headMap in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>

tailMap

@Deprecated
default Byte2CharSortedMap tailMap(java.lang.Byte fromKey)

Deprecated.

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Byte,java.lang.Character>