PartitionedMap (intarsys runtime library)

java.lang.Object
- de.intarsys.tools.collection.PartitionedMap

All Implemented Interfaces:: Map

public class PartitionedMap
extends Object
implements Map

A map that wraps two other maps.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PartitionedMap()

PartitionedMap(Map parent, Map child)

Constructors
Constructor and Description
`PartitionedMap()`
`PartitionedMap(Map parent, Map child)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all mappings from this map (optional operation).
`boolean`	`containsKey(Object key)` Returns `true` if this map contains a mapping for the specified key.
`boolean`	`containsValue(Object value)` Returns `true` if this map maps one or more keys to the specified value.
`static Map`	`create(Map parent, Map child)`
`Set`	`entrySet()` Returns a set view of the mappings contained in this map.
`Object`	`get(Object key)` Returns the value to which this map maps the specified key.
`Map`	`getParent()`
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`Set`	`keySet()` Returns a set view of the keys contained in this map.
`Object`	`put(Object key, Object value)` Associates the specified value with the specified key in this map (optional operation).
`void`	`putAll(Map t)` Copies all of the mappings from the specified map to this map (optional operation).
`Object`	`remove(Object key)` Removes the mapping for this key from this map if present (optional operation).
`void`	`setParent(Map newParent)`
`int`	`size()` Returns the number of key-value mappings in this map.
`String`	`toString()`
`Collection`	`values()` Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - PartitionedMap
```
public PartitionedMap()
```
  - PartitionedMap
```
public PartitionedMap(Map parent,
              Map child)
```
- Method Detail
  - create
```
public static Map create(Map parent,
         Map child)
```
  - clear
```
public void clear()
```
    Removes all mappings from this map (optional operation).
    
    Specified by:
    
    clear in interface Map
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Map
    
    Parameters:
    key - key whose presence in this map is to be tested.
    
    Returns:
    true if this map contains a mapping for the specified key.
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
    
    Specified by:
    
    containsValue in interface Map
    
    Parameters:
    value - value whose presence in this map is to be tested.
    
    Returns:
    true if this map maps one or more keys to the specified value.
  - entrySet
```
public Set entrySet()
```
    Returns a set view of the mappings contained in this map. Each element in the returned set is a Map.Entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    entrySet in interface Map
    
    Returns:
    a set view of the mappings contained in this map.
  - get
```
public Object get(Object key)
```
    Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
    
    Specified by:
    
    get in interface Map
    
    Parameters:
    key - key whose associated value is to be returned.
    
    Returns:
    the value to which this map maps the specified key, or null if the map contains no mapping for this key.
    See Also:
    containsKey(Object)
  - getParent
```
public Map getParent()
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this map contains no key-value mappings.
    
    Specified by:
    
    isEmpty in interface Map
    
    Returns:
    true if this map contains no key-value mappings.
  - keySet
```
public Set keySet()
```
    Returns a set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress, the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAllretainAll, and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    keySet in interface Map
    
    Returns:
    a set view of the keys contained in this map.
  - put
```
public Object put(Object key,
         Object value)
```
    Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for this key, the old value is replaced.
    
    Specified by:
    
    put in interface Map
    
    Parameters:
    key - key with which the specified value is to be associated.
    value - value to be associated with the specified key.
    
    Returns:
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
  - putAll
```
public void putAll(Map t)
```
    Copies all of the mappings from the specified map to this map (optional operation). These mappings will replace any mappings that this map had for any of the keys currently in the specified map.
    
    Specified by:
    
    putAll in interface Map
    
    Parameters:
    t - Mappings to be stored in this map.
  - remove
```
public Object remove(Object key)
```
    Removes the mapping for this key from this map if present (optional operation).
    
    Specified by:
    
    remove in interface Map
    
    Parameters:
    key - key whose mapping is to be removed from the map.
    
    Returns:
    previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.
  - setParent
```
public void setParent(Map newParent)
```
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface Map
    
    Returns:
    the number of key-value mappings in this map.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - values
```
public Collection values()
```
    Returns a collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
    
    Specified by:
    
    values in interface Map
    
    Returns:
    a collection view of the values contained in this map.

Class PartitionedMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PartitionedMap

PartitionedMap

Method Detail

create

clear

containsKey

containsValue

entrySet

get

getParent

isEmpty

keySet

put

putAll

remove

setParent

size

toString

values