org.apache.commons.collections4.bidimap

## Class AbstractDualBidiMap.View<K,V,E>

- java.lang.Object
- - org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
  - - org.apache.commons.collections4.bidimap.AbstractDualBidiMap.View<K,V,E>

- All Implemented Interfaces:
    Serializable, Iterable<E>, Collection<E>
  Direct Known Subclasses:
    AbstractDualBidiMap.EntrySet, AbstractDualBidiMap.KeySet, AbstractDualBidiMap.Values
  Enclosing class:
    AbstractDualBidiMap<K,V>

      protected abstract static class AbstractDualBidiMap.View<K,V,E>
      extends AbstractCollectionDecorator<E>

  Inner class View.
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected AbstractDualBidiMap<K,V>` | `parent` The parent map

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `AbstractDualBidiMap.View(Collection<E> coll, AbstractDualBidiMap<K,V> parent)` Constructs a new view of the BidiMap.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `clear()`
    `boolean` | `equals(Object object)`
    `int` | `hashCode()`
    `boolean` | `removeAll(Collection<?> coll)`
    `boolean` | `retainAll(Collection<?> coll)`

    - ### Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

      `add, addAll, contains, containsAll, decorated, isEmpty, iterator, remove, setCollection, size, toArray, toArray, toString`

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

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

- - ### Field Detail

    - #### parent

          protected final AbstractDualBidiMap<K,V> parent

      The parent map

  - ### Constructor Detail

    - #### AbstractDualBidiMap.View

          protected AbstractDualBidiMap.View(Collection<E> coll,
                                  AbstractDualBidiMap<K,V> parent)

      Constructs a new view of the BidiMap.
      Parameters:
        `coll` - the collection view being decorated
        `parent` - the parent BidiMap

  - ### Method Detail

    - #### equals

          public boolean equals(Object object)

      Specified by:
        `equals` in interface `Collection<E>`
      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Specified by:
        `hashCode` in interface `Collection<E>`
      Overrides:
        `hashCode` in class `Object`

    - #### removeAll

          public boolean removeAll(Collection<?> coll)

      Specified by:
        `removeAll` in interface `Collection<E>`
      Overrides:
        `removeAll` in class `AbstractCollectionDecorator<E>`

    - #### retainAll

          public boolean retainAll(Collection<?> coll)

      This implementation iterates over the elements of this bidi map, checking each element in turn to see if it's contained in `coll`. If it's not contained, it's removed from this bidi map. As a consequence, it is advised to use a collection type for `coll` that provides a fast (e.g. O(1)) implementation of `Collection.contains(Object)`.

      Specified by:
        `retainAll` in interface `Collection<E>`
      Overrides:
        `retainAll` in class `AbstractCollectionDecorator<E>`

    - #### clear

          public void clear()

      Specified by:
        `clear` in interface `Collection<E>`
      Overrides:
        `clear` in class `AbstractCollectionDecorator<E>`

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