com.cinchapi.concourse.util

Class PrettyLinkedHashMap<K,V>

Object

AbstractMap<K,V>

HashMap<K,V>

LinkedHashMap<K,V>

PrettyLinkedHashMap<K,V>

All Implemented Interfaces:

PrettyMap<K,V>, Serializable, Cloneable, Map<K,V>

public class PrettyLinkedHashMap<K,V>
extends LinkedHashMap<K,V>
implements PrettyMap<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>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
static <K,V> PrettyMap<K,V>	create() Return an empty Map with "pretty" string representation, using default key/value names.
static <K,V> PrettyMap<K,V>	create(String keyColumnHeader, String valueColumnHeader) Return an empty Map with "pretty" string representation.
static <K,V> PrettyLinkedHashMap<K,V>	newPrettyLinkedHashMap() Deprecated. use create() instead
static <K,V> PrettyLinkedHashMap<K,V>	newPrettyLinkedHashMap(String keyColumnHeader, String valueColumnHeader) Deprecated. use create(String, String) instead
static <K,V> PrettyMap<K,V>	of(Map<K,V> data) Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.
static <K,V> PrettyMap<K,V>	of(Map<K,V> data, String keyColumnHeader, String valueColumnHeader) Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
PrettyMap<K,V>	setKeyColumnHeader(String header) Set the keyColumnHeader to header.
PrettyLinkedHashMap<K,V>	setKeyName(String name) Deprecated. use setKeyColumnHeader(String) instead
PrettyMap<K,V>	setValueColumnHeader(String header) Set the valueColumnHeader to header
PrettyLinkedHashMap<K,V>	setValueName(String name) Deprecated. use setValueColumnHeader(String) instead
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

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

create

public static <K,V> PrettyMap<K,V> create()

Return an empty Map with "pretty" string representation, using default key/value names.

Returns:

the new Map

create

public static <K,V> PrettyMap<K,V> create(String keyColumnHeader,
                                          String valueColumnHeader)

Return an empty Map with "pretty" string representation.

keyColumnHeader is used as the header for the column that contains the the keys and valueColumnHeader is used for the column that contains the values.

Parameters:

keyColumnHeader -

valueColumnHeader -

Returns:

the new Map

newPrettyLinkedHashMap

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

Deprecated. use create() instead

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

Returns:

the PrettyLinkedHashMap

newPrettyLinkedHashMap

@Deprecated
public static <K,V> PrettyLinkedHashMap<K,V> newPrettyLinkedHashMap(String keyColumnHeader,
                                                                                String valueColumnHeader)

Deprecated. use create(String, String) instead

Return an empty TLinkedHashMap with the specified keyColumnHeader and valueColumnHeader.

Parameters:

keyColumnHeader -

valueColumnHeader -

Returns:

the PrettyLinkedHashMap.

of

public static <K,V> PrettyMap<K,V> of(Map<K,V> data)

Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.

The returned Map copies, but does not "read through" to data. It is mutable, but changes made to it are not reflected in data and vice versa.

Parameters:

data -

Returns:

a Map containing data that has pretty toString() output

of

public static <K,V> PrettyMap<K,V> of(Map<K,V> data,
                                      String keyColumnHeader,
                                      String valueColumnHeader)

Return a new Map containing all the entries from data that "prettifies" its string representation on-demand.

The returned Map copies, but does not "read through" to data. It is mutable, but changes made to it are not reflected in data and vice versa.

keyColumnHeader is used as the header for the column that contains the the keys and valueColumnHeader is used for the column that contains the values.

Parameters:

data -

keyColumnHeader -

valueColumnHeader -

Returns:

a Map containing data that has pretty toString() output

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>

setKeyColumnHeader

public PrettyMap<K,V> setKeyColumnHeader(String header)

Description copied from interface: PrettyMap

Set the keyColumnHeader to header.

Specified by:

setKeyColumnHeader in interface PrettyMap<K,V>

Returns:

this

setKeyName

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

Deprecated. use setKeyColumnHeader(String) instead

Set the keyColumnHeader to name.

Parameters:

name -

Returns:

this

setValueColumnHeader

public PrettyMap<K,V> setValueColumnHeader(String header)

Description copied from interface: PrettyMap

Set the valueColumnHeader to header

Specified by:

setValueColumnHeader in interface PrettyMap<K,V>

Returns:

this

setValueName

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

Deprecated. use setValueColumnHeader(String) instead

Set the valueColumnHeader to name

Parameters:

name -

Returns:

this

toString

public String toString()

Overrides:

toString in class AbstractMap<K,V>