ImmutableAbstractMap (Open Traffic Sim demo classes 0.12.00 API)

java.lang.Object
- org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap<K,V>

Type Parameters:

K - the key type of content of this Map

V - the value type of content of this Map

All Implemented Interfaces:

Serializable, ImmutableMap<K,V>

Direct Known Subclasses:

ImmutableHashMap, ImmutableTreeMap
```
public abstract class ImmutableAbstractMap<K,V>
extends Object
implements ImmutableMap<K,V>
```
An abstract base class for an immutable wrapper for a Map.
Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version May 7, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected ImmutableAbstractMap(Map<K,V> map, boolean copy)
Construct an abstract immutable map.

Constructors
Modifier	Constructor and Description
`protected`	`ImmutableAbstractMap(Map<K,V> map, boolean copy)` Construct an abstract immutable map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`boolean`	`equals(Object obj)` Force to redefine equals for the implementations of immutable collection classes.
`V`	`get(Object key)` Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
`protected Map<K,V>`	`getMap()` Prepare the map of the right type for use a subclass.
`int`	`hashCode()` Force to redefine hashCode for the implementations of immutable collection classes.
`boolean`	`isEmpty()` Returns `true` if this immutable collection contains no elements.
`boolean`	`isWrap()` Return whether the internal storage is a wrapped pointer to the original map.
`int`	`size()` Returns the number of elements in this immutable collection.
`String`	`toString()`
`ImmutableCollection<V>`	`values()` Returns a `ImmutableCollection` view of the values contained in this map.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableMap
forEach, getOrDefault, isCopy, keySet, toMap

- Constructor Detail
  - ImmutableAbstractMap
```
protected ImmutableAbstractMap(Map<K,V> map,
                               boolean copy)
```
    Construct an abstract immutable map. Make sure that the argument is a safe copy of the map of the right type!
    
    Parameters:
    
    map - a safe copy of the map to use as the immutable map
    
    copy - indicate whether the immutable is a copy or a wrap
- Method Detail
  - getMap
```
protected Map<K,V> getMap()
```
    Prepare the map of the right type for use a subclass. Implement e.g. as follows:
```
  @Override
 protected HashMap<E> getMap()
 {
     return (HashMap<E>) super.getMap();
 }
 
```
    Returns:
    
    the map of the right type for use a subclass
  - size
```
public final int size()
```
    Returns the number of elements in this immutable collection. If this immutable collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface ImmutableMap<K,V>
    
    Returns:
    
    the number of elements in this immutable collection
  - isEmpty
```
public final boolean isEmpty()
```
    Returns true if this immutable collection contains no elements.
    
    Specified by:
    
    isEmpty in interface ImmutableMap<K,V>
    
    Returns:
    
    true if this immutable collection contains no elements
  - containsKey
```
public final boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)
    
    Specified by:
    
    containsKey in interface ImmutableMap<K,V>
    
    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 final 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 ImmutableMap<K,V>
    
    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
  - get
```
public final V get(Object key)
```
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
    More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)
    If this map permits null values, then 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 ImmutableMap<K,V>
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this map contains no mapping for the key
  - values
```
public final ImmutableCollection<V> values()
```
    Returns a ImmutableCollection view of the values contained in this map.
    
    Specified by:
    
    values in interface ImmutableMap<K,V>
    
    Returns:
    
    an immutable collection view of the values contained in this map
  - isWrap
```
public final boolean isWrap()
```
    Return whether the internal storage is a wrapped pointer to the original map. If true, this means that anyone holding a pointer to this data structure can still change it. The users of the ImmutableMap itself can, however, not make any changes.
    
    Specified by:
    
    isWrap in interface ImmutableMap<K,V>
    
    Returns:
    
    boolean; whether the internal storage is a wrapped pointer to the original map
  - hashCode
```
public int hashCode()
```
    Force to redefine hashCode for the implementations of immutable collection classes.
    
    Specified by:
    
    hashCode in interface ImmutableMap<K,V>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the calculated hashCode
  - equals
```
public boolean equals(Object obj)
```
    Force to redefine equals for the implementations of immutable collection classes.
    
    Specified by:
    
    equals in interface ImmutableMap<K,V>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare this collection with
    
    Returns:
    
    whether the objects are equal
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ImmutableAbstractMap<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableMap

Constructor Detail

ImmutableAbstractMap

Method Detail

getMap

size

isEmpty

containsKey

containsValue

get

values

isWrap

hashCode

equals

toString