com.moderocky.mask.api.container

Class NDimensionalHashMap<Q,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<Q[],V>

com.moderocky.mask.api.container.NDimensionalHashMap<Q,V>

Type Parameters:

Q - Key array type

V - Value type

All Implemented Interfaces:

Serializable, Cloneable, Map<Q[],V>

public class NDimensionalHashMap<Q,V>
extends HashMap<Q[],V>

A map designed to store values keyed to an array of properties. When queried, the query is done based on the property array using seperate criteria.

You are able to query for an exact match using get(Object) or instead query with a single property or collection of partially-matching properties in order to get relevant entries. See the following:

getAnyMatching(Object[]) getEntries(Object[]) getEntries(Object, int)

Remember that the N-Dimensional HashMap requires an explicit number of dimensions in order to configure the correct property array. All property key entries must be of the same length. Use null-values as individual array members if properties are unknown.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
NDimensionalHashMap(int dimensions)

Method Summary

Modifier and Type	Method and Description
V	get(Object key) Retrieve a single value based on an exact match.
@NotNull Collection<V>	getAnyMatching(Q[] properties)
int	getDimensions()
@NotNull Collection<V>	getEntries(Q[] properties)
@NotNull Collection<V>	getEntries(Q property, int position)
V	getOrDefault(Object key, V defaultValue)
V	put(Q[] key, V value)
void	putAll(Map<? extends Q[],? extends V> m)
V	putIfAbsent(Q[] key, V value)
V	replace(Q[] key, V value)
boolean	replace(Q[] key, V oldValue, V newValue)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, isEmpty, keySet, merge, remove, remove, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

NDimensionalHashMap

public NDimensionalHashMap(int dimensions)

Method Detail

get

public V get(Object key)

Retrieve a single value based on an exact match.

Specified by:

get in interface Map<Q[],V>

Overrides:

get in class HashMap<Q[],V>

Parameters:

key - An array-type of Q, with the exact length of getDimensions().

Returns:

The value, otherwise null

put

public V put(Q[] key,
             V value)

Specified by:

put in interface Map<Q[],V>

Overrides:

put in class HashMap<Q[],V>

Parameters:

key - An array-type of Q, with the exact length of getDimensions().

putAll

public void putAll(Map<? extends Q[],? extends V> m)

Specified by:

putAll in interface Map<Q[],V>

Overrides:

putAll in class HashMap<Q[],V>

getOrDefault

public V getOrDefault(Object key,
                      V defaultValue)

Specified by:

getOrDefault in interface Map<Q[],V>

Overrides:

getOrDefault in class HashMap<Q[],V>

putIfAbsent

public V putIfAbsent(Q[] key,
                     V value)

Specified by:

putIfAbsent in interface Map<Q[],V>

Overrides:

putIfAbsent in class HashMap<Q[],V>

replace

public boolean replace(Q[] key,
                       V oldValue,
                       V newValue)

Specified by:

replace in interface Map<Q[],V>

Overrides:

replace in class HashMap<Q[],V>

replace

public V replace(Q[] key,
                 V value)

Specified by:

replace in interface Map<Q[],V>

Overrides:

replace in class HashMap<Q[],V>

getDimensions

public int getDimensions()

getEntries

@NotNull
public @NotNull Collection<V> getEntries(Q property,
                                                  int position)

getEntries

@NotNull
public @NotNull Collection<V> getEntries(Q[] properties)

getAnyMatching

@NotNull
public @NotNull Collection<V> getAnyMatching(Q[] properties)