MapUtils (Bremersee Utilities 1.0.5 API)

java.lang.Object
- org.bremersee.utils.MapUtils

```
public abstract class MapUtils
extends Object
```
Some methods to work with maps.

Author:

Christian Bremer

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Object`	`getFirstValue(Map<?,?> map, Object key, Object defaultValue)` Get the first value with the specified key.
`static BigDecimal`	`getValueAsBigDecimal(Map<?,?> map, Object key, BigDecimal defaultValue)` Get a value as `BigDecimal`.
`static BigInteger`	`getValueAsBigInteger(Map<?,?> map, Object key, BigInteger defaultValue)` Get a value as `BigInteger`.
`static Boolean`	`getValueAsBoolean(Map<?,?> map, Object key, Boolean defaultValue)` Get a value as boolean.
`static Byte`	`getValueAsByte(Map<?,?> map, Object key, Byte defaultValue)` Get a value as byte.
`static Collection<?>`	`getValueAsCollection(Map<?,?> map, Object key)` Get a value as collection.
`static Double`	`getValueAsDouble(Map<?,?> map, Object key, Double defaultValue)` Get a value as double.
`static <T extends Enum<T>> T`	`getValueAsEnum(Map<?,?> map, Object key, Class<T> enumType, T defaultValue)` Get a value as enumeration.
`static Float`	`getValueAsFloat(Map<?,?> map, Object key, Float defaultValue)` Get a value as float.
`static Integer`	`getValueAsInteger(Map<?,?> map, Object key, Integer defaultValue)` Get a value as integer.
`static List<?>`	`getValueAsList(Map<?,?> map, Object key)` Get a value as list.
`static Long`	`getValueAsLong(Map<?,?> map, Object key, Long defaultValue)` Get a value as long.
`static Set<?>`	`getValueAsSet(Map<?,?> map, Object key)` Get a value as set.
`static Short`	`getValueAsShort(Map<?,?> map, Object key, Short defaultValue)` Get a value as short.
`static String`	`getValueAsString(Map<?,?> map, Object key, String defaultValue)` Get a value as string.
`static <K,V> Map<K,V>`	`sort(Map<? extends K,? extends V> map)` Sort the map by the values natural sort order and return an unmodifiable map.
`static <K,V> Map<K,V>`	`sort(Map<? extends K,? extends V> map, Comparator<? extends V> valueComparator)` Sort the map by it's values and return an unmodifiable map.

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

- Method Detail
  - sort
```
public static <K,V> Map<K,V> sort(Map<? extends K,? extends V> map)
```
    Sort the map by the values natural sort order and return an unmodifiable map.
    
    Parameters:
    
    map - the map
    
    Returns:
    
    the sorted map
  - sort
```
public static <K,V> Map<K,V> sort(Map<? extends K,? extends V> map,
                                  Comparator<? extends V> valueComparator)
```
    Sort the map by it's values and return an unmodifiable map.
    
    Parameters:
    
    map - the map
    
    valueComparator - a value comparator
    
    Returns:
    
    the sorted map
  - getFirstValue
```
public static Object getFirstValue(Map<?,?> map,
                                   Object key,
                                   Object defaultValue)
```
    Get the first value with the specified key. If no value exists with the specified key, the default value will be returned.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the first value if it exists otherwise the default value
  - getValueAsCollection
```
public static Collection<?> getValueAsCollection(Map<?,?> map,
                                                 Object key)
```
    Get a value as collection. If no value exists with the specified key, an empty collection will be returned.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    Returns:
    
    a collection
  - getValueAsList
```
public static List<?> getValueAsList(Map<?,?> map,
                                     Object key)
```
    Get a value as list. If no value exists with the specified key, an empty list will be returned.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    Returns:
    
    a list
  - getValueAsSet
```
public static Set<?> getValueAsSet(Map<?,?> map,
                                   Object key)
```
    Get a value as set. If no value exists with the specified key, an empty set will be returned.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    Returns:
    
    a set
  - getValueAsString
```
public static String getValueAsString(Map<?,?> map,
                                      Object key,
                                      String defaultValue)
```
    Get a value as string. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsBoolean
```
public static Boolean getValueAsBoolean(Map<?,?> map,
                                        Object key,
                                        Boolean defaultValue)
```
    Get a value as boolean. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsBigInteger
```
public static BigInteger getValueAsBigInteger(Map<?,?> map,
                                              Object key,
                                              BigInteger defaultValue)
```
    Get a value as BigInteger. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsLong
```
public static Long getValueAsLong(Map<?,?> map,
                                  Object key,
                                  Long defaultValue)
```
    Get a value as long. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsInteger
```
public static Integer getValueAsInteger(Map<?,?> map,
                                        Object key,
                                        Integer defaultValue)
```
    Get a value as integer. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsByte
```
public static Byte getValueAsByte(Map<?,?> map,
                                  Object key,
                                  Byte defaultValue)
```
    Get a value as byte. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsShort
```
public static Short getValueAsShort(Map<?,?> map,
                                    Object key,
                                    Short defaultValue)
```
    Get a value as short. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsBigDecimal
```
public static BigDecimal getValueAsBigDecimal(Map<?,?> map,
                                              Object key,
                                              BigDecimal defaultValue)
```
    Get a value as BigDecimal. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsDouble
```
public static Double getValueAsDouble(Map<?,?> map,
                                      Object key,
                                      Double defaultValue)
```
    Get a value as double. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsFloat
```
public static Float getValueAsFloat(Map<?,?> map,
                                    Object key,
                                    Float defaultValue)
```
    Get a value as float. If no value exists with the specified key, the default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key
  - getValueAsEnum
```
public static <T extends Enum<T>> T getValueAsEnum(Map<?,?> map,
                                                   Object key,
                                                   Class<T> enumType,
                                                   T defaultValue)
```
    Get a value as enumeration. If no value exists with the specified key, default value will be returned. If the value cannot be cast to the return type, the default value will be returned, too.
    
    Parameters:
    
    map - the map
    
    key - the key
    
    enumType - the enumeration type (can only be null if default value is not null or a value of the specified key exists and has a type of the wanted enumeration
    
    defaultValue - a default value
    
    Returns:
    
    the value of the key

Class MapUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sort

sort

getFirstValue

getValueAsCollection

getValueAsList

getValueAsSet

getValueAsString

getValueAsBoolean

getValueAsBigInteger

getValueAsLong

getValueAsInteger

getValueAsByte

getValueAsShort

getValueAsBigDecimal

getValueAsDouble

getValueAsFloat

getValueAsEnum