it.unimi.dsi.fastutil.bytes
Interface Byte2ReferenceSortedMap<V>

All Superinterfaces:
Byte2ReferenceFunction<V>, Byte2ReferenceMap<V>, Function<java.lang.Byte,V>, java.util.Map<java.lang.Byte,V>, java.util.SortedMap<java.lang.Byte,V>
All Known Implementing Classes:
AbstractByte2ReferenceSortedMap, Byte2ReferenceAVLTreeMap, Byte2ReferenceLinkedOpenHashMap, Byte2ReferenceRBTreeMap, Byte2ReferenceSortedMaps.EmptySortedMap, Byte2ReferenceSortedMaps.Singleton, Byte2ReferenceSortedMaps.SynchronizedSortedMap, Byte2ReferenceSortedMaps.UnmodifiableSortedMap

public interface Byte2ReferenceSortedMap<V>
extends Byte2ReferenceMap<V>, java.util.SortedMap<java.lang.Byte,V>

A type-specific SortedMap; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens entrySet(), keySet(), values(), comparator(), SortedMap.subMap(Object,Object), SortedMap.headMap(Object) and SortedMap.tailMap(Object).

See Also:
SortedMap

Nested Class Summary
static interface Byte2ReferenceSortedMap.FastSortedEntrySet<V>
          A sorted entry set providing fast iteration.
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ReferenceMap
Byte2ReferenceMap.Entry<V>, Byte2ReferenceMap.FastEntrySet<V>
 
Method Summary
 ObjectSortedSet<Byte2ReferenceMap.Entry<V>> byte2ReferenceEntrySet()
          Returns a type-specific sorted-set view of the mappings contained in this map.
 ByteComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
 ObjectSortedSet<java.util.Map.Entry<java.lang.Byte,V>> entrySet()
          Returns a sorted-set view of the mappings contained in this map.
 byte firstByteKey()
           
 Byte2ReferenceSortedMap<V> headMap(byte toKey)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 Byte2ReferenceSortedMap<V> headMap(java.lang.Byte toKey)
          Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
 ByteSortedSet keySet()
          Returns a sorted-set view of the keys contained in this map.
 byte lastByteKey()
           
 Byte2ReferenceSortedMap<V> subMap(byte fromKey, byte toKey)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Byte2ReferenceSortedMap<V> subMap(java.lang.Byte fromKey, java.lang.Byte toKey)
          Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
 Byte2ReferenceSortedMap<V> tailMap(byte fromKey)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 Byte2ReferenceSortedMap<V> tailMap(java.lang.Byte fromKey)
          Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
 ReferenceCollection<V> values()
          Returns a set view of the values contained in this map.
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunction
containsKey, defaultReturnValue, defaultReturnValue, get, put, remove
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
clear, containsKey, get, put, remove, size
 
Methods inherited from interface java.util.SortedMap
firstKey, lastKey
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size
 

Method Detail

entrySet

ObjectSortedSet<java.util.Map.Entry<java.lang.Byte,V>> entrySet()
Returns a sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:
entrySet in interface Byte2ReferenceMap<V>
Specified by:
entrySet in interface java.util.Map<java.lang.Byte,V>
Specified by:
entrySet in interface java.util.SortedMap<java.lang.Byte,V>
Returns:
a sorted-set view of the mappings contained in this map.
See Also:
Map.entrySet()

byte2ReferenceEntrySet

ObjectSortedSet<Byte2ReferenceMap.Entry<V>> byte2ReferenceEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:
byte2ReferenceEntrySet in interface Byte2ReferenceMap<V>
Returns:
a type-specific sorted-set view of the mappings contained in this map.
See Also:
entrySet()

keySet

ByteSortedSet keySet()
Returns a sorted-set view of the keys contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:
keySet in interface Byte2ReferenceMap<V>
Specified by:
keySet in interface java.util.Map<java.lang.Byte,V>
Specified by:
keySet in interface java.util.SortedMap<java.lang.Byte,V>
Returns:
a sorted-set view of the keys contained in this map.
See Also:
Map.keySet()

values

ReferenceCollection<V> values()
Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends SortedMap.

Specified by:
values in interface Byte2ReferenceMap<V>
Specified by:
values in interface java.util.Map<java.lang.Byte,V>
Specified by:
values in interface java.util.SortedMap<java.lang.Byte,V>
Returns:
a set view of the values contained in this map.
See Also:
Map.values()

comparator

ByteComparator comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

Specified by:
comparator in interface java.util.SortedMap<java.lang.Byte,V>
See Also:
SortedMap.comparator()

subMap

Byte2ReferenceSortedMap<V> subMap(java.lang.Byte fromKey,
                                  java.lang.Byte toKey)
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:
subMap in interface java.util.SortedMap<java.lang.Byte,V>
See Also:
SortedMap.subMap(Object,Object)

headMap

Byte2ReferenceSortedMap<V> headMap(java.lang.Byte toKey)
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Note that this specification strengthens the one given in SortedMap.headMap(Object).

Specified by:
headMap in interface java.util.SortedMap<java.lang.Byte,V>
See Also:
SortedMap.headMap(Object)

tailMap

Byte2ReferenceSortedMap<V> tailMap(java.lang.Byte fromKey)
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Note that this specification strengthens the one given in SortedMap.tailMap(Object).

Specified by:
tailMap in interface java.util.SortedMap<java.lang.Byte,V>
See Also:
SortedMap.tailMap(Object)

subMap

Byte2ReferenceSortedMap<V> subMap(byte fromKey,
                                  byte toKey)
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

See Also:
SortedMap.subMap(Object,Object)

headMap

Byte2ReferenceSortedMap<V> headMap(byte toKey)
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

See Also:
SortedMap.headMap(Object)

tailMap

Byte2ReferenceSortedMap<V> tailMap(byte fromKey)
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

See Also:
SortedMap.tailMap(Object)

firstByteKey

byte firstByteKey()
See Also:
SortedMap.firstKey()

lastByteKey

byte lastByteKey()
See Also:
SortedMap.lastKey()