org.openzen.zengarden.index

Class OrderedIndex<K,V>

java.lang.Object

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

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Index<K,V>

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

Represents an ordered index. An ordered index preserves the order of values in it - multiple values for the same key will be returned in the same order as originally added.

Constructor Summary

Constructors

Constructor and Description
OrderedIndex()

Method Summary

Modifier and Type	Method and Description
java.util.List<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 a value to the index, for the given key.
void	remove(K key, V value) Removes a value from the index, for the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedIndex

public OrderedIndex()

Method Detail

put

public void put(K key,
                V value)

Adds a value to the index, for the given key.

Parameters:

key - key

value - value

remove

public void remove(K key,
                   V value)

Removes a value from the index, for the given key. Does nothing if the value is not in the index.

Parameters:

key - key

value - value

find

public java.util.List<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