Char2ObjectOrderedMap (Primitive-Collections 0.8.0 API)

Type Parameters:

V - the keyType of elements maintained by this Collection

All Superinterfaces:

Char2ObjectMap<V>, CharFunction<V>, java.util.Map<java.lang.Character,V>

All Known Implementing Classes:

Char2ObjectArrayMap, Char2ObjectLinkedOpenCustomHashMap, Char2ObjectLinkedOpenHashMap, Char2ObjectMaps.SynchronizedOrderedMap, Char2ObjectMaps.UnmodifyableOrderedMap, ImmutableChar2ObjectOpenHashMap
```
public interface Char2ObjectOrderedMap<V>
extends Char2ObjectMap<V>
```
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`	`Char2ObjectOrderedMap.FastOrderedSet<V>` 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.Char2ObjectMap
Char2ObjectMap.BuilderCache<V>, Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>, Char2ObjectMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ObjectOrderedSet<Char2ObjectMap.Entry<V>>`	`char2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Char2ObjectOrderedMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`char`	`firstCharKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`V`	`getAndMoveToFirst(char key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`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.
`V`	`lastValue()` 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.
`V`	`putAndMoveToFirst(char key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(char key, V value)` A customized put method that allows you to insert into the last index.
`default Char2ObjectOrderedMap<V>`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Char2ObjectOrderedMap<V>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`default Char2ObjectOrderedMap<V>`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectMap
apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
V putAndMoveToFirst(char key,
                    V 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
```
V putAndMoveToLast(char key,
                   V 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
```
V 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
```
V 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
  - firstValue
```
V firstValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastValue
```
V lastValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - copy
```
Char2ObjectOrderedMap<V> copy()
```
    Description copied from interface: Char2ObjectMap
    
    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 Char2ObjectMap<V>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
CharOrderedSet keySet()
```
    Specified by:
    
    keySet in interface Char2ObjectMap<V>
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,V>
  - char2ObjectEntrySet
```
ObjectOrderedSet<Char2ObjectMap.Entry<V>> char2ObjectEntrySet()
```
    Description copied from interface: Char2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    char2ObjectEntrySet in interface Char2ObjectMap<V>
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Char2ObjectOrderedMap<V> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Char2ObjectMap<V>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)
  - synchronize
```
default Char2ObjectOrderedMap<V> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Char2ObjectMap<V>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Char2ObjectMaps.synchronize(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)
  - unmodifiable
```
default Char2ObjectOrderedMap<V> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Char2ObjectMap<V>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Char2ObjectMaps.unmodifiable(speiger.src.collections.chars.maps.interfaces.Char2ObjectMap<V>)

Interface Char2ObjectOrderedMap<V>

Nested Class Summary

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

Method Summary

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

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstValue

lastValue

copy

keySet

char2ObjectEntrySet

synchronize

synchronize

unmodifiable