nova.core.util

Class Dictionary<T>

java.lang.Object

nova.core.util.Dictionary<T>

Type Parameters:

T - The object type

Direct Known Subclasses:

ItemDictionary

public class Dictionary<T>
extends java.lang.Object

A dictionary where each identifying string represents a set of objects and each object can have a set of identifiers.

Constructor Summary

Constructors

Constructor and Description
Dictionary()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, T... objects) Add multiple objects to the dictionary.
void	add(java.lang.String key, T object) Add an object to the dictionary.
java.util.Set<java.lang.String>	find(T object) Find the names of a given object.
void	forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.util.Set<T>> action)
java.util.Set<T>	get(java.lang.String name) Get an object set from the dictionary.
java.util.Set<java.lang.String>	keys() Gets a Set view of the names in this dictionary.
java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Set<T>>>	parallelStream()
void	remove(java.lang.String key, T... objects) Removes multiple objects from the dictionary.
void	remove(java.lang.String key, T object) Removes an object from the dictionary.
void	removeAll(java.lang.String key) Removes all objects from the dictionary registered for the key.
java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Set<T>>>	stream()
EventListenerHandle<DictionaryEvent.Add<T>>	whenEntryAdded(EventListener<DictionaryEvent.Add<T>> listener)
EventListenerHandle<DictionaryEvent.Remove<T>>	whenEntryRemoved(EventListener<DictionaryEvent.Remove<T>> listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

Dictionary

public Dictionary()

Method Detail

add

public void add(java.lang.String key,
                T object)

Add an object to the dictionary.

Parameters:

key - the name of the object.

object - the object to register.

add

public void add(java.lang.String key,
                T... objects)

Add multiple objects to the dictionary.

Parameters:

key - the name of the object.

objects - the objects to register.

remove

public void remove(java.lang.String key,
                   T object)

Removes an object from the dictionary.

Parameters:

key - the name of the object.

object - the object to remove.

remove

public void remove(java.lang.String key,
                   T... objects)

Removes multiple objects from the dictionary.

Parameters:

key - the name of the object.

objects - the objects to remove.

removeAll

public void removeAll(java.lang.String key)

Removes all objects from the dictionary registered for the key.

Parameters:

key - the name of the objects

get

public java.util.Set<T> get(java.lang.String name)

Get an object set from the dictionary.

Parameters:

name - the dictionary name.

Returns:

the list of objects.

find

public java.util.Set<java.lang.String> find(T object)

Find the names of a given object.

Parameters:

object - the object to find.

Returns:

the list of names this object is identified by

keys

public java.util.Set<java.lang.String> keys()

Gets a Set view of the names in this dictionary. This view is backed by the dictionary, but it cannot be used to modify the dictionary. To do that use either remove(String, T) or removeAll(String).

Returns:

a Set view of the names in this dictionary.

forEach

public void forEach(java.util.function.BiConsumer<? super java.lang.String,? super java.util.Set<T>> action)

stream

public java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Set<T>>> stream()

parallelStream

public java.util.stream.Stream<java.util.Map.Entry<java.lang.String,java.util.Set<T>>> parallelStream()

whenEntryAdded

public EventListenerHandle<DictionaryEvent.Add<T>> whenEntryAdded(EventListener<DictionaryEvent.Add<T>> listener)

whenEntryRemoved

public EventListenerHandle<DictionaryEvent.Remove<T>> whenEntryRemoved(EventListener<DictionaryEvent.Remove<T>> listener)