IntCharHashMap (GS Collections

java.lang.Object
- com.gs.collections.impl.map.mutable.primitive.IntCharHashMap

All Implemented Interfaces:

CharIterable, IntCharMap, MutableIntCharMap, PrimitiveIterable, Externalizable, Serializable
```
public class IntCharHashMap
extends Object
implements MutableIntCharMap, Externalizable
```
This file was automatically generated from template file primitivePrimitiveHashMap.stg.

Since:

3.0.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IntCharHashMap()

IntCharHashMap(int initialCapacity)

IntCharHashMap(IntCharMap map)

Constructors
Constructor and Description
`IntCharHashMap()`
`IntCharHashMap(int initialCapacity)`
`IntCharHashMap(IntCharMap map)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`addToValue(int key, char toBeAdded)`
`boolean`	`allSatisfy(CharPredicate predicate)`
`boolean`	`anySatisfy(CharPredicate predicate)`
`void`	`appendString(Appendable appendable)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String separator)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String start, String separator, String end)` Prints a string representation of this collection onto the given `Appendable`.
`LazyCharIterable`	`asLazy()`
`MutableIntCharMap`	`asSynchronized()`
`MutableIntCharMap`	`asUnmodifiable()`
`double`	`average()`
`CharIterator`	`charIterator()`
`void`	`clear()`
`<V> MutableCollection<V>`	`collect(CharToObjectFunction<? extends V> function)`
`void`	`compact()` Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
`boolean`	`contains(char value)`
`boolean`	`containsAll(char... source)`
`boolean`	`containsAll(CharIterable source)`
`boolean`	`containsKey(int key)`
`boolean`	`containsValue(char value)`
`int`	`count(CharPredicate predicate)`
`char`	`detectIfNone(CharPredicate predicate, char value)`
`boolean`	`equals(Object obj)` Follows the same general contract as `Map.equals(Object)`.
`void`	`forEach(CharProcedure procedure)`
`void`	`forEachKey(IntProcedure procedure)`
`void`	`forEachKeyValue(IntCharProcedure procedure)`
`void`	`forEachValue(CharProcedure procedure)`
`char`	`get(int key)`
`char`	`getIfAbsent(int key, char ifAbsent)`
`char`	`getIfAbsentPut(int key, char value)`
`char`	`getIfAbsentPut(int key, CharFunction0 function)`
`<P> char`	`getIfAbsentPutWith(int key, CharFunction<? super P> function, P parameter)`
`char`	`getIfAbsentPutWithKey(int key, IntToCharFunction function)`
`char`	`getOrThrow(int key)`
`int`	`hashCode()` Follows the same general contract as `Map.hashCode()`.
`<V> V`	`injectInto(V injectedValue, ObjectCharToObjectFunction<? super V,? extends V> function)`
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`MutableIntSet`	`keySet()`
`LazyIntIterable`	`keysView()`
`RichIterable<IntCharPair>`	`keyValuesView()`
`String`	`makeString()` Returns a string representation of this collection by delegating to `PrimitiveIterable.makeString(String)` and defaulting the separator parameter to the characters `", "` (comma and space).
`String`	`makeString(String separator)` Returns a string representation of this collection by delegating to `PrimitiveIterable.makeString(String, String, String)` and defaulting the start and end parameters to `""` (the empty String).
`String`	`makeString(String start, String separator, String end)` Returns a string representation of this collection.
`char`	`max()`
`char`	`maxIfEmpty(char defaultValue)`
`double`	`median()`
`char`	`min()`
`char`	`minIfEmpty(char defaultValue)`
`static IntCharHashMap`	`newWithKeysValues(int key1, char value1)`
`static IntCharHashMap`	`newWithKeysValues(int key1, char value1, int key2, char value2)`
`static IntCharHashMap`	`newWithKeysValues(int key1, char value1, int key2, char value2, int key3, char value3)`
`static IntCharHashMap`	`newWithKeysValues(int key1, char value1, int key2, char value2, int key3, char value3, int key4, char value4)`
`boolean`	`noneSatisfy(CharPredicate predicate)`
`boolean`	`notEmpty()` The English equivalent of !this.isEmpty()
`void`	`put(int key, char value)`
`void`	`putAll(IntCharMap map)`
`void`	`readExternal(ObjectInput in)`
`MutableCharCollection`	`reject(CharPredicate predicate)`
`IntCharHashMap`	`reject(IntCharPredicate predicate)`
`void`	`remove(int key)`
`void`	`removeKey(int key)`
`char`	`removeKeyIfAbsent(int key, char value)`
`MutableCharCollection`	`select(CharPredicate predicate)`
`IntCharHashMap`	`select(IntCharPredicate predicate)`
`int`	`size()` Returns the number of items in this iterable.
`long`	`sum()`
`char[]`	`toArray()`
`MutableCharBag`	`toBag()`
`ImmutableIntCharMap`	`toImmutable()`
`MutableCharList`	`toList()`
`MutableCharSet`	`toSet()`
`char[]`	`toSortedArray()`
`MutableCharList`	`toSortedList()`
`String`	`toString()` Returns a string representation of this IntCharMap.
`char`	`updateValue(int key, char initialValueIfAbsent, CharToCharFunction function)`
`MutableCharCollection`	`values()`
`IntCharHashMap`	`withKeysValues(int key1, char value1, int key2, char value2)`
`IntCharHashMap`	`withKeysValues(int key1, char value1, int key2, char value2, int key3, char value3)`
`IntCharHashMap`	`withKeysValues(int key1, char value1, int key2, char value2, int key3, char value3, int key4, char value4)`
`IntCharHashMap`	`withKeyValue(int key1, char value1)`
`IntCharHashMap`	`withoutAllKeys(IntIterable keys)`
`IntCharHashMap`	`withoutKey(int key)`
`void`	`writeExternal(ObjectOutput out)`

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

- Constructor Detail
  - IntCharHashMap
```
public IntCharHashMap()
```
  - IntCharHashMap
```
public IntCharHashMap(int initialCapacity)
```
  - IntCharHashMap
```
public IntCharHashMap(IntCharMap map)
```
- Method Detail
  - newWithKeysValues
```
public static IntCharHashMap newWithKeysValues(int key1,
                                               char value1)
```
  - newWithKeysValues
```
public static IntCharHashMap newWithKeysValues(int key1,
                                               char value1,
                                               int key2,
                                               char value2)
```
  - newWithKeysValues
```
public static IntCharHashMap newWithKeysValues(int key1,
                                               char value1,
                                               int key2,
                                               char value2,
                                               int key3,
                                               char value3)
```
  - newWithKeysValues
```
public static IntCharHashMap newWithKeysValues(int key1,
                                               char value1,
                                               int key2,
                                               char value2,
                                               int key3,
                                               char value3,
                                               int key4,
                                               char value4)
```
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: IntCharMap
    
    Follows the same general contract as Map.equals(Object).
    
    Specified by:
    
    equals in interface IntCharMap
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Description copied from interface: IntCharMap
    
    Follows the same general contract as Map.hashCode().
    
    Specified by:
    
    hashCode in interface IntCharMap
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Description copied from interface: IntCharMap
    
    Returns a string representation of this IntCharMap. The string representation consists of a list of the map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs are separated by the characters ", " (comma and space). Keys and values are converted to strings as by String#valueOf().
    
    Specified by:
    
    toString in interface IntCharMap
    
    Specified by:
    
    toString in interface PrimitiveIterable
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this IntCharMap
  - size
```
public int size()
```
    Description copied from interface: PrimitiveIterable
    
    Returns the number of items in this iterable.
    
    Specified by:
    
    size in interface PrimitiveIterable
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: PrimitiveIterable
    
    Returns true if this iterable has zero items.
    
    Specified by:
    
    isEmpty in interface PrimitiveIterable
  - notEmpty
```
public boolean notEmpty()
```
    Description copied from interface: PrimitiveIterable
    
    The English equivalent of !this.isEmpty()
    
    Specified by:
    
    notEmpty in interface PrimitiveIterable
  - makeString
```
public String makeString()
```
    Description copied from interface: PrimitiveIterable
    
    Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
    
    Specified by:
    
    makeString in interface PrimitiveIterable
    
    Returns:
    
    a string representation of this collection.
  - makeString
```
public String makeString(String separator)
```
    Description copied from interface: PrimitiveIterable
    
    Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
    
    Specified by:
    
    makeString in interface PrimitiveIterable
    
    Returns:
    
    a string representation of this collection.
  - makeString
```
public String makeString(String start,
                         String separator,
                         String end)
```
    Description copied from interface: PrimitiveIterable
    
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings using the appropriate version of String.valueOf().
    
    Specified by:
    
    makeString in interface PrimitiveIterable
    
    Returns:
    
    a string representation of this collection.
  - appendString
```
public void appendString(Appendable appendable)
```
    Description copied from interface: PrimitiveIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().
    
    Specified by:
    
    appendString in interface PrimitiveIterable
  - appendString
```
public void appendString(Appendable appendable,
                         String separator)
```
    Description copied from interface: PrimitiveIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).
    
    Specified by:
    
    appendString in interface PrimitiveIterable
  - appendString
```
public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         String end)
```
    Description copied from interface: PrimitiveIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).
    
    Specified by:
    
    appendString in interface PrimitiveIterable
  - charIterator
```
public CharIterator charIterator()
```
    Specified by:
    
    charIterator in interface CharIterable
  - toArray
```
public char[] toArray()
```
    Specified by:
    
    toArray in interface CharIterable
  - contains
```
public boolean contains(char value)
```
    Specified by:
    
    contains in interface CharIterable
  - containsAll
```
public boolean containsAll(char... source)
```
    Specified by:
    
    containsAll in interface CharIterable
  - containsAll
```
public boolean containsAll(CharIterable source)
```
    Specified by:
    
    containsAll in interface CharIterable
  - forEach
```
public void forEach(CharProcedure procedure)
```
    Specified by:
    
    forEach in interface CharIterable
  - select
```
public MutableCharCollection select(CharPredicate predicate)
```
    Specified by:
    
    select in interface CharIterable
    
    Specified by:
    
    select in interface MutableIntCharMap
  - reject
```
public MutableCharCollection reject(CharPredicate predicate)
```
    Specified by:
    
    reject in interface CharIterable
    
    Specified by:
    
    reject in interface MutableIntCharMap
  - collect
```
public <V> MutableCollection<V> collect(CharToObjectFunction<? extends V> function)
```
    Specified by:
    
    collect in interface CharIterable
    
    Specified by:
    
    collect in interface MutableIntCharMap
  - detectIfNone
```
public char detectIfNone(CharPredicate predicate,
                         char value)
```
    Specified by:
    
    detectIfNone in interface CharIterable
  - count
```
public int count(CharPredicate predicate)
```
    Specified by:
    
    count in interface CharIterable
  - anySatisfy
```
public boolean anySatisfy(CharPredicate predicate)
```
    Specified by:
    
    anySatisfy in interface CharIterable
  - allSatisfy
```
public boolean allSatisfy(CharPredicate predicate)
```
    Specified by:
    
    allSatisfy in interface CharIterable
  - noneSatisfy
```
public boolean noneSatisfy(CharPredicate predicate)
```
    Specified by:
    
    noneSatisfy in interface CharIterable
  - injectInto
```
public <V> V injectInto(V injectedValue,
                        ObjectCharToObjectFunction<? super V,? extends V> function)
```
    Specified by:
    
    injectInto in interface CharIterable
  - toList
```
public MutableCharList toList()
```
    Specified by:
    
    toList in interface CharIterable
  - toSet
```
public MutableCharSet toSet()
```
    Specified by:
    
    toSet in interface CharIterable
  - toBag
```
public MutableCharBag toBag()
```
    Specified by:
    
    toBag in interface CharIterable
  - asLazy
```
public LazyCharIterable asLazy()
```
    Specified by:
    
    asLazy in interface CharIterable
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface MutableIntCharMap
  - put
```
public void put(int key,
                char value)
```
    Specified by:
    
    put in interface MutableIntCharMap
  - putAll
```
public void putAll(IntCharMap map)
```
    Specified by:
    
    putAll in interface MutableIntCharMap
  - removeKey
```
public void removeKey(int key)
```
    Specified by:
    
    removeKey in interface MutableIntCharMap
  - remove
```
public void remove(int key)
```
    Specified by:
    
    remove in interface MutableIntCharMap
  - removeKeyIfAbsent
```
public char removeKeyIfAbsent(int key,
                              char value)
```
    Specified by:
    
    removeKeyIfAbsent in interface MutableIntCharMap
  - getIfAbsentPut
```
public char getIfAbsentPut(int key,
                           char value)
```
    Specified by:
    
    getIfAbsentPut in interface MutableIntCharMap
  - getIfAbsentPut
```
public char getIfAbsentPut(int key,
                           CharFunction0 function)
```
    Specified by:
    
    getIfAbsentPut in interface MutableIntCharMap
  - getIfAbsentPutWith
```
public <P> char getIfAbsentPutWith(int key,
                                   CharFunction<? super P> function,
                                   P parameter)
```
    Specified by:
    
    getIfAbsentPutWith in interface MutableIntCharMap
  - getIfAbsentPutWithKey
```
public char getIfAbsentPutWithKey(int key,
                                  IntToCharFunction function)
```
    Specified by:
    
    getIfAbsentPutWithKey in interface MutableIntCharMap
  - addToValue
```
public char addToValue(int key,
                       char toBeAdded)
```
    Specified by:
    
    addToValue in interface MutableIntCharMap
  - updateValue
```
public char updateValue(int key,
                        char initialValueIfAbsent,
                        CharToCharFunction function)
```
    Specified by:
    
    updateValue in interface MutableIntCharMap
  - withKeyValue
```
public IntCharHashMap withKeyValue(int key1,
                                   char value1)
```
    Specified by:
    
    withKeyValue in interface MutableIntCharMap
  - withKeysValues
```
public IntCharHashMap withKeysValues(int key1,
                                     char value1,
                                     int key2,
                                     char value2)
```
  - withKeysValues
```
public IntCharHashMap withKeysValues(int key1,
                                     char value1,
                                     int key2,
                                     char value2,
                                     int key3,
                                     char value3)
```
  - withKeysValues
```
public IntCharHashMap withKeysValues(int key1,
                                     char value1,
                                     int key2,
                                     char value2,
                                     int key3,
                                     char value3,
                                     int key4,
                                     char value4)
```
  - withoutKey
```
public IntCharHashMap withoutKey(int key)
```
    Specified by:
    
    withoutKey in interface MutableIntCharMap
  - withoutAllKeys
```
public IntCharHashMap withoutAllKeys(IntIterable keys)
```
    Specified by:
    
    withoutAllKeys in interface MutableIntCharMap
  - asUnmodifiable
```
public MutableIntCharMap asUnmodifiable()
```
    Specified by:
    
    asUnmodifiable in interface MutableIntCharMap
  - asSynchronized
```
public MutableIntCharMap asSynchronized()
```
    Specified by:
    
    asSynchronized in interface MutableIntCharMap
  - toImmutable
```
public ImmutableIntCharMap toImmutable()
```
    Specified by:
    
    toImmutable in interface IntCharMap
  - get
```
public char get(int key)
```
    Specified by:
    
    get in interface IntCharMap
  - getIfAbsent
```
public char getIfAbsent(int key,
                        char ifAbsent)
```
    Specified by:
    
    getIfAbsent in interface IntCharMap
  - getOrThrow
```
public char getOrThrow(int key)
```
    Specified by:
    
    getOrThrow in interface IntCharMap
  - containsKey
```
public boolean containsKey(int key)
```
    Specified by:
    
    containsKey in interface IntCharMap
  - containsValue
```
public boolean containsValue(char value)
```
    Specified by:
    
    containsValue in interface IntCharMap
  - forEachValue
```
public void forEachValue(CharProcedure procedure)
```
    Specified by:
    
    forEachValue in interface IntCharMap
  - forEachKey
```
public void forEachKey(IntProcedure procedure)
```
    Specified by:
    
    forEachKey in interface IntCharMap
  - forEachKeyValue
```
public void forEachKeyValue(IntCharProcedure procedure)
```
    Specified by:
    
    forEachKeyValue in interface IntCharMap
  - keysView
```
public LazyIntIterable keysView()
```
    Specified by:
    
    keysView in interface IntCharMap
  - keyValuesView
```
public RichIterable<IntCharPair> keyValuesView()
```
    Specified by:
    
    keyValuesView in interface IntCharMap
  - select
```
public IntCharHashMap select(IntCharPredicate predicate)
```
    Specified by:
    
    select in interface IntCharMap
    
    Specified by:
    
    select in interface MutableIntCharMap
  - reject
```
public IntCharHashMap reject(IntCharPredicate predicate)
```
    Specified by:
    
    reject in interface IntCharMap
    
    Specified by:
    
    reject in interface MutableIntCharMap
  - sum
```
public long sum()
```
    Specified by:
    
    sum in interface CharIterable
  - max
```
public char max()
```
    Specified by:
    
    max in interface CharIterable
  - maxIfEmpty
```
public char maxIfEmpty(char defaultValue)
```
    Specified by:
    
    maxIfEmpty in interface CharIterable
  - min
```
public char min()
```
    Specified by:
    
    min in interface CharIterable
  - minIfEmpty
```
public char minIfEmpty(char defaultValue)
```
    Specified by:
    
    minIfEmpty in interface CharIterable
  - average
```
public double average()
```
    Specified by:
    
    average in interface CharIterable
  - median
```
public double median()
```
    Specified by:
    
    median in interface CharIterable
  - toSortedArray
```
public char[] toSortedArray()
```
    Specified by:
    
    toSortedArray in interface CharIterable
  - toSortedList
```
public MutableCharList toSortedList()
```
    Specified by:
    
    toSortedList in interface CharIterable
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - compact
```
public void compact()
```
    Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
  - keySet
```
public MutableIntSet keySet()
```
    Specified by:
    
    keySet in interface IntCharMap
  - values
```
public MutableCharCollection values()
```
    Specified by:
    
    values in interface IntCharMap

Class IntCharHashMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntCharHashMap

IntCharHashMap

IntCharHashMap

Method Detail

newWithKeysValues

newWithKeysValues

newWithKeysValues

newWithKeysValues

equals

hashCode

toString

size

isEmpty

notEmpty

makeString

makeString

makeString

appendString

appendString

appendString

charIterator

toArray

contains

containsAll

containsAll

forEach

select

reject

collect

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

injectInto

toList

toSet

toBag

asLazy

clear

put

putAll

removeKey

remove

removeKeyIfAbsent

getIfAbsentPut

getIfAbsentPut

getIfAbsentPutWith

getIfAbsentPutWithKey

addToValue

updateValue

withKeyValue

withKeysValues

withKeysValues

withKeysValues

withoutKey

withoutAllKeys

asUnmodifiable

asSynchronized

toImmutable

get

getIfAbsent

getOrThrow

containsKey

containsValue

forEachValue

forEachKey

forEachKeyValue

keysView

keyValuesView

select

reject

sum

max

maxIfEmpty