org.openzen.zengarden.index

Interface Index<K,V>

Type Parameters:

K - key type

V - value type

All Known Subinterfaces:

WatchedIndex<K,V>

All Known Implementing Classes:

AutoIndex, OrderedIndex, UnorderedIndex, WatchedAutoIndex

public interface Index<K,V>

Represents an index. Indexes map keys to a set of values and allow for efficient lookup as such. They are multimaps.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<V>	find(K key) Finds all values indexed by the given key.
void	forEachValue(Consumer<V> consumer) Iterates over each value indexed by this index.
java.util.Set<K>	getKeys() Retrieves the set of all keys.

Method Detail

find

java.util.Collection<V> find(K key)

Finds all values indexed by the given key.

Parameters:

key - key to find values for

Returns:

all values matching the given key

getKeys

java.util.Set<K> getKeys()

Retrieves the set of all keys.

Returns:

key set

forEachValue

void forEachValue(Consumer<V> consumer)

Iterates over each value indexed by this index.

Parameters:

consumer - value consumer