org.mini2Dx.core.collections

Class CharMap<V>

java.lang.Object

org.mini2Dx.core.collections.CharMap<V>

All Implemented Interfaces:

java.lang.Iterable<CharMap.Entry<V>>

Direct Known Subclasses:

ConcurrentCharMap

public class CharMap<V>
extends java.lang.Object
implements java.lang.Iterable<CharMap.Entry<V>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharMap.Entries<V>
static class	CharMap.Entry<V>
static class	CharMap.Keys
static class	CharMap.Values<V>

Field Summary

Fields

Modifier and Type	Field and Description
int	size

Constructor Summary

Constructors

Constructor and Description
CharMap() Creates a new map with an initial capacity of 51 and a load factor of 0.8.
CharMap(CharMap<? extends V> map) Creates a new map identical to the specified map.
CharMap(int initialCapacity) Creates a new map with a load factor of 0.8.
CharMap(int initialCapacity, float loadFactor) Creates a new map with the specified initial capacity and load factor.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	clear(int maximumCapacity) Clears the map and reduces the size of the backing arrays to be the specified capacity if they are larger.
boolean	containsKey(char key)
boolean	containsValue(java.lang.Object value, boolean identity) Returns true if the specified value is in the map.
void	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
CharMap.Entries<V>	entries() Returns an iterator for the entries in the map.
boolean	equals(java.lang.Object obj)
char	findKey(java.lang.Object value, boolean identity, char notFound) Returns the key for the specified value, or notFound if it is not in the map.
V	get(char key)
V	get(char key, V defaultValue)
int	hashCode()
java.util.Iterator<CharMap.Entry<V>>	iterator()
CharMap.Keys	keys() Returns an iterator for the keys in the map.
V	put(char key, V value)
void	putAll(CharMap<V> map)
V	remove(char key)
void	shrink(int maximumCapacity) Reduces the size of the backing arrays to be the specified capacity or less.
java.lang.String	toString()
CharMap.Values<V>	values() Returns an iterator for the values in the map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

size

public int size

Constructor Detail

CharMap

public CharMap()

Creates a new map with an initial capacity of 51 and a load factor of 0.8.

CharMap

public CharMap(int initialCapacity)

Creates a new map with a load factor of 0.8.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

CharMap

public CharMap(int initialCapacity,
               float loadFactor)

Creates a new map with the specified initial capacity and load factor. This map will hold initialCapacity items before growing the backing table.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

CharMap

public CharMap(CharMap<? extends V> map)

Creates a new map identical to the specified map.

Method Detail

put

public V put(char key,
             V value)

putAll

public void putAll(CharMap<V> map)

get

public V get(char key)

get

public V get(char key,
             V defaultValue)

remove

public V remove(char key)

shrink

public void shrink(int maximumCapacity)

Reduces the size of the backing arrays to be the specified capacity or less. If the capacity is already less, nothing is done. If the map contains more items than the specified capacity, the next highest power of two capacity is used instead.

clear

public void clear(int maximumCapacity)

Clears the map and reduces the size of the backing arrays to be the specified capacity if they are larger.

clear

public void clear()

containsValue

public boolean containsValue(java.lang.Object value,
                             boolean identity)

Returns true if the specified value is in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

containsKey

public boolean containsKey(char key)

findKey

public char findKey(java.lang.Object value,
                    boolean identity,
                    char notFound)

Returns the key for the specified value, or notFound if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

Parameters:

identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

ensureCapacity

public void ensureCapacity(int additionalCapacity)

Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<CharMap.Entry<V>> iterator()

Specified by:

iterator in interface java.lang.Iterable<CharMap.Entry<V>>

entries

public CharMap.Entries<V> entries()

Returns an iterator for the entries in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the CharMap.Entries constructor for nested or multithreaded iteration.

values

public CharMap.Values<V> values()

Returns an iterator for the values in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the CharMap.Entries constructor for nested or multithreaded iteration.

keys

public CharMap.Keys keys()

Returns an iterator for the keys in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the CharMap.Entries constructor for nested or multithreaded iteration.