com.neeve.lang

Interface XCharMap<V>

All Known Implementing Classes:

XCharLinkedHashMap

public interface XCharMap<V>

Defines a map with primitive char keys.

An XCharMap serves as an alternative to Map that can be used to avoid garbage associated with autoboxing of key values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XCharMap.Entry<V> A Map Entry with a primitive char key.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all map's entries.
boolean	containsKey(char key)
boolean	containsValue(Object value)
Set<XCharMap.Entry<V>>	entrySet() Returns a Set view of the mappings contained in this map.
boolean	equals(Object o)
V	get(char key) Returns the value to which this map associates the specified key.
int	hashCode()
boolean	isEmpty()
XCharSet	keySet() Returns a XCharSet view of the keys contained in this map.
V	put(char key, V value) Associates the specified value with the specified key in this map.
void	putAll(XCharMap<? extends V> map) Copies all of the mappings from the specified map to this map.
V	remove(char key) Removes the entry for the specified key if present.
XIterator<XCharMap.Entry<V>>	reuseableEntryIterator() Returns a reusable value iterator.
XCharIterator	reuseableKeyIterator() Returns a reusable key iterator.
XIterator<V>	reuseableValueIterator() Returns a reusable value iterator.
int	size()
Collection<V>	values() Returns a Collection view of the values contained in this map.

Method Detail

size

int size()

Returns:

The size of the map

See Also:

Map.size()

isEmpty

boolean isEmpty()

Returns:

true if the map is empty.

See Also:

Map.isEmpty()

containsKey

boolean containsKey(char key)

Returns:

true if the map contains the key

See Also:

Map.containsKey(Object)

containsValue

boolean containsValue(Object value)

Returns:

true if the map is empty.

See Also:

Map.containsValue(Object)

get

V get(char key)

Returns the value to which this map associates the specified key.

Parameters:

key - the key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key, or null if there is no mapping for the key.

See Also:

Map.get(Object)

put

V put(char key,
    V value)

Associates the specified value with the specified key in this map. If this map previously contained a mapping for this key, the old value is replaced.

Parameters:

key - the key with which the specified value is to be associated.

value - the value to be associated with the specified key.

Returns:

the previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

See Also:

Map.put(Object, Object)

remove

V remove(char key)

Removes the entry for the specified key if present. The entry is recycled..

Note: Shared maps in ImmortalMemory (e.g. static) should not remove their entries as it could cause a memory leak (ImmortalMemory is never garbage collected), instead they should set their entry values to null.

Parameters:

key - the key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

putAll

void putAll(XCharMap<? extends V> map)

Copies all of the mappings from the specified map to this map.

Parameters:

map - the mappings to be stored in this map.

Throws:

NullPointerException - the specified map is null, or the specified map contains null keys.

clear

void clear()

Removes all map's entries.

keySet

XCharSet keySet()

Returns a XCharSet view of the keys contained in this map.

The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the values contained in this map.

reuseableKeyIterator

XCharIterator reuseableKeyIterator()

Returns a reusable key iterator. This iterator may only be used by a single thread at a time. Prior to returning the iterator XIterator.toFirst() is called by this method to reset it to the beginning.

Returns:

The shared key iterator.

Throws:

UnsupportedOperationException - if the map doesn't support reusable iterators.

reuseableValueIterator

XIterator<V> reuseableValueIterator()

Returns a reusable value iterator. This iterator may only be used by a single thread at a time. Prior to returning the iterator XIterator.toFirst() is called by this method to reset it to the beginning.

Returns:

The shared key iterator.

Throws:

UnsupportedOperationException - if the map doesn't support reusable iterators.

reuseableEntryIterator

XIterator<XCharMap.Entry<V>> reuseableEntryIterator()

Returns a reusable value iterator. This iterator may only be used by a single thread at a time. Prior to returning the iterator XIterator.toFirst() is called by this method to reset it to the beginning.

Returns:

The shared key iterator.

Throws:

UnsupportedOperationException - if the map doesn't support reusable iterators.

values

Collection<V> values()

Returns a Collection view of the values contained in this map.

The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. The collection supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:

a collection view of the values contained in this map.

entrySet

Set<XCharMap.Entry<V>> entrySet()

Returns a Set view of the mappings contained in this map.

Each element in the returned set is a XCharMap.Entry. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. The set supports element removal, which removes the corresponding mapping from this map, via the Iterator.remove, Set.remove,removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:

a Set view of the mappings contained in this map.

equals

boolean equals(Object o)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object