org.apache.commons.collections15.map.LazySortedMap.java Source code

Introduction

Here is the source code for org.apache.commons.collections15.map.LazySortedMap.java

Source

// GenericsNote: Converted.
/*
 *  Copyright 2003-2004 The Apache Software Foundation
 *
 *  Licensed 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.collections15.map;

import java.util.Comparator;
import java.util.SortedMap;

import org.apache.commons.collections15.Factory;
import org.apache.commons.collections15.Transformer;

/**
 * Decorates another <code>SortedMap</code> to create objects in the map on demand.
 * <p/>
 * When the {@link #get(Object)} method is called with a key that does not
 * exist in the map, the factory is used to create the object. The created
 * object will be added to the map using the requested key.
 * <p/>
 * For instance:
 * <pre>
 * Factory factory = new Factory() {
 *     public Object create() {
 *         return new Date();
 *     }
 * }
 * SortedMap lazy = Lazy.sortedMap(new HashMap(), factory);
 * Object obj = lazy.get("NOW");
 * </pre>
 * <p/>
 * After the above code is executed, <code>obj</code> will contain
 * a new <code>Date</code> instance. Furthermore, that <code>Date</code>
 * instance is mapped to the "NOW" key in the map.
 * <p/>
 * This class is Serializable from Commons Collections 3.1.
 *
 * @author Stephen Colebourne
 * @author Matt Hall, John Watkinson, Paul Jack
 * @version $Revision: 1.1 $ $Date: 2005/10/11 17:05:32 $
 * @since Commons Collections 3.0
 */
public class LazySortedMap<K, V> extends LazyMap<K, V> implements SortedMap<K, V> {

    /**
     * Serialization version
     */
    private static final long serialVersionUID = 2715322183617658933L;

    /**
     * Factory method to create a lazily instantiated sorted map.
     *
     * @param map     the map to decorate, must not be null
     * @param factory the factory to use, must not be null
     * @throws IllegalArgumentException if map or factory is null
     */
    public static <K, V> SortedMap<K, V> decorate(SortedMap<K, V> map, Factory<V> factory) {
        return new LazySortedMap<K, V>(map, factory);
    }

    /**
     * Factory method to create a lazily instantiated sorted map.
     *
     * @param map           Map to decorate, must not be null
     * @param transformer   Transformer to use, must not be null
     * @throws IllegalArgumentException if map or transformer is null
     */
    public static <K, V> SortedMap<K, V> decorate(SortedMap<K, V> map, Transformer<K, V> transformer) {
        return new LazySortedMap<K, V>(map, transformer);
    }

    //-----------------------------------------------------------------------
    /**
     * Constructor that wraps (not copies).
     *
     * @param map     the map to decorate, must not be null
     * @param factory the factory to use, must not be null
     * @throws IllegalArgumentException if map or factory is null
     */
    protected LazySortedMap(SortedMap<K, V> map, Factory<V> factory) {
        super(map, factory);
    }

    /**
     * Constructor that wraps (not copies).
     *
     * @param map           Map to decorate, must not be null
     * @param transformer   Transformer to use, must not be null
     * @throws IllegalArgumentException if map or transformer is null
     */
    protected LazySortedMap(SortedMap<K, V> map, Transformer<K, V> transformer) {
        super(map, transformer);
    }

    //-----------------------------------------------------------------------
    /**
     * Gets the map being decorated.
     *
     * @return the decorated map
     */
    protected SortedMap<K, V> getSortedMap() {
        return (SortedMap<K, V>) map;
    }

    //-----------------------------------------------------------------------
    public K firstKey() {
        return getSortedMap().firstKey();
    }

    public K lastKey() {
        return getSortedMap().lastKey();
    }

    public Comparator<? super K> comparator() {
        return getSortedMap().comparator();
    }

    public SortedMap<K, V> subMap(K fromKey, K toKey) {
        SortedMap<K, V> map = getSortedMap().subMap(fromKey, toKey);
        return new LazySortedMap<K, V>(map, transformer);
    }

    public SortedMap<K, V> headMap(K toKey) {
        SortedMap<K, V> map = getSortedMap().headMap(toKey);
        return new LazySortedMap<K, V>(map, transformer);
    }

    public SortedMap<K, V> tailMap(K fromKey) {
        SortedMap<K, V> map = getSortedMap().tailMap(fromKey);
        return new LazySortedMap<K, V>(map, transformer);
    }

}