TCharIntMapDecorator

java.lang.Object
- java.util.AbstractMap<Character,Integer>
- - gnu.trove.decorator.TCharIntMapDecorator

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Map<Character,Integer>
```
public class TCharIntMapDecorator
extends AbstractMap<Character,Integer>
implements Map<Character,Integer>, Externalizable, Cloneable
```
Wrapper class to make a TCharIntMap conform to the java.util.Map API. This class simply decorates an underlying TCharIntMap 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 and Description
`protected TCharIntMap`	`_map` the wrapped primitive map

Constructor Summary

Constructors

Constructor and Description
`TCharIntMapDecorator()` FOR EXTERNALIZATION ONLY!!
`TCharIntMapDecorator(TCharIntMap 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(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<Character,Integer>>`	`entrySet()` Returns a Set view on the entries of the map.
`Integer`	`get(Object key)` Retrieves the value for `key`
`TCharIntMap`	`getMap()` Returns a reference to the map wrapped by this decorator.
`boolean`	`isEmpty()` Indicates whether map has any entries.
`Integer`	`put(Character key, Integer value)` Inserts a key/value pair into the map.
`void`	`putAll(Map<? extends Character,? extends Integer> map)` Copies the key/value mappings in `map` into this map.
`void`	`readExternal(ObjectInput in)`
`Integer`	`remove(Object key)` Deletes a key/value pair from the map.
`int`	`size()` Returns the number of entries in the map.
`protected char`	`unwrapKey(Object key)` Unwraps a key
`protected int`	`unwrapValue(Object value)` Unwraps a value
`protected Character`	`wrapKey(char k)` Wraps a key
`protected Integer`	`wrapValue(int 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 Detail
  - _map
```
protected TCharIntMap _map
```
    the wrapped primitive map
- Constructor Detail
  - TCharIntMapDecorator
```
public TCharIntMapDecorator()
```
    FOR EXTERNALIZATION ONLY!!
  - TCharIntMapDecorator
```
public TCharIntMapDecorator(TCharIntMap map)
```
    Creates a wrapper that decorates the specified primitive map.
    
    Parameters:
    
    map - the TCharIntMap to wrap.
- Method Detail
  - getMap
```
public TCharIntMap getMap()
```
    Returns a reference to the map wrapped by this decorator.
    
    Returns:
    
    the wrapped TCharIntMap instance.
  - put
```
public Integer put(Character key,
                   Integer value)
```
    Inserts a key/value pair into the map.
    
    Specified by:
    
    put in interface Map<Character,Integer>
    
    Overrides:
    
    put in class AbstractMap<Character,Integer>
    
    Parameters:
    
    key - an Object value
    
    value - an Object value
    
    Returns:
    
    the previous value associated with key, or Integer(0) if none was found.
  - get
```
public Integer get(Object key)
```
    Retrieves the value for key
    
    Specified by:
    
    get in interface Map<Character,Integer>
    
    Overrides:
    
    get in class AbstractMap<Character,Integer>
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    the value of key or null if no such mapping exists.
  - clear
```
public void clear()
```
    Empties the map.
  - remove
```
public Integer remove(Object key)
```
    Deletes a key/value pair from the map.
    
    Specified by:
    
    remove in interface Map<Character,Integer>
    
    Overrides:
    
    remove in class AbstractMap<Character,Integer>
    
    Parameters:
    
    key - an Object value
    
    Returns:
    
    the removed value, or null if it was not found in the map
  - entrySet
```
public Set<Map.Entry<Character,Integer>> entrySet()
```
    Returns a Set view on the entries of the map.
    
    Specified by:
    
    entrySet in interface Map<Character,Integer>
    
    Specified by:
    
    entrySet in class AbstractMap<Character,Integer>
    
    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<Character,Integer>
    
    Overrides:
    
    containsValue in class AbstractMap<Character,Integer>
    
    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<Character,Integer>
    
    Overrides:
    
    containsKey in class AbstractMap<Character,Integer>
    
    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<Character,Integer>
    
    Overrides:
    
    size in class AbstractMap<Character,Integer>
    
    Returns:
    
    the map's size.
  - isEmpty
```
public boolean isEmpty()
```
    Indicates whether map has any entries.
    
    Specified by:
    
    isEmpty in interface Map<Character,Integer>
    
    Overrides:
    
    isEmpty in class AbstractMap<Character,Integer>
    
    Returns:
    
    true if the map is empty
  - putAll
```
public void putAll(Map<? extends Character,? extends Integer> 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<Character,Integer>
    
    Overrides:
    
    putAll in class AbstractMap<Character,Integer>
    
    Parameters:
    
    map - a Map value
  - wrapKey
```
protected Character wrapKey(char k)
```
    Wraps a key
    
    Parameters:
    
    k - key in the underlying map
    
    Returns:
    
    an Object representation of the key
  - unwrapKey
```
protected char unwrapKey(Object key)
```
    Unwraps a key
    
    Parameters:
    
    key - wrapped key
    
    Returns:
    
    an unwrapped representation of the key
  - wrapValue
```
protected Integer wrapValue(int k)
```
    Wraps a value
    
    Parameters:
    
    k - value in the underlying map
    
    Returns:
    
    an Object representation of the value
  - unwrapValue
```
protected int 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

Class TCharIntMapDecorator

Nested Class Summary

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

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

Field Summary

Fields

Constructor Summary

Constructors

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

TCharIntMapDecorator

TCharIntMapDecorator

Method Detail

getMap

put

get

clear

remove

entrySet

containsValue

containsKey

size

isEmpty

putAll

wrapKey

unwrapKey

wrapValue

unwrapValue

readExternal

writeExternal