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.collections.bidimap;
18
19 import org.apache.commons.collections.OrderedBidiMap;
20 import org.apache.commons.collections.OrderedMapIterator;
21
22 /**
23 * Provides a base decorator that enables additional functionality to be added
24 * to an OrderedBidiMap via decoration.
25 * <p>
26 * Methods are forwarded directly to the decorated map.
27 * <p>
28 * This implementation does not perform any special processing with the map views.
29 * Instead it simply returns the inverse from the wrapped map. This may be
30 * undesirable, for example if you are trying to write a validating implementation
31 * it would provide a loophole around the validation.
32 * But, you might want that loophole, so this class is kept simple.
33 *
34 * @since 3.0
35 * @version $Id: AbstractOrderedBidiMapDecorator.java 1429905 2013-01-07 17:15:14Z ggregory $
36 */
37 public abstract class AbstractOrderedBidiMapDecorator<K, V>
38 extends AbstractBidiMapDecorator<K, V>
39 implements OrderedBidiMap<K, V> {
40
41 /**
42 * Constructor that wraps (not copies).
43 *
44 * @param map the map to decorate, must not be null
45 * @throws IllegalArgumentException if the collection is null
46 */
47 protected AbstractOrderedBidiMapDecorator(final OrderedBidiMap<K, V> map) {
48 super(map);
49 }
50
51 /**
52 * Gets the map being decorated.
53 *
54 * @return the decorated map
55 */
56 @Override
57 protected OrderedBidiMap<K, V> decorated() {
58 return (OrderedBidiMap<K, V>) super.decorated();
59 }
60
61 //-----------------------------------------------------------------------
62 @Override
63 public OrderedMapIterator<K, V> mapIterator() {
64 return decorated().mapIterator();
65 }
66
67 public K firstKey() {
68 return decorated().firstKey();
69 }
70
71 public K lastKey() {
72 return decorated().lastKey();
73 }
74
75 public K nextKey(final K key) {
76 return decorated().nextKey(key);
77 }
78
79 public K previousKey(final K key) {
80 return decorated().previousKey(key);
81 }
82
83 @Override
84 public OrderedBidiMap<V, K> inverseBidiMap() {
85 return decorated().inverseBidiMap();
86 }
87
88 }