KeyComparatorHashMap (Jersey 3.0.16 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - org.glassfish.jersey.internal.util.collection.KeyComparatorHashMap<K,V>

Type Parameters:

K - Type of keys

V - Type of values

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>

Direct Known Subclasses:

KeyComparatorLinkedHashMap
```
public class KeyComparatorHashMap<K,V>
extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable
```
A implementation similar to HashMap but supports the comparison of keys using a KeyComparator.

Author:

Paul Sandoz

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description
`KeyComparatorHashMap(int initialCapacity, float loadFactor, KeyComparator<K> keyComparator)` Constructs an empty `HashMap` with the specified initial capacity and load factor.
`KeyComparatorHashMap(int initialCapacity, KeyComparator<K> keyComparator)` Constructs an empty `HashMap` with the specified initial capacity and the default load factor (0.75).
`KeyComparatorHashMap(KeyComparator<K> keyComparator)` Constructs an empty `HashMap` with the default initial capacity (16) and the default load factor (0.75).
`KeyComparatorHashMap(Map<? extends K,? extends V> m, KeyComparator<K> keyComparator)` Constructs a new `HashMap` with the same mappings as the specified `Map`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all mappings from this map.
`Object`	`clone()` Returns a shallow copy of this `HashMap` instance: the keys and values themselves are not cloned.
`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<Map.Entry<K,V>>`	`entrySet()` Returns a collection view of the mappings contained in this map.
`V`	`get(Object key)` Returns the value to which the specified key is mapped in this identity hash map, or `null` if the map contains no mapping for this key.
`int`	`getModCount()` Get the number of times this HashMap has been structurally modified Structural modifications are those that change the number of mappings in the HashMap or otherwise modify its internal structure (e.g., rehash).
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`V`	`put(K key, V value)` Associates the specified value with the specified key in this map.
`void`	`putAll(Map<? extends K,? extends V> m)` Copies all of the mappings from the specified map to this map These mappings will replace any mappings that this map had for any of the keys currently in the specified map.
`V`	`remove(Object key)` Removes the mapping for this key from this map if present.
`int`	`size()` Returns the number of key-value mappings in this map.

Methods inherited from class java.util.AbstractMap
equals, hashCode, keySet, toString, values

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

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

- Constructor Detail
  - KeyComparatorHashMap
```
public KeyComparatorHashMap(int initialCapacity,
                            float loadFactor,
                            KeyComparator<K> keyComparator)
```
    Constructs an empty HashMap with the specified initial capacity and load factor.
    
    Parameters:
    
    initialCapacity - The initial capacity.
    
    loadFactor - The load factor.
    
    keyComparator - the map key comparator.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive.
  - KeyComparatorHashMap
```
public KeyComparatorHashMap(int initialCapacity,
                            KeyComparator<K> keyComparator)
```
    Constructs an empty HashMap with the specified initial capacity and the default load factor (0.75).
    
    Parameters:
    
    initialCapacity - the initial capacity.
    
    keyComparator - the map key comparator.
    
    Throws:
    
    IllegalArgumentException - if the initial capacity is negative.
  - KeyComparatorHashMap
```
public KeyComparatorHashMap(KeyComparator<K> keyComparator)
```
    Constructs an empty HashMap with the default initial capacity (16) and the default load factor (0.75).
    
    Parameters:
    
    keyComparator - the map key comparator.
  - KeyComparatorHashMap
```
public KeyComparatorHashMap(Map<? extends K,? extends V> m,
                            KeyComparator<K> keyComparator)
```
    Constructs a new HashMap with the same mappings as the specified Map. The HashMap is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified Map.
    
    Parameters:
    
    m - the map whose mappings are to be placed in this map.
    
    keyComparator - the comparator
    
    Throws:
    
    NullPointerException - if the specified map is null.
- Method Detail
  - getModCount
```
public int getModCount()
```
    Get the number of times this HashMap has been structurally modified Structural modifications are those that change the number of mappings in the HashMap or otherwise modify its internal structure (e.g., rehash).
    
    Returns:
    
    return the modification count.
  - size
```
public int size()
```
    Returns the number of key-value mappings in this map.
    
    Specified by:
    
    size in interface Map<K,V>
    
    Overrides:
    
    size in class AbstractMap<K,V>
    
    Returns:
    
    the number of key-value mappings in this map.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this map contains no key-value mappings.
    
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Overrides:
    
    isEmpty in class AbstractMap<K,V>
    
    Returns:
    
    true if this map contains no key-value mappings.
  - get
```
public V get(Object key)
```
    Returns the value to which the specified key is mapped in this identity hash map, or 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 is also possible that the map explicitly maps the key to null. The containsKey method may be used to distinguish these two cases.
    
    Specified by:
    
    get in interface Map<K,V>
    
    Overrides:
    
    get in class AbstractMap<K,V>
    
    Parameters:
    
    key - the 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:
    
    put(Object, Object)
  - containsKey
```
public boolean containsKey(Object key)
```
    Returns true if this map contains a mapping for the specified key.
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Overrides:
    
    containsKey in class AbstractMap<K,V>
    
    Parameters:
    
    key - The key whose presence in this map is to be tested
    
    Returns:
    
    true if this map contains a mapping for the specified key.
  - put
```
public V put(K key,
             V 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.
    
    Specified by:
    
    put in interface Map<K,V>
    
    Overrides:
    
    put in class AbstractMap<K,V>
    
    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 HashMap previously associated null with the specified key.
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Copies all of the mappings from the specified map to this map 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<K,V>
    
    Overrides:
    
    putAll in class AbstractMap<K,V>
    
    Parameters:
    
    m - mappings to be stored in this map.
    
    Throws:
    
    NullPointerException - if the specified map is null.
  - remove
```
public V remove(Object key)
```
    Removes the mapping for this key from this map if present.
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Overrides:
    
    remove in class AbstractMap<K,V>
    
    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.
  - clear
```
public void clear()
```
    Removes all mappings from this map.
    
    Specified by:
    
    clear in interface Map<K,V>
    
    Overrides:
    
    clear in class AbstractMap<K,V>
  - 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<K,V>
    
    Overrides:
    
    containsValue in class AbstractMap<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.
  - clone
```
public Object clone()
```
    Returns a shallow copy of this HashMap instance: the keys and values themselves are not cloned.
    
    Overrides:
    
    clone in class AbstractMap<K,V>
    
    Returns:
    
    a shallow copy of this map.
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Returns a collection view of the mappings contained in this map. Each element in the returned collection is a Map.Entry. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. 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:
    
    entrySet in interface Map<K,V>
    
    Specified by:
    
    entrySet in class AbstractMap<K,V>
    
    Returns:
    
    a collection view of the mappings contained in this map.

Class KeyComparatorHashMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

KeyComparatorHashMap

KeyComparatorHashMap

KeyComparatorHashMap

KeyComparatorHashMap

Method Detail

getModCount

size

isEmpty

get

containsKey

put

putAll

remove

clear

containsValue

clone

entrySet