ValueMap (analytics 4.5.0-beta.2 API)

java.lang.Object
- com.segment.analytics.ValueMap

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

AnalyticsContext, AnalyticsContext.Campaign, AnalyticsContext.Device, AnalyticsContext.Location, AnalyticsContext.Referrer, BasePayload, Properties, Properties.Product, Traits, Traits.Address
```
public class ValueMap
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.Object>
```
A class that wraps an existing Map to expose value type functionality. All Map methods will simply be forwarded to a delegate map. This class is meant to subclassed and provide methods to access values in keys.
Library users won't need to create instances of this class, they can use plain old Map instead, and our library will handle serializing them.
Although it lets you use custom objects for values, note that type information is lost during serialization. You should use one of the coercion methods instead to get objects of a concrete type.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ValueMap()

ValueMap(int initialCapacity)

ValueMap(java.util.Map<java.lang.String,java.lang.Object> map)

Constructors
Constructor and Description
`ValueMap()`
`ValueMap(int initialCapacity)`
`ValueMap(java.util.Map<java.lang.String,java.lang.Object> map)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>`	`entrySet()`
`boolean`	`equals(java.lang.Object object)`
`java.lang.Object`	`get(java.lang.Object key)`
`boolean`	`getBoolean(java.lang.String key, boolean defaultValue)` Returns the value mapped by `key` if it exists and is a boolean or can be coerced to a boolean.
`char`	`getChar(java.lang.String key, char defaultValue)` Returns the value mapped by `key` if it exists and is a char or can be coerced to a char.
`double`	`getDouble(java.lang.String key, double defaultValue)` Returns the value mapped by `key` if it exists and is a double or can be coerced to a double.
`<T extends java.lang.Enum<T>> T`	`getEnum(java.lang.Class<T> enumType, java.lang.String key)` Returns the value mapped by `key` if it exists and is a enum or can be coerced to an enum.
`float`	`getFloat(java.lang.String key, float defaultValue)` Returns the value mapped by `key` if it exists and is a float or can be coerced to a float.
`int`	`getInt(java.lang.String key, int defaultValue)` Returns the value mapped by `key` if it exists and is a integer or can be coerced to a integer.
`<T extends ValueMap> java.util.List<T>`	`getList(java.lang.Object key, java.lang.Class<T> clazz)` Returns the value mapped by `key` if it exists and is a List of `T`.
`long`	`getLong(java.lang.String key, long defaultValue)` Returns the value mapped by `key` if it exists and is a long or can be coerced to a long.
`java.lang.String`	`getString(java.lang.String key)` Returns the value mapped by `key` if it exists and is a string or can be coerced to a string.
`ValueMap`	`getValueMap(java.lang.Object key)` Returns the value mapped by `key` if it exists and is a `ValueMap`.
`<T extends ValueMap> T`	`getValueMap(java.lang.String key, java.lang.Class<T> clazz)` Returns the value mapped by `key` if it exists and if it can be coerced to the given type.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`java.lang.Object`	`put(java.lang.String key, java.lang.Object value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,?> map)`
`ValueMap`	`putValue(java.lang.String key, java.lang.Object value)` Helper method to be able to chain put methods.
`java.lang.Object`	`remove(java.lang.Object key)`
`int`	`size()`
`org.json.JSONObject`	`toJsonObject()` Return a copy of the contents of this map as a `JSONObject`.
`java.lang.String`	`toString()`
`java.util.Map<java.lang.String,java.lang.String>`	`toStringMap()` Return a copy of the contents of this map as a `Map<String, String>`.
`java.util.Collection<java.lang.Object>`	`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
  - ValueMap
```
public ValueMap()
```
  - ValueMap
```
public ValueMap(int initialCapacity)
```
  - ValueMap
```
public ValueMap(java.util.Map<java.lang.String,java.lang.Object> map)
```
- Method Detail
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<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>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<java.lang.String,java.lang.Object>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<java.lang.String,java.lang.Object>
  - get
```
public java.lang.Object get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<java.lang.String,java.lang.Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>
  - keySet
```
public java.util.Set<java.lang.String> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.String,java.lang.Object>
  - put
```
public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
```
    Specified by:
    
    put in interface java.util.Map<java.lang.String,java.lang.Object>
  - putAll
```
public void putAll(java.util.Map<? extends java.lang.String,?> map)
```
    Specified by:
    
    putAll in interface java.util.Map<java.lang.String,java.lang.Object>
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<java.lang.String,java.lang.Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<java.lang.String,java.lang.Object>
  - values
```
public java.util.Collection<java.lang.Object> values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.String,java.lang.Object>
  - equals
```
public boolean equals(java.lang.Object object)
```
    Specified by:
    
    equals in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map<java.lang.String,java.lang.Object>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - putValue
```
public ValueMap putValue(java.lang.String key,
                         java.lang.Object value)
```
    Helper method to be able to chain put methods.
  - getInt
```
public int getInt(java.lang.String key,
                  int defaultValue)
```
    Returns the value mapped by key if it exists and is a integer or can be coerced to a integer. Returns defaultValue otherwise.
  - getLong
```
public long getLong(java.lang.String key,
                    long defaultValue)
```
    Returns the value mapped by key if it exists and is a long or can be coerced to a long. Returns defaultValue otherwise.
  - getFloat
```
public float getFloat(java.lang.String key,
                      float defaultValue)
```
    Returns the value mapped by key if it exists and is a float or can be coerced to a float. Returns defaultValue otherwise.
  - getDouble
```
public double getDouble(java.lang.String key,
                        double defaultValue)
```
    Returns the value mapped by key if it exists and is a double or can be coerced to a double. Returns defaultValue otherwise.
  - getChar
```
public char getChar(java.lang.String key,
                    char defaultValue)
```
    Returns the value mapped by key if it exists and is a char or can be coerced to a char. Returns defaultValue otherwise.
  - getString
```
public java.lang.String getString(java.lang.String key)
```
    Returns the value mapped by key if it exists and is a string or can be coerced to a string. Returns null otherwise.
    This will return null only if the value does not exist, since all types can have a String representation.
  - getBoolean
```
public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)
```
    Returns the value mapped by key if it exists and is a boolean or can be coerced to a boolean. Returns defaultValue otherwise.
  - getEnum
```
public <T extends java.lang.Enum<T>> T getEnum(java.lang.Class<T> enumType,
                                               java.lang.String key)
```
    Returns the value mapped by key if it exists and is a enum or can be coerced to an enum. Returns null otherwise.
  - getValueMap
```
public ValueMap getValueMap(java.lang.Object key)
```
    Returns the value mapped by key if it exists and is a ValueMap. Returns null otherwise.
  - getValueMap
```
public <T extends ValueMap> T getValueMap(java.lang.String key,
                                          java.lang.Class<T> clazz)
```
    Returns the value mapped by key if it exists and if it can be coerced to the given type. The expected subclass MUST have a constructor that accepts a Map.
  - getList
```
public <T extends ValueMap> java.util.List<T> getList(java.lang.Object key,
                                                      java.lang.Class<T> clazz)
```
    Returns the value mapped by key if it exists and is a List of T. Returns null otherwise.
  - toJsonObject
```
public org.json.JSONObject toJsonObject()
```
    Return a copy of the contents of this map as a JSONObject.
  - toStringMap
```
public java.util.Map<java.lang.String,java.lang.String> toStringMap()
```
    Return a copy of the contents of this map as a Map<String, String>.

Class ValueMap

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ValueMap

ValueMap

ValueMap

Method Detail

clear

containsKey

containsValue

entrySet

get

isEmpty

keySet

put

putAll

remove

size

values

equals

hashCode

toString

putValue

getInt

getLong

getFloat

getDouble

getChar

getString

getBoolean

getEnum

getValueMap

getValueMap

getList

toJsonObject

toStringMap