Modul speiger.src.collections

Package speiger.src.collections.ints.utils.maps

Klasse Int2CharMaps

java.lang.Object

speiger.src.collections.ints.utils.maps.Int2CharMaps

public class Int2CharMaps
extends Object

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

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	Int2CharMaps.EmptyMap	Empty Map impementation that is used for the emptyMap() function
static class	Int2CharMaps.SingletonMap	Singleton Map instance that is used in the helper method
static class	Int2CharMaps.SynchronizedMap	The Synchronized Map implementation used by the synchronizedMap helper function
static class	Int2CharMaps.SynchronizedNavigableMap	The Synchronized Navigable Map implementation used by the synchronizedMap helper function
static class	Int2CharMaps.SynchronizedOrderedMap	The Synchronized Ordered Map implementation used by the synchronizedMap helper function
static class	Int2CharMaps.SynchronizedSortedMap	The Synchronized Sorted Map implementation used by the synchronizedMap helper function
static class	Int2CharMaps.UnmodifyableEntry	The Unmodifyable Entry implementation for the helper function unmodifiableEntry()
static class	Int2CharMaps.UnmodifyableEntrySet	The Unmodifyable Set implementation for the Unmodifyable Map implementation
static class	Int2CharMaps.UnmodifyableMap	The Unmodifyable Map implementation that is sued for the unmodifyableMap function
static class	Int2CharMaps.UnmodifyableNavigableMap	The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function
static class	Int2CharMaps.UnmodifyableOrderedEntrySet	The Unmodifyable Ordered Set implementation for the Unmodifyable Ordered Map implementation
static class	Int2CharMaps.UnmodifyableOrderedMap	The Unmodifyable Ordered Map implementation that is sued for the unmodifyableMap function
static class	Int2CharMaps.UnmodifyableSortedMap	The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Int2CharMaps()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static Int2CharMap	empty()	Empty Map getter function that autocasts to the desired Key and Value
static void	fastForEach(Int2CharMap map, Consumer<Int2CharMap.Entry> action)	A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput
static ObjectIterable<Int2CharMap.Entry>	fastIterable(Int2CharMap map)	Helper method that provides the fastIterable that recycles a single Entry to increase throughput.
static ObjectIterator<Int2CharMap.Entry>	fastIterator(Int2CharMap map)	Helper method that provides the fastIterator that recycles a single Entry to increase throughput.
static Int2CharMap	singleton(int key, char value)	Creates a Singleton map from the provided values.
static Int2CharMap	synchronize(Int2CharMap map)	Helper function that creates a Helper wrapper to synchronize access into the map.
static Int2CharMap	synchronize(Int2CharMap map, Object mutex)	Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.
static Int2CharNavigableMap	synchronize(Int2CharNavigableMap map)	Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.
static Int2CharNavigableMap	synchronize(Int2CharNavigableMap map, Object mutex)	Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.
static Int2CharOrderedMap	synchronize(Int2CharOrderedMap map)	Helper function that creates a Helper wrapper to synchronize access into the OrderedMap.
static Int2CharOrderedMap	synchronize(Int2CharOrderedMap map, Object mutex)	Helper function that creates a Helper wrapper to synchronize access with custom access control into the OrderedMap.
static Int2CharSortedMap	synchronize(Int2CharSortedMap map)	Helper function that creates a Helper wrapper to synchronize access into the SortedMap.
static Int2CharSortedMap	synchronize(Int2CharSortedMap map, Object mutex)	Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.
static Int2CharMap.Entry	unmodifiable(Map.Entry<Integer,Character> entry)	A Helper function that creates a Unmodifyable Entry
static Int2CharMap	unmodifiable(Int2CharMap map)	A Helper function that creates a Helper wrapper to only allow Read Access into the Map
static Int2CharMap.Entry	unmodifiable(Int2CharMap.Entry entry)	A Helper function that creates a Unmodifyable Entry
static Int2CharNavigableMap	unmodifiable(Int2CharNavigableMap map)	A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map
static Int2CharOrderedMap	unmodifiable(Int2CharOrderedMap map)	A Helper function that creates a Helper wrapper to only allow Read Access into the OrderedMap
static Int2CharSortedMap	unmodifiable(Int2CharSortedMap map)	A Helper function that creates a Helper wrapper to only allow Read Access into the SortedMap

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

Int2CharMaps

public Int2CharMaps()

Methodendetails

empty

public static Int2CharMap empty()

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

Gibt zurück:

empty map of desired type

fastIterator

public static ObjectIterator<Int2CharMap.Entry> fastIterator(Int2CharMap map)

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

Parameter:

map - the map the fastIterator should be accessed from

Gibt zurück:

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

fastIterable

public static ObjectIterable<Int2CharMap.Entry> fastIterable(Int2CharMap map)

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

Parameter:

map - the map the fastIterable should be accessed from

Gibt zurück:

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

fastForEach

public static void fastForEach(Int2CharMap map,
 Consumer<Int2CharMap.Entry> action)

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

Parameter:

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

synchronize

public static Int2CharMap synchronize(Int2CharMap map)

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

Parameter:

map - the map that should be synchronized

Gibt zurück:

a synchronized Map

Note:

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

synchronize

public static Int2CharMap synchronize(Int2CharMap map,
 Object mutex)

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

Parameter:

map - the map that should be synchronized

mutex - the object that controls access

Gibt zurück:

a synchronized Map

Note:

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

synchronize

public static Int2CharSortedMap synchronize(Int2CharSortedMap map)

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

Parameter:

map - the SortedMap that should be synchronized

Gibt zurück:

a synchronized SortedMap

Note:

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

synchronize

public static Int2CharSortedMap synchronize(Int2CharSortedMap map,
 Object mutex)

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

Parameter:

map - the SortedMap that should be synchronized

mutex - the object that controls access

Gibt zurück:

a synchronized SortedMap

Note:

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

synchronize

public static Int2CharOrderedMap synchronize(Int2CharOrderedMap map)

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

Parameter:

map - the OrderedMap that should be synchronized

Gibt zurück:

a synchronized OrderedMap

Note:

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

synchronize

public static Int2CharOrderedMap synchronize(Int2CharOrderedMap map,
 Object mutex)

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

Parameter:

map - the OrderedMap that should be synchronized

mutex - the object that controls access

Gibt zurück:

a synchronized OrderedMap

Note:

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

synchronize

public static Int2CharNavigableMap synchronize(Int2CharNavigableMap map)

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

Parameter:

map - the NavigableMap that should be synchronized

Gibt zurück:

a synchronized NavigableMap

Note:

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

synchronize

public static Int2CharNavigableMap synchronize(Int2CharNavigableMap map,
 Object mutex)

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

Parameter:

map - the NavigableMap that should be synchronized

mutex - the object that controls access

Gibt zurück:

a synchronized NavigableMap

Note:

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

unmodifiable

public static Int2CharMap unmodifiable(Int2CharMap map)

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

Parameter:

map - the map that should be made Unmodifiable

Gibt zurück:

a unmodifiable Map

Note:

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

unmodifiable

public static Int2CharOrderedMap unmodifiable(Int2CharOrderedMap map)

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

Parameter:

map - the OrderedMap that should be made Unmodifiable

Gibt zurück:

a unmodifiable OrderedMap

Note:

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

unmodifiable

public static Int2CharSortedMap unmodifiable(Int2CharSortedMap map)

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

Parameter:

map - the SortedMap that should be made Unmodifiable

Gibt zurück:

a unmodifiable SortedMap

Note:

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

unmodifiable

public static Int2CharNavigableMap unmodifiable(Int2CharNavigableMap map)

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

Parameter:

map - the NavigableMap that should be made Unmodifiable

Gibt zurück:

a unmodifiable NavigableMap

Note:

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

unmodifiable

public static Int2CharMap.Entry unmodifiable(Int2CharMap.Entry entry)

A Helper function that creates a Unmodifyable Entry

Parameter:

entry - the Entry that should be made unmodifiable

Gibt zurück:

a Unmodifyable Entry

unmodifiable

public static Int2CharMap.Entry unmodifiable(Map.Entry<Integer,Character> entry)

A Helper function that creates a Unmodifyable Entry

Parameter:

entry - the Entry that should be made unmodifiable

Gibt zurück:

a Unmodifyable Entry

singleton

public static Int2CharMap singleton(int key,
 char value)

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

Parameter:

key - the key that should be turned into a singleton

value - the value that should be turned into a singleton

Gibt zurück:

a unmodifiable Singleton map.