AbstractBidiMapDecorator.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.apache.commons.collections4.bidimap;

  18. import java.util.Set;

  19. import org.apache.commons.collections4.BidiMap;
  20. import org.apache.commons.collections4.MapIterator;
  21. import org.apache.commons.collections4.map.AbstractMapDecorator;

  22. /**
  23.  * Provides a base decorator that enables additional functionality to be added
  24.  * to a BidiMap via decoration.
  25.  * <p>
  26.  * Methods are forwarded directly to the decorated map.
  27.  * </p>
  28.  * <p>
  29.  * This implementation does not perform any special processing with the map views.
  30.  * Instead it simply returns the set/collection from the wrapped map. This may be
  31.  * undesirable, for example if you are trying to write a validating implementation
  32.  * it would provide a loophole around the validation.
  33.  * But, you might want that loophole, so this class is kept simple.
  34.  * </p>
  35.  *
  36.  * @param <K> the type of the keys in this map
  37.  * @param <V> the type of the values in this map
  38.  * @since 3.0
  39.  */
  40. public abstract class AbstractBidiMapDecorator<K, V>
  41.         extends AbstractMapDecorator<K, V> implements BidiMap<K, V> {

  42.     /**
  43.      * Constructor that wraps (not copies).
  44.      *
  45.      * @param map  the map to decorate, must not be null
  46.      * @throws NullPointerException if the collection is null
  47.      */
  48.     protected AbstractBidiMapDecorator(final BidiMap<K, V> map) {
  49.         super(map);
  50.     }

  51.     /**
  52.      * Gets the map being decorated.
  53.      *
  54.      * @return the decorated map
  55.      */
  56.     @Override
  57.     protected BidiMap<K, V> decorated() {
  58.         return (BidiMap<K, V>) super.decorated();
  59.     }

  60.     @Override
  61.     public K getKey(final Object value) {
  62.         return decorated().getKey(value);
  63.     }

  64.     @Override
  65.     public BidiMap<V, K> inverseBidiMap() {
  66.         return decorated().inverseBidiMap();
  67.     }

  68.     @Override
  69.     public MapIterator<K, V> mapIterator() {
  70.         return decorated().mapIterator();
  71.     }

  72.     @Override
  73.     public K removeValue(final Object value) {
  74.         return decorated().removeValue(value);
  75.     }

  76.     @Override
  77.     public Set<V> values() {
  78.         return decorated().values();
  79.     }

  80. }