Short2ShortMaps (Primitive-Collections 0.2.0 API)

java.lang.Object
- speiger.src.collections.shorts.utils.maps.Short2ShortMaps

```
public class Short2ShortMaps
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`	`Short2ShortMaps.EmptyMap` Empty Map impementation that is used for the emptyMap() function
`static class`	`Short2ShortMaps.SingletonMap` Singleton Map instance that is used in the helper method
`static class`	`Short2ShortMaps.SynchronizedMap` The Synchronized Map implementation used by the synchronizedMap helper function
`static class`	`Short2ShortMaps.SynchronizedNavigableMap` The Synchronized Navigable Map implementation used by the synchronizedMap helper function
`static class`	`Short2ShortMaps.SynchronizedSortedMap` The Synchronized Sorted Map implementation used by the synchronizedMap helper function
`static class`	`Short2ShortMaps.UnmodifyableEntry` The Unmodifyable Entry implementation for the helper function unmodifiableEntry()
`static class`	`Short2ShortMaps.UnmodifyableEntrySet` The Unmodifyable Set implementation for the Unmodifyable Map implementation
`static class`	`Short2ShortMaps.UnmodifyableMap` The Unmodifyable Map implementation that is sued for the unmodifyableMap function
`static class`	`Short2ShortMaps.UnmodifyableNavigableMap` The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function
`static class`	`Short2ShortMaps.UnmodifyableSortedMap` The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Field Summary

Fields
Modifier and Type Field and Description

static Short2ShortMap EMPTY
Empty Map Variable

Fields
Modifier and Type	Field and Description
`static Short2ShortMap`	`EMPTY` Empty Map Variable

Constructor Summary

Constructors
Constructor and Description

Short2ShortMaps()

Constructors
Constructor and Description
`Short2ShortMaps()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Short2ShortMap`	`emptyMap()` Empty Map getter function that autocasts to the desired Key and Value
`static void`	`fastForEach(Short2ShortMap map, java.util.function.Consumer<Short2ShortMap.Entry> action)` A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput
`static ObjectIterable<Short2ShortMap.Entry>`	`fastIterable(Short2ShortMap map)` Helper method that provides the fastIterable that recycles a single Entry to increase throughput.
`static ObjectIterator<Short2ShortMap.Entry>`	`fastIterator(Short2ShortMap map)` Helper method that provides the fastIterator that recycles a single Entry to increase throughput.
`static Short2ShortMap`	`singletonMap(short key, short value)` Creates a Singleton map from the provided values.
`static Short2ShortMap`	`synchronizeMap(Short2ShortMap map)` Helper function that creates a Helper wrapper to synchronize access into the map.
`static Short2ShortMap`	`synchronizeMap(Short2ShortMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.
`static Short2ShortNavigableMap`	`synchronizeMap(Short2ShortNavigableMap map)` Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.
`static Short2ShortNavigableMap`	`synchronizeMap(Short2ShortNavigableMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.
`static Short2ShortSortedMap`	`synchronizeMap(Short2ShortSortedMap map)` Helper function that creates a Helper wrapper to synchronize access into the SortedMap.
`static Short2ShortSortedMap`	`synchronizeMap(Short2ShortSortedMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.
`static Short2ShortMap.Entry`	`unmodifyableEntry(java.util.Map.Entry<java.lang.Short,java.lang.Short> entry)` A Helper function that creates a Unmodifyable Entry
`static Short2ShortMap.Entry`	`unmodifyableEntry(Short2ShortMap.Entry entry)` A Helper function that creates a Unmodifyable Entry
`static Short2ShortMap`	`unmodifyableMap(Short2ShortMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into the Map
`static Short2ShortNavigableMap`	`unmodifyableMap(Short2ShortNavigableMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map
`static Short2ShortSortedMap`	`unmodifyableMap(Short2ShortSortedMap 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 Short2ShortMap EMPTY
```
    Empty Map Variable
- Constructor Detail
  - Short2ShortMaps
```
public Short2ShortMaps()
```
- Method Detail
  - fastIterator
```
public static ObjectIterator<Short2ShortMap.Entry> fastIterator(Short2ShortMap map)
```
    Helper method that provides the fastIterator that recycles a single Entry to increase throughput.
    
    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 ObjectIterable<Short2ShortMap.Entry> fastIterable(Short2ShortMap map)
```
    Helper method that provides the fastIterable that recycles a single Entry to increase throughput.
    
    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 void fastForEach(Short2ShortMap map,
                               java.util.function.Consumer<Short2ShortMap.Entry> action)
```
    A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput
    
    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 Short2ShortMap emptyMap()
```
    Empty Map getter function that autocasts to the desired Key and Value
    
    Returns:
    
    empty map of desired type
  - synchronizeMap
```
public static Short2ShortMap synchronizeMap(Short2ShortMap map)
```
    Helper function that creates a Helper wrapper to synchronize access into the map.
    
    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 Short2ShortMap synchronizeMap(Short2ShortMap map,
                                            java.lang.Object mutex)
```
    Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.
    
    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 Short2ShortSortedMap synchronizeMap(Short2ShortSortedMap map)
```
    Helper function that creates a Helper wrapper to synchronize access into the SortedMap.
    
    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 Short2ShortSortedMap synchronizeMap(Short2ShortSortedMap map,
                                                  java.lang.Object mutex)
```
    Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.
    
    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 Short2ShortNavigableMap synchronizeMap(Short2ShortNavigableMap map)
```
    Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.
    
    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 Short2ShortNavigableMap synchronizeMap(Short2ShortNavigableMap map,
                                                     java.lang.Object mutex)
```
    Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.
    
    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 Short2ShortMap unmodifyableMap(Short2ShortMap map)
```
    A Helper function that creates a Helper wrapper to only allow Read Access into the Map
    
    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 Short2ShortSortedMap unmodifyableMap(Short2ShortSortedMap map)
```
    A Helper function that creates a Helper wrapper to only allow Read Access into the SortedMap
    
    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 Short2ShortNavigableMap unmodifyableMap(Short2ShortNavigableMap map)
```
    A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map
    
    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 Short2ShortMap.Entry unmodifyableEntry(Short2ShortMap.Entry entry)
```
    A Helper function that creates a Unmodifyable Entry
    
    Parameters:
    
    entry - the Entry that should be made unmodifyable
    
    Returns:
    
    a Unmodifyable Entry
  - unmodifyableEntry
```
public static Short2ShortMap.Entry unmodifyableEntry(java.util.Map.Entry<java.lang.Short,java.lang.Short> entry)
```
    A Helper function that creates a Unmodifyable Entry
    
    Parameters:
    
    entry - the Entry that should be made unmodifyable
    
    Returns:
    
    a Unmodifyable Entry
  - singletonMap
```
public static Short2ShortMap singletonMap(short key,
                                          short value)
```
    Creates a Singleton map from the provided values. This reduces overhead that normal Map implementations have.
    
    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.

Class Short2ShortMaps

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Constructor Detail

Short2ShortMaps

Method Detail

fastIterator

fastIterable

fastForEach

emptyMap

synchronizeMap

synchronizeMap

synchronizeMap

synchronizeMap

synchronizeMap

synchronizeMap

unmodifyableMap

unmodifyableMap

unmodifyableMap

unmodifyableEntry

unmodifyableEntry

singletonMap