com.neeve.lang

Interface XMap<K,V>

All Superinterfaces:

Map<K,V>

All Known Implementing Classes:

XLinkedHashMap

public interface XMap<K,V>
extends Map<K,V>

Defines a map with reusable iterators to allow zero garbage iteration.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
XIterator<Map.Entry<K,V>>	reuseableEntryIterator() Returns a reusable value iterator.
XIterator<K>	reuseableKeyIterator() Returns a reusable key iterator.
XIterator<V>	reuseableValueIterator() Returns a reusable value iterator.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

reuseableKeyIterator

XIterator<K> 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<Map.Entry<K,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.