org.apache.commons.collections4.bidimap

## Class DualTreeBidiMap.ViewMap<K,V>

- java.lang.Object
- - org.apache.commons.collections4.map.AbstractIterableMap<K,V>
  - - org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
    - - org.apache.commons.collections4.map.AbstractSortedMapDecorator<K,V>
      - - org.apache.commons.collections4.bidimap.DualTreeBidiMap.ViewMap<K,V>

- All Implemented Interfaces:
    Map<K,V>, SortedMap<K,V>, Get<K,V>, IterableGet<K,V>, IterableMap<K,V>, IterableSortedMap<K,V>, OrderedMap<K,V>, Put<K,V>
  Enclosing class:
    DualTreeBidiMap<K,V>

      protected static class DualTreeBidiMap.ViewMap<K,V>
      extends AbstractSortedMapDecorator<K,V>

  Internal sorted map view.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator

      `AbstractSortedMapDecorator.SortedMapIterator<K,V>`

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

      `Map.Entry<K,V>`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `DualTreeBidiMap.ViewMap(DualTreeBidiMap<K,V> bidi, SortedMap<K,V> sm)` Constructor.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `clear()`
    `boolean` | `containsValue(Object value)`
    `protected DualTreeBidiMap<K,V>` | `decorated()` Gets the map being decorated.
    `SortedMap<K,V>` | `headMap(K toKey)`
    `K` | `nextKey(K key)` Gets the next key after the one specified.
    `K` | `previousKey(K key)` Gets the previous key before the one specified.
    `SortedMap<K,V>` | `subMap(K fromKey, K toKey)`
    `SortedMap<K,V>` | `tailMap(K fromKey)`

    - ### Methods inherited from class org.apache.commons.collections4.map.AbstractSortedMapDecorator

      `comparator, firstKey, lastKey, mapIterator`

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

      `containsKey, entrySet, equals, get, 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

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

    - ### Methods inherited from interface org.apache.commons.collections4.Put

      `put, putAll`

    - ### Methods inherited from interface org.apache.commons.collections4.Get

      `containsKey, entrySet, get, isEmpty, keySet, remove, size, values`

- - ### Constructor Detail

    - #### DualTreeBidiMap.ViewMap

          protected DualTreeBidiMap.ViewMap(DualTreeBidiMap<K,V> bidi,
                                 SortedMap<K,V> sm)

      Constructor.
      Parameters:
        `bidi` - the parent bidi map
        `sm` - the subMap sorted map

  - ### Method Detail

    - #### containsValue

          public boolean containsValue(Object value)

      Specified by:
        `containsValue` in interface `Map<K,V>`
      Specified by:
        `containsValue` in interface `Get<K,V>`
      Overrides:
        `containsValue` in class `AbstractMapDecorator<K,V>`
      See Also:
        `Map.containsValue(Object)`

    - #### clear

          public void clear()

      Specified by:
        `clear` in interface `Map<K,V>`
      Specified by:
        `clear` in interface `Put<K,V>`
      Overrides:
        `clear` in class `AbstractMapDecorator<K,V>`
      See Also:
        `Map.clear()`

    - #### headMap

          public SortedMap<K,V> headMap(K toKey)

      Specified by:
        `headMap` in interface `SortedMap<K,V>`
      Overrides:
        `headMap` in class `AbstractSortedMapDecorator<K,V>`

    - #### tailMap

          public SortedMap<K,V> tailMap(K fromKey)

      Specified by:
        `tailMap` in interface `SortedMap<K,V>`
      Overrides:
        `tailMap` in class `AbstractSortedMapDecorator<K,V>`

    - #### subMap

          public SortedMap<K,V> subMap(K fromKey,
                              K toKey)

      Specified by:
        `subMap` in interface `SortedMap<K,V>`
      Overrides:
        `subMap` in class `AbstractSortedMapDecorator<K,V>`

    - #### decorated

          protected DualTreeBidiMap<K,V> decorated()

      Description copied from class: `AbstractSortedMapDecorator`
      Gets the map being decorated.
      Overrides:
        `decorated` in class `AbstractSortedMapDecorator<K,V>`
      Returns:
        the decorated map

    - #### previousKey

          public K previousKey(K key)

      Description copied from interface: `OrderedMap`
      Gets the previous key before the one specified.
      Specified by:
        `previousKey` in interface `OrderedMap<K,V>`
      Overrides:
        `previousKey` in class `AbstractSortedMapDecorator<K,V>`
      Parameters:
        `key` - the key to search for previous from
      Returns:
        the previous key, null if no match or at start

    - #### nextKey

          public K nextKey(K key)

      Description copied from interface: `OrderedMap`
      Gets the next key after the one specified.
      Specified by:
        `nextKey` in interface `OrderedMap<K,V>`
      Overrides:
        `nextKey` in class `AbstractSortedMapDecorator<K,V>`
      Parameters:
        `key` - the key to search for next from
      Returns:
        the next key, null if no match or at end

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