Char2IntOrderedMap (Primitive-Collections 0.7.0 API)

All Superinterfaces:

Char2IntFunction, Char2IntMap, java.util.Map<java.lang.Character,java.lang.Integer>

All Known Implementing Classes:

Char2IntArrayMap, Char2IntLinkedOpenCustomHashMap, Char2IntLinkedOpenHashMap, Char2IntMaps.SynchronizedOrderedMap, Char2IntMaps.UnmodifyableOrderedMap, ImmutableChar2IntOpenHashMap
```
public interface Char2IntOrderedMap
extends Char2IntMap
```
A Special Map Interface giving Access to some really usefull functions The Idea behind this interface is to allow access to functions that give control to the Order of elements. Since Linked implementations as examples can be reordered outside of the Insertion Order. This interface provides basic access to such functions while also providing some Sorted/NaivgableMap implementations that still fit into here.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Char2IntOrderedMap.FastOrderedSet` Fast Ordered Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap
Char2IntMap.BuilderCache, Char2IntMap.Entry, Char2IntMap.FastEntrySet, Char2IntMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ObjectOrderedSet<Char2IntMap.Entry>`	`char2IntEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Char2IntOrderedMap`	`copy()` A Function that does a shallow clone of the Map itself.
`char`	`firstCharKey()` A method to get the first Key of a Map.
`int`	`firstIntValue()` A method to get the first Value of a Map.
`int`	`getAndMoveToFirst(char key)` A Specific get method that allows to move teh given key/value int the first index.
`int`	`getAndMoveToLast(char key)` A Specific get method that allows to move teh given key/value int the last index.
`CharOrderedSet`	`keySet()`
`char`	`lastCharKey()` A method to get the last Key of a Map.
`int`	`lastIntValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(char key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(char key)` A specific move method to move a given key/value to the last index.
`char`	`pollFirstCharKey()` A method to get and remove the first Key of a Map.
`char`	`pollLastCharKey()` A method to get and remove the last Key of a Map.
`int`	`putAndMoveToFirst(char key, int value)` A customized put method that allows you to insert into the first index.
`int`	`putAndMoveToLast(char key, int value)` A customized put method that allows you to insert into the last index.
`default Char2IntOrderedMap`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Char2IntOrderedMap`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`default Char2IntOrderedMap`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap
addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, subFrom, supplyIntIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
int putAndMoveToFirst(char key,
                      int value)
```
    A customized put method that allows you to insert into the first index.
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - putAndMoveToLast
```
int putAndMoveToLast(char key,
                     int value)
```
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
  - moveToFirst
```
boolean moveToFirst(char key)
```
    A specific move method to move a given key/value to the first index.
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place
  - moveToLast
```
boolean moveToLast(char key)
```
    A specific move method to move a given key/value to the last index.
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place
  - getAndMoveToFirst
```
int getAndMoveToFirst(char key)
```
    A Specific get method that allows to move teh given key/value int the first index.
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
int getAndMoveToLast(char key)
```
    A Specific get method that allows to move teh given key/value int the last index.
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - firstCharKey
```
char firstCharKey()
```
    A method to get the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollFirstCharKey
```
char pollFirstCharKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - lastCharKey
```
char lastCharKey()
```
    A method to get the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - pollLastCharKey
```
char pollLastCharKey()
```
    A method to get and remove the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - firstIntValue
```
int firstIntValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastIntValue
```
int lastIntValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - copy
```
Char2IntOrderedMap copy()
```
    Description copied from interface: Char2IntMap
    
    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
    
    Specified by:
    
    copy in interface Char2IntMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
CharOrderedSet keySet()
```
    Specified by:
    
    keySet in interface Char2IntMap
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,java.lang.Integer>
  - char2IntEntrySet
```
ObjectOrderedSet<Char2IntMap.Entry> char2IntEntrySet()
```
    Description copied from interface: Char2IntMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    char2IntEntrySet in interface Char2IntMap
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Char2IntOrderedMap synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Char2IntMap
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Char2IntMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2IntMap)
  - synchronize
```
default Char2IntOrderedMap synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Char2IntMap
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Char2IntMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2IntMap)
  - unmodifiable
```
default Char2IntOrderedMap unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Char2IntMap
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Char2IntMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2IntMap)

Interface Char2IntOrderedMap

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap

Method Summary

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstIntValue

lastIntValue

copy

keySet

char2IntEntrySet

synchronize

synchronize

unmodifiable