Class TreeMap<K,V>

  • All Implemented Interfaces:
    Map<K,V>


    public class TreeMap<K,V>
    extends AbstractSortedMap<K,V>
    An implementation of a sorted map using a binary search tree. TODO: Finish implementation
    • Constructor Summary

      Constructors 
      Constructor and Description
      TreeMap()
      Constructs an empty map using the natural ordering of keys.
      TreeMap(java.util.Comparator<K> comp)
      Constructs an empty map using the given comparator to order keys.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.Iterable<Entry<K,V>> entrySet()
      Returns an iterable collection of all key-value entries of the map.
      V get(K key)
      Returns the value associated with the specified key, or null if no such entry exists.
      V put(K key, V value)
      Associates the given value with the given key.
      V remove(K key)
      Removes the entry with the specified key, if present, and returns its associated value.
      int size()
      Returns the number of entries in the map.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TreeMap

        public TreeMap()
        Constructs an empty map using the natural ordering of keys.
      • TreeMap

        public TreeMap(java.util.Comparator<K> comp)
        Constructs an empty map using the given comparator to order keys.
        Parameters:
        comp - comparator defining the order of keys in the map
    • Method Detail

      • size

        public int size()
        Returns the number of entries in the map.
        Returns:
        number of entries in the map
      • get

        public V get(K key)
              throws java.lang.IllegalArgumentException
        Returns the value associated with the specified key, or null if no such entry exists.
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the associated value, or null if no such entry exists
        Throws:
        java.lang.IllegalArgumentException
      • put

        public V put(K key,
                     V value)
              throws java.lang.IllegalArgumentException
        Associates the given value with the given key. If an entry with the key was already in the map, this replaced the previous value with the new one and returns the old value. Otherwise, a new entry is added and null is returned.
        Parameters:
        key - key with which the specified value is to be associated
        value - value to be associated with the specified key
        Returns:
        the previous value associated with the key (or null, if no such entry)
        Throws:
        java.lang.IllegalArgumentException
      • remove

        public V remove(K key)
                 throws java.lang.IllegalArgumentException
        Removes the entry with the specified key, if present, and returns its associated value. Otherwise does nothing and returns null.
        Parameters:
        key - the key whose entry is to be removed from the map
        Returns:
        the previous value associated with the removed key, or null if no such entry exists
        Throws:
        java.lang.IllegalArgumentException
      • entrySet

        public java.lang.Iterable<Entry<K,V>> entrySet()
        Returns an iterable collection of all key-value entries of the map.
        Returns:
        iterable collection of the map's entries