gausssoft.collections
Class FilterSortedMap

java.lang.Object
  |
  +--gausssoft.collections.FilterSortedMap
All Implemented Interfaces:
Map, Serializable, SortedMap

public class FilterSortedMap
extends Object
implements Serializable, SortedMap

The FilterSortedMap class contains another SortedMap, which it uses as it's basic source of data, possibly transforming the data along the way or providing additional functionality.

Each method in this implementation calls the method with the same signature in the backing sorted map.

This class can only be serialized if the backing sorted map is serializable.

Author:
Allan Crooks
See Also:
SortedMap, Serialized Form

Inner classes inherited from class java.util.Map
Map.Entry
 
Field Summary
protected  SortedMap root
          The backing sorted set.
 
Constructor Summary
FilterSortedMap(SortedMap root)
          Creates a new FilterSortedMap.
 
Method Summary
 void clear()
           
 Comparator comparator()
           
 boolean containsKey(Object key)
           
 boolean containsValue(Object value)
           
 Set entrySet()
           
 boolean equals(Object o)
           
 Object firstKey()
           
 Object get(Object key)
           
 int hashCode()
           
 SortedMap headMap(Object toKey)
           
 boolean isEmpty()
           
 Set keySet()
           
 Object lastKey()
           
 Object put(Object key, Object value)
           
 void putAll(Map t)
           
 Object remove(Object key)
           
 int size()
           
 SortedMap subMap(Object fromKey, Object toKey)
           
 SortedMap tailMap(Object fromKey)
           
 String toString()
           
 Collection values()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

root

protected SortedMap root
The backing sorted set.
Constructor Detail

FilterSortedMap

public FilterSortedMap(SortedMap root)
Creates a new FilterSortedMap.
Parameters:
root - The root to wrap this FilterMap around.
Throws:
NullPointerException - root is null.
Method Detail

size

public int size()
Specified by:
size in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map

containsKey

public boolean containsKey(Object key)
Specified by:
containsKey in interface Map

containsValue

public boolean containsValue(Object value)
Specified by:
containsValue in interface Map

get

public Object get(Object key)
Specified by:
get in interface Map

put

public Object put(Object key,
                  Object value)
Specified by:
put in interface Map

remove

public Object remove(Object key)
Specified by:
remove in interface Map

putAll

public void putAll(Map t)
Specified by:
putAll in interface Map

clear

public void clear()
Specified by:
clear in interface Map

keySet

public Set keySet()
Specified by:
keySet in interface Map

values

public Collection values()
Specified by:
values in interface Map

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

equals

public boolean equals(Object o)
Specified by:
equals in interface Map
Overrides:
equals in class Object

hashCode

public int hashCode()
Specified by:
hashCode in interface Map
Overrides:
hashCode in class Object

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedMap

subMap

public SortedMap subMap(Object fromKey,
                        Object toKey)
Specified by:
subMap in interface SortedMap

headMap

public SortedMap headMap(Object toKey)
Specified by:
headMap in interface SortedMap

tailMap

public SortedMap tailMap(Object fromKey)
Specified by:
tailMap in interface SortedMap

firstKey

public Object firstKey()
Specified by:
firstKey in interface SortedMap

lastKey

public Object lastKey()
Specified by:
lastKey in interface SortedMap

toString

public String toString()
Overrides:
toString in class Object