org.apache.commons.collections.map

Class LazySortedMap

Implemented Interfaces:
Map, Serializable, SortedMap

public class LazySortedMap
extends LazyMap
implements SortedMap

Decorates another SortedMap to create objects in the map on demand.

When the 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.

For instance:

 Factory factory = new Factory() {
     public Object create() {
         return new Date();
     }
 }
 SortedMap lazy = Lazy.sortedMap(new HashMap(), factory);
 Object obj = lazy.get("NOW");
 
After the above code is executed, obj will contain a new Date instance. Furthermore, that Date instance is mapped to the "NOW" key in the map.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.6 $ $Date: 2004/04/09 10:36:01 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

Field Summary

Fields inherited from class org.apache.commons.collections.map.LazyMap

factory

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

map

Constructor Summary

LazySortedMap(SortedMap map, Factory factory)
Constructor that wraps (not copies).
LazySortedMap(SortedMap map, Transformer factory)
Constructor that wraps (not copies).

Method Summary

Comparator
comparator()
static SortedMap
decorate(SortedMap map, Factory factory)
Factory method to create a lazily instantiated sorted map.
static SortedMap
decorate(SortedMap map, Transformer factory)
Factory method to create a lazily instantiated sorted map.
Object
firstKey()
protected SortedMap
getSortedMap()
Gets the map being decorated.
SortedMap
headMap(Object toKey)
Object
lastKey()
SortedMap
subMap(Object fromKey, Object toKey)
SortedMap
tailMap(Object fromKey)

Methods inherited from class org.apache.commons.collections.map.LazyMap

decorate, decorate, get

Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Constructor Details

LazySortedMap

protected LazySortedMap(SortedMap map,
                        Factory factory)
Constructor that wraps (not copies).
Parameters:
map - the map to decorate, must not be null
factory - the factory to use, must not be null

LazySortedMap

protected LazySortedMap(SortedMap map,
                        Transformer factory)
Constructor that wraps (not copies).
Parameters:
map - the map to decorate, must not be null
factory - the factory to use, must not be null

Method Details

comparator

public Comparator comparator()

decorate

public static SortedMap decorate(SortedMap map,
                                 Factory factory)
Factory method to create a lazily instantiated sorted map.
Parameters:
map - the map to decorate, must not be null
factory - the factory to use, must not be null

decorate

public static SortedMap decorate(SortedMap map,
                                 Transformer factory)
Factory method to create a lazily instantiated sorted map.
Parameters:
map - the map to decorate, must not be null
factory - the factory to use, must not be null

firstKey

public Object firstKey()

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.
Returns:
the decorated map

headMap

public SortedMap headMap(Object toKey)

lastKey

public Object lastKey()

subMap

public SortedMap subMap(Object fromKey,
                        Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.