Package net.minecraftforge.common.util

Class MutableHashedLinkedMap<K,V>

java.lang.Object

net.minecraftforge.common.util.MutableHashedLinkedMap<K,V>

Type Parameters:

K - the type of keys

V - the type of mapped values

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>

public class MutableHashedLinkedMap<K,V>
extends Object
implements Iterable<Map.Entry<K,V>>

A mutable linked map with a hashing strategy and a merge function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MutableHashedLinkedMap.BasicStrategy
private class	MutableHashedLinkedMap.Entry
private static class	MutableHashedLinkedMap.IdentityStrategy
static interface	MutableHashedLinkedMap.MergeFunction<Key,Value>

Field Summary

Fields

Modifier and Type	Field	Description
static final it.unimi.dsi.fastutil.Hash.Strategy<? super Object>	BASIC	A strategy that uses Objects.hashCode(Object) and Object.equals(Object).
private int	changes
private final Map<K,MutableHashedLinkedMap<K,V>.Entry>	entries
private MutableHashedLinkedMap<K,V>.Entry	head
static final it.unimi.dsi.fastutil.Hash.Strategy<? super Object>	IDENTITY	A strategy that uses System.identityHashCode(Object) and a == b comparisons.
private MutableHashedLinkedMap<K,V>.Entry	last
private final MutableHashedLinkedMap.MergeFunction<K,V>	merge
private final it.unimi.dsi.fastutil.Hash.Strategy<? super K>	strategy

Constructor Summary

Constructors

Constructor	Description
MutableHashedLinkedMap()	Creates a new instance using the BASIC strategy.
MutableHashedLinkedMap(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)	Creates a mutable linked map with a default new-value-selecting merge function.
MutableHashedLinkedMap(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy, MutableHashedLinkedMap.MergeFunction<K,V> merge)	Creates a mutable linked map with a custom merge function.

Method Summary

Modifier and Type	Method	Description
boolean	contains(K key)
V	get(K key)
boolean	isEmpty()
Iterator<Map.Entry<K,V>>	iterator()
V	put(K key, V value)	Inserts the mapping with the specified key and value pair.
V	putAfter(K after, K key, V value)	Inserts the mapping with this key and value pair immediately after the entry with the specified positioning key.
V	putBefore(K before, K key, V value)	Inserts the mapping with this key and value pair immediately before the entry with the specified positioning key.
V	putFirst(K key, V value)	Inserts the mapping with the specified key and value pair at the beginning of this map.
V	remove(K key)
private void	remove(MutableHashedLinkedMap<K,V>.Entry e)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

BASIC

public static final it.unimi.dsi.fastutil.Hash.Strategy<? super Object> BASIC

A strategy that uses Objects.hashCode(Object) and Object.equals(Object).

IDENTITY

public static final it.unimi.dsi.fastutil.Hash.Strategy<? super Object> IDENTITY

A strategy that uses System.identityHashCode(Object) and a == b comparisons.

strategy

private final it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy

entries

private final Map<K,MutableHashedLinkedMap<K,V>.Entry> entries

merge

private final MutableHashedLinkedMap.MergeFunction<K,V> merge

head

private MutableHashedLinkedMap<K,V>.Entry head

last

private MutableHashedLinkedMap<K,V>.Entry last

changes

private transient int changes

Constructor Details

MutableHashedLinkedMap

public MutableHashedLinkedMap()

Creates a new instance using the BASIC strategy.

MutableHashedLinkedMap

public MutableHashedLinkedMap(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy)

Creates a mutable linked map with a default new-value-selecting merge function.

Parameters:

strategy - the hashing strategy

MutableHashedLinkedMap

public MutableHashedLinkedMap(it.unimi.dsi.fastutil.Hash.Strategy<? super K> strategy,
 MutableHashedLinkedMap.MergeFunction<K,V> merge)

Creates a mutable linked map with a custom merge function.

Parameters:

strategy - the hashing strategy

merge - the function used when merging an existing value and a new value

Method Details

put

@Nullable
public V put(K key,
 V value)

Inserts the mapping with the specified key and value pair.

If there is a mapping already associated with this key, then the previous value and the specified (new) value are merged according to this collection's merge function, and the position of the entry is not modified. If there is no such mapping, then the key-value mapping is inserted at the end of this collection.

Parameters:

key - key to be inserted

value - (new) value to be associated with the key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key

contains

public boolean contains(K key)

isEmpty

public boolean isEmpty()

remove

@Nullable
public V remove(K key)

get

@Nullable
public V get(K key)

iterator

public Iterator<Map.Entry<K,V>> iterator()

Specified by:

iterator in interface Iterable<K>

putFirst

@Nullable
public V putFirst(K key,
 V value)

Inserts the mapping with the specified key and value pair at the beginning of this map.

If there is a mapping already associated with this key, then the previous value and the specified (new) value are first merged according to this map's merge function, then the entry is moved to the beginning of the map.

Parameters:

key - key to be inserted at the beginning

value - (new) value to be associated with the key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key

See Also:

• putBefore(Object, Object, Object)

putAfter

@Nullable
public V putAfter(K after,
 K key,
 V value)

Inserts the mapping with this key and value pair immediately after the entry with the specified positioning key.

If the specified positioning key is not present within this map, then this method behaves like put(Object, Object). If there is a mapping already associated with this key, then the previous value and the specified (new) value are first merged according to this map's merge function, then the entry is moved to directly after the entry with the specified positioning key.

Parameters:

after - the key to position this new entry afterwards

key - key to be inserted at the beginning

value - (new) value to be associated with the key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key

See Also:

• putBefore(Object, Object, Object)

putBefore

@Nullable
public V putBefore(K before,
 K key,
 V value)

Inserts the mapping with this key and value pair immediately before the entry with the specified positioning key.

If the specified positioning key is not present within this map, then this method behaves like put(Object, Object). If there is a mapping already associated with this key, then the previous value and the specified (new) value are first merged according to this map's merge function, then the entry is moved to directly before the entry with the specified positioning key.

Parameters:

before - the key to position this new entry afterwards

key - key to be inserted at the beginning

value - (new) value to be associated with the key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key

See Also:

• putAfter(Object, Object, Object)

remove

private void remove(MutableHashedLinkedMap<K,V>.Entry e)