Int2ShortOrderedMap (Primitive-Collections 0.8.0 API)

All Superinterfaces:

Int2ShortFunction, Int2ShortMap, java.util.Map<java.lang.Integer,java.lang.Short>

All Known Implementing Classes:

ImmutableInt2ShortOpenHashMap, Int2ShortArrayMap, Int2ShortLinkedOpenCustomHashMap, Int2ShortLinkedOpenHashMap, Int2ShortMaps.SynchronizedOrderedMap, Int2ShortMaps.UnmodifyableOrderedMap
```
public interface Int2ShortOrderedMap
extends Int2ShortMap
```
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`	`Int2ShortOrderedMap.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.ints.maps.interfaces.Int2ShortMap
Int2ShortMap.BuilderCache, Int2ShortMap.Entry, Int2ShortMap.FastEntrySet, Int2ShortMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortMap
addTo, addToAll, applyAsShort, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
short putAndMoveToFirst(int key,
                        short 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
```
short putAndMoveToLast(int key,
                       short 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(int 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(int 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
```
short getAndMoveToFirst(int 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
```
short getAndMoveToLast(int 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
  - firstIntKey
```
int firstIntKey()
```
    A method to get the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
int pollFirstIntKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
int lastIntKey()
```
    A method to get the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
int pollLastIntKey()
```
    A method to get and remove the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - firstShortValue
```
short firstShortValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastShortValue
```
short lastShortValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - copy
```
Int2ShortOrderedMap copy()
```
    Description copied from interface: Int2ShortMap
    
    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 Int2ShortMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
IntOrderedSet keySet()
```
    Specified by:
    
    keySet in interface Int2ShortMap
    
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,java.lang.Short>
  - int2ShortEntrySet
```
ObjectOrderedSet<Int2ShortMap.Entry> int2ShortEntrySet()
```
    Description copied from interface: Int2ShortMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    int2ShortEntrySet in interface Int2ShortMap
    
    Returns:
    
    a EntrySet of the collection
  - synchronize
```
default Int2ShortOrderedMap synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Int2ShortMap
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Int2ShortMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)
  - synchronize
```
default Int2ShortOrderedMap synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Int2ShortMap
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Int2ShortMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)
  - unmodifiable
```
default Int2ShortOrderedMap unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Int2ShortMap
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Int2ShortMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)

Interface Int2ShortOrderedMap

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortMap

Method Summary

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2ShortMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstShortValue

lastShortValue

copy

keySet

int2ShortEntrySet

synchronize

synchronize

unmodifiable