java.util

Interface SortedMap<K,V>

All Superinterfaces:
Map<K,V>
Known Subinterfaces:
SortedBidiMap
Known Implementing Classes:
AbstractSortedBidiMapDecorator, AbstractSortedMapDecorator, DualTreeBidiMap, DualTreeBidiMap.ViewMap, FastTreeMap, FixedSizeSortedMap, LazySortedMap, PersistentSortedMap, PredicatedSortedMap, TransformedSortedMap, TreeMap<K,V>, UnmodifiableSortedBidiMap, UnmodifiableSortedMap

public interface SortedMap<K,V>
extends Map<K,V>

A map that further guarantees that it will be in ascending key order, sorted according to the natural ordering of its keys (see the Comparable interface), or by a comparator provided at sorted map creation time. This order is reflected when iterating over the sorted map's collection views (returned by the entrySet, keySet and values methods). Several additional operations are provided to take advantage of the ordering. (This interface is the map analogue of the SortedSet interface.)

All keys inserted into a sorted map must implement the Comparable interface (or be accepted by the specified comparator). Furthermore, all such keys must be mutually comparable: k1.compareTo(k2) (or comparator.compare(k1, k2)) must not throw a ClassCastException for any elements k1 and k2 in the sorted map. Attempts to violate this restriction will cause the offending method or constructor invocation to throw a ClassCastException.

Note that the ordering maintained by a sorted map (whether or not an explicit comparator is provided) must be consistent with equals if the sorted map is to correctly implement the Map interface. (See the Comparable interface or Comparator interface for a precise definition of consistent with equals.) This is so because the Map interface is defined in terms of the equals operation, but a sorted map performs all key comparisons using its compareTo (or compare) method, so two keys that are deemed equal by this method are, from the standpoint of the sorted map, equal. The behavior of a tree map is well-defined even if its ordering is inconsistent with equals; it just fails to obey the general contract of the Map interface.

All general-purpose sorted map implementation classes should provide four "standard" constructors: 1) A void (no arguments) constructor, which creates an empty sorted map sorted according to the natural order of its keys. 2) A constructor with a single argument of type Comparator, which creates an empty sorted map sorted according to the specified comparator. 3) A constructor with a single argument of type Map, which creates a new map with the same key-value mappings as its argument, sorted according to the keys' natural ordering. 4) A constructor with a single argument of type sorted map, which creates a new sorted map with the same key-value mappings and the same ordering as the input sorted map. There is no way to enforce this recommendation (as interfaces cannot contain constructors) but the JDK implementation (TreeMap) complies.

This interface is a member of the ../../../guide/collections/index.html"> Java Collections Framework.

Since:
1.2
See Also:
Map, TreeMap, SortedSet, Comparator, Comparable, Collection, ClassCastException

Method Summary

K
firstKey()
Returns the first (lowest) key currently in this sorted map.
SortedMap
headMap(K toKey)
Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
K
lastKey()
Returns the last (highest) key currently in this sorted map.
SortedMap
subMap(K fromKey, K toKey)
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Comparator
super K> comparator()
Returns the comparator associated with this sorted map, or null if it uses its keys' natural ordering.
SortedMap
tailMap(K fromKey)
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Methods inherited from interface java.util.Map<K,V>

V>> entrySet, clear, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Details

firstKey

public K firstKey()
Returns the first (lowest) key currently in this sorted map.
Returns:
the first (lowest) key currently in this sorted map.
Throws:
NoSuchElementException - if this map is empty.
Usages and Demos :

View More Examples of firstKey()
   1: 
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5: {
   6:     private final SortedMap mLines = new TreeMap();
   7: 
   8:         ...
   9:     {
  10:         final Object firstLineKey = mLines.firstKey();
  11:         return ((Integer) mLines.get(firstLineKey)).intValue();
  12:         ...
  13:     {
  14:         return ((Integer) mLines.firstKey()).intValue();

View Full Code Here
   1: import java.util.HashMap;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:     private int capacity;
   6:     private SortedMap timeToKey = new TreeMap();
   7:     
   8:         ...
   9:         if (size() == capacity) {
  10:             Object oldestKey = timeToKey.get(timeToKey.firstKey());
  11:             remove(oldestKey);

View Full Code Here
   1: import java.util.Date;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5: 
   6:    protected SortedMap entries = new TreeMap();
   7: 
   8:         ...
   9: 
  10:    public SortedMap getEntries()
  11:    {
  12:         ...
  13:             {
  14:                entries.remove(entries.firstKey());

View Full Code Here
   1:     Map       recsToLongs = new HashMap();
   2:     SortedMap longsToRecs = new TreeMap();
   3:     Map       stmtsToRecs = new HashMap();
   4:         ...
   5:                         {
   6:                             Object oldestLong = longsToRecs.firstKey();
   7:                             Rec oldestRec = (Rec) longsToRecs.get( oldestLong );
   8:                               longsToRecs.remove( oldestLong );
   9:                               recsToLongs.remove( oldestRec );

View Full Code Here
   1: import java.util.Iterator;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:         String classKey = getController().getFrontier().getClassKey(cauri);
   6:         SortedMap tail = map.tailMap(classKey);
   7:         if(tail.isEmpty()) {
   8:         ...
   9:         }
  10:         return (String) tail.get(tail.firstKey());
  11:     }

View Full Code Here

headMap

public SortedMap headMap(K toKey)
Returns a view of the portion of this sorted map whose keys are strictly less than toKey. The returned sorted map is backed by this sorted map, so changes in the returned sorted map are reflected in this sorted map, and vice-versa. The returned map supports all optional map operations that this sorted map supports.

The map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key outside the specified range.

Note: this method always returns a view that does not contain its (high) endpoint. If you need a view that does contain this endpoint, and the key type allows for calculation of the successor a given key, merely request a headMap bounded by successor(highEndpoint). For example, suppose that suppose that m is a map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are less than or equal to high:

    Map head = m.headMap(high+"\0");
Parameters:
toKey - high endpoint (exclusive) of the subMap.
Returns:
a view of the specified initial range of this sorted map.
Throws:
ClassCastException - if toKey is not compatible with this map's comparator (or, if the map has no comparator, if toKey does not implement Comparable). Implementations may, but are not required to, throw this exception if toKey cannot be compared to keys currently in the map.
IllegalArgumentException - if this map is itself a subMap, headMap, or tailMap, and toKey is not within the specified range of the subMap, headMap, or tailMap.
NullPointerException - if toKey is null and this sorted map does not tolerate null keys.
Usages and Demos :

View More Examples of headMap(K toKey)
   1: import java.util.Map;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:     
   6:     protected SortedMap decorateMap(SortedMap map, Factory factory) {
   7:         return LazySortedMap.decorate(map, factory);
   8:         ...
   9:         assertEquals("Last key in head map should be B", 
  10:             map.headMap("C").lastKey(), "B");
  11:         assertEquals("Last key in submap should be B",

View Full Code Here
   1:         super(normalMap, reverseMap, inverseBidiMap);
   2:         this.comparator = ((SortedMap<K, V>) normalMap).comparator();
   3:     }
   4:         ...
   5:     public Comparator<? super K> comparator() {
   6:         return ((SortedMap<K, V>) forwardMap).comparator();
   7:     }
   8:         ...
   9:     public K firstKey() {
  10:         return ((SortedMap<K, V>) forwardMap).firstKey();
  11:     }
  12:         ...
  13:         SortedMap<K, V> sm = (SortedMap<K, V>) forwardMap;
  14:         SortedMap<K, V> hm = sm.headMap(key);

View Full Code Here
   1: 
   2:   protected SortedMap normal = new RedBlackMap();
   3: 
   4:         ...
   5:   protected SortedMap reverse = new RedBlackMap();
   6: 
   7:         ...
   8:   protected SortedMap nulls = new RedBlackMap();
   9: 
  10:         ...
  11:   public SortedMap keyHeadMap(Object value) {
  12:     return normal.headMap(value);

View Full Code Here
   1: 
   2:   protected static void testRemove(SortedMap map) {
   3:     Id[] sorted = (Id[]) map.keySet().toArray(new Id[0]);
   4:         ...
   5: 
   6:   protected static void testRemove(SortedMap map, Id[] sorted, Id remove) {
   7:     System.out.println("REMOVING " + remove);
   8:         ...
   9: 
  10:   protected static void printMap(SortedMap map) {
  11:     Iterator i = map.keySet().iterator();
  12:         ...
  13: 
  14:       testHeadMap(id1, sorted, map.headMap(id1));

View Full Code Here
   1: 
   2:     private transient SortedMap map;
   3: 
   4:         ...
   5: 
   6:     private TreeSet(SortedMap backingMap)
   7:     {
   8:         ...
   9:             copy = (TreeSet)super.clone();
  10:             copy.map = (SortedMap)((AbstractTreeMap)map).clone();
  11: #if USE_ORIGINAL_CODE
  12:         ...
  13:     {
  14:         return new TreeSet(map.headMap(to));

View Full Code Here

lastKey

public K lastKey()
Returns the last (highest) key currently in this sorted map.
Returns:
the last (highest) key currently in this sorted map.
Throws:
NoSuchElementException - if this map is empty.
Usages and Demos :

View More Examples of lastKey()
   1: import java.util.Comparator;
   2: import java.util.SortedMap;
   3: 
   4:         ...
   5:     public static void main(String[] pArgs) {
   6:         SortedMap m1 = new TreeMap(NULL_AT_END);
   7:         m1.put("a", "a");
   8:         ...
   9: 
  10:         SortedMap m2 = new TreeMap(m1);
  11: 
  12:         ...
  13:         System.out.println(m1.lastKey());

View Full Code Here
   1: 
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5: {
   6:     private final SortedMap mLines = new TreeMap();
   7: 
   8:         ...
   9:     {
  10:         return ((Integer) mLines.lastKey()).intValue();
  11:     }

View Full Code Here
   1: import java.util.Set;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:         if( tmp == null )
   6:             SortedMap headMap = namespacePerms.headMap(key);
   7:             try
   8:         ...
   9:             {
  10:                 PermissionName lastKey = (PermissionName) headMap.lastKey();
  11:                 if( lastKey.isParent(key) == true )

View Full Code Here
   1: import java.util.Set;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:         if( tmp == null )
   6:             SortedMap headMap = namespacePerms.headMap(key);
   7:             try
   8:         ...
   9:             {
  10:                 PermissionName lastKey = (PermissionName) headMap.lastKey();
  11:                 if( lastKey.isParent(key) == true )

View Full Code Here
   1: import java.util.Random;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:     protected int capacity;
   6:     protected SortedMap cache = new TreeMap ();
   7:     protected Node first, last;
   8:         ...
   9: 
  10:         SortedMap hm = cache.headMap (guid);
  11:         SortedMap tm = null;
  12:         ...
  13:                 
  14:             BigInteger largest_key = (BigInteger) cache.lastKey();

View Full Code Here

subMap

public SortedMap subMap(K fromKey,
                             K toKey)
Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned sorted map is empty.) The returned sorted map is backed by this sorted map, so changes in the returned sorted map are reflected in this sorted map, and vice-versa. The returned Map supports all optional map operations that this sorted map supports.

The map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key outside the specified range.

Note: this method always returns a half-open range (which includes its low endpoint but not its high endpoint). If you need a closed range (which includes both endpoints), and the key type allows for calculation of the successor a given key, merely request the subrange from lowEndpoint to successor(highEndpoint). For example, suppose that m is a map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, inclusive:

    Map sub = m.subMap(low, high+"\0");
A similarly technique can be used to generate an open range (which contains neither endpoint). The following idiom obtains a view containing all of the key-value mappings in m whose keys are between low and high, exclusive:
    Map sub = m.subMap(low+"\0", high);
Parameters:
fromKey - low endpoint (inclusive) of the subMap.
toKey - high endpoint (exclusive) of the subMap.
Returns:
a view of the specified range within this sorted map.
Throws:
ClassCastException - if fromKey and toKey cannot be compared to one another using this map's comparator (or, if the map has no comparator, using natural ordering). Implementations may, but are not required to, throw this exception if fromKey or toKey cannot be compared to keys currently in the map.
IllegalArgumentException - if fromKey is greater than toKey; or if this map is itself a subMap, headMap, or tailMap, and fromKey or toKey are not within the specified range of the subMap, headMap, or tailMap.
NullPointerException - if fromKey or toKey is null and this sorted map does not tolerate null keys.
Usages and Demos :

View More Examples of subMap(K fromKey,K toKey)
   1: import java.util.Map;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:     
   6:     protected SortedMap decorateMap(SortedMap map, Factory factory) {
   7:         return LazySortedMap.decorate(map, factory);
   8:         ...
   9:         assertEquals("Last key in submap should be B",
  10:            map.subMap("A","C").lastKey(), "B");
  11:         

View Full Code Here
   1: import java.util.LinkedList;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:   private final Channel assignedWuQueue = new LinkedQueue();
   6:   private final SortedMap keyedTree =
   7:       Collections.synchronizedSortedMap(new TreeMap());
   8:         ...
   9:     List listToReturned = new LinkedList();
  10:     SortedMap subMap = null;
  11:     synchronized (keyedTree) {
  12:         ...
  13:                 lastAva.getAttr(), lastAva.getValue() + 1);
  14:         subMap = keyedTree.subMap(parentCtx, toKey);

View Full Code Here
   1: import java.util.Iterator;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:       LogUtil.getLogger(DispatchedWorkUnitTable.class);
   6:   private final SortedMap keyedTree =
   7:       Collections.synchronizedSortedMap(new TreeMap());
   8:         ...
   9:   public synchronized void removeRecords(WorkUnitContext parentCtx) {
  10:     SortedMap subMap = null;
  11:     synchronized (keyedTree) {
  12:         ...
  13:                 lastAva.getAttr(), lastAva.getValue() + 1);
  14:         subMap = keyedTree.subMap(parentCtx, toKey);

View Full Code Here
   1: import java.util.Set;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5: 
   6:     private SortedMap mySearchKey2dependency = new TreeMap();
   7: 
   8:         ...
   9:         SearchKey toKey = new RangeSearchToKey(task);
  10:         SortedMap submap = mySearchKey2dependency.subMap(fromKey, toKey);
  11:         return (TaskDependency[]) submap.values()
  12:         ...
  13:                 .getTaskID(), -1);
  14:         SortedMap submap = mySearchKey2dependency.subMap(fromKey, toKey);

View Full Code Here
   1: 
   2:   protected SortedMap normal = new RedBlackMap();
   3: 
   4:         ...
   5:   protected SortedMap reverse = new RedBlackMap();
   6: 
   7:         ...
   8:   protected SortedMap nulls = new RedBlackMap();
   9: 
  10:         ...
  11:   public SortedMap keySubMap(Object start, Object end) {
  12:     return normal.subMap(start, end);

View Full Code Here

super K> comparator

public Comparatorsuper K> comparator()
Returns the comparator associated with this sorted map, or null if it uses its keys' natural ordering.
Returns:
the comparator associated with this sorted map, or null if it uses its keys' natural ordering.

tailMap

public SortedMap tailMap(K fromKey)
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey. The returned sorted map is backed by this sorted map, so changes in the returned sorted map are reflected in this sorted map, and vice-versa. The returned map supports all optional map operations that this sorted map supports.

The map returned by this method will throw an IllegalArgumentException if the user attempts to insert a key outside the specified range.

Note: this method always returns a view that contains its (low) endpoint. If you need a view that does not contain this endpoint, and the element type allows for calculation of the successor a given value, merely request a tailMap bounded by successor(lowEndpoint). For example, suppose that suppose that m is a map whose keys are strings. The following idiom obtains a view containing all of the key-value mappings in m whose keys are strictly greater than low:

    Map tail = m.tailMap(low+"\0");
Parameters:
fromKey - low endpoint (inclusive) of the tailMap.
Returns:
a view of the specified final range of this sorted map.
Throws:
ClassCastException - if fromKey is not compatible with this map's comparator (or, if the map has no comparator, if fromKey does not implement Comparable). Implementations may, but are not required to, throw this exception if fromKey cannot be compared to keys currently in the map.
IllegalArgumentException - if this map is itself a subMap, headMap, or tailMap, and fromKey is not within the specified range of the subMap, headMap, or tailMap.
NullPointerException - if fromKey is null and this sorted map does not tolerate null keys.
Usages and Demos :

View More Examples of tailMap(K fromKey)
   1:       Iterator symbols = nOrderSymbols.iterator();
   2:       SortedMap tree = new TreeMap();
   3:       while(symbols.hasNext()){
   4:         ...
   5: 
   6:       SortedMap sig = tree.tailMap(threshold);
   7:       Set keys = sig.keySet();
   8:       System.out.println("threshold = " + threshold.doubleValue());
   9:       System.out.println("\nNMER\tWEIGHT");

View Full Code Here
   1: import java.util.Map;
   2: import java.util.SortedMap;
   3: import java.util.TreeMap;
   4:         ...
   5:     
   6:     protected SortedMap decorateMap(SortedMap map, Factory factory) {
   7:         return LazySortedMap.decorate(map, factory);
   8:         ...
   9:         assertEquals("First key in tail map should be B", 
  10:             map.tailMap("B").firstKey(), "B");
  11:         assertEquals("Last key in head map should be B", 

View Full Code Here
   1: import java.util.TreeMap;
   2: import java.util.SortedMap;
   3: import java.util.HashMap;
   4:         ...
   5: {
   6:     protected SortedMap map = null;
   7:     protected String key;
   8:         ...
   9: 
  10:     public CategoryIterator(SortedMap map, String key)
  11:     {
  12:         ...
  13:         else
  14:             this.map = map.tailMap(key);

View Full Code Here
   1: 
   2:   Iterator get(SortedMap m, Statement st) throws ModelException {
   3: 
   4:         ...
   5: 
   6:     public PrefixIterator(Statement st, SortedMap m) throws ModelException {
   7: 
   8:         ...
   9:     maxIt = 1;
  10:     this.it = m.tailMap(st).values().iterator();
  11:       } else {

View Full Code Here
   1: 
   2:   protected SortedMap normal = new RedBlackMap();
   3: 
   4:         ...
   5:   protected SortedMap reverse = new RedBlackMap();
   6: 
   7:         ...
   8:   protected SortedMap nulls = new RedBlackMap();
   9: 
  10:         ...
  11:   public SortedMap keyTailMap(Object value) {
  12:     return normal.tailMap(value);

View Full Code Here