ej.basictool.map

Class PackedMap<K,V>

java.lang.Object

ej.basictool.map.AbstractPackedMap<K,V>

ej.basictool.map.PackedMap<K,V>

Type Parameters:

K - the type of keys maintained by this map.

V - the type of mapped values.

public class PackedMap<K,V>
extends AbstractPackedMap<K,V>

This class implements the AbstractPackedMap class, using object-equality when comparing keys. In other words, in an PackedMap, two keys k1 and k2 are considered equal if and only if (k1.equals(k2)) (with k1 not null for sure as long as this map does not accept null keys).

Field Summary

Fields inherited from class ej.basictool.map.AbstractPackedMap

keysValues

Constructor Summary

Constructors

Constructor and Description
PackedMap() Constructs an empty map.
PackedMap(PackedMap<K,V> map) Constructs a map with the same mappings as the specified map.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a shallow copy of this map instance: the keys and values themselves are not cloned.
protected boolean	isSame(java.lang.Object key, java.lang.Object candidateKey) Checks whether two keys are equal or not.

Methods inherited from class ej.basictool.map.AbstractPackedMap

clear, containsKey, containsUnwrappedKey, containsValue, equals, get, getKeyHashCode, getWrappedKeyHashCode, hashCode, isEmpty, keySet, put, remove, size, unwrapKey, values, wrapKey

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PackedMap

public PackedMap()

Constructs an empty map.

PackedMap

public PackedMap(PackedMap<K,V> map)

Constructs a map with the same mappings as the specified map.

Parameters:

map - the map whose mappings are to be placed in this map.

Throws:

java.lang.NullPointerException - if the specified map is null.

Method Detail

clone

public java.lang.Object clone()

Description copied from class: AbstractPackedMap

Returns a shallow copy of this map instance: the keys and values themselves are not cloned.

Specified by:

clone in class AbstractPackedMap<K,V>

Returns:

a shallow copy of this map

isSame

protected boolean isSame(java.lang.Object key,
                         @Nullable
                         java.lang.Object candidateKey)

Description copied from class: AbstractPackedMap

Checks whether two keys are equal or not. The key must not be null.

Specified by:

isSame in class AbstractPackedMap<K,V>

Parameters:

key - the key searched in the map.

candidateKey - the key in the map to compare with. Can be null if and only if AbstractPackedMap.unwrapKey(Object) implementation can return null.

Returns:

true if the two keys are equal, false otherwise.