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
19 import java.util.Comparator;
20 import java.util.SortedMap;
21
22 import org.apache.commons.collections4.SortedBidiMap;
23
24 /**
25 * Provides a base decorator that enables additional functionality to be added
26 * to a SortedBidiMap via decoration.
27 * <p>
28 * Methods are forwarded directly to the decorated map.
29 * </p>
30 * <p>
31 * This implementation does not perform any special processing with the map views.
32 * Instead it simply returns the inverse from the wrapped map. This may be
33 * undesirable, for example if you are trying to write a validating implementation
34 * it would provide a loophole around the validation.
35 * But, you might want that loophole, so this class is kept simple.
36 * </p>
37 *
38 * @param <K> the type of the keys in this map
39 * @param <V> the type of the values in this map
40 * @since 3.0
41 */
42 public abstract class AbstractSortedBidiMapDecorator<K, V>
43 extends AbstractOrderedBidiMapDecorator<K, V> implements SortedBidiMap<K, V> {
44
45 /**
46 * Constructor that wraps (not copies).
47 *
48 * @param map the map to decorate, must not be null
49 * @throws NullPointerException if the collection is null
50 */
51 public AbstractSortedBidiMapDecorator(final SortedBidiMap<K, V> map) {
52 super(map);
53 }
54
55 @Override
56 public Comparator<? super K> comparator() {
57 return decorated().comparator();
58 }
59
60 /**
61 * Gets the map being decorated.
62 *
63 * @return the decorated map
64 */
65 @Override
66 protected SortedBidiMap<K, V> decorated() {
67 return (SortedBidiMap<K, V>) super.decorated();
68 }
69
70 @Override
71 public SortedMap<K, V> headMap(final K toKey) {
72 return decorated().headMap(toKey);
73 }
74
75 @Override
76 public SortedBidiMap<V, K> inverseBidiMap() {
77 return decorated().inverseBidiMap();
78 }
79
80 @Override
81 public SortedMap<K, V> subMap(final K fromKey, final K toKey) {
82 return decorated().subMap(fromKey, toKey);
83 }
84
85 @Override
86 public SortedMap<K, V> tailMap(final K fromKey) {
87 return decorated().tailMap(fromKey);
88 }
89
90 @Override
91 public Comparator<? super V> valueComparator() {
92 return decorated().valueComparator();
93 }
94
95 }