AbstractObject2IntMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Integer>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2IntMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToIntFunction<T>, java.util.Map<T,java.lang.Integer>, Object2IntFunction<T>, Object2IntMap<T>

Direct Known Subclasses:

Enum2IntMap, Object2IntArrayMap, Object2IntAVLTreeMap, Object2IntMaps.EmptyMap, Object2IntMaps.SingletonMap, Object2IntMaps.SynchronizedMap, Object2IntMaps.UnmodifyableMap, Object2IntOpenCustomHashMap, Object2IntOpenHashMap, Object2IntRBTreeMap
```
public abstract class AbstractObject2IntMap<T>
extends java.util.AbstractMap<T,java.lang.Integer>
implements Object2IntMap<T>
```
A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractObject2IntMap.BasicEntry<T>
A Simple Type Specific Entry class to reduce boxing/unboxing
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap
  Object2IntMap.Entry<T>, Object2IntMap.FastEntrySet<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractObject2IntMap.BasicEntry<T>` A Simple Type Specific Entry class to reduce boxing/unboxing

Constructor Summary

Constructors
Constructor and Description

AbstractObject2IntMap()

Constructors
Constructor and Description
`AbstractObject2IntMap()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToAll(Object2IntMap<T> m)` A Helper method to bulk add primitives together.
`int`	`computeInt(T key, ObjectIntUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfAbsent(T key, Object2IntFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`int`	`computeIntIfPresent(T key, ObjectIntUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(int value)` Type Specific method to reduce boxing/unboxing of values
`ObjectSet<java.util.Map.Entry<T,java.lang.Integer>>`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`void`	`forEach(ObjectIntConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`java.lang.Integer`	`get(java.lang.Object key)`
`int`	`getDefaultReturnValue()` Method to see what the default return value is.
`java.lang.Integer`	`getOrDefault(java.lang.Object key, java.lang.Integer defaultValue)`
`int`	`hashCode()`
`ObjectSet<T>`	`keySet()`
`void`	`mergeAllInt(Object2IntMap<T> m, IntIntUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`int`	`mergeInt(T key, int value, IntIntUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`void`	`putAll(java.util.Map<? extends T,? extends java.lang.Integer> m)`
`void`	`putAll(Object2IntMap<T> m)` Type Specific function for the bull putting of values
`void`	`putAll(T[] keys, int[] values, int offset, int size)` Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
`void`	`putAllIfAbsent(Object2IntMap<T> m)` Type-Specific bulk put method put elements into the map if not present.
`int`	`replace(T key, int value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(T key, int oldValue, int newValue)` A Type Specific replace method to replace an existing value
`void`	`replaceInts(Object2IntMap<T> m)` Type-Specific bulk replace method.
`void`	`replaceInts(ObjectIntUnaryOperator<T> mappingFunction)` A Type Specific mass replace method to reduce boxing/unboxing
`AbstractObject2IntMap<T>`	`setDefaultReturnValue(int v)` Method to define the default return value if a requested key isn't present
`IntCollection`	`values()`

Methods inherited from class java.util.AbstractMap
clear, containsValue, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap
addTo, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, getInt, getOrDefault, merge, object2IntEntrySet, put, put, putAll, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map
clear, isEmpty, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2IntFunction
applyAsInt

- Constructor Detail
  - AbstractObject2IntMap
```
public AbstractObject2IntMap()
```
- Method Detail
  - getDefaultReturnValue
```
public int getDefaultReturnValue()
```
    Description copied from interface: Object2IntMap
    
    Method to see what the default return value is.
    
    Specified by:
    
    getDefaultReturnValue in interface Object2IntMap<T>
    
    Returns:
    
    default return value
  - setDefaultReturnValue
```
public AbstractObject2IntMap<T> setDefaultReturnValue(int v)
```
    Description copied from interface: Object2IntMap
    
    Method to define the default return value if a requested key isn't present
    
    Specified by:
    
    setDefaultReturnValue in interface Object2IntMap<T>
    
    Parameters:
    
    v - value that should be the default return value
    
    Returns:
    
    itself
  - addToAll
```
public void addToAll(Object2IntMap<T> m)
```
    Description copied from interface: Object2IntMap
    
    A Helper method to bulk add primitives together.
    
    Specified by:
    
    addToAll in interface Object2IntMap<T>
    
    Parameters:
    
    m - the values that should be added/inserted
  - putAll
```
public void putAll(Object2IntMap<T> m)
```
    Description copied from interface: Object2IntMap
    
    Type Specific function for the bull putting of values
    
    Specified by:
    
    putAll in interface Object2IntMap<T>
    
    Parameters:
    
    m - the elements that should be inserted
  - putAll
```
public void putAll(java.util.Map<? extends T,? extends java.lang.Integer> m)
```
    Specified by:
    
    putAll in interface java.util.Map<T,java.lang.Integer>
    
    Overrides:
    
    putAll in class java.util.AbstractMap<T,java.lang.Integer>
  - putAll
```
public void putAll(T[] keys,
                   int[] values,
                   int offset,
                   int size)
```
    Description copied from interface: Object2IntMap
    
    Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
    
    Specified by:
    
    putAll in interface Object2IntMap<T>
    
    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
    
    See Also:
    
    Map.putAll(Map)
  - putAllIfAbsent
```
public void putAllIfAbsent(Object2IntMap<T> m)
```
    Description copied from interface: Object2IntMap
    
    Type-Specific bulk put method put elements into the map if not present.
    
    Specified by:
    
    putAllIfAbsent in interface Object2IntMap<T>
    
    Parameters:
    
    m - elements that should be added if not present.
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<T,java.lang.Integer>
    
    Overrides:
    
    containsKey in class java.util.AbstractMap<T,java.lang.Integer>
  - containsValue
```
public boolean containsValue(int value)
```
    Description copied from interface: Object2IntMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Object2IntMap<T>
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - replace
```
public boolean replace(T key,
                       int oldValue,
                       int newValue)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Object2IntMap<T>
    
    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
  - replace
```
public int replace(T key,
                   int value)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Object2IntMap<T>
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - replaceInts
```
public void replaceInts(Object2IntMap<T> m)
```
    Description copied from interface: Object2IntMap
    
    Type-Specific bulk replace method. Could be seen as putAllIfPresent
    
    Specified by:
    
    replaceInts in interface Object2IntMap<T>
    
    Parameters:
    
    m - elements that should be replaced.
  - replaceInts
```
public void replaceInts(ObjectIntUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific mass replace method to reduce boxing/unboxing
    
    Specified by:
    
    replaceInts in interface Object2IntMap<T>
    
    Parameters:
    
    mappingFunction - operation to replace all values
  - computeInt
```
public int computeInt(T key,
                      ObjectIntUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeInt in interface Object2IntMap<T>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeIntIfAbsent
```
public int computeIntIfAbsent(T key,
                              Object2IntFunction<T> mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfAbsent in interface Object2IntMap<T>
    
    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
  - computeIntIfPresent
```
public int computeIntIfPresent(T key,
                               ObjectIntUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeIntIfPresent in interface Object2IntMap<T>
    
    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
  - mergeInt
```
public int mergeInt(T key,
                    int value,
                    IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeInt in interface Object2IntMap<T>
    
    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
  - mergeAllInt
```
public void mergeAllInt(Object2IntMap<T> m,
                        IntIntUnaryOperator mappingFunction)
```
    Description copied from interface: Object2IntMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllInt in interface Object2IntMap<T>
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - get
```
public java.lang.Integer get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    get in interface Object2IntMap<T>
    
    Overrides:
    
    get in class java.util.AbstractMap<T,java.lang.Integer>
  - getOrDefault
```
public java.lang.Integer getOrDefault(java.lang.Object key,
                                      java.lang.Integer defaultValue)
```
    Specified by:
    
    getOrDefault in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    getOrDefault in interface Object2IntMap<T>
  - forEach
```
public void forEach(ObjectIntConsumer<T> action)
```
    Description copied from interface: Object2IntMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2IntMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - keySet
```
public ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    keySet in interface Object2IntMap<T>
    
    Overrides:
    
    keySet in class java.util.AbstractMap<T,java.lang.Integer>
  - values
```
public IntCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    values in interface Object2IntMap<T>
    
    Overrides:
    
    values in class java.util.AbstractMap<T,java.lang.Integer>
  - entrySet
```
public ObjectSet<java.util.Map.Entry<T,java.lang.Integer>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<T,java.lang.Integer>
    
    Specified by:
    
    entrySet in interface Object2IntMap<T>
    
    Specified by:
    
    entrySet in class java.util.AbstractMap<T,java.lang.Integer>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map<T,java.lang.Integer>
    
    Overrides:
    
    equals in class java.util.AbstractMap<T,java.lang.Integer>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<T,java.lang.Integer>
    
    Overrides:
    
    hashCode in class java.util.AbstractMap<T,java.lang.Integer>

Class AbstractObject2IntMap<T>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2IntMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2IntFunction

Constructor Detail

AbstractObject2IntMap

Method Detail

getDefaultReturnValue

setDefaultReturnValue

addToAll

putAll

putAll

putAll

putAllIfAbsent

containsKey

containsValue

replace

replace

replaceInts

replaceInts

computeInt

computeIntIfAbsent

computeIntIfPresent

mergeInt

mergeAllInt

get

getOrDefault

forEach

keySet

values

entrySet

equals

hashCode