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     */
017    package org.apache.commons.collections.bidimap;
018    
019    import org.apache.commons.collections.OrderedBidiMap;
020    import org.apache.commons.collections.OrderedMapIterator;
021    
022    /** 
023     * Provides a base decorator that enables additional functionality to be added
024     * to an OrderedBidiMap via decoration.
025     * <p>
026     * Methods are forwarded directly to the decorated map.
027     * <p>
028     * This implementation does not perform any special processing with the map views.
029     * Instead it simply returns the inverse from the wrapped map. This may be
030     * undesirable, for example if you are trying to write a validating implementation
031     * it would provide a loophole around the validation.
032     * But, you might want that loophole, so this class is kept simple.
033     *
034     * @since Commons Collections 3.0
035     * @version $Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $
036     * 
037     * @author Stephen Colebourne
038     */
039    public abstract class AbstractOrderedBidiMapDecorator
040            extends AbstractBidiMapDecorator implements OrderedBidiMap {
041        
042        /**
043         * Constructor that wraps (not copies).
044         *
045         * @param map  the map to decorate, must not be null
046         * @throws IllegalArgumentException if the collection is null
047         */
048        protected AbstractOrderedBidiMapDecorator(OrderedBidiMap map) {
049            super(map);
050        }
051    
052        /**
053         * Gets the map being decorated.
054         * 
055         * @return the decorated map
056         */
057        protected OrderedBidiMap getOrderedBidiMap() {
058            return (OrderedBidiMap) map;
059        }
060    
061        //-----------------------------------------------------------------------
062        public OrderedMapIterator orderedMapIterator() {
063            return getOrderedBidiMap().orderedMapIterator();
064        }
065    
066        public Object firstKey() {
067            return getOrderedBidiMap().firstKey();
068        }
069    
070        public Object lastKey() {
071            return getOrderedBidiMap().lastKey();
072        }
073    
074        public Object nextKey(Object key) {
075            return getOrderedBidiMap().nextKey(key);
076        }
077    
078        public Object previousKey(Object key) {
079            return getOrderedBidiMap().previousKey(key);
080        }
081    
082        public OrderedBidiMap inverseOrderedBidiMap() {
083            return getOrderedBidiMap().inverseOrderedBidiMap();
084        }
085    
086    }