Package com.identity4j.util

Class MultiMap

java.lang.Object

com.identity4j.util.MultiMap

All Implemented Interfaces:

Serializable, Map<String,String[]>

public class MultiMap
extends Object
implements Serializable, Map<String,String[]>

Object that acts like a Map that can have multiple string values.

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
MultiMap()	Construct using a empty map.
MultiMap(Map<String,String[]> values)	Construct using a string array map.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,String[]>>	entrySet()
boolean	equals(Object obj)
static MultiMap	fromMap(Map<String,String[]> map)
static MultiMap	fromMapSingle(Map<String,String> values)
String[]	get(Object key)
Boolean	getBoolean(String key)	Get the boolean value of an entry given its key.
Boolean	getBooleanOrDefault(String key, boolean defaultValue)	Get the boolean value of an entry given its key or a default value if no such entry exists.
Boolean	getBooleanOrFail(String key)	Get the boolean value of an entry given its key or fail with an exception if it does not.
Boolean	getBooleanOrNull(String key)	Get the boolean value of an entry given its key or null if no such entry exists.
Integer	getInteger(String key)	Get the integer value of an entry given its key.
Integer	getIntegerOrDefault(String key, Integer defaultValue)	Get the integer value of an entry given its key or a default value if no such entry exists..
Integer	getIntegerOrFail(String key)	Get the boolean value of an entry given its key or fail with an exception if it does not.
Integer	getIntegerOrNull(String key)	Get the integer value of an entry given its key or null if no such entry exists.
Iterable<String>	getKeyIterator()	Get an iterator of all keys.
Map<String,String>	getMap(String key)	Get the java.util.Map value of an entry given its key.
Map<String,String>	getMapOrDefault(String key, Map<String,String> defaultValue)	Get the java.util.Map value of an entry given its key or a default value if no such entry exists.
Map<String,String>	getMapOrFail(String key)	Get the java.util.Map value of an entry given its key or fail with an exception if it does not.
Map<String,String>	getMapOrNull(String key)	Get the java.util.Map value of an entry given its key or null if no such entry exists.
String	getString(String key)	Get the string value of an entry given its key.
String[]	getStringArray(String key)	Get the string array value of an entry given its key.
String[]	getStringArrayOrDefault(String key, String... defaultValues)	Get the string array value of an entry given its key or default values if no such entry exists.
String[]	getStringArrayOrFail(String key)	Get the string array value of an entry given its key or fail with an exception if it does not.
String[]	getStringArrayOrNull(String key)	Get the string array value of an entry given its key or null if no such entry exists.
String	getStringOrDefault(String key, String defaultValue)	Get the string value of an entry given its key or a default value if no such entry exists..
String	getStringOrFail(String key)	Get the string value of an entry given its key or fail with an exception if it does not.
String	getStringOrNull(String key)	Get the string value of an entry given its key or null if no such entry exists.
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
void	merge(MultiMap source)
String[]	put(String key, String[] value)
void	putAll(Map<? extends String,? extends String[]> map)
String[]	remove(Object key)
String[]	set(String key, String... values)	Set a value.
String[]	set(String key, Collection<String> values)	Set a value.
void	setAll(Map<String,String[]> values)	Sets supplied values.
String[]	setMore(String key, String... values)	Adds the supplied values to any values currently set under this key.
int	size()
Map<String,String[]>	toMap()
static Map<String,String>	toMap(Map<String,String[]> map)
static MultiMap	toMultiMap(Map<String,String> originalMap)	Create a new MultiMap given a string array map.
static MultiMap	toMultiMap(Properties originalMap)	Create a new MultiMap given properties.
String	toString()
Collection<String[]>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

MultiMap

public MultiMap()

Construct using a empty map.

MultiMap

public MultiMap(Map<String,String[]> values)

Construct using a string array map.

Parameters:

values -

Method Detail

fromMapSingle

public static MultiMap fromMapSingle(Map<String,String> values)

fromMap

public static MultiMap fromMap(Map<String,String[]> map)

setAll

public void setAll(Map<String,String[]> values)

Sets supplied values.

Parameters:

values -

setMore

public String[] setMore(String key,
                        String... values)

Adds the supplied values to any values currently set under this key. A null value will be returned if no such value exists.

Parameters:

key - key

values - values

Returns:

old value

set

public String[] set(String key,
                    String... values)

Set a value. A null value will be returned if no such value exists.

Parameters:

key - key

values - values

Returns:

old value

set

public String[] set(String key,
                    Collection<String> values)

Set a value. A null value will be returned if no such value exists.

Parameters:

key - key

values - values

Returns:

old value

getString

public final String getString(String key)

Get the string value of an entry given its key. An empty string will be returned if no such entry exists.

Parameters:

key - entry key

Returns:

string entry value

getStringOrDefault

public final String getStringOrDefault(String key,
                                       String defaultValue)

Get the string value of an entry given its key or a default value if no such entry exists..

Parameters:

key - entry key

defaultValue - default value

Returns:

string entry value

getStringOrNull

public final String getStringOrNull(String key)

Get the string value of an entry given its key or null if no such entry exists.

Parameters:

key - entry key

Returns:

string entry value

getStringOrFail

public final String getStringOrFail(String key)

Get the string value of an entry given its key or fail with an exception if it does not.

Parameters:

key - key

Returns:

string value

Throws:

MultiMapException - if no such entry exists

getStringArray

public final String[] getStringArray(String key)

Get the string array value of an entry given its key. An empty array will be returned if no such entry exists.

Parameters:

key - entry key

Returns:

string array entry values

getStringArrayOrDefault

public final String[] getStringArrayOrDefault(String key,
                                              String... defaultValues)

Get the string array value of an entry given its key or default values if no such entry exists.

Parameters:

key - entry key

defaultValues - default values

Returns:

string array entry values

getStringArrayOrNull

public final String[] getStringArrayOrNull(String key)

Get the string array value of an entry given its key or null if no such entry exists.

Parameters:

key - entry key

Returns:

string array entry value

getStringArrayOrFail

public final String[] getStringArrayOrFail(String key)

Get the string array value of an entry given its key or fail with an exception if it does not.

Parameters:

key - entry key

Returns:

string array entry value

Throws:

MultiMapException - if no such entry exists

getBoolean

public final Boolean getBoolean(String key)

Get the boolean value of an entry given its key. Boolean.FALSE will be returned if no such entry exists.

Parameters:

key - entry key

Returns:

boolean entry value

getBooleanOrDefault

public final Boolean getBooleanOrDefault(String key,
                                         boolean defaultValue)

Get the boolean value of an entry given its key or a default value if no such entry exists.

Parameters:

key - entry key

defaultValue - default value

Returns:

boolean entry value

getBooleanOrNull

public final Boolean getBooleanOrNull(String key)

Get the boolean value of an entry given its key or null if no such entry exists.

Parameters:

key - entry key

Returns:

boolean entry value

getBooleanOrFail

public final Boolean getBooleanOrFail(String key)

Get the boolean value of an entry given its key or fail with an exception if it does not.

Parameters:

key - key

Returns:

boolean entry value

Throws:

MultiMapException - if no such entry exists

getInteger

public final Integer getInteger(String key)

Get the integer value of an entry given its key. -1 will be returned if no such entry exists.

Parameters:

key - entry key

Returns:

integer entry value

getIntegerOrDefault

public final Integer getIntegerOrDefault(String key,
                                         Integer defaultValue)

Get the integer value of an entry given its key or a default value if no such entry exists..

Parameters:

key - entry key

defaultValue - default value

Returns:

integer entry value

getIntegerOrNull

public final Integer getIntegerOrNull(String key)

Get the integer value of an entry given its key or null if no such entry exists.

Parameters:

key - entry key

Returns:

integer entry value

getIntegerOrFail

public final Integer getIntegerOrFail(String key)

Get the boolean value of an entry given its key or fail with an exception if it does not.

Parameters:

key - key

Returns:

boolean entry value

Throws:

MultiMapException - if no such entry exists

getMap

public final Map<String,String> getMap(String key)

Get the java.util.Map value of an entry given its key. Collections.emptyMap() will be returned if no such entry exists.

Parameters:

key - entry key

Returns:

Map entry value

getMapOrDefault

public final Map<String,String> getMapOrDefault(String key,
                                                      Map<String,String> defaultValue)

Get the java.util.Map value of an entry given its key or a default value if no such entry exists.

Parameters:

key - entry key

defaultValue - default value

Returns:

Map entry value

getMapOrNull

public final Map<String,String> getMapOrNull(String key)

Get the java.util.Map value of an entry given its key or null if no such entry exists.

Parameters:

key - entry key

Returns:

Map entry value

getMapOrFail

public final Map<String,String> getMapOrFail(String key)

Get the java.util.Map value of an entry given its key or fail with an exception if it does not.

Parameters:

key - key

Returns:

Map entry value

Throws:

MultiMapException - if no such entry exists

getKeyIterator

public final Iterable<String> getKeyIterator()

Get an iterator of all keys.

Returns:

key iterator

toMap

public final Map<String,String[]> toMap()

clear

public final void clear()

Specified by:

clear in interface Map<String,String[]>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<String,String[]>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,String[]>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toMultiMap

public static MultiMap toMultiMap(Properties originalMap)

Create a new MultiMap given properties.

Parameters:

originalMap - string array map

Returns:

map

toMultiMap

public static MultiMap toMultiMap(Map<String,String> originalMap)

Create a new MultiMap given a string array map.

Parameters:

originalMap - string array map

Returns:

map

toMap

public static Map<String,String> toMap(Map<String,String[]> map)

merge

public void merge(MultiMap source)

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,String[]>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,String[]>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,String[]>

entrySet

public Set<Map.Entry<String,String[]>> entrySet()

Specified by:

entrySet in interface Map<String,String[]>

get

public String[] get(Object key)

Specified by:

get in interface Map<String,String[]>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,String[]>

put

public String[] put(String key,
                    String[] value)

Specified by:

put in interface Map<String,String[]>

putAll

public void putAll(Map<? extends String,? extends String[]> map)

Specified by:

putAll in interface Map<String,String[]>

remove

public String[] remove(Object key)

Specified by:

remove in interface Map<String,String[]>

size

public int size()

Specified by:

size in interface Map<String,String[]>

values

public Collection<String[]> values()

Specified by:

values in interface Map<String,String[]>