001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4.bidimap;
018
019import java.util.Set;
020
021import org.apache.commons.collections4.BidiMap;
022import org.apache.commons.collections4.MapIterator;
023import org.apache.commons.collections4.map.AbstractMapDecorator;
024
025/**
026 * Provides a base decorator that enables additional functionality to be added
027 * to a BidiMap via decoration.
028 * <p>
029 * Methods are forwarded directly to the decorated map.
030 * <p>
031 * This implementation does not perform any special processing with the map views.
032 * Instead it simply returns the set/collection from the wrapped map. This may be
033 * undesirable, for example if you are trying to write a validating implementation
034 * it would provide a loophole around the validation.
035 * But, you might want that loophole, so this class is kept simple.
036 *
037 * @since 3.0
038 * @version $Id: AbstractBidiMapDecorator.html 972421 2015-11-14 20:00:04Z tn $
039 */
040public abstract class AbstractBidiMapDecorator<K, V>
041        extends AbstractMapDecorator<K, V> implements BidiMap<K, V> {
042
043    /**
044     * Constructor that wraps (not copies).
045     *
046     * @param map  the map to decorate, must not be null
047     * @throws IllegalArgumentException if the collection is null
048     */
049    protected AbstractBidiMapDecorator(final BidiMap<K, V> map) {
050        super(map);
051    }
052
053    /**
054     * Gets the map being decorated.
055     *
056     * @return the decorated map
057     */
058    @Override
059    protected BidiMap<K, V> decorated() {
060        return (BidiMap<K, V>) super.decorated();
061    }
062
063    //-----------------------------------------------------------------------
064    @Override
065    public MapIterator<K, V> mapIterator() {
066        return decorated().mapIterator();
067    }
068
069    public K getKey(final Object value) {
070        return decorated().getKey(value);
071    }
072
073    public K removeValue(final Object value) {
074        return decorated().removeValue(value);
075    }
076
077    public BidiMap<V, K> inverseBidiMap() {
078        return decorated().inverseBidiMap();
079    }
080
081    @Override
082    public Set<V> values() {
083        return decorated().values();
084    }
085
086}