ShortCharHashMap (GS Collections

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

All Implemented Interfaces:

CharIterable, MutableShortCharMap, ShortCharMap, PrimitiveIterable, Externalizable, Serializable
```
public class ShortCharHashMap
extends Object
implements MutableShortCharMap, Externalizable
```
This file was automatically generated from template file primitivePrimitiveHashMap.stg.

Since:

3.0.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ShortCharHashMap()

ShortCharHashMap(int initialCapacity)

ShortCharHashMap(ShortCharMap map)

Constructors
Constructor and Description
`ShortCharHashMap()`
`ShortCharHashMap(int initialCapacity)`
`ShortCharHashMap(ShortCharMap map)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`addToValue(short 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()`
`MutableShortCharMap`	`asSynchronized()`
`MutableShortCharMap`	`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(short 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(ShortProcedure procedure)`
`void`	`forEachKeyValue(ShortCharProcedure procedure)`
`void`	`forEachValue(CharProcedure procedure)`
`char`	`get(short key)`
`char`	`getIfAbsent(short key, char ifAbsent)`
`char`	`getIfAbsentPut(short key, char value)`
`char`	`getIfAbsentPut(short key, CharFunction0 function)`
`<P> char`	`getIfAbsentPutWith(short key, CharFunction<? super P> function, P parameter)`
`char`	`getIfAbsentPutWithKey(short key, ShortToCharFunction function)`
`char`	`getOrThrow(short 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.
`MutableShortSet`	`keySet()`
`LazyShortIterable`	`keysView()`
`RichIterable<ShortCharPair>`	`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 ShortCharHashMap`	`newWithKeysValues(short key1, char value1)`
`static ShortCharHashMap`	`newWithKeysValues(short key1, char value1, short key2, char value2)`
`static ShortCharHashMap`	`newWithKeysValues(short key1, char value1, short key2, char value2, short key3, char value3)`
`static ShortCharHashMap`	`newWithKeysValues(short key1, char value1, short key2, char value2, short key3, char value3, short key4, char value4)`
`boolean`	`noneSatisfy(CharPredicate predicate)`
`boolean`	`notEmpty()` The English equivalent of !this.isEmpty()
`void`	`put(short key, char value)`
`void`	`putAll(ShortCharMap map)`
`void`	`readExternal(ObjectInput in)`
`MutableCharCollection`	`reject(CharPredicate predicate)`
`ShortCharHashMap`	`reject(ShortCharPredicate predicate)`
`void`	`remove(short key)`
`void`	`removeKey(short key)`
`char`	`removeKeyIfAbsent(short key, char value)`
`MutableCharCollection`	`select(CharPredicate predicate)`
`ShortCharHashMap`	`select(ShortCharPredicate predicate)`
`int`	`size()` Returns the number of items in this iterable.
`long`	`sum()`
`char[]`	`toArray()`
`MutableCharBag`	`toBag()`
`ImmutableShortCharMap`	`toImmutable()`
`MutableCharList`	`toList()`
`MutableCharSet`	`toSet()`
`char[]`	`toSortedArray()`
`MutableCharList`	`toSortedList()`
`String`	`toString()` Returns a string representation of this ShortCharMap.
`char`	`updateValue(short key, char initialValueIfAbsent, CharToCharFunction function)`
`MutableCharCollection`	`values()`
`ShortCharHashMap`	`withKeysValues(short key1, char value1, short key2, char value2)`
`ShortCharHashMap`	`withKeysValues(short key1, char value1, short key2, char value2, short key3, char value3)`
`ShortCharHashMap`	`withKeysValues(short key1, char value1, short key2, char value2, short key3, char value3, short key4, char value4)`
`ShortCharHashMap`	`withKeyValue(short key1, char value1)`
`ShortCharHashMap`	`withoutAllKeys(ShortIterable keys)`
`ShortCharHashMap`	`withoutKey(short key)`
`void`	`writeExternal(ObjectOutput out)`

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

- Constructor Detail
  - ShortCharHashMap
```
public ShortCharHashMap()
```
  - ShortCharHashMap
```
public ShortCharHashMap(int initialCapacity)
```
  - ShortCharHashMap
```
public ShortCharHashMap(ShortCharMap map)
```
- Method Detail
  - newWithKeysValues
```
public static ShortCharHashMap newWithKeysValues(short key1,
                                                 char value1)
```
  - newWithKeysValues
```
public static ShortCharHashMap newWithKeysValues(short key1,
                                                 char value1,
                                                 short key2,
                                                 char value2)
```
  - newWithKeysValues
```
public static ShortCharHashMap newWithKeysValues(short key1,
                                                 char value1,
                                                 short key2,
                                                 char value2,
                                                 short key3,
                                                 char value3)
```
  - newWithKeysValues
```
public static ShortCharHashMap newWithKeysValues(short key1,
                                                 char value1,
                                                 short key2,
                                                 char value2,
                                                 short key3,
                                                 char value3,
                                                 short key4,
                                                 char value4)
```
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: ShortCharMap
    
    Follows the same general contract as Map.equals(Object).
    
    Specified by:
    
    equals in interface ShortCharMap
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Description copied from interface: ShortCharMap
    
    Follows the same general contract as Map.hashCode().
    
    Specified by:
    
    hashCode in interface ShortCharMap
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Description copied from interface: ShortCharMap
    
    Returns a string representation of this ShortCharMap. 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 ShortCharMap
    
    Specified by:
    
    toString in interface PrimitiveIterable
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this ShortCharMap
  - 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 MutableShortCharMap
  - reject
```
public MutableCharCollection reject(CharPredicate predicate)
```
    Specified by:
    
    reject in interface CharIterable
    
    Specified by:
    
    reject in interface MutableShortCharMap
  - collect
```
public <V> MutableCollection<V> collect(CharToObjectFunction<? extends V> function)
```
    Specified by:
    
    collect in interface CharIterable
    
    Specified by:
    
    collect in interface MutableShortCharMap
  - 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 MutableShortCharMap
  - put
```
public void put(short key,
                char value)
```
    Specified by:
    
    put in interface MutableShortCharMap
  - putAll
```
public void putAll(ShortCharMap map)
```
    Specified by:
    
    putAll in interface MutableShortCharMap
  - removeKey
```
public void removeKey(short key)
```
    Specified by:
    
    removeKey in interface MutableShortCharMap
  - remove
```
public void remove(short key)
```
    Specified by:
    
    remove in interface MutableShortCharMap
  - removeKeyIfAbsent
```
public char removeKeyIfAbsent(short key,
                              char value)
```
    Specified by:
    
    removeKeyIfAbsent in interface MutableShortCharMap
  - getIfAbsentPut
```
public char getIfAbsentPut(short key,
                           char value)
```
    Specified by:
    
    getIfAbsentPut in interface MutableShortCharMap
  - getIfAbsentPut
```
public char getIfAbsentPut(short key,
                           CharFunction0 function)
```
    Specified by:
    
    getIfAbsentPut in interface MutableShortCharMap
  - getIfAbsentPutWith
```
public <P> char getIfAbsentPutWith(short key,
                                   CharFunction<? super P> function,
                                   P parameter)
```
    Specified by:
    
    getIfAbsentPutWith in interface MutableShortCharMap
  - getIfAbsentPutWithKey
```
public char getIfAbsentPutWithKey(short key,
                                  ShortToCharFunction function)
```
    Specified by:
    
    getIfAbsentPutWithKey in interface MutableShortCharMap
  - addToValue
```
public char addToValue(short key,
                       char toBeAdded)
```
    Specified by:
    
    addToValue in interface MutableShortCharMap
  - updateValue
```
public char updateValue(short key,
                        char initialValueIfAbsent,
                        CharToCharFunction function)
```
    Specified by:
    
    updateValue in interface MutableShortCharMap
  - withKeyValue
```
public ShortCharHashMap withKeyValue(short key1,
                                     char value1)
```
    Specified by:
    
    withKeyValue in interface MutableShortCharMap
  - withKeysValues
```
public ShortCharHashMap withKeysValues(short key1,
                                       char value1,
                                       short key2,
                                       char value2)
```
  - withKeysValues
```
public ShortCharHashMap withKeysValues(short key1,
                                       char value1,
                                       short key2,
                                       char value2,
                                       short key3,
                                       char value3)
```
  - withKeysValues
```
public ShortCharHashMap withKeysValues(short key1,
                                       char value1,
                                       short key2,
                                       char value2,
                                       short key3,
                                       char value3,
                                       short key4,
                                       char value4)
```
  - withoutKey
```
public ShortCharHashMap withoutKey(short key)
```
    Specified by:
    
    withoutKey in interface MutableShortCharMap
  - withoutAllKeys
```
public ShortCharHashMap withoutAllKeys(ShortIterable keys)
```
    Specified by:
    
    withoutAllKeys in interface MutableShortCharMap
  - asUnmodifiable
```
public MutableShortCharMap asUnmodifiable()
```
    Specified by:
    
    asUnmodifiable in interface MutableShortCharMap
  - asSynchronized
```
public MutableShortCharMap asSynchronized()
```
    Specified by:
    
    asSynchronized in interface MutableShortCharMap
  - toImmutable
```
public ImmutableShortCharMap toImmutable()
```
    Specified by:
    
    toImmutable in interface ShortCharMap
  - get
```
public char get(short key)
```
    Specified by:
    
    get in interface ShortCharMap
  - getIfAbsent
```
public char getIfAbsent(short key,
                        char ifAbsent)
```
    Specified by:
    
    getIfAbsent in interface ShortCharMap
  - getOrThrow
```
public char getOrThrow(short key)
```
    Specified by:
    
    getOrThrow in interface ShortCharMap
  - containsKey
```
public boolean containsKey(short key)
```
    Specified by:
    
    containsKey in interface ShortCharMap
  - containsValue
```
public boolean containsValue(char value)
```
    Specified by:
    
    containsValue in interface ShortCharMap
  - forEachValue
```
public void forEachValue(CharProcedure procedure)
```
    Specified by:
    
    forEachValue in interface ShortCharMap
  - forEachKey
```
public void forEachKey(ShortProcedure procedure)
```
    Specified by:
    
    forEachKey in interface ShortCharMap
  - forEachKeyValue
```
public void forEachKeyValue(ShortCharProcedure procedure)
```
    Specified by:
    
    forEachKeyValue in interface ShortCharMap
  - keysView
```
public LazyShortIterable keysView()
```
    Specified by:
    
    keysView in interface ShortCharMap
  - keyValuesView
```
public RichIterable<ShortCharPair> keyValuesView()
```
    Specified by:
    
    keyValuesView in interface ShortCharMap
  - select
```
public ShortCharHashMap select(ShortCharPredicate predicate)
```
    Specified by:
    
    select in interface MutableShortCharMap
    
    Specified by:
    
    select in interface ShortCharMap
  - reject
```
public ShortCharHashMap reject(ShortCharPredicate predicate)
```
    Specified by:
    
    reject in interface MutableShortCharMap
    
    Specified by:
    
    reject in interface ShortCharMap
  - 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 MutableShortSet keySet()
```
    Specified by:
    
    keySet in interface ShortCharMap
  - values
```
public MutableCharCollection values()
```
    Specified by:
    
    values in interface ShortCharMap

Class ShortCharHashMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShortCharHashMap

ShortCharHashMap

ShortCharHashMap

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