Byte2CharMaps (Primitive-Collections 0.7.0 API)

java.lang.Object
- speiger.src.collections.bytes.utils.maps.Byte2CharMaps

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

Constructor Summary

Constructors
Constructor and Description

Byte2CharMaps()

Constructors
Constructor and Description
`Byte2CharMaps()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Byte2CharMap`	`empty()` Empty Map getter function that autocasts to the desired Key and Value
`static void`	`fastForEach(Byte2CharMap map, java.util.function.Consumer<Byte2CharMap.Entry> action)` A Helper function that provides a faster forEach iterator implementation that recycles the entry to increase throughput
`static ObjectIterable<Byte2CharMap.Entry>`	`fastIterable(Byte2CharMap map)` Helper method that provides the fastIterable that recycles a single Entry to increase throughput.
`static ObjectIterator<Byte2CharMap.Entry>`	`fastIterator(Byte2CharMap map)` Helper method that provides the fastIterator that recycles a single Entry to increase throughput.
`static Byte2CharMap`	`singleton(byte key, char value)` Creates a Singleton map from the provided values.
`static Byte2CharMap`	`synchronize(Byte2CharMap map)` Helper function that creates a Helper wrapper to synchronize access into the map.
`static Byte2CharMap`	`synchronize(Byte2CharMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the map.
`static Byte2CharNavigableMap`	`synchronize(Byte2CharNavigableMap map)` Helper function that creates a Helper wrapper to synchronize access into the NavigableMap.
`static Byte2CharNavigableMap`	`synchronize(Byte2CharNavigableMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the NavigableMap.
`static Byte2CharOrderedMap`	`synchronize(Byte2CharOrderedMap map)` Helper function that creates a Helper wrapper to synchronize access into the OrderedMap.
`static Byte2CharOrderedMap`	`synchronize(Byte2CharOrderedMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the OrderedMap.
`static Byte2CharSortedMap`	`synchronize(Byte2CharSortedMap map)` Helper function that creates a Helper wrapper to synchronize access into the SortedMap.
`static Byte2CharSortedMap`	`synchronize(Byte2CharSortedMap map, java.lang.Object mutex)` Helper function that creates a Helper wrapper to synchronize access with custom access control into the SortedMap.
`static Byte2CharMap.Entry`	`unmodifiable(Byte2CharMap.Entry entry)` A Helper function that creates a Unmodifyable Entry
`static Byte2CharMap`	`unmodifiable(Byte2CharMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into the Map
`static Byte2CharNavigableMap`	`unmodifiable(Byte2CharNavigableMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into NavigableMap Map
`static Byte2CharOrderedMap`	`unmodifiable(Byte2CharOrderedMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into the OrderedMap
`static Byte2CharSortedMap`	`unmodifiable(Byte2CharSortedMap map)` A Helper function that creates a Helper wrapper to only allow Read Access into the SortedMap
`static Byte2CharMap.Entry`	`unmodifiable(java.util.Map.Entry<java.lang.Byte,java.lang.Character> entry)` A Helper function that creates a Unmodifyable Entry

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

- Constructor Detail
  - Byte2CharMaps
```
public Byte2CharMaps()
```
- Method Detail
  - empty
```
public static Byte2CharMap empty()
```
    Empty Map getter function that autocasts to the desired Key and Value
    
    Returns:
    
    empty map of desired type
  - fastIterator
```
public static ObjectIterator<Byte2CharMap.Entry> fastIterator(Byte2CharMap 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<Byte2CharMap.Entry> fastIterable(Byte2CharMap 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(Byte2CharMap map,
                               java.util.function.Consumer<Byte2CharMap.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
  - synchronize
```
public static Byte2CharMap synchronize(Byte2CharMap 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
  - synchronize
```
public static Byte2CharMap synchronize(Byte2CharMap 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
  - synchronize
```
public static Byte2CharSortedMap synchronize(Byte2CharSortedMap 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
  - synchronize
```
public static Byte2CharSortedMap synchronize(Byte2CharSortedMap 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
  - synchronize
```
public static Byte2CharOrderedMap synchronize(Byte2CharOrderedMap map)
```
    Helper function that creates a Helper wrapper to synchronize access into the OrderedMap.
    
    Parameters:
    
    map - the OrderedMap that should be synchronized
    
    Returns:
    
    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 Byte2CharOrderedMap synchronize(Byte2CharOrderedMap map,
                                              java.lang.Object mutex)
```
    Helper function that creates a Helper wrapper to synchronize access with custom access control into the OrderedMap.
    
    Parameters:
    
    map - the OrderedMap that should be synchronized
    
    mutex - the object that controls access
    
    Returns:
    
    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 Byte2CharNavigableMap synchronize(Byte2CharNavigableMap 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
  - synchronize
```
public static Byte2CharNavigableMap synchronize(Byte2CharNavigableMap 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
  - unmodifiable
```
public static Byte2CharMap unmodifiable(Byte2CharMap 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
  - unmodifiable
```
public static Byte2CharOrderedMap unmodifiable(Byte2CharOrderedMap map)
```
    A Helper function that creates a Helper wrapper to only allow Read Access into the OrderedMap
    
    Parameters:
    
    map - the OrderedMap that should be made Unmodifiable
    
    Returns:
    
    a unmodifiable OrderedMap
    
    Note:
    
    if the inputted OrderedMap is already unmodifiable then it will just return it instead
  - unmodifiable
```
public static Byte2CharSortedMap unmodifiable(Byte2CharSortedMap 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
  - unmodifiable
```
public static Byte2CharNavigableMap unmodifiable(Byte2CharNavigableMap 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
  - unmodifiable
```
public static Byte2CharMap.Entry unmodifiable(Byte2CharMap.Entry entry)
```
    A Helper function that creates a Unmodifyable Entry
    
    Parameters:
    
    entry - the Entry that should be made unmodifiable
    
    Returns:
    
    a Unmodifyable Entry
  - unmodifiable
```
public static Byte2CharMap.Entry unmodifiable(java.util.Map.Entry<java.lang.Byte,java.lang.Character> entry)
```
    A Helper function that creates a Unmodifyable Entry
    
    Parameters:
    
    entry - the Entry that should be made unmodifiable
    
    Returns:
    
    a Unmodifyable Entry
  - singleton
```
public static Byte2CharMap singleton(byte key,
                                     char 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 unmodifiable Singleton map.

Class Byte2CharMaps

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Byte2CharMaps

Method Detail

empty

fastIterator

fastIterable

fastForEach

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

synchronize

unmodifiable

unmodifiable

unmodifiable

unmodifiable

unmodifiable

unmodifiable

singleton