ClassMap (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.util.ClassMap

All Implemented Interfaces:

Serializable, Map
```
public class ClassMap
extends Object
implements Map, Serializable
```
This map is intended to map (source) classes to (target) classes. The main reason to prefer this class over a simply (Hash)Map is that if the given sourceclass is not contained in this map, ClassMap will look for mappings of the superclasses of the sourceclass. Example: If you look for a mapping of the sourceclass Double and there is none contained in this map then ClassMap will look for a mapping of Number and eventually for Object. If there is still nothing found null will be returned.

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

ClassMap()
Creates a new, empty ClassMap.

Constructors
Constructor and Description
`ClassMap()` Creates a new, empty ClassMap.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all mappings from this map.
`boolean`	`containsClass(Class classKey)` Returns true if this map contains a mapping for the specified classkey.
`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.
`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.
`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.
`void`	`putAll(Map map)` Copies all of the mappings from the specified map to this map.
`Object`	`remove(Object key)` Removes the mapping for this key from this map if it is present.
`int`	`size()` Returns the number of key-value mappings in this map.
`Collection`	`values()` Returns a collection view of the values contained in this map.

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

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

- Constructor Detail
  - ClassMap
```
public ClassMap()
```
    Creates a new, empty ClassMap.
- Method Detail
  - 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
  - clear
```
public void clear()
```
    Removes all mappings from this map.
    
    Specified by:
    
    clear in interface Map
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this map contains no key-value mappings.
    
    Specified by:
    
    isEmpty in interface Map
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key. It only returns true if there is actually an exactly matching mapping for the given key. If you want to know if there is a mapping for a class or one of its superclasses, you will have to use containsClass() instead!
    
    Specified by:
    
    containsKey in interface Map
    
    Parameters:
    
    key - key whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains an exact mapping for the specified key
  - containsClass
```
public boolean containsClass(Class classKey)
```
    Returns true if this map contains a mapping for the specified classkey. Contrary to containsKey(), this method will also return true if there is a mapping for one of the superclasses of classKey. Note: This behaviour implies that this method will always be true as soon as there is a mapping for the class Object in this map!
    
    Parameters:
    
    classKey - class whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains a mapping for the specified class (see comments above)
  - containsValue
```
public boolean containsValue(Object value)
```
    Returns true if this map maps one or more keys to the specified value.
    
    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.
  - 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
  - putAll
```
public void putAll(Map map)
```
    Copies all of the mappings from the specified map to this map. The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.
    
    Specified by:
    
    putAll in interface Map
    
    Parameters:
    
    map - Mappings to be stored in this map.
  - 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
  - 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, removeAll retainAll, 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.
  - get
```
public Object get(Object key)
```
    Returns the value to which this map maps the specified key. Additionally if the given key is of type Class the map will also be searched for superclasses of the given class (upto the Object class). 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. Note: If this map contains an entry for the key class Object then this method will always return return a non-null entry if you use an object of type Class as parameter.
    
    Specified by:
    
    get in interface Map
    
    Parameters:
    
    key - key whose associated value is to be returned (see comments above when using a Class object as key)
  - remove
```
public Object remove(Object key)
```
    Removes the mapping for this key from this map if it is present. Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.
    
    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
  - put
```
public Object put(Object key,
                  Object value)
```
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.))
    
    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

Class ClassMap

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

ClassMap

Method Detail

size

clear

isEmpty

containsKey

containsClass

containsValue

values

putAll

entrySet

keySet

get

remove

put