Short2ObjectOrderedMap (Primitive-Collections 0.7.0 API)

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<java.lang.Short,V>, Short2ObjectFunction<V>, Short2ObjectMap<V>

All Known Implementing Classes:

ImmutableShort2ObjectOpenHashMap, Short2ObjectArrayMap, Short2ObjectLinkedOpenCustomHashMap, Short2ObjectLinkedOpenHashMap, Short2ObjectMaps.SynchronizedOrderedMap, Short2ObjectMaps.UnmodifyableOrderedMap
```
public interface Short2ObjectOrderedMap<V>
extends Short2ObjectMap<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`	`Short2ObjectOrderedMap.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.shorts.maps.interfaces.Short2ObjectMap
Short2ObjectMap.BuilderCache<V>, Short2ObjectMap.Entry<V>, Short2ObjectMap.FastEntrySet<V>, Short2ObjectMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap
builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, 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(short 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(short 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(short 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(short 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(short 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(short 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
  - firstShortKey
```
short firstShortKey()
```
    A method to get the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollFirstShortKey
```
short pollFirstShortKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - lastShortKey
```
short lastShortKey()
```
    A method to get the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - pollLastShortKey
```
short pollLastShortKey()
```
    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
```
Short2ObjectOrderedMap<V> copy()
```
    Description copied from interface: Short2ObjectMap
    
    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 Short2ObjectMap<V>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ShortOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Short,V>
    
    Specified by:
    
    keySet in interface Short2ObjectMap<V>
  - short2ObjectEntrySet
```
ObjectOrderedSet<Short2ObjectMap.Entry<V>> short2ObjectEntrySet()
```
    Description copied from interface: Short2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    short2ObjectEntrySet in interface Short2ObjectMap<V>
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Short2ObjectOrderedMap<V> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Short2ObjectMap<V>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)
  - synchronize
```
default Short2ObjectOrderedMap<V> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Short2ObjectMap<V>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Short2ObjectMaps.synchronize(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)
  - unmodifiable
```
default Short2ObjectOrderedMap<V> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Short2ObjectMap<V>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Short2ObjectMaps.unmodifiable(speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap<V>)

Interface Short2ObjectOrderedMap<V>

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

Method Summary

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ObjectMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstValue

lastValue

copy

keySet

short2ObjectEntrySet

synchronize

synchronize

unmodifiable