speiger.src.collections.objects.utils.maps

Class Object2ObjectMaps

java.lang.Object

speiger.src.collections.objects.utils.maps.Object2ObjectMaps

public class Object2ObjectMaps
extends java.lang.Object

A Helper class that provides you with Singleton/Empty/Synchronized/Unmodifyable Maps

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Object2ObjectMaps.EmptyMap<T,V> Empty Map impementation that is used for the emptyMap() function
static class	Object2ObjectMaps.SingletonMap<T,V> Singleton Map instance that is used in the helper method
static class	Object2ObjectMaps.SynchronizedMap<T,V> The Synchronized Map implementation used by the synchronizedMap helper function
static class	Object2ObjectMaps.SynchronizedNavigableMap<T,V> The Synchronized Navigable Map implementation used by the synchronizedMap helper function
static class	Object2ObjectMaps.SynchronizedSortedMap<T,V> The Synchronized Sorted Map implementation used by the synchronizedMap helper function
static class	Object2ObjectMaps.UnmodifyableEntry<T,V> The Unmodifyable Entry implementation for the helper function unmodifiableEntry()
static class	Object2ObjectMaps.UnmodifyableEntrySet<T,V> The Unmodifyable Set implementation for the Unmodifyable Map implementation
static class	Object2ObjectMaps.UnmodifyableMap<T,V> The Unmodifyable Map implementation that is sued for the unmodifyableMap function
static class	Object2ObjectMaps.UnmodifyableNavigableMap<T,V> The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function
static class	Object2ObjectMaps.UnmodifyableSortedMap<T,V> The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Field Summary

Fields

Modifier and Type	Field and Description
static Object2ObjectMap<?,?>	EMPTY Empty Map Variable

Constructor Summary

Constructors

Constructor and Description
Object2ObjectMaps()

Method Summary

Modifier and Type	Method and Description
static <T,V> Object2ObjectMap<T,V>	emptyMap() Empty Map getter function that autocasts to the desired Key and Value
static <T,V> void	fastForEach(Object2ObjectMap<T,V> map, java.util.function.Consumer<Object2ObjectMap.Entry<T,V>> action) A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput
static <T,V> ObjectIterable<Object2ObjectMap.Entry<T,V>>	fastIterable(Object2ObjectMap<T,V> map) Helper method that provides the fastIterable that recycles a single Entry to increase throughput.
static <T,V> ObjectIterator<Object2ObjectMap.Entry<T,V>>	fastIterator(Object2ObjectMap<T,V> map) Helper method that provides the fastIterator that recycles a single Entry to increase throughput.
static <T,V> Object2ObjectMap<T,V>	singletonMap(T key, V value) Creates a Singleton map from the provided values.
static <T,V> Object2ObjectMap<T,V>	synchronizeMap(Object2ObjectMap<T,V> map) Helper function that creates a Helper wrapper to synchronize access into the map.
static <T,V> Object2ObjectMap<T,V>	synchronizeMap(Object2ObjectMap<T,V> map, java.lang.Object mutex) Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.
static <T,V> Object2ObjectNavigableMap<T,V>	synchronizeMap(Object2ObjectNavigableMap<T,V> map) Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.
static <T,V> Object2ObjectNavigableMap<T,V>	synchronizeMap(Object2ObjectNavigableMap<T,V> map, java.lang.Object mutex) Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.
static <T,V> Object2ObjectSortedMap<T,V>	synchronizeMap(Object2ObjectSortedMap<T,V> map) Helper function that creates a Helper wrapper to synchronize access into the SortedMap.
static <T,V> Object2ObjectSortedMap<T,V>	synchronizeMap(Object2ObjectSortedMap<T,V> map, java.lang.Object mutex) Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.
static <T,V> Object2ObjectMap.Entry<T,V>	unmodifyableEntry(java.util.Map.Entry<T,V> entry) A Helper function that creates a Unmodifyable Entry
static <T,V> Object2ObjectMap.Entry<T,V>	unmodifyableEntry(Object2ObjectMap.Entry<T,V> entry) A Helper function that creates a Unmodifyable Entry
static <T,V> Object2ObjectMap<T,V>	unmodifyableMap(Object2ObjectMap<T,V> map) A Helper function that creates a Helper wrapper to only allow Read Access into the Map
static <T,V> Object2ObjectNavigableMap<T,V>	unmodifyableMap(Object2ObjectNavigableMap<T,V> map) A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map
static <T,V> Object2ObjectSortedMap<T,V>	unmodifyableMap(Object2ObjectSortedMap<T,V> map) A Helper function that creates a Helper wrapper to only allow Read Access into the SortedMap

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Object2ObjectMap<?,?> EMPTY

Empty Map Variable

Constructor Detail

Object2ObjectMaps

public Object2ObjectMaps()

Method Detail

fastIterator

public static <T,V> ObjectIterator<Object2ObjectMap.Entry<T,V>> fastIterator(Object2ObjectMap<T,V> map)

Helper method that provides the fastIterator that recycles a single Entry to increase throughput.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map the fastIterator should be accessed from

Returns:

either a normal iterator if it does not support this feature to a fastIterator

fastIterable

public static <T,V> ObjectIterable<Object2ObjectMap.Entry<T,V>> fastIterable(Object2ObjectMap<T,V> map)

Helper method that provides the fastIterable that recycles a single Entry to increase throughput.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map the fastIterable should be accessed from

Returns:

either a normal iterable if it does not support this feature to a fastIterable

fastForEach

public static <T,V> void fastForEach(Object2ObjectMap<T,V> map,
                                     java.util.function.Consumer<Object2ObjectMap.Entry<T,V>> action)

A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map the fast forEach should be accessed from

action - the action that should be performed on each entry

Note:

if the fast forEach is not supported will default to a normal forEach

emptyMap

public static <T,V> Object2ObjectMap<T,V> emptyMap()

Empty Map getter function that autocasts to the desired Key and Value

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Returns:

empty map of desired type

synchronizeMap

public static <T,V> Object2ObjectMap<T,V> synchronizeMap(Object2ObjectMap<T,V> map)

Helper function that creates a Helper wrapper to synchronize access into the map.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map that should be synchronized

Returns:

a synchronized Map

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

synchronizeMap

public static <T,V> Object2ObjectMap<T,V> synchronizeMap(Object2ObjectMap<T,V> map,
                                                         java.lang.Object mutex)

Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map that should be synchronized

mutex - the object that controls access

Returns:

a synchronized Map

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

synchronizeMap

public static <T,V> Object2ObjectSortedMap<T,V> synchronizeMap(Object2ObjectSortedMap<T,V> map)

Helper function that creates a Helper wrapper to synchronize access into the SortedMap.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the SortedMap that should be synchronized

Returns:

a synchronized SortedMap

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

synchronizeMap

public static <T,V> Object2ObjectSortedMap<T,V> synchronizeMap(Object2ObjectSortedMap<T,V> map,
                                                               java.lang.Object mutex)

Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the SortedMap that should be synchronized

mutex - the object that controls access

Returns:

a synchronized SortedMap

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

synchronizeMap

public static <T,V> Object2ObjectNavigableMap<T,V> synchronizeMap(Object2ObjectNavigableMap<T,V> map)

Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the NavigableMap that should be synchronized

Returns:

a synchronized NavigableMap

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

synchronizeMap

public static <T,V> Object2ObjectNavigableMap<T,V> synchronizeMap(Object2ObjectNavigableMap<T,V> map,
                                                                  java.lang.Object mutex)

Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the NavigableMap that should be synchronized

mutex - the object that controls access

Returns:

a synchronized NavigableMap

Note:

if the inputted map is already synchronized then it will just return it instead, iterators do not support synchronization

unmodifyableMap

public static <T,V> Object2ObjectMap<T,V> unmodifyableMap(Object2ObjectMap<T,V> map)

A Helper function that creates a Helper wrapper to only allow Read Access into the Map

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the map that should be made Unmodifiable

Returns:

a unmodifiable Map

Note:

if the inputted map is already unmodifiable then it will just return it instead

unmodifyableMap

public static <T,V> Object2ObjectSortedMap<T,V> unmodifyableMap(Object2ObjectSortedMap<T,V> map)

A Helper function that creates a Helper wrapper to only allow Read Access into the SortedMap

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the SortedMap that should be made Unmodifiable

Returns:

a unmodifiable SortedMap

Note:

if the inputted SortedMap is already unmodifiable then it will just return it instead

unmodifyableMap

public static <T,V> Object2ObjectNavigableMap<T,V> unmodifyableMap(Object2ObjectNavigableMap<T,V> map)

A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

map - the NavigableMap that should be made Unmodifiable

Returns:

a unmodifiable NavigableMap

Note:

if the inputted NavigableMap is already unmodifiable then it will just return it instead

unmodifyableEntry

public static <T,V> Object2ObjectMap.Entry<T,V> unmodifyableEntry(Object2ObjectMap.Entry<T,V> entry)

A Helper function that creates a Unmodifyable Entry

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

entry - the Entry that should be made unmodifyable

Returns:

a Unmodifyable Entry

unmodifyableEntry

public static <T,V> Object2ObjectMap.Entry<T,V> unmodifyableEntry(java.util.Map.Entry<T,V> entry)

A Helper function that creates a Unmodifyable Entry

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

entry - the Entry that should be made unmodifyable

Returns:

a Unmodifyable Entry

singletonMap

public static <T,V> Object2ObjectMap<T,V> singletonMap(T key,
                                                       V value)

Creates a Singleton map from the provided values. This reduces overhead that normal Map implementations have.

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

Parameters:

key - the key that should be turned into a singleton

value - the value that should be turned into a singleton

Returns:

a unmodifyable Singleton map.