Object2ObjectOrderedMap (Primitive-Collections 0.8.0 API)

Type Parameters:

T - the keyType of elements maintained by this Collection

V - the keyType of elements maintained by this Collection

All Superinterfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectMap<T,V>, UnaryOperator<T,V>

All Known Implementing Classes:

ImmutableObject2ObjectOpenHashMap, LinkedEnum2ObjectMap, Object2ObjectArrayMap, Object2ObjectLinkedOpenCustomHashMap, Object2ObjectLinkedOpenHashMap, Object2ObjectMaps.SynchronizedOrderedMap, Object2ObjectMaps.UnmodifyableOrderedMap
```
public interface Object2ObjectOrderedMap<T,V>
extends Object2ObjectMap<T,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`	`Object2ObjectOrderedMap.FastOrderedSet<T,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.objects.maps.interfaces.Object2ObjectMap
Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Object2ObjectOrderedMap<T,V>`	`copy()` A Function that does a shallow clone of the Map itself.
`T`	`firstKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`V`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`ObjectOrderedSet<T>`	`keySet()`
`T`	`lastKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(T key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(T key)` A specific move method to move a given key/value to the last index.
`ObjectOrderedSet<Object2ObjectMap.Entry<T,V>>`	`object2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`V`	`putAndMoveToFirst(T key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(T key, V value)` A customized put method that allows you to insert into the last index.
`default Object2ObjectOrderedMap<T,V>`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Object2ObjectOrderedMap<T,V>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`default Object2ObjectOrderedMap<T,V>`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap
apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, getObject, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent, values

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

Methods inherited from interface speiger.src.collections.objects.functions.function.UnaryOperator
andThen, compose, identity

Methods inherited from interface java.util.function.Function
andThen, compose

- Method Detail
  - putAndMoveToFirst
```
V putAndMoveToFirst(T 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(T 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(T 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(T 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(T 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(T 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
  - firstKey
```
T firstKey()
```
    A method to get the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollFirstKey
```
T pollFirstKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - lastKey
```
T lastKey()
```
    A method to get the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - pollLastKey
```
T pollLastKey()
```
    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
```
Object2ObjectOrderedMap<T,V> copy()
```
    Description copied from interface: Object2ObjectMap
    
    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 Object2ObjectMap<T,V>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ObjectOrderedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,V>
    
    Specified by:
    
    keySet in interface Object2ObjectMap<T,V>
  - object2ObjectEntrySet
```
ObjectOrderedSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()
```
    Description copied from interface: Object2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    object2ObjectEntrySet in interface Object2ObjectMap<T,V>
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Object2ObjectOrderedMap<T,V> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2ObjectMap<T,V>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Object2ObjectMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)
  - synchronize
```
default Object2ObjectOrderedMap<T,V> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2ObjectMap<T,V>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Object2ObjectMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)
  - unmodifiable
```
default Object2ObjectOrderedMap<T,V> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2ObjectMap<T,V>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2ObjectMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)

Interface Object2ObjectOrderedMap<T,V>

Nested Class Summary

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

Method Summary

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

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.util.function.Function

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstKey

pollFirstKey

lastKey

pollLastKey

firstValue

lastValue

copy

keySet

object2ObjectEntrySet

synchronize

synchronize

unmodifiable