speiger.src.collections.chars.maps.interfaces

Interface Char2ObjectMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Char2ObjectFunction<V>, java.util.Map<java.lang.Character,V>

All Known Subinterfaces:

Char2ObjectConcurrentMap<V>, Char2ObjectNavigableMap<V>, Char2ObjectOrderedMap<V>, Char2ObjectSortedMap<V>

All Known Implementing Classes:

AbstractChar2ObjectMap, Char2ObjectArrayMap, Char2ObjectAVLTreeMap, Char2ObjectConcurrentOpenHashMap, Char2ObjectLinkedOpenCustomHashMap, Char2ObjectLinkedOpenHashMap, Char2ObjectMaps.EmptyMap, Char2ObjectMaps.SingletonMap, Char2ObjectMaps.SynchronizedMap, Char2ObjectMaps.SynchronizedNavigableMap, Char2ObjectMaps.SynchronizedOrderedMap, Char2ObjectMaps.SynchronizedSortedMap, Char2ObjectMaps.UnmodifyableMap, Char2ObjectMaps.UnmodifyableNavigableMap, Char2ObjectMaps.UnmodifyableOrderedMap, Char2ObjectMaps.UnmodifyableSortedMap, Char2ObjectOpenCustomHashMap, Char2ObjectOpenHashMap, Char2ObjectRBTreeMap, ImmutableChar2ObjectOpenHashMap

public interface Char2ObjectMap<V>
extends java.util.Map<java.lang.Character,V>, Char2ObjectFunction<V>

A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Char2ObjectMap.BuilderCache<V> Builder Cache for allowing to buildMaps
static interface	Char2ObjectMap.Entry<V> Type Specific Map Entry that reduces boxing/unboxing
static interface	Char2ObjectMap.FastEntrySet<V> Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value
static class	Char2ObjectMap.MapBuilder Helper class that reduces the method spam of the Map Class.

Method Summary

Modifier and Type	Method and Description
static Char2ObjectMap.MapBuilder	builder() Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
ObjectSet<Char2ObjectMap.Entry<V>>	char2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
default V	compute(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction) Deprecated.
V	compute(char key, CharObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default V	computeIfAbsent(java.lang.Character key, java.util.function.Function<? super java.lang.Character,? extends V> mappingFunction) Deprecated.
V	computeIfAbsent(char key, Char2ObjectFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default V	computeIfPresent(java.lang.Character key, java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction) Deprecated.
V	computeIfPresent(char key, CharObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(char key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
Char2ObjectMap<V>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Character,V>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Character,? super V> action) Deprecated.
void	forEach(CharObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(char key) A Type Specific get method to reduce boxing/unboxing
default V	get(java.lang.Object key) Deprecated.
V	getDefaultReturnValue() Method to see what the default return value is.
V	getOrDefault(char key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default V	getOrDefault(java.lang.Object key, V defaultValue) Deprecated.
CharSet	keySet()
default V	merge(java.lang.Character key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> mappingFunction) Deprecated.
V	merge(char key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Char2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
default V	put(java.lang.Character key, V value) Deprecated.
V	put(char key, V value) Type Specific method to reduce boxing/unboxing of values
default void	putAll(char[] keys, V[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(char[] keys, V[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(Char2ObjectMap<V> m) Type Specific function for the bull putting of values
default void	putAll(java.lang.Character[] keys, V[] values) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.lang.Character[] keys, V[] values, int offset, int size) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAllIfAbsent(Char2ObjectMap<V> m) Type-Specific bulk put method put elements into the map if not present.
default V	putIfAbsent(java.lang.Character key, V value) Deprecated.
V	putIfAbsent(char key, V value) Type Specific method to reduce boxing/unboxing of values
V	remove(char key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(char key, V value) Type Specific remove function to reduce boxing/unboxing
default V	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
V	removeOrDefault(char key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
default V	replace(java.lang.Character key, V value) Deprecated.
default boolean	replace(java.lang.Character key, V oldValue, V newValue) Deprecated.
V	replace(char key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(char key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction) Deprecated.
void	replaceObjects(Char2ObjectMap<V> m) Type-Specific bulk replace method.
void	replaceObjects(CharObjectUnaryOperator<V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Char2ObjectMap<V>	setDefaultReturnValue(V v) Method to define the default return value if a requested key isn't present
V	supplyIfAbsent(char key, ObjectSupplier<V> valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
default Char2ObjectMap<V>	synchronize() Creates a Wrapped Map that is Synchronized
default Char2ObjectMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped Map that is Synchronized
default Char2ObjectMap<V>	unmodifiable() Creates a Wrapped Map that is unmodifiable
ObjectCollection<V>	values()

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

builder

static Char2ObjectMap.MapBuilder builder()

Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.

Returns:

a MapBuilder

getDefaultReturnValue

V getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Char2ObjectMap<V> setDefaultReturnValue(V v)

Method to define the default return value if a requested key isn't present

Parameters:

v - value that should be the default return value

Returns:

itself

copy

Char2ObjectMap<V> copy()

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Returns:

a Shallow Copy of the Map

Note:

Wrappers and view Maps will not support this feature

put

V put(char key,
      V value)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putAll

default void putAll(char[] keys,
                    V[] values)

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

void putAll(char[] keys,
            V[] values,
            int offset,
            int size)

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putAll

default void putAll(java.lang.Character[] keys,
                    V[] values)

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

void putAll(java.lang.Character[] keys,
            V[] values,
            int offset,
            int size)

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putIfAbsent

V putIfAbsent(char key,
              V value)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

putAllIfAbsent

void putAllIfAbsent(Char2ObjectMap<V> m)

Type-Specific bulk put method put elements into the map if not present.

Parameters:

m - elements that should be added if not present.

putAll

void putAll(Char2ObjectMap<V> m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(char key)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

default boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Character,V>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

Note:

in some implementations key does not have to be Character but just have to support equals with Character.

remove

V remove(char key)

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remove

default V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Character,V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

Note:

in some implementations key does not have to be Character but just have to support equals with Character.

remove

boolean remove(char key,
               V value)

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

default boolean remove(java.lang.Object key,
                       java.lang.Object value)

Specified by:

remove in interface java.util.Map<java.lang.Character,V>

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

removeOrDefault

V removeOrDefault(char key,
                  V defaultValue)

Type-Specific Remove function with a default return value if wanted.

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

replace

boolean replace(char key,
                V oldValue,
                V newValue)

A Type Specific replace method to replace an existing value

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

Note:

this fails if the value is not present even if it matches the oldValue

replace

V replace(char key,
          V value)

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

Note:

this fails if the value is not present

replaceObjects

void replaceObjects(Char2ObjectMap<V> m)

Type-Specific bulk replace method. Could be seen as putAllIfPresent

Parameters:

m - elements that should be replaced.

replaceObjects

void replaceObjects(CharObjectUnaryOperator<V> mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

compute

V compute(char key,
          CharObjectUnaryOperator<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

V computeIfAbsent(char key,
                  Char2ObjectFunction<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

supplyIfAbsent

V supplyIfAbsent(char key,
                 ObjectSupplier<V> valueProvider)

A Supplier based computeIfAbsent function to fill the most used usecase of this function

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeIfPresent

V computeIfPresent(char key,
                   CharObjectUnaryOperator<V> mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

Note:

if not present then compute is not executed

merge

V merge(char key,
        V value,
        ObjectObjectUnaryOperator<V,V> mappingFunction)

A Type Specific merge method to reduce boxing/unboxing

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

Note:

if the result matches the default return value then the key is removed from the map

mergeAll

void mergeAll(Char2ObjectMap<V> m,
              ObjectObjectUnaryOperator<V,V> mappingFunction)

A Bulk method for merging Maps.

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

Note:

if the result matches the default return value then the key is removed from the map

replace

@Deprecated
default boolean replace(java.lang.Character key,
                                     V oldValue,
                                     V newValue)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Character,V>

replace

@Deprecated
default V replace(java.lang.Character key,
                               V value)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Character,V>

get

V get(char key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Char2ObjectFunction<V>

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

V getOrDefault(char key,
               V defaultValue)

A Type Specific getOrDefault method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

get

@Deprecated
default V get(java.lang.Object key)

Deprecated.

Specified by:

get in interface java.util.Map<java.lang.Character,V>

getOrDefault

@Deprecated
default V getOrDefault(java.lang.Object key,
                                    V defaultValue)

Deprecated.

Specified by:

getOrDefault in interface java.util.Map<java.lang.Character,V>

replaceAll

@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

replaceAll in interface java.util.Map<java.lang.Character,V>

compute

@Deprecated
default V compute(java.lang.Character key,
                               java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

compute in interface java.util.Map<java.lang.Character,V>

computeIfAbsent

@Deprecated
default V computeIfAbsent(java.lang.Character key,
                                       java.util.function.Function<? super java.lang.Character,? extends V> mappingFunction)

Deprecated.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.Character,V>

computeIfPresent

@Deprecated
default V computeIfPresent(java.lang.Character key,
                                        java.util.function.BiFunction<? super java.lang.Character,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.Character,V>

merge

@Deprecated
default V merge(java.lang.Character key,
                             V value,
                             java.util.function.BiFunction<? super V,? super V,? extends V> mappingFunction)

Deprecated.

Specified by:

merge in interface java.util.Map<java.lang.Character,V>

forEach

void forEach(CharObjectConsumer<V> action)

Type Specific forEach method to reduce boxing/unboxing

Parameters:

action - processor of the values that are iterator over

forEach

@Deprecated
default void forEach(java.util.function.BiConsumer<? super java.lang.Character,? super V> action)

Deprecated.

Specified by:

forEach in interface java.util.Map<java.lang.Character,V>

keySet

CharSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Character,V>

values

ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<java.lang.Character,V>

entrySet

@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Character,V>> entrySet()

Deprecated.

Specified by:

entrySet in interface java.util.Map<java.lang.Character,V>

char2ObjectEntrySet

ObjectSet<Char2ObjectMap.Entry<V>> char2ObjectEntrySet()

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Returns:

a EntrySet of the collection

synchronize

default Char2ObjectMap<V> synchronize()

Creates a Wrapped Map that is Synchronized

Returns:

a new Map that is synchronized

See Also:

Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

synchronize

default Char2ObjectMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped Map that is Synchronized

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new Map Wrapper that is synchronized

See Also:

Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

unmodifiable

default Char2ObjectMap<V> unmodifiable()

Creates a Wrapped Map that is unmodifiable

Returns:

a new Map Wrapper that is unmodifiable

See Also:

Char2ObjectMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

put

@Deprecated
default V put(java.lang.Character key,
                           V value)

Deprecated.

Specified by:

put in interface java.util.Map<java.lang.Character,V>

putIfAbsent

@Deprecated
default V putIfAbsent(java.lang.Character key,
                                   V value)

Deprecated.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.Character,V>