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 * @since 3.0 037 * @version $Id: AbstractSortedBidiMapDecorator.html 972421 2015-11-14 20:00:04Z tn $ 038 */ 039public abstract class AbstractSortedBidiMapDecorator<K, V> 040 extends AbstractOrderedBidiMapDecorator<K, V> implements SortedBidiMap<K, V> { 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 public AbstractSortedBidiMapDecorator(final SortedBidiMap<K, V> map) { 049 super(map); 050 } 051 052 /** 053 * Gets the map being decorated. 054 * 055 * @return the decorated map 056 */ 057 @Override 058 protected SortedBidiMap<K, V> decorated() { 059 return (SortedBidiMap<K, V>) super.decorated(); 060 } 061 062 //----------------------------------------------------------------------- 063 @Override 064 public SortedBidiMap<V, K> inverseBidiMap() { 065 return decorated().inverseBidiMap(); 066 } 067 068 public Comparator<? super K> comparator() { 069 return decorated().comparator(); 070 } 071 072 public Comparator<? super V> valueComparator() { 073 return decorated().valueComparator(); 074 } 075 076 public SortedMap<K, V> subMap(final K fromKey, final K toKey) { 077 return decorated().subMap(fromKey, toKey); 078 } 079 080 public SortedMap<K, V> headMap(final K toKey) { 081 return decorated().headMap(toKey); 082 } 083 084 public SortedMap<K, V> tailMap(final K fromKey) { 085 return decorated().tailMap(fromKey); 086 } 087 088}