com.cinchapi.concourse.util

Class PrettyLinkedHashMap<K,V>

Object

AbstractMap<K,V>

HashMap<K,V>

LinkedHashMap<K,V>

PrettyLinkedHashMap<K,V>

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>

public class PrettyLinkedHashMap<K,V>
extends LinkedHashMap<K,V>

A special LinkedHashMap with a named key and value that returns a pretty toString() representation in the form of a two column table where the key/value pairs are listed in different rows :

 +-------------------------------+
 | Key  | Values                 |
 +-------------------------------+
 | age  | [1]                    |
 | foo  | [1]                    |
 | name | [Jeff Nelson, jeffery] |
 +-------------------------------+
 

A PrettyLinkedHashMap is suitable to use when displaying information about a single record or document.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Modifier and Type	Method and Description
static <K,V> PrettyLinkedHashMap<K,V>	newPrettyLinkedHashMap() Return an empty PrettyLinkedHashMap with the default key and value names.
static <K,V> PrettyLinkedHashMap<K,V>	newPrettyLinkedHashMap(String keyName, String valueName) Return an empty TLinkedHashMap with the specified keyName and valueName.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
PrettyLinkedHashMap<K,V>	setKeyName(String name) Set the keyName to name.
PrettyLinkedHashMap<K,V>	setValueName(String name) Set the valueName to name
String	toString()

Methods inherited from class LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class AbstractMap

equals, hashCode

Methods inherited from class Object

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

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, putIfAbsent, remove, remove, replace, replace, size

Method Detail

newPrettyLinkedHashMap

public static <K,V> PrettyLinkedHashMap<K,V> newPrettyLinkedHashMap()

Return an empty PrettyLinkedHashMap with the default key and value names.

Returns:

the PrettyLinkedHashMap

newPrettyLinkedHashMap

public static <K,V> PrettyLinkedHashMap<K,V> newPrettyLinkedHashMap(String keyName,
                                                                    String valueName)

Return an empty TLinkedHashMap with the specified keyName and valueName.

Parameters:

keyName -

valueName -

Returns:

the PrettyLinkedHashMap.

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class HashMap<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class HashMap<K,V>

setKeyName

public PrettyLinkedHashMap<K,V> setKeyName(String name)

Set the keyName to name.

Parameters:

name -

Returns:

this

setValueName

public PrettyLinkedHashMap<K,V> setValueName(String name)

Set the valueName to name

Parameters:

name -

Returns:

this

toString

public String toString()

Overrides:

toString in class AbstractMap<K,V>