org.biojava.utils
Class OverlayMap

java.lang.Object
  java.util.AbstractMap
      org.biojava.utils.OverlayMap

All Implemented Interfaces:

Map

public class OverlayMap

extends AbstractMap

Overlap one map onto another. This allows you to have a map with local values and default values. The local and default values are provided by a child and parent map.

Author:

Thomas Down, Matthew Pocock

Nested Class Summary

Nested classes inherited from class java.util.Map

Map.Entry

Constructor Summary

OverlayMap(Map parent)
Build a new map with default key-value pairs.

OverlayMap(Map parent, Map overlay)
Build a new map with default key-value pairs.

Method Summary

boolean	containsKey(Object key)
Set	entrySet()
Object	get(Object key)
Map	getOverlayMap() Return the object containing the overlay mappings.
Map	getParentMap() Return the object containing the fallback mappings.
Set	keySet()
Object	put(Object key, Object value)

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, isEmpty, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OverlayMap

public OverlayMap(Map parent,
                  Map overlay)

Build a new map with default key-value pairs.

Parameters:

parent - the default fall-through Map

overlay - the overriding Map

OverlayMap

public OverlayMap(Map parent)

Build a new map with default key-value pairs.

Parameters:

parent - the default fall-through Map

Method Detail

getParentMap

public Map getParentMap()

Return the object containing the fallback mappings. This is the actual parent map, not a copy.

Returns:

the parent map

getOverlayMap

public Map getOverlayMap()

Return the object containing the overlay mappings. This is the actual child map, not a copy.

Returns:

the child map

get

public Object get(Object key)

entrySet

public Set entrySet()

keySet

public Set keySet()

containsKey

public boolean containsKey(Object key)

put

public Object put(Object key,
                  Object value)