java.util
public interface
public interface
java.util.SortedMap
| java.util.SortedMap | Map |
SortedMap is a Map where the iterators sequence in order of the sorted keys.
Known Indirect Subclasses
Summary
Public Methods
| Comparator | comparator() | ||||
| Answers the Comparator used to compare elements in this SortedMap. | |||||
| K | firstKey() | ||||
| Answer the first sorted key in this SortedMap. | |||||
| SortedMap | headMap(K endKey) | ||||
Answers a SortedMap of the specified portion of this
SortedMap which contains keys less than the end key. |
|||||
| K | lastKey() | ||||
| Answers the last sorted key in this SortedMap. | |||||
| SortedMap | subMap(K startKey, K endKey) | ||||
| Answers a SortedMap of the specified portion of this SortedMap which contains keys greater or equal to the start key but less than the end key. | |||||
| SortedMap | tailMap(K startKey) | ||||
| Answers a SortedMap of the specified portion of this SortedMap which contains keys greater or equal to the start key. | |||||
Methods inherited
from interface
java.util.Map
Details
Public Methods
public Comparator comparator()
Answers the Comparator used to compare elements in this SortedMap.
Returns
- a Comparator or null if the natural order is used
public K firstKey()
Answer the first sorted key in this SortedMap.
Returns
- the first sorted key
Throws
| NoSuchElementException | when this SortedMap is empty |
|---|
public SortedMap headMap(K endKey)
Answers a
SortedMap of the specified portion of this
SortedMap which contains keys less than the end key. Users
should be aware that the return value is actually backed by this
SortedMap. Hence any modifications made to one will be
immediately visible to the other.
Parameters
| endKey | the end key |
|---|
Returns
- a submap where the keys are less than
endKey
Throws
| ClassCastException | when the class of the end key is inappropriate for this SubMap |
|---|---|
| NullPointerException | when the end key is null and this SortedMap does not support null keys |
public K lastKey()
Answers the last sorted key in this SortedMap.
Returns
- the last sorted key
Throws
| NoSuchElementException | when this SortedMap is empty |
|---|
public SortedMap subMap(K startKey, K endKey)
Answers a SortedMap of the specified portion of this SortedMap which
contains keys greater or equal to the start key but less than the end
key. Users should be aware that the return value is actually backed by
this
SortedMap. Hence any modifications made to one will
be immediately visible to the other.
Parameters
| startKey | the start key |
|---|---|
| endKey | the end key |
Returns
- a submap where the keys are greater or equal to
startKeyand less thanendKey
Throws
| ClassCastException | when the class of the start or end key is inappropriate for this SubMap |
|---|---|
| NullPointerException | when the start or end key is null and this SortedMap does not support null keys |
| IllegalArgumentException | when the start key is greater than the end key |
public SortedMap tailMap(K startKey)
Answers a SortedMap of the specified portion of this SortedMap which
contains keys greater or equal to the start key. The returned SortedMap
is backed by this SortedMap so changes to one are reflected by the other.
Parameters
| startKey | the start key |
|---|
Returns
- a submap where the keys are greater or equal to
startKey
Throws
| ClassCastException | when the class of the start key is inappropriate for this SubMap |
|---|---|
| NullPointerException | when the start key is null and this SortedMap does not support null keys |