EnumMap4D (TotalCrossSDK 6.1.0 API)

java.lang.Object
- totalcross.util.AbstractMap4D<K,V>
- - totalcross.util.EnumMap4D<K,V>

All Implemented Interfaces:: java.lang.Cloneable, java.util.Map<K,V>

public class EnumMap4D<K extends java.lang.Enum<K>,V>
extends AbstractMap4D<K,V>
implements java.lang.Cloneable

Since:: 1.5

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

Constructor Summary

Constructors
Constructor and Description

EnumMap4D(java.lang.Class<K> keyType)

EnumMap4D(EnumMap4D<K,? extends V> map)

EnumMap4D(java.util.Map<K,? extends V> map)

Constructors
Constructor and Description
`EnumMap4D(java.lang.Class<K> keyType)`
`EnumMap4D(EnumMap4D<K,? extends V> map)`
`EnumMap4D(java.util.Map<K,? extends V> map)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Remove all entries from this Map (optional operation).
`EnumMap4D<K,V>`	`clone()` Create a shallow copy of this Map, no keys or values are copied.
`boolean`	`containsKey(java.lang.Object key)` Returns true if this contains a mapping for the given key.
`boolean`	`containsValue(java.lang.Object value)` Returns true if this contains at least one mapping with the given value.
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()` Returns a set view of the mappings in this Map.
`boolean`	`equals(java.lang.Object o)` Compares the specified object with this map for equality.
`V`	`get(java.lang.Object key)` Returns the value mapped by the given key.
`java.util.Set<K>`	`keySet()` Returns a set view of this map's keys.
`V`	`put(K key, V value)` Associates the given key to the given value (optional operation).
`void`	`putAll(java.util.Map<? extends K,? extends V> map)` Copies all entries of the given map to this one (optional operation).
`V`	`remove(java.lang.Object key)` Removes the mapping for this key if present (optional operation).
`int`	`size()` Returns the number of key-value mappings in the map.
`java.util.Collection<V>`	`values()` Returns a collection or bag view of this map's values.

Methods inherited from class totalcross.util.AbstractMap4D
equals, hashCode, hashCode, isEmpty, toString

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - EnumMap4D
```
public EnumMap4D(java.lang.Class<K> keyType)
```
  - EnumMap4D
```
public EnumMap4D(EnumMap4D<K,? extends V> map)
```
  - EnumMap4D
```
public EnumMap4D(java.util.Map<K,? extends V> map)
```
- Method Detail
  - size
```
public int size()
```
    Description copied from class: AbstractMap4D
    
    Returns the number of key-value mappings in the map. If there are more than Integer.MAX_VALUE mappings, return Integer.MAX_VALUE. This is implemented as entrySet().size().
    
    Specified by:
    
    size in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    size in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Returns:
    
    the number of mappings
    
    See Also:
    
    Set.size()
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Description copied from class: AbstractMap4D
    
    Returns true if this contains at least one mapping with the given value. This implementation does a linear search, O(n), over the entrySet(), returning true if a match is found, false if the iteration ends. A match is defined as a value, v, where (value == null ? v == null : value.equals(v)). Subclasses are unlikely to implement this more efficiently.
    
    Specified by:
    
    containsValue in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    containsValue in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    value - the value to search for
    
    Returns:
    
    true if the map contains the value
    
    See Also:
    
    AbstractMap4D.containsKey(Object)
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Description copied from class: AbstractMap4D
    
    Returns true if this contains a mapping for the given key. This implementation does a linear search, O(n), over the entrySet(), returning true if a match is found, false if the iteration ends. Many subclasses can implement this more efficiently.
    
    Specified by:
    
    containsKey in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    containsKey in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    key - the key to search for
    
    Returns:
    
    true if the map contains the key
    
    See Also:
    
    AbstractMap4D.containsValue(Object)
  - get
```
public V get(java.lang.Object key)
```
    Description copied from class: AbstractMap4D
    
    Returns the value mapped by the given key. Returns null if there is no mapping. However, in Maps that accept null values, you must rely on containsKey to determine if a mapping exists. This iteration takes linear time, searching entrySet().iterator() of the key. Many implementations override this method.
    
    Specified by:
    
    get in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    get in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    key - the key to look up
    
    Returns:
    
    the value associated with the key, or null if key not in map
    
    See Also:
    
    AbstractMap4D.containsKey(Object)
  - put
```
public V put(K key,
             V value)
```
    Description copied from class: AbstractMap4D
    
    Associates the given key to the given value (optional operation). If the map already contains the key, its value is replaced. This implementation simply throws an UnsupportedOperationException. Be aware that in a map that permits null values, a null return does not always imply that the mapping was created.
    
    Specified by:
    
    put in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    put in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    key - the key to map
    
    value - the value to be mapped
    
    Returns:
    
    the previous value of the key, or null if there was no mapping
    
    See Also:
    
    AbstractMap4D.containsKey(Object)
  - remove
```
public V remove(java.lang.Object key)
```
    Description copied from class: AbstractMap4D
    
    Removes the mapping for this key if present (optional operation). This implementation iterates over the entrySet searching for a matching key, at which point it calls the iterator's remove method. It returns the result of getValue() on the entry, if found, or null if no entry is found. Note that maps which permit null values may also return null if the key was removed. If the entrySet does not support removal, this will also fail. This is O(n), so many implementations override it for efficiency.
    
    Specified by:
    
    remove in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    remove in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    key - the key to remove
    
    Returns:
    
    the value the key mapped to, or null if not present. Null may also be returned if null values are allowed in the map and the value of this mapping is null.
    
    See Also:
    
    Iterator.remove()
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> map)
```
    Description copied from class: AbstractMap4D
    
    Copies all entries of the given map to this one (optional operation). If the map already contains a key, its value is replaced. This implementation simply iterates over the map's entrySet(), calling put, so it is not supported if puts are not.
    
    Specified by:
    
    putAll in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    putAll in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    map - the mapping to load into this map
    
    See Also:
    
    AbstractMap4D.put(Object, Object)
  - clear
```
public void clear()
```
    Description copied from class: AbstractMap4D
    
    Remove all entries from this Map (optional operation). This default implementation calls entrySet().clear(). NOTE: If the entry set does not permit clearing, then this will fail, too. Subclasses often override this for efficiency. Your implementation of entrySet() should not call AbstractMap.clear unless you want an infinite loop.
    
    Specified by:
    
    clear in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    clear in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    See Also:
    
    Set.clear()
  - keySet
```
public java.util.Set<K> keySet()
```
    Description copied from class: AbstractMap4D
    
    Returns a set view of this map's keys. The set is backed by the map, so changes in one show up in the other. Modifications while an iteration is in progress produce undefined behavior. The set supports removal if entrySet() does, but does not support element addition.
    This implementation creates an AbstractSet, where the iterator wraps the entrySet iterator, size defers to the Map's size, and contains defers to the Map's containsKey. The set is created on first use, and returned on subsequent uses, although since no synchronization occurs, there is a slight possibility of creating two sets.
    
    Specified by:
    
    keySet in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    keySet in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Returns:
    
    a Set view of the keys
    
    See Also:
    
    Set.iterator(), AbstractMap4D.size(), AbstractMap4D.containsKey(Object), AbstractMap4D.values()
  - values
```
public java.util.Collection<V> values()
```
    Description copied from class: AbstractMap4D
    
    Returns a collection or bag view of this map's values. The collection is backed by the map, so changes in one show up in the other. Modifications while an iteration is in progress produce undefined behavior. The collection supports removal if entrySet() does, but does not support element addition.
    This implementation creates an AbstractCollection, where the iterator wraps the entrySet iterator, size defers to the Map's size, and contains defers to the Map's containsValue. The collection is created on first use, and returned on subsequent uses, although since no synchronization occurs, there is a slight possibility of creating two collections.
    
    Specified by:
    
    values in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    values in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Returns:
    
    a Collection view of the values
    
    See Also:
    
    Collection.iterator(), AbstractMap4D.size(), AbstractMap4D.containsValue(Object), AbstractMap4D.keySet()
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Description copied from class: AbstractMap4D
    
    Returns a set view of the mappings in this Map. Each element in the set must be an implementation of Map.Entry. The set is backed by the map, so that changes in one show up in the other. Modifications made while an iterator is in progress cause undefined behavior. If the set supports removal, these methods must be valid: Iterator.remove, Set.remove, removeAll, retainAll, and clear. Element addition is not supported via this set.
    
    Specified by:
    
    entrySet in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Specified by:
    
    entrySet in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Returns:
    
    the entry set
    
    See Also:
    
    Map.Entry
  - equals
```
public boolean equals(java.lang.Object o)
```
    Description copied from class: AbstractMap4D
    
    Compares the specified object with this map for equality. Returns true if the other object is a Map with the same mappings, that is,
    o instanceof Map && entrySet().equals(((Map) o).entrySet();
    
    Specified by:
    
    equals in interface java.util.Map<K extends java.lang.Enum<K>,V>
    
    Overrides:
    
    equals in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Parameters:
    
    o - the object to be compared
    
    Returns:
    
    true if the object equals this map
    
    See Also:
    
    Set.equals(Object)
  - clone
```
public EnumMap4D<K,V> clone()
```
    Description copied from class: AbstractMap4D
    
    Create a shallow copy of this Map, no keys or values are copied. The default implementation simply calls super.clone().
    
    Overrides:
    
    clone in class AbstractMap4D<K extends java.lang.Enum<K>,V>
    
    Returns:
    
    the shallow clone
    
    See Also:
    
    Cloneable, Object.clone()

Class EnumMap4D<K extends java.lang.Enum<K>,V>

Nested Class Summary

Nested classes/interfaces inherited from class totalcross.util.AbstractMap4D

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

Constructor Summary

Method Summary

Methods inherited from class totalcross.util.AbstractMap4D

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

EnumMap4D

EnumMap4D

EnumMap4D

Method Detail

size

containsValue

containsKey

get

put

remove

putAll

clear

keySet

values

entrySet

equals

clone