SortedMap (TwelBox 1.05)

java.lang.Object
- org.brains2b.collection.SortedMap<A,B>

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator, java.util.Map<A,B>
```
public class SortedMap<A,B>
extends java.lang.Object
implements java.util.Map<A,B>, java.util.Comparator, java.io.Serializable
```
Map implementation that can be sorted defined by a given sort order Possible sort orders are
- KEY
- VALUE
- NO_SORT
Not sorted is the default implementation. Note:When using SortedMap with a Hashtable the sort order first is set to KEY. All other MAPs are set to NO_SORT regardless of how the Map sorting was implemented.
Since:

TwelBox 0.30

Version:

$Revision$ $Date$

Author:

dennis@brains2b.nl

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type Field and Description

static int KEY
value to set sorting on KEY

static int NO_SORT
value to set NO SORTING

static int VALUE
value to set sorting on VALUE

Fields
Modifier and Type	Field and Description
`static int`	`KEY` value to set sorting on KEY
`static int`	`NO_SORT` value to set NO SORTING
`static int`	`VALUE` value to set sorting on VALUE

Constructor Summary

Constructors
Constructor and Description
`SortedMap()` Constructor for SortedMap.
`SortedMap(java.util.Hashtable ht)` Constructor for SortedMap.
`SortedMap(int sortOrder)` Constructor for SortedMap.
`SortedMap(java.util.Map map)` Constructor for SortedMap.
`SortedMap(java.util.Map map, int sortOrder)` Constructor for SortedMap.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`int`	`compare(java.lang.Object oLeft, java.lang.Object oRight)` compare to Objects and returns the natural order Implementation takes the given sort order into account and will compare the keys or values respectively.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set`	`entrySet()`
`B`	`get(java.lang.Object key)` Overwritten the default get for performance reasons We bypass the entrySet() while it will sort the collection first.
`int`	`getSortOrder()` gets the sort order.
`boolean`	`isEmpty()`
`java.util.Set`	`keySet()`
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)` SortedMap does not allow null for keys or values
`void`	`putAll(java.util.Map m)`
`B`	`remove(java.lang.Object key)`
`void`	`setSortOrder(int sortOrder)` sets the sort order for this SortedMap
`int`	`size()`
`java.util.Collection`	`values()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Field Detail
  - KEY
```
public static final int KEY
```
    value to set sorting on KEY
    
    See Also:
    
    Constant Field Values
  - VALUE
```
public static final int VALUE
```
    value to set sorting on VALUE
    
    See Also:
    
    Constant Field Values
  - NO_SORT
```
public static final int NO_SORT
```
    value to set NO SORTING
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SortedMap
```
public SortedMap(int sortOrder)
```
    Constructor for SortedMap. initializes an empty SortedMap with the supplied sort Order
    
    Parameters:
    
    sortOrder - int in KEY|VALUE|SORT
  - SortedMap
```
public SortedMap()
```
    Constructor for SortedMap. initializes an empty SortedMap with NO_SORT
  - SortedMap
```
public SortedMap(java.util.Map map,
                 int sortOrder)
```
    Constructor for SortedMap. Initializes the SortedMap with a Map and a given sortOrder
    
    Parameters:
    
    map - java.util.Map
    
    sortOrder - int in KEY|VALUE|SORT
  - SortedMap
```
public SortedMap(java.util.Map map)
```
    Constructor for SortedMap. initializes the SortedMap with a Map and no sort order
    
    Parameters:
    
    map - java.util.Map
  - SortedMap
```
public SortedMap(java.util.Hashtable ht)
```
    Constructor for SortedMap. initializes the SortedMap with a Hashtable, sorted on keys
    
    Parameters:
    
    ht - Hashtable
- Method Detail
  - getSortOrder
```
public int getSortOrder()
```
    gets the sort order.
    
    Returns:
    
    int, the sort order used by this SortedMap, with a possible of three values: KEY, VALUE, NO_SORT
  - setSortOrder
```
public void setSortOrder(int sortOrder)
```
    sets the sort order for this SortedMap
    
    Parameters:
    
    sortOrder - int, the new sort order for this SortedMap, possible values are: KEY,VALUE, NO_SORT
  - compare
```
public int compare(java.lang.Object oLeft,
                   java.lang.Object oRight)
```
    compare to Objects and returns the natural order Implementation takes the given sort order into account and will compare the keys or values respectively. It will always return 1 if sort order is set to NO_SORT
    
    Specified by:
    
    compare in interface java.util.Comparator
    
    See Also:
    
    Comparator.compare(Object, Object)
  - entrySet
```
public java.util.Set entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<A,B>
    
    See Also:
    
    Map.entrySet()
  - get
```
public B get(java.lang.Object key)
```
    Overwritten the default get for performance reasons We bypass the entrySet() while it will sort the collection first. Something we don't need to get an individual value
    
    Specified by:
    
    get in interface java.util.Map<A,B>
    
    See Also:
    
    AbstractMap.get(java.lang.Object)
  - put
```
public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
```
    SortedMap does not allow null for keys or values
    
    Specified by:
    
    put in interface java.util.Map<A,B>
    
    See Also:
    
    Map.put(Object, Object)
  - putAll
```
public void putAll(java.util.Map m)
```
    Specified by:
    
    putAll in interface java.util.Map<A,B>
    
    See Also:
    
    Map.putAll(Map)
  - remove
```
public B remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<A,B>
    
    See Also:
    
    Map.remove(Object)
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<A,B>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<A,B>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<A,B>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<A,B>
  - keySet
```
public java.util.Set keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<A,B>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<A,B>
  - values
```
public java.util.Collection values()
```
    Specified by:
    
    values in interface java.util.Map<A,B>

Class SortedMap<A,B>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface java.util.Comparator

Field Detail

KEY

VALUE

NO_SORT

Constructor Detail

SortedMap

SortedMap

SortedMap

SortedMap

SortedMap

Method Detail

getSortOrder

setSortOrder

compare

entrySet

get

put

putAll

remove

clear

containsKey

containsValue

isEmpty

keySet

size

values