TCharCharMapDecorator (Trove 3.0.3)

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Character,java.lang.Character>
```
public class TCharCharMapDecorator
extends java.util.AbstractMap<java.lang.Character,java.lang.Character>
implements java.util.Map<java.lang.Character,java.lang.Character>, java.io.Externalizable, java.lang.Cloneable
```
Wrapper class to make a TCharCharMap conform to the java.util.Map API. This class simply decorates an underlying TCharCharMap 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
  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 TCharCharMap _map
the wrapped primitive map

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

Constructor Summary

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

Class TCharCharMapDecorator

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

TCharCharMapDecorator

TCharCharMapDecorator

Method Detail

getMap

put

get

clear

remove

entrySet

containsValue

containsKey

size

isEmpty

putAll

wrapKey

unwrapKey

wrapValue

unwrapValue

readExternal

writeExternal