Package gnu.trove.decorator

# Class TIntLongMapDecorator

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

All Implemented Interfaces:
  `Externalizable`, `Serializable`, `Cloneable`, `Map<Integer,Long>`

public class TIntLongMapDecorator extends AbstractMap<Integer,Long> implements Map<Integer,Long>, Externalizable, Cloneable
Wrapper class to make a TIntLongMap conform to the `java.util.Map` API. This class simply decorates an underlying TIntLongMap 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

See Also:
  - Serialized Form

## Nested Class Summary

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

`AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>`

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

`Map.Entry<K,V>`

## Field Summary

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

## Constructor Summary

Constructors
Constructor
Description
`TIntLongMapDecorator()`
FOR EXTERNALIZATION ONLY!!
`TIntLongMapDecorator(TIntLongMap map)`
Creates a wrapper that decorates the specified primitive map.

## Method Summary

Modifier and Type
Method
Description
`void`
`clear()`
Empties the map.
`boolean`
`containsKey(Object key)`
Checks for the present of `key` in the keys of the map.
`boolean`
`containsValue(Object val)`
Checks for the presence of `val` in the values of the map.
`Set<Map.Entry<Integer,Long>>`
`entrySet()`
Returns a Set view on the entries of the map.
`Long`
`get(Object key)`
Retrieves the value for `key`
`TIntLongMap`
`getMap()`
Returns a reference to the map wrapped by this decorator.
`boolean`
`isEmpty()`
Indicates whether map has any entries.
`Long`
`put(Integer key, Long value)`
Inserts a key/value pair into the map.
`void`
`putAll(Map<? extends Integer,? extends Long> map)`
Copies the key/value mappings in `map` into this map.
`void`
`readExternal(ObjectInput in)`
`Long`
`remove(Object key)`
Deletes a key/value pair from the map.
`int`
`size()`
Returns the number of entries in the map.
`protected int`
`unwrapKey(Object key)`
Unwraps a key
`protected long`
`unwrapValue(Object value)`
Unwraps a value
`protected Integer`
`wrapKey(int k)`
Wraps a key
`protected Long`
`wrapValue(long k)`
Wraps a value
`void`
`writeExternal(ObjectOutput out)`

### Methods inherited from class java.util.AbstractMap

`clone, 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`

## Field Details

### _map

protected TIntLongMap _map
the wrapped primitive map

## Constructor Details

### TIntLongMapDecorator

public TIntLongMapDecorator()
FOR EXTERNALIZATION ONLY!!

### TIntLongMapDecorator

public TIntLongMapDecorator(TIntLongMap map)
Creates a wrapper that decorates the specified primitive map.

Parameters:
  `map` - the `TIntLongMap` to wrap.

## Method Details

### getMap

public TIntLongMap getMap()
Returns a reference to the map wrapped by this decorator.

Returns:
  the wrapped `TIntLongMap` instance.

### put

public Long put(Integer key, Long value)
Inserts a key/value pair into the map.

Specified by:
  `put` in interface `Map<Integer,Long>`
Overrides:
  `put` in class `AbstractMap<Integer,Long>`
Parameters:
  `key` - an `Object` value
  `value` - an `Object` value
Returns:
  the previous value associated with `key`, or Long(0) if none was found.

### get

public Long get(Object key)
Retrieves the value for `key`

Specified by:
  `get` in interface `Map<Integer,Long>`
Overrides:
  `get` in class `AbstractMap<Integer,Long>`
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 `Map<Integer,Long>`
Overrides:
  `clear` in class `AbstractMap<Integer,Long>`

### remove

public Long remove(Object key)
Deletes a key/value pair from the map.

Specified by:
  `remove` in interface `Map<Integer,Long>`
Overrides:
  `remove` in class `AbstractMap<Integer,Long>`
Parameters:
  `key` - an `Object` value
Returns:
  the removed value, or null if it was not found in the map

### entrySet

public Set<Map.Entry<Integer,Long>> entrySet()
Returns a Set view on the entries of the map.

Specified by:
  `entrySet` in interface `Map<Integer,Long>`
Specified by:
  `entrySet` in class `AbstractMap<Integer,Long>`
Returns:
  a `Set` value

### containsValue

public boolean containsValue(Object val)
Checks for the presence of `val` in the values of the map.

Specified by:
  `containsValue` in interface `Map<Integer,Long>`
Overrides:
  `containsValue` in class `AbstractMap<Integer,Long>`
Parameters:
  `val` - an `Object` value
Returns:
  a `boolean` value

### containsKey

public boolean containsKey(Object key)
Checks for the present of `key` in the keys of the map.

Specified by:
  `containsKey` in interface `Map<Integer,Long>`
Overrides:
  `containsKey` in class `AbstractMap<Integer,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 `Map<Integer,Long>`
Overrides:
  `size` in class `AbstractMap<Integer,Long>`
Returns:
  the map's size.

### isEmpty

public boolean isEmpty()
Indicates whether map has any entries.

Specified by:
  `isEmpty` in interface `Map<Integer,Long>`
Overrides:
  `isEmpty` in class `AbstractMap<Integer,Long>`
Returns:
  true if the map is empty

### putAll

public void putAll(Map<? extends Integer,? extends 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 `Map<Integer,Long>`
Overrides:
  `putAll` in class `AbstractMap<Integer,Long>`
Parameters:
  `map` - a `Map` value

### wrapKey

protected 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(Object key)
Unwraps a key

Parameters:
  `key` - wrapped key
Returns:
  an unwrapped representation of the key

### wrapValue

protected 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(Object value)
Unwraps a value

Parameters:
  `value` - wrapped value
Returns:
  an unwrapped representation of the value

### readExternal

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

Specified by:
  `readExternal` in interface `Externalizable`
Throws:
  `IOException`
  `ClassNotFoundException`

### writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Specified by:
  `writeExternal` in interface `Externalizable`
Throws:
  `IOException`