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.Comparator; 020import java.util.SortedMap; 021 022import org.apache.commons.collections4.SortedBidiMap; 023 024/** 025 * Provides a base decorator that enables additional functionality to be added 026 * to a SortedBidiMap via decoration. 027 * <p> 028 * Methods are forwarded directly to the decorated map. 029 * <p> 030 * This implementation does not perform any special processing with the map views. 031 * Instead it simply returns the inverse from the wrapped map. This may be 032 * undesirable, for example if you are trying to write a validating implementation 033 * it would provide a loophole around the validation. 034 * But, you might want that loophole, so this class is kept simple. 035 * 036 * @param <K> the type of the keys in this map 037 * @param <V> the type of the values in this map 038 * @since 3.0 039 */ 040public abstract class AbstractSortedBidiMapDecorator<K, V> 041 extends AbstractOrderedBidiMapDecorator<K, V> implements SortedBidiMap<K, V> { 042 043 /** 044 * Constructor that wraps (not copies). 045 * 046 * @param map the map to decorate, must not be null 047 * @throws NullPointerException if the collection is null 048 */ 049 public AbstractSortedBidiMapDecorator(final SortedBidiMap<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 SortedBidiMap<K, V> decorated() { 060 return (SortedBidiMap<K, V>) super.decorated(); 061 } 062 063 //----------------------------------------------------------------------- 064 @Override 065 public SortedBidiMap<V, K> inverseBidiMap() { 066 return decorated().inverseBidiMap(); 067 } 068 069 @Override 070 public Comparator<? super K> comparator() { 071 return decorated().comparator(); 072 } 073 074 @Override 075 public Comparator<? super V> valueComparator() { 076 return decorated().valueComparator(); 077 } 078 079 @Override 080 public SortedMap<K, V> subMap(final K fromKey, final K toKey) { 081 return decorated().subMap(fromKey, toKey); 082 } 083 084 @Override 085 public SortedMap<K, V> headMap(final K toKey) { 086 return decorated().headMap(toKey); 087 } 088 089 @Override 090 public SortedMap<K, V> tailMap(final K fromKey) { 091 return decorated().tailMap(fromKey); 092 } 093 094}