/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.collections4.map;

import org.apache.commons.collections4.OrderedMap;
import org.apache.commons.collections4.OrderedMapIterator;

Provides a base decorator that enables additional functionality to be added
to an OrderedMap via decoration.

Methods are forwarded directly to the decorated map.


This implementation does not perform any special processing with the map views.
Instead it simply returns the set/collection from the wrapped map. This may be
undesirable, for example if you are trying to write a validating implementation
it would provide a loophole around the validation.
But, you might want that loophole, so this class is kept simple.

Type parameters:
<K> – the type of the keys in this map
<V> – the type of the values in this map
Since:
3.0/**
 * Provides a base decorator that enables additional functionality to be added
 * to an OrderedMap via decoration.
 * <p>
 * Methods are forwarded directly to the decorated map.
 * </p>
 * <p>
 * This implementation does not perform any special processing with the map views.
 * Instead it simply returns the set/collection from the wrapped map. This may be
 * undesirable, for example if you are trying to write a validating implementation
 * it would provide a loophole around the validation.
 * But, you might want that loophole, so this class is kept simple.
 * </p>
 *
 * @param <K> the type of the keys in this map
 * @param <V> the type of the values in this map
 * @since 3.0
 */
public abstract class AbstractOrderedMapDecorator<K, V> extends AbstractMapDecorator<K, V>
        implements OrderedMap<K, V> {

    
Constructor only used in deserialization, do not use otherwise.
Since:
3.1/**
     * Constructor only used in deserialization, do not use otherwise.
     * @since 3.1
     */
    protected AbstractOrderedMapDecorator() {
        super();
    }

    
Constructor that wraps (not copies).
Params:
map –  the map to decorate, must not be null
Throws:
NullPointerException – if the map is null/**
     * Constructor that wraps (not copies).
     *
     * @param map  the map to decorate, must not be null
     * @throws NullPointerException if the map is null
     */
    public AbstractOrderedMapDecorator(final OrderedMap<K, V> map) {
        super(map);
    }

    
Gets the map being decorated.
Returns:
the decorated map/**
     * Gets the map being decorated.
     *
     * @return the decorated map
     */
    @Override
    protected OrderedMap<K, V> decorated() {
        return (OrderedMap<K, V>) super.decorated();
    }

    //-----------------------------------------------------------------------
    @Override
    public K firstKey() {
        return decorated().firstKey();
    }

    @Override
    public K lastKey() {
        return decorated().lastKey();
    }

    @Override
    public K nextKey(final K key) {
        return decorated().nextKey(key);
    }

    @Override
    public K previousKey(final K key) {
        return decorated().previousKey(key);
    }

    @Override
    public OrderedMapIterator<K, V> mapIterator() {
        return decorated().mapIterator();
    }

}