Package com.petrolpark.util

Class NestedSequenceBiMap<K,V>

java.lang.Object

com.petrolpark.util.NestedSequenceBiMap<K,V>

All Implemented Interfaces:

ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Direct Known Subclasses:

EnumSequenceBiMap

public abstract class NestedSequenceBiMap<K,V>
extends Object
implements ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NestedSequenceBiMap.Entry<K,V>

Nested classes/interfaces inherited from interface com.petrolpark.util.ISequenceBiMap

ISequenceBiMap.IEntry<K,V,S extends Iterable<K>,E extends ISequenceBiMap.IEntry<K,V,S,E,M>,M extends ISequenceBiMap<K,V,S,E,M>>

Constructor Summary

Constructors

Constructor	Description
NestedSequenceBiMap()

Method Summary

Modifier and Type	Method	Description
final V	follow(List<K> sequence)	Follow a sequence of keys until a value is found.
final NestedSequenceBiMap.Entry<K,V>	get(List<K> sequence)	Get the ISequenceBiMap.IEntry at this exact sequence position.
final NestedSequenceBiMap.Entry<K,V>	get(K key)	Get the ISequenceBiMap.IEntry associated with this key.
protected abstract Map<K,NestedSequenceBiMap.Entry<K,V>>	getEntryMap()
final List<K>	getKeySequence(V value)	Essentially a shortcut for ISequenceBiMap.getKeySequenceMap().Map.get(Object).
protected static <K, V> void	populateSequenceMap(Map<V,List<K>> sequenceMap, NestedSequenceBiMap.Entry<K,V> entry, List<K> sequence)
final Collection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.petrolpark.util.ISequenceBiMap

getKeySequenceMap

Constructor Details

NestedSequenceBiMap

public NestedSequenceBiMap()

Method Details

getEntryMap

protected abstract Map<K,NestedSequenceBiMap.Entry<K,V>> getEntryMap()

get

public final NestedSequenceBiMap.Entry<K,V> get(K key)

Description copied from interface: ISequenceBiMap

Get the ISequenceBiMap.IEntry associated with this key. Equivalently, the ISequenceBiMap.IEntry associated with the sequence of length 1 containing this key.

Specified by:

get in interface ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Parameters:

key -

Returns:

null if no ISequenceBiMap.IEntry exists

get

public final NestedSequenceBiMap.Entry<K,V> get(List<K> sequence)

Description copied from interface: ISequenceBiMap

Get the ISequenceBiMap.IEntry at this exact sequence position.

Specified by:

get in interface ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Parameters:

sequence - Not mutated

Returns:

ISequenceBiMap.IEntry or null if no entry exists with that sequence.

See Also:

• ISequenceBiMap.follow(Iterable)

follow

public final V follow(List<K> sequence)

Description copied from interface: ISequenceBiMap

Follow a sequence of keys until a value is found. A key is taken off the start of the sequence and used to find the ISequenceBiMap.IEntry there. If this ISequenceBiMap.IEntry is a value, this is returned. If it is a sub-map, then the process is repeated with the next key.

Specified by:

follow in interface ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Parameters:

sequence - This is shortened by this operation

Returns:

The value found by following the sequence of keys, or null if the sequence reaches a dead end, or the sequence runs out before a value is found.

See Also:

• ISequenceBiMap.get(Iterable)

getKeySequence

public final List<K> getKeySequence(V value)

Description copied from interface: ISequenceBiMap

Essentially a shortcut for ISequenceBiMap.getKeySequenceMap().Map.get(Object).

Specified by:

getKeySequence in interface ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

Parameters:

value -

Returns:

The sequence such that get(sequence) == value, or null if that value is not in this Map

See Also:

• ISequenceBiMap.getKeySequenceMap()

values

public final Collection<V> values()

Specified by:

values in interface ISequenceBiMap<K,V,List<K>,NestedSequenceBiMap.Entry<K,V>,NestedSequenceBiMap<K,V>>

populateSequenceMap

protected static <K,
V> void populateSequenceMap(Map<V,List<K>> sequenceMap,
 NestedSequenceBiMap.Entry<K,V> entry,
 List<K> sequence)