TIntLongHashMapDecorator (core 1.0.20200330 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Integer,java.lang.Long>
- - gnu.trove.decorator.TIntLongHashMapDecorator

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Long>
```
public class TIntLongHashMapDecorator
extends java.util.AbstractMap<java.lang.Integer,java.lang.Long>
```
Wrapper class to make a TIntLongHashMap conform to the java.util.Map API. This class simply decorates an underlying TIntLongHashMap and translates the Object-based APIs into their Trove primitive analogs.

Note that wrapping and unwrapping primitive values is extremely inefficient. If possible, users of this class should override the appropriate methods in this class and use a table of canonical values.

Created: Mon Sep 23 22:07:40 PDT 2002

Since:

trove 0.1.8

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

Field Summary

Fields
Modifier and Type Field and Description

protected TIntLongHashMap _map
the wrapped primitive map

Fields
Modifier and Type	Field and Description
`protected TIntLongHashMap`	`_map` the wrapped primitive map

Constructor Summary

Constructors
Constructor and Description

TIntLongHashMapDecorator(TIntLongHashMap map)
Creates a wrapper that decorates the specified primitive map.

Constructors
Constructor and Description
`TIntLongHashMapDecorator(TIntLongHashMap map)` Creates a wrapper that decorates the specified primitive map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Empties the map.
`boolean`	`containsKey(java.lang.Object key)` Checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(java.lang.Object val)` Checks for the presence of `val` in the values of the map.
`java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Long>>`	`entrySet()` Returns a Set view on the entries of the map.
`boolean`	`equals(java.lang.Object other)` Compares this map with another map for equality of their stored entries.
`java.lang.Long`	`get(java.lang.Integer key)` Retrieves the value for `key`
`java.lang.Long`	`get(java.lang.Object object)`
`boolean`	`isEmpty()` Indicates whether map has any entries.
`java.lang.Long`	`put(java.lang.Integer key, java.lang.Long value)` Inserts a key/value pair into the map.
`void`	`putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> map)` Copies the key/value mappings in `map` into this map.
`java.lang.Long`	`remove(java.lang.Integer key)` Deletes a key/value pair from the map.
`java.lang.Long`	`remove(java.lang.Object object)`
`int`	`size()` Returns the number of entries in the map.
`protected int`	`unwrapKey(java.lang.Object key)` Unwraps a key
`protected long`	`unwrapValue(java.lang.Object value)` Unwraps a value
`protected java.lang.Integer`	`wrapKey(int k)` Wraps a key
`protected java.lang.Long`	`wrapValue(long k)` Wraps a value

Methods inherited from class java.util.AbstractMap
clone, 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, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Field Detail
  - _map
```
protected final TIntLongHashMap _map
```
    the wrapped primitive map
- Constructor Detail
  - TIntLongHashMapDecorator
```
public TIntLongHashMapDecorator(TIntLongHashMap map)
```
    Creates a wrapper that decorates the specified primitive map.
- Method Detail
  - put
```
public java.lang.Long put(java.lang.Integer key,
                          java.lang.Long value)
```
    Inserts a key/value pair into the map.
    
    Specified by:
    
    put in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    put in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Parameters:
    
    key - an Object value
    
    value - an Object value
    
    Returns:
    
    the previous value associated with key, or Long(0) if none was found.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this map with another map for equality of their stored entries.
    
    Specified by:
    
    equals in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    equals in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Parameters:
    
    other - an Object value
    
    Returns:
    
    true if the maps are identical
  - get
```
public java.lang.Long get(java.lang.Object object)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    get in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
  - get
```
public java.lang.Long get(java.lang.Integer key)
```
    Retrieves the value for key
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    the value of key or null if no such mapping exists.
  - clear
```
public void clear()
```
    Empties the map.
    
    Specified by:
    
    clear in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    clear in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
  - remove
```
public java.lang.Long remove(java.lang.Integer key)
```
    Deletes a key/value pair from the map.
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    the removed value, or Long(0) if it was not found in the map
  - remove
```
public java.lang.Long remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    remove in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Long>> entrySet()
```
    Returns a Set view on the entries of the map.
    
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Specified by:
    
    entrySet in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Returns:
    
    a Set value
  - containsValue
```
public boolean containsValue(java.lang.Object val)
```
    Checks for the presence of val in the values of the map.
    
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    containsValue in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Parameters:
    
    val - an Object value
    
    Returns:
    
    a boolean value
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Checks for the present of key in the keys of the map.
    
    Specified by:
    
    containsKey in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    a boolean value
  - size
```
public int size()
```
    Returns the number of entries in the map.
    
    Specified by:
    
    size in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    size in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Returns:
    
    the map's size.
  - isEmpty
```
public boolean isEmpty()
```
    Indicates whether map has any entries.
    
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    isEmpty in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Returns:
    
    true if the map is empty
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> map)
```
    Copies the key/value mappings in map into this map. Note that this will be a deep copy, as storage is by primitive value.
    
    Specified by:
    
    putAll in interface java.util.Map<java.lang.Integer,java.lang.Long>
    
    Overrides:
    
    putAll in class java.util.AbstractMap<java.lang.Integer,java.lang.Long>
    
    Parameters:
    
    map - a Map value
  - wrapKey
```
protected java.lang.Integer wrapKey(int k)
```
    Wraps a key
    
    Parameters:
    
    k - key in the underlying map
    
    Returns:
    
    an Object representation of the key
  - unwrapKey
```
protected int unwrapKey(java.lang.Object key)
```
    Unwraps a key
    
    Parameters:
    
    key - wrapped key
    
    Returns:
    
    an unwrapped representation of the key
  - wrapValue
```
protected java.lang.Long wrapValue(long k)
```
    Wraps a value
    
    Parameters:
    
    k - value in the underlying map
    
    Returns:
    
    an Object representation of the value
  - unwrapValue
```
protected long unwrapValue(java.lang.Object value)
```
    Unwraps a value
    
    Parameters:
    
    value - wrapped value
    
    Returns:
    
    an unwrapped representation of the value

Class TIntLongHashMapDecorator

Nested Class Summary

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

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

Field Summary

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

Field Detail

_map

Constructor Detail

TIntLongHashMapDecorator

Method Detail

put

equals

get

get

clear

remove

remove

entrySet

containsValue

containsKey

size

isEmpty

putAll

wrapKey

unwrapKey

wrapValue

unwrapValue