TUnmodifiableShortCharMap (core 3.1.0 API)

java.lang.Object
- gnu.trove.impl.unmodifiable.TUnmodifiableShortCharMap

All Implemented Interfaces:: TShortCharMap, java.io.Serializable

public class TUnmodifiableShortCharMap
extends java.lang.Object
implements TShortCharMap, java.io.Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

TUnmodifiableShortCharMap(TShortCharMap m)

Constructors
Constructor and Description
`TUnmodifiableShortCharMap(TShortCharMap m)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`adjustOrPutValue(short key, char adjust_amount, char put_amount)` Adjusts the primitive value mapped to the key if the key is present in the map.
`boolean`	`adjustValue(short key, char amount)` Adjusts the primitive value mapped to key.
`void`	`clear()` Empties the map.
`boolean`	`containsKey(short key)` Checks for the present of `key` in the keys of the map.
`boolean`	`containsValue(char val)` Checks for the presence of `val` in the values of the map.
`boolean`	`equals(java.lang.Object o)`
`boolean`	`forEachEntry(TShortCharProcedure procedure)` Executes `procedure` for each key/value entry in the map.
`boolean`	`forEachKey(TShortProcedure procedure)` Executes `procedure` for each key in the map.
`boolean`	`forEachValue(TCharProcedure procedure)` Executes `procedure` for each value in the map.
`char`	`get(short key)` Retrieves the value for `key`.
`short`	`getNoEntryKey()` Returns the value that will be returned from `TShortCharMap.get(short)` or `TShortCharMap.put(short, char)` if no entry exists for a given key.
`char`	`getNoEntryValue()` Returns the value that will be returned from `TShortCharMap.get(short)` or `TShortCharMap.put(short, char)` if no entry exists for a given key.
`int`	`hashCode()`
`boolean`	`increment(short key)` Increments the primitive value mapped to key by 1
`boolean`	`isEmpty()` Returns `true` if this map contains no key-value mappings.
`TShortCharIterator`	`iterator()`
`short[]`	`keys()` Returns the keys of the map as an array of `short` values.
`short[]`	`keys(short[] array)` Returns the keys of the map.
`TShortSet`	`keySet()` Returns the keys of the map as a `TShortSet`
`char`	`put(short key, char value)` Inserts a key/value pair into the map.
`void`	`putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> map)` Put all the entries from the given Map into this map.
`void`	`putAll(TShortCharMap m)` Put all the entries from the given map into this map.
`char`	`putIfAbsent(short key, char value)` Inserts a key/value pair into the map if the specified key is not already associated with a value.
`char`	`remove(short key)` Deletes a key/value pair from the map.
`boolean`	`retainEntries(TShortCharProcedure procedure)` Retains only those entries in the map for which the procedure returns a true value.
`int`	`size()` Returns an `int` value that is the number of elements in the map.
`java.lang.String`	`toString()`
`void`	`transformValues(TCharFunction function)` Transform the values in this map using `function`.
`TCharCollection`	`valueCollection()` Returns the values of the map as a `TCharCollection`
`char[]`	`values()` Returns the values of the map as an array of `#e#` values.
`char[]`	`values(char[] array)` Returns the values of the map using an existing array.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TUnmodifiableShortCharMap
```
public TUnmodifiableShortCharMap(TShortCharMap m)
```
- Method Detail
  - size
```
public int size()
```
    Description copied from interface: TShortCharMap
    
    Returns an int value that is the number of elements in the map.
    
    Specified by:
    
    size in interface TShortCharMap
    
    Returns:
    
    an int value that is the number of elements in the map.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: TShortCharMap
    
    Returns true if this map contains no key-value mappings.
    
    Specified by:
    
    isEmpty in interface TShortCharMap
    
    Returns:
    
    true if this map contains no key-value mappings
  - containsKey
```
public boolean containsKey(short key)
```
    Description copied from interface: TShortCharMap
    
    Checks for the present of key in the keys of the map.
    
    Specified by:
    
    containsKey in interface TShortCharMap
  - containsValue
```
public boolean containsValue(char val)
```
    Description copied from interface: TShortCharMap
    
    Checks for the presence of val in the values of the map.
    
    Specified by:
    
    containsValue in interface TShortCharMap
  - get
```
public char get(short key)
```
    Description copied from interface: TShortCharMap
    
    Retrieves the value for key.
    
    Specified by:
    
    get in interface TShortCharMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TShortCharMap.getNoEntryValue()).
  - put
```
public char put(short key,
                char value)
```
    Description copied from interface: TShortCharMap
    
    Inserts a key/value pair into the map.
    
    Specified by:
    
    put in interface TShortCharMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TShortCharMap.getNoEntryValue()).
  - remove
```
public char remove(short key)
```
    Description copied from interface: TShortCharMap
    
    Deletes a key/value pair from the map.
    
    Specified by:
    
    remove in interface TShortCharMap
    
    Parameters:
    
    key - an short value
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TShortCharMap.getNoEntryValue()).
  - putAll
```
public void putAll(TShortCharMap m)
```
    Description copied from interface: TShortCharMap
    
    Put all the entries from the given map into this map.
    
    Specified by:
    
    putAll in interface TShortCharMap
    
    Parameters:
    
    m - The map from which entries will be obtained to put into this map.
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> map)
```
    Description copied from interface: TShortCharMap
    
    Put all the entries from the given Map into this map.
    
    Specified by:
    
    putAll in interface TShortCharMap
    
    Parameters:
    
    map - The Map from which entries will be obtained to put into this map.
  - clear
```
public void clear()
```
    Description copied from interface: TShortCharMap
    
    Empties the map.
    
    Specified by:
    
    clear in interface TShortCharMap
  - keySet
```
public TShortSet keySet()
```
    Description copied from interface: TShortCharMap
    
    Returns the keys of the map as a TShortSet
    
    Specified by:
    
    keySet in interface TShortCharMap
    
    Returns:
    
    the keys of the map as a TShortSet
  - keys
```
public short[] keys()
```
    Description copied from interface: TShortCharMap
    
    Returns the keys of the map as an array of short values.
    
    Specified by:
    
    keys in interface TShortCharMap
    
    Returns:
    
    the keys of the map as an array of short values.
  - keys
```
public short[] keys(short[] array)
```
    Description copied from interface: TShortCharMap
    
    Returns the keys of the map.
    
    Specified by:
    
    keys in interface TShortCharMap
    
    Parameters:
    
    array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
    
    Returns:
    
    the keys of the map as an array.
  - valueCollection
```
public TCharCollection valueCollection()
```
    Description copied from interface: TShortCharMap
    
    Returns the values of the map as a TCharCollection
    
    Specified by:
    
    valueCollection in interface TShortCharMap
    
    Returns:
    
    the values of the map as a TCharCollection
  - values
```
public char[] values()
```
    Description copied from interface: TShortCharMap
    
    Returns the values of the map as an array of #e# values.
    
    Specified by:
    
    values in interface TShortCharMap
    
    Returns:
    
    the values of the map as an array of #e# values.
  - values
```
public char[] values(char[] array)
```
    Description copied from interface: TShortCharMap
    
    Returns the values of the map using an existing array.
    
    Specified by:
    
    values in interface TShortCharMap
    
    Parameters:
    
    array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
    
    Returns:
    
    the values of the map as an array of #e# values.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getNoEntryKey
```
public short getNoEntryKey()
```
    Description copied from interface: TShortCharMap
    
    Returns the value that will be returned from TShortCharMap.get(short) or TShortCharMap.put(short, char) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
    
    Specified by:
    
    getNoEntryKey in interface TShortCharMap
    
    Returns:
    
    the value that represents a null key in this collection.
  - getNoEntryValue
```
public char getNoEntryValue()
```
    Description copied from interface: TShortCharMap
    
    Returns the value that will be returned from TShortCharMap.get(short) or TShortCharMap.put(short, char) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
    
    Specified by:
    
    getNoEntryValue in interface TShortCharMap
    
    Returns:
    
    the value that represents a null value in this collection.
  - forEachKey
```
public boolean forEachKey(TShortProcedure procedure)
```
    Description copied from interface: TShortCharMap
    
    Executes procedure for each key in the map.
    
    Specified by:
    
    forEachKey in interface TShortCharMap
    
    Parameters:
    
    procedure - a TShortProcedure value
    
    Returns:
    
    false if the loop over the keys terminated because the procedure returned false for some key.
  - forEachValue
```
public boolean forEachValue(TCharProcedure procedure)
```
    Description copied from interface: TShortCharMap
    
    Executes procedure for each value in the map.
    
    Specified by:
    
    forEachValue in interface TShortCharMap
    
    Parameters:
    
    procedure - a T#F#Procedure value
    
    Returns:
    
    false if the loop over the values terminated because the procedure returned false for some value.
  - forEachEntry
```
public boolean forEachEntry(TShortCharProcedure procedure)
```
    Description copied from interface: TShortCharMap
    
    Executes procedure for each key/value entry in the map.
    
    Specified by:
    
    forEachEntry in interface TShortCharMap
    
    Parameters:
    
    procedure - a TOShortCharProcedure value
    
    Returns:
    
    false if the loop over the entries terminated because the procedure returned false for some entry.
  - iterator
```
public TShortCharIterator iterator()
```
    Specified by:
    
    iterator in interface TShortCharMap
    
    Returns:
    
    a TShortCharIterator with access to this map's keys and values
  - putIfAbsent
```
public char putIfAbsent(short key,
                        char value)
```
    Description copied from interface: TShortCharMap
    
    Inserts a key/value pair into the map if the specified key is not already associated with a value.
    
    Specified by:
    
    putIfAbsent in interface TShortCharMap
    
    Returns:
    
    the previous value associated with key, or the "no entry" value if none was found (see TShortCharMap.getNoEntryValue()).
  - transformValues
```
public void transformValues(TCharFunction function)
```
    Description copied from interface: TShortCharMap
    
    Transform the values in this map using function.
    
    Specified by:
    
    transformValues in interface TShortCharMap
    
    Parameters:
    
    function - a TCharFunction value
  - retainEntries
```
public boolean retainEntries(TShortCharProcedure procedure)
```
    Description copied from interface: TShortCharMap
    
    Retains only those entries in the map for which the procedure returns a true value.
    
    Specified by:
    
    retainEntries in interface TShortCharMap
    
    Parameters:
    
    procedure - determines which entries to keep
    
    Returns:
    
    true if the map was modified.
  - increment
```
public boolean increment(short key)
```
    Description copied from interface: TShortCharMap
    
    Increments the primitive value mapped to key by 1
    
    Specified by:
    
    increment in interface TShortCharMap
    
    Parameters:
    
    key - the key of the value to increment
    
    Returns:
    
    true if a mapping was found and modified.
  - adjustValue
```
public boolean adjustValue(short key,
                           char amount)
```
    Description copied from interface: TShortCharMap
    
    Adjusts the primitive value mapped to key.
    
    Specified by:
    
    adjustValue in interface TShortCharMap
    
    Parameters:
    
    key - the key of the value to increment
    
    amount - the amount to adjust the value by.
    
    Returns:
    
    true if a mapping was found and modified.
  - adjustOrPutValue
```
public char adjustOrPutValue(short key,
                             char adjust_amount,
                             char put_amount)
```
    Description copied from interface: TShortCharMap
    
    Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.
    
    Specified by:
    
    adjustOrPutValue in interface TShortCharMap
    
    Parameters:
    
    key - the key of the value to increment
    
    adjust_amount - the amount to adjust the value by
    
    put_amount - the value put into the map if the key is not present
    
    Returns:
    
    the value present in the map after the adjustment or put operation

Class TUnmodifiableShortCharMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TUnmodifiableShortCharMap

Method Detail

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

putAll

clear

keySet

keys

keys

valueCollection

values

values

equals

hashCode

toString

getNoEntryKey

getNoEntryValue

forEachKey

forEachValue

forEachEntry

iterator

putIfAbsent

transformValues

retainEntries

increment

adjustValue

adjustOrPutValue