Short2CharOrderedMap (Primitive-Collections 0.8.0 API)

All Superinterfaces:

java.util.Map<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap

All Known Implementing Classes:

ImmutableShort2CharOpenHashMap, Short2CharArrayMap, Short2CharLinkedOpenCustomHashMap, Short2CharLinkedOpenHashMap, Short2CharMaps.SynchronizedOrderedMap, Short2CharMaps.UnmodifyableOrderedMap
```
public interface Short2CharOrderedMap
extends Short2CharMap
```
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`	`Short2CharOrderedMap.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.shorts.maps.interfaces.Short2CharMap
Short2CharMap.BuilderCache, Short2CharMap.Entry, Short2CharMap.FastEntrySet, Short2CharMap.MapBuilder

Method Summary

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

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap
addTo, addToAll, applyAsChar, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent, values

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

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

Interface Short2CharOrderedMap

Nested Class Summary

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

Method Summary

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

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstCharValue

lastCharValue

copy

keySet

short2CharEntrySet

synchronize

synchronize

unmodifiable