com.alee.utils

Class MapUtils

java.lang.Object

com.alee.utils.MapUtils

public final class MapUtils
extends Object

This class provides a set of utilities to work with various Map implementations.

Author:

Mikle Garin

Method Summary

Modifier and Type	Method and Description
static <K,V> HashMap<K,V>	copyHashMap(HashMap<K,V> map) Returns copied HashMap.
static <K,V> LinkedHashMap<K,V>	copyLinkedHashMap(LinkedHashMap<K,V> map) Returns copied LinkedHashMap.
static <K,V> HashMap<K,V>	copyMap(Map<K,V> map) Returns copied Map.
static boolean	isEmpty(Map map) Returns whether specified Map is empty or not.
static <K,V> HashMap<K,V>	merge(Map<K,V>... maps) Merges specified maps into one new map and returns it.
static <K,V> HashMap<K,V>	newHashMap(K key, V value) Returns newly created HashMap with the specified key and value pair added.
static <K,V> HashMap<K,V>	newHashMap(Map<K,V> data) Returns newly created HashMap with the specified map data.
static <K,V> HashMap<K,V>	newHashMap(Object... objects) Returns newly created HashMap with the specified key and value pairs added.
static <K,V> LinkedHashMap<K,V>	newLinkedHashMap(K key, V value) Returns newly created LinkedHashMap with the specified key and value pair added.
static <K,V> LinkedHashMap<K,V>	newLinkedHashMap(Object... objects) Returns newly created LinkedHashMap with the specified key and value pairs added.
static <K,V> Map<K,V>	nonNull(Map<K,V> map) Returns non-null Map that is either specified map or new empty HashMap.
static boolean	notEmpty(Map map) Returns whether specified Map is empty or not.
static <K,V> void	removeAllValues(Map<K,V> map, V value) Removes all map entries where value is the same as the specified one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isEmpty

public static boolean isEmpty(@Nullable
                              Map map)

Returns whether specified Map is empty or not.

Parameters:

map - Map to process

Returns:

true if specified Map is empty, false otherwise

notEmpty

public static boolean notEmpty(@Nullable
                               Map map)

Returns whether specified Map is empty or not.

Parameters:

map - Map to process

Returns:

true if specified Map is not empty, false otherwise

nonNull

@NotNull
public static <K,V> Map<K,V> nonNull(@Nullable
                                              Map<K,V> map)

Returns non-null Map that is either specified map or new empty HashMap.

Type Parameters:

K - map key type

V - map value type

Parameters:

map - Map

Returns:

non-null Map that is either specified map or new empty HashMap

copyMap

@NotNull
public static <K,V> HashMap<K,V> copyMap(@NotNull
                                                  Map<K,V> map)

Returns copied Map.

Type Parameters:

K - map key type

V - map value type

Parameters:

map - map to copy

Returns:

copied Map

copyHashMap

@NotNull
public static <K,V> HashMap<K,V> copyHashMap(@NotNull
                                                      HashMap<K,V> map)

Returns copied HashMap.

Type Parameters:

K - HashMap key type

V - HashMap value type

Parameters:

map - HashMap to copy

Returns:

copied HashMap

copyLinkedHashMap

@NotNull
public static <K,V> LinkedHashMap<K,V> copyLinkedHashMap(@NotNull
                                                                  LinkedHashMap<K,V> map)

Returns copied LinkedHashMap.

Type Parameters:

K - LinkedHashMap key type

V - LinkedHashMap value type

Parameters:

map - LinkedHashMap to copy

Returns:

copied LinkedHashMap

newHashMap

@NotNull
public static <K,V> HashMap<K,V> newHashMap(@NotNull
                                                     Map<K,V> data)

Returns newly created HashMap with the specified map data.

Type Parameters:

K - key type

V - value type

Parameters:

data - data map

Returns:

newly created HashMap

newHashMap

@NotNull
public static <K,V> HashMap<K,V> newHashMap(@Nullable
                                                     K key,
                                                     @Nullable
                                                     V value)

Returns newly created HashMap with the specified key and value pair added.

Type Parameters:

K - key type

V - value type

Parameters:

key - key to add

value - value to add

Returns:

newly created HashMap

newHashMap

@NotNull
public static <K,V> HashMap<K,V> newHashMap(@Nullable
                                                     Object... objects)

Returns newly created HashMap with the specified key and value pairs added.

Type Parameters:

K - key type

V - value type

Parameters:

objects - mixed keys and values

Returns:

newly created HashMap

newLinkedHashMap

@NotNull
public static <K,V> LinkedHashMap<K,V> newLinkedHashMap(@Nullable
                                                                 K key,
                                                                 @Nullable
                                                                 V value)

Returns newly created LinkedHashMap with the specified key and value pair added.

Type Parameters:

K - key type

V - value type

Parameters:

key - key to add

value - value to add

Returns:

newly created LinkedHashMap

newLinkedHashMap

@NotNull
public static <K,V> LinkedHashMap<K,V> newLinkedHashMap(@Nullable
                                                                 Object... objects)

Returns newly created LinkedHashMap with the specified key and value pairs added.

Type Parameters:

K - key type

V - value type

Parameters:

objects - key-value pairs

Returns:

newly created LinkedHashMap

removeAllValues

public static <K,V> void removeAllValues(@NotNull
                                         Map<K,V> map,
                                         @Nullable
                                         V value)

Removes all map entries where value is the same as the specified one.

Type Parameters:

K - key type

V - value type

Parameters:

map - map to remove entries from

value - value for which entries should be removed

merge

@NotNull
public static <K,V> HashMap<K,V> merge(@NotNull
                                                Map<K,V>... maps)

Merges specified maps into one new map and returns it.

Type Parameters:

K - key type

V - value type

Parameters:

maps - maps to merge into new one

Returns:

new map containing all provided maps merged into it