com.linkedin.data

Class DataMap

java.lang.Object

com.linkedin.data.collections.CheckedMap<java.lang.String,java.lang.Object>

com.linkedin.data.DataMap

All Implemented Interfaces:

Common, CommonMap<java.lang.String,java.lang.Object>, DataComplex, Instrumentable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class DataMap
extends CheckedMap<java.lang.String,java.lang.Object>
implements DataComplex

An DataMap maps strings to Data objects.

The key of this map is always a string. When a key is being added or replaced, the map will verify that key is a string. If the key is not a string, the map will throw an IllegalArgumentException.

When an value is being added or replaced on the map, the map will verify that the value is a Data object. If the value is not a Data object, then the map will throw an IllegalArgumentException.

Cloning via the clone() method will shallow copy the DataMap and will not deep copy contained complex objects. Copying via the copy() method will deep copy the DataMap, which includes deep copying the contained complex objects. Keys are not deep copied because the keys are immutable strings.

Instrumentation if enabled is only enabled for the DataMap and not for the underlying CheckedMap. Furthermore, if a DataMap is cloned, the clone will not have instrumentation enabled and the clone's instrumented data will be cleared.

Since DataMap extends CheckedMap, copying of the DataMap is lazy and may be delayed until the DataMap is about to be modified.

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ERROR_KEY
static java.lang.String	RESERVED_CONSTANT_PREFIX
static java.lang.String	RESERVED_CONSTANT_SUFFIX

Fields inherited from interface com.linkedin.data.Instrumentable

TIMES_ACCESSED, VALUE

Constructor Summary

Constructors

Constructor and Description
DataMap() Constructs an empty DataMap.
DataMap(int initialCapacity) Constructs a DataMap with the specified initial capacity and default load factor.
DataMap(int initialCapacity, float loadFactor) Constructs a DataMap with the specified initial capacity and load factor.
DataMap(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map) Constructs a DataMap with the entries provided by the input map.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addError(java.lang.String msg) Adds an error message to the DataMap.
void	clearInstrumentedData() Clear tracked data.
DataMap	clone() Shallow clone.
void	collectInstrumentedData(java.lang.StringBuilder keyPrefix, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> instrumentedData, boolean collectAllData) Collect either all the data in this and contained Instrumentable or only the keys or indices that have been marked as accessed depending on the collectAllData flag.
boolean	containsKey(java.lang.Object key)
DataMap	copy() Deep copy.
void	copyReferencedObjects(com.linkedin.data.DataComplexTable alreadyCopied) Deep copy this object and the complex Data objects referenced by this object.
int	dataComplexHashCode() Returns the data complex hash code of this data complex object.
java.lang.Object	get(java.lang.Object key)
java.lang.Boolean	getBoolean(java.lang.String key) Returns the value to which the specified key is mapped and cast to Boolean, or null if this map contains no mapping for the key.
ByteString	getByteString(java.lang.String key) Returns the value to which the specified key is mapped and cast to ByteString, or null if this map contains no mapping for the key.
DataList	getDataList(java.lang.String key) Returns the value to which the specified key is mapped and cast to DataList, or null if this map contains no mapping for the key.
DataMap	getDataMap(java.lang.String key) Returns the value to which the specified key is mapped and cast to DataMap, or null if this map contains no mapping for the key.
java.lang.Double	getDouble(java.lang.String key) Returns the value to which the specified key is mapped and cast to Double, or null if this map contains no mapping for the key.
java.lang.String	getError() Returns the value to which ERROR_KEY is mapped and cast to String, or null if this map contains no mapping for the key.
java.lang.Float	getFloat(java.lang.String key) Returns the value to which the specified key is mapped and cast to Float, or null if this map contains no mapping for the key.
java.lang.Integer	getInteger(java.lang.String key) Returns the value to which the specified key is mapped and cast to Integer, or null if this map contains no mapping for the key.
java.lang.Long	getLong(java.lang.String key) Returns the value to which the specified key is mapped and cast to Long, or null if this map contains no mapping for the key.
java.lang.String	getString(java.lang.String key) Returns the value to which the specified key is mapped and cast to String, or null if this map contains no mapping for the key.
boolean	isMadeReadOnly() Whether this object and recursively contained complex objects are read-only.
void	makeReadOnly() Make read-only this object and recursively contained complex objects.
static java.lang.String	reservedConstant(java.lang.String name)
void	startInstrumentingAccess() Sets the state of this Instrumentable to start instrumenting data access.
void	stopInstrumentingAccess() Sets the state of this Instrumentable to stop instrumenting data access.

Methods inherited from class com.linkedin.data.collections.CheckedMap

clear, containsValue, entrySet, equals, getObject, hashCode, invalidate, isEmpty, isReadOnly, keySet, put, putAll, putAllWithoutChecking, putWithoutChecking, remove, setReadOnly, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.data.DataComplex

values

Methods inherited from interface com.linkedin.data.collections.Common

invalidate, isReadOnly, setReadOnly

Methods inherited from interface java.util.Map

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

Field Detail

RESERVED_CONSTANT_PREFIX

public static final java.lang.String RESERVED_CONSTANT_PREFIX

See Also:

Constant Field Values

RESERVED_CONSTANT_SUFFIX

public static final java.lang.String RESERVED_CONSTANT_SUFFIX

See Also:

Constant Field Values

ERROR_KEY

public static final java.lang.String ERROR_KEY

Constructor Detail

DataMap

public DataMap()

Constructs an empty DataMap.

DataMap

public DataMap(java.util.Map<? extends java.lang.String,? extends java.lang.Object> map)

Constructs a DataMap with the entries provided by the input map.

Parameters:

map - provides the entries of the new DataMap.

DataMap

public DataMap(int initialCapacity)

Constructs a DataMap with the specified initial capacity and default load factor.

Parameters:

initialCapacity - provides the initial capacity of the DataMap.

See Also:

HashMap

DataMap

public DataMap(int initialCapacity,
               float loadFactor)

Constructs a DataMap with the specified initial capacity and load factor.

Parameters:

initialCapacity - provides the initial capacity of the DataMap.

loadFactor - provides the load factor of the DataMap.

See Also:

HashMap

Method Detail

reservedConstant

public static java.lang.String reservedConstant(java.lang.String name)

clone

public DataMap clone()
              throws java.lang.CloneNotSupportedException

Description copied from interface: Common

Shallow clone. The contained values are not recursively cloned. The clone will be read-write enabled.

Specified by:

clone in interface Common

Specified by:

clone in interface CommonMap<java.lang.String,java.lang.Object>

Specified by:

clone in interface DataComplex

Overrides:

clone in class CheckedMap<java.lang.String,java.lang.Object>

Returns:

the clone.

Throws:

java.lang.CloneNotSupportedException - if the object cannot be shallow copied.

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

get in class CheckedMap<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

containsKey in class CheckedMap<java.lang.String,java.lang.Object>

copy

public DataMap copy()
             throws java.lang.CloneNotSupportedException

Description copied from interface: DataComplex

Deep copy. Clones this object, deep copies complex Data objects referenced by this object, and update internal references to point to the deep copies.

Specified by:

copy in interface DataComplex

Throws:

java.lang.CloneNotSupportedException - if the object cannot be deep copied.

copyReferencedObjects

public void copyReferencedObjects(com.linkedin.data.DataComplexTable alreadyCopied)
                           throws java.lang.CloneNotSupportedException

Deep copy this object and the complex Data objects referenced by this object.

Parameters:

alreadyCopied - provides the objects already copied, and their copies.

Throws:

java.lang.CloneNotSupportedException - if the referenced object cannot be copied.

makeReadOnly

public void makeReadOnly()

Description copied from interface: DataComplex

Make read-only this object and recursively contained complex objects. This is irreversible, once a complex object becomes read-only, it cannot be changed back to read-write. Note: Contained primitive types are always immutable.

Specified by:

makeReadOnly in interface DataComplex

isMadeReadOnly

public boolean isMadeReadOnly()

Description copied from interface: DataComplex

Whether this object and recursively contained complex objects are read-only. Note: Contained primitive types are always immutable.

Specified by:

isMadeReadOnly in interface DataComplex

Returns:

whether this object and recursively contained complex objects are read-only.

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Returns the value to which the specified key is mapped and cast to Boolean, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to Boolean, or null if this map contains no mapping for the key.

getInteger

public java.lang.Integer getInteger(java.lang.String key)

Returns the value to which the specified key is mapped and cast to Integer, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to Integer, or null if this map contains no mapping for the key.

getLong

public java.lang.Long getLong(java.lang.String key)

Returns the value to which the specified key is mapped and cast to Long, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to Long, or null if this map contains no mapping for the key.

getFloat

public java.lang.Float getFloat(java.lang.String key)

Returns the value to which the specified key is mapped and cast to Float, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to Float, or null if this map contains no mapping for the key.

getDouble

public java.lang.Double getDouble(java.lang.String key)

Returns the value to which the specified key is mapped and cast to Double, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to Double, or null if this map contains no mapping for the key.

getString

public java.lang.String getString(java.lang.String key)

Returns the value to which the specified key is mapped and cast to String, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to String, or null if this map contains no mapping for the key.

getByteString

public ByteString getByteString(java.lang.String key)

Returns the value to which the specified key is mapped and cast to ByteString, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to ByteString, or null if this map contains no mapping for the key.

getDataMap

public DataMap getDataMap(java.lang.String key)

Returns the value to which the specified key is mapped and cast to DataMap, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to DataMap, or null if this map contains no mapping for the key.

getDataList

public DataList getDataList(java.lang.String key)

Returns the value to which the specified key is mapped and cast to DataList, or null if this map contains no mapping for the key.

Parameters:

key - provides the key whose associated value is to be returned.

Returns:

the value to which the specified key is mapped and cast to DataList, or null if this map contains no mapping for the key.

getError

public java.lang.String getError()

Returns the value to which ERROR_KEY is mapped and cast to String, or null if this map contains no mapping for the key.

Returns:

the value to which the specified key is mapped and cast to String, or null if this map contains no mapping for the key.

addError

public java.lang.String addError(java.lang.String msg)

Adds an error message to the DataMap. If a value is not mapped to ERROR_KEY, bind the specified error message to ERROR_KEY. Otherwise, replace the value of ERROR_KEY with a new String constructed by appending the specified error message to the previous value of ERROR_KEY.

Parameters:

msg - provides the error message to add.

Returns:

the new value of ERROR_KEY.

startInstrumentingAccess

public void startInstrumentingAccess()

Description copied from interface: Instrumentable

Sets the state of this Instrumentable to start instrumenting data access. The types of accesses that are instrumented depends on the actual concrete classes that implement this interface. The minimum expectation is that read access via Collection#get, Map#get, and Map.containsKey(Object) are instrumented as an access.

Specified by:

startInstrumentingAccess in interface Instrumentable

stopInstrumentingAccess

public void stopInstrumentingAccess()

Description copied from interface: Instrumentable

Sets the state of this Instrumentable to stop instrumenting data access.

Specified by:

stopInstrumentingAccess in interface Instrumentable

clearInstrumentedData

public void clearInstrumentedData()

Description copied from interface: Instrumentable

Clear tracked data.

Specified by:

clearInstrumentedData in interface Instrumentable

collectInstrumentedData

public void collectInstrumentedData(java.lang.StringBuilder keyPrefix,
                                    java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> instrumentedData,
                                    boolean collectAllData)

Description copied from interface: Instrumentable

Collect either all the data in this and contained Instrumentable or only the keys or indices that have been marked as accessed depending on the collectAllData flag. The data is collected into the instrumentedData supplied. Each entry's key in the instrumentedData map is the fully qualified name of the accessed key or index. The fully qualified name is constructed by pre-pending the provided keyPrefix and the keys and indices of antecedent objects traversed to reach this particular key or index. Each entry's value in the instrumentedData map is another map. The minimum expectation is that the latter map has at least two entries, the "value" entry holds the String representation object identified by the fully qualified name, and the "timesAcessed" entry has the number of times the fully qualified name has been accessed. The number of times accessed may be null in case it is unknown how many times the key or index was accessed due to instrumentation limitations.

Specified by:

collectInstrumentedData in interface Instrumentable

Parameters:

keyPrefix - is the prefix to prepend to the fully qualified name of accessed keys and indices.

instrumentedData - provides the map to hold the output of the collected instrumented data, each map entry's key is the fully qualified name of the key or index accessed, and the map entry's value is another map that holds collected data.

collectAllData - indicates whether to collect all data in this and contained Instrumentable or only the keys or indices accessed.

dataComplexHashCode

public int dataComplexHashCode()

Description copied from interface: DataComplex

Returns the data complex hash code of this data complex object.

Specified by:

dataComplexHashCode in interface DataComplex

Returns:

the data complex hash code.