Package gnu.trove.decorator

# Class TShortObjectMapDecorator<V>

java.lang.Object
java.util.AbstractMap<Short,V>
gnu.trove.decorator.TShortObjectMapDecorator<V>

All Implemented Interfaces:
  `Externalizable`, `Serializable`, `Cloneable`, `Map<Short,V>`

public class TShortObjectMapDecorator<V> extends AbstractMap<Short,V> implements Map<Short,V>, Externalizable, Cloneable
Wrapper class to make a TShortObjectMap conform to the `java.util.Map` API. This class simply decorates an underlying TShortObjectMap 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 TShortObjectMap<V>`
`_map`
the wrapped primitive map

## Constructor Summary

Constructors
Constructor
Description
`TShortObjectMapDecorator()`
FOR EXTERNALIZATION ONLY!!
`TShortObjectMapDecorator(TShortObjectMap<V> 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<Short,V>>`
`entrySet()`
Returns a Set view on the entries of the map.
`V`
`get(Object key)`
Retrieves the value for `key`
`TShortObjectMap<V>`
`getMap()`
Returns a reference to the map wrapped by this decorator.
`boolean`
`isEmpty()`
Indicates whether map has any entries.
`V`
`put(Short key, V value)`
Inserts a key/value pair into the map.
`void`
`putAll(Map<? extends Short,? extends V> map)`
Copies the key/value mappings in `map` into this map.
`void`
`readExternal(ObjectInput in)`
`V`
`remove(Object key)`
Deletes a key/value pair from the map.
`int`
`size()`
Returns the number of entries in the map.
`protected short`
`unwrapKey(Short key)`
Unwraps a key
`protected Short`
`wrapKey(short k)`
Wraps a key
`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 TShortObjectMap<V> _map
the wrapped primitive map

## Constructor Details

### TShortObjectMapDecorator

public TShortObjectMapDecorator()
FOR EXTERNALIZATION ONLY!!

### TShortObjectMapDecorator

public TShortObjectMapDecorator(TShortObjectMap<V> map)
Creates a wrapper that decorates the specified primitive map.

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

## Method Details

### getMap

public TShortObjectMap<V> getMap()
Returns a reference to the map wrapped by this decorator.

Returns:
  the wrapped `TShortObjectMap` instance.

### put

public V put(Short key, V value)
Inserts a key/value pair into the map.

Specified by:
  `put` in interface `Map<Short,V>`
Overrides:
  `put` in class `AbstractMap<Short,V>`
Parameters:
  `key` - an `Short` value
  `value` - an `Object` value
Returns:
  the previous value associated with `key`, or `null` if none was found.

### get

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

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

### remove

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

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

### entrySet

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

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

### isEmpty

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

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

### putAll

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

### wrapKey

protected Short wrapKey(short k)
Wraps a key

Parameters:
  `k` - key in the underlying map
Returns:
  an Object representation of the key

### unwrapKey

protected short unwrapKey(Short key)
Unwraps a key

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

### 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`