org.apache.commons.collections.map

## Class AbstractSortedMapDecorator

- java.lang.Object
- - org.apache.commons.collections.map.AbstractMapDecorator
  - - org.apache.commons.collections.map.AbstractSortedMapDecorator

- All Implemented Interfaces:
    Map, SortedMap
  Direct Known Subclasses:
    DualTreeBidiMap.ViewMap, FixedSizeSortedMap, UnmodifiableSortedMap

      public abstract class AbstractSortedMapDecorator
      extends AbstractMapDecorator
      implements SortedMap

  Provides a base decorator that enables additional functionality to be added to a Map via decoration.

  Methods are forwarded directly to the decorated map.

  This implementation does not perform any special processing with the map views. Instead it simply returns the set/collection from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.

  Since:
    Commons Collections 3.0
  Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
  Author:
    Stephen Colebourne

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface java.util.Map

      `Map.Entry`

  - ### Field Summary

    - ### Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

      `map`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `AbstractSortedMapDecorator()` Constructor only used in deserialization, do not use otherwise.
    `` | `AbstractSortedMapDecorator(SortedMap map)` Constructor that wraps (not copies).

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Comparator` | `comparator()`
    `Object` | `firstKey()`
    `protected SortedMap` | `getSortedMap()` Gets the map being decorated.
    `SortedMap` | `headMap(Object toKey)`
    `Object` | `lastKey()`
    `SortedMap` | `subMap(Object fromKey, Object toKey)`
    `SortedMap` | `tailMap(Object fromKey)`

    - ### Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

      `clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface java.util.SortedMap

      `entrySet, keySet, values`

    - ### Methods inherited from interface java.util.Map

      `clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size`

- - ### Constructor Detail

    - #### AbstractSortedMapDecorator

          protected AbstractSortedMapDecorator()

      Constructor only used in deserialization, do not use otherwise.
      Since:
        Commons Collections 3.1

    - #### AbstractSortedMapDecorator

          public AbstractSortedMapDecorator(SortedMap map)

      Constructor that wraps (not copies).
      Parameters:
        `map` - the map to decorate, must not be null
      Throws:
        `IllegalArgumentException` - if the collection is null

  - ### Method Detail

    - #### getSortedMap

          protected SortedMap getSortedMap()

      Gets the map being decorated.
      Returns:
        the decorated map

    - #### comparator

          public Comparator comparator()

      Specified by:
        `comparator` in interface `SortedMap`

    - #### firstKey

          public Object firstKey()

      Specified by:
        `firstKey` in interface `SortedMap`

    - #### headMap

          public SortedMap headMap(Object toKey)

      Specified by:
        `headMap` in interface `SortedMap`

    - #### lastKey

          public Object lastKey()

      Specified by:
        `lastKey` in interface `SortedMap`

    - #### subMap

          public SortedMap subMap(Object fromKey,
                         Object toKey)

      Specified by:
        `subMap` in interface `SortedMap`

    - #### tailMap

          public SortedMap tailMap(Object fromKey)

      Specified by:
        `tailMap` in interface `SortedMap`

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.