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.map; 018 019import org.apache.commons.collections4.OrderedMap; 020import org.apache.commons.collections4.OrderedMapIterator; 021 022/** 023 * Provides a base decorator that enables additional functionality to be added 024 * to an OrderedMap 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 set/collection 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 3.0 035 * @version $Id: AbstractOrderedMapDecorator.html 972421 2015-11-14 20:00:04Z tn $ 036 */ 037public abstract class AbstractOrderedMapDecorator<K, V> extends AbstractMapDecorator<K, V> 038 implements OrderedMap<K, V> { 039 040 /** 041 * Constructor only used in deserialization, do not use otherwise. 042 * @since 3.1 043 */ 044 protected AbstractOrderedMapDecorator() { 045 super(); 046 } 047 048 /** 049 * Constructor that wraps (not copies). 050 * 051 * @param map the map to decorate, must not be null 052 * @throws IllegalArgumentException if the collection is null 053 */ 054 public AbstractOrderedMapDecorator(final OrderedMap<K, V> map) { 055 super(map); 056 } 057 058 /** 059 * Gets the map being decorated. 060 * 061 * @return the decorated map 062 */ 063 @Override 064 protected OrderedMap<K, V> decorated() { 065 return (OrderedMap<K, V>) super.decorated(); 066 } 067 068 //----------------------------------------------------------------------- 069 public K firstKey() { 070 return decorated().firstKey(); 071 } 072 073 public K lastKey() { 074 return decorated().lastKey(); 075 } 076 077 public K nextKey(final K key) { 078 return decorated().nextKey(key); 079 } 080 081 public K previousKey(final K key) { 082 return decorated().previousKey(key); 083 } 084 085 @Override 086 public OrderedMapIterator<K, V> mapIterator() { 087 return decorated().mapIterator(); 088 } 089 090}