org.openzen.zengarden.index

Class UnorderedIndex<K,V>

java.lang.Object

org.openzen.zengarden.index.UnorderedIndex<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Index<K,V>

public class UnorderedIndex<K,V>
extends java.lang.Object
implements Index<K,V>

Represents an unordered index. Values are returned in no particular order. This implementation has a more efficient remove method, and returns a set instead of a list when values are looked up.

Constructor Summary

Constructors

Constructor and Description
UnorderedIndex()

Method Summary

Modifier and Type	Method and Description
java.util.Set<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.
void	put(K key, V value) Adds the given key / value pair to the index.
void	remove(K key, V value) Removes the given key / value pair from the index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UnorderedIndex

public UnorderedIndex()

Method Detail

put

public void put(K key,
                V value)

Adds the given key / value pair to the index.

Parameters:

key - key to be added

value - value to be added

remove

public void remove(K key,
                   V value)

Removes the given key / value pair from the index. Does nothing if the value is not in the index.

Parameters:

key - key to be removed

value - value to be removed

find

public java.util.Set<V> find(K key)

Description copied from interface: Index

Finds all values indexed by the given key.

Specified by:

find in interface Index<K,V>

Parameters:

key - key to find values for

Returns:

all values matching the given key

getKeys

public java.util.Set<K> getKeys()

Description copied from interface: Index

Retrieves the set of all keys.

Specified by:

getKeys in interface Index<K,V>

Returns:

key set

forEachValue

public void forEachValue(Consumer<V> consumer)

Description copied from interface: Index

Iterates over each value indexed by this index.

Specified by:

forEachValue in interface Index<K,V>

Parameters:

consumer - value consumer