com.simplify.payments

Class PaymentsMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

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

com.simplify.payments.PaymentsMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

AccessToken, PaymentsObject, ResourceList

public class PaymentsMap
extends java.util.LinkedHashMap<java.lang.String,java.lang.Object>

Map object that extends the LinkedHashMap map with support for insertion and retrieval of keys using special key path values. The key path support nested maps and array values.

A key path consists of a sequence of key values separated by '.' characters. Each part of the key path consists of a separate map. For example a key path of 'k1.k2.k3' is a map containing a key 'k1' whose value is a map containing a key 'k2' whose values is a map containing a key 'k3'. A key path can also contain an array notation '[ When using the array index notation the value inserted must be a map; inserting values is not permitted. For example using put("a[3].k1", 1) is permitted while put("a[3]", 1) results in an IllegalArgumentException.

Examples:

 PaymentsMap map  = new PaymentsMap();
 map.put("card.number", "5555555555554444");
 map.put("card.cvc", "123");
 map.put("card.expMonth", 5);
 map.put("card.expYear", 15);
 map.put("currency", "USD");
 map.put("amount", 1234);
 

There is also an set() method which is similar to put() but returns the map providing a fluent map builder.

 PaymentsMap map = new PaymentsMap()
      .set("card.number", "5555555555554444")
      .set("card.cvc", "123")
      .set("card.expMonth", 5)
      .set("card.expYear", 15)
      .set("currency", "USD")
      .set("amount", 1234);
 

Both of these examples construct a PaymentsMap containing the keys 'currency', 'amount' and 'card'. The value for the 'card' key is a map containing the key 'number', 'cvc', 'expMonth' and 'expYear'.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Constructor Summary

Constructors

Constructor and Description
PaymentsMap() Constructs an empty map with the default capacity and load factor.
PaymentsMap(int initialCapacity) Constructs an empty map with the specified capacity and default load factor.
PaymentsMap(int initialCapacity, float loadFactor) Constructs an empty map with the specified capacity and load factor.
PaymentsMap(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a map with the same mappings as in the specifed map.
PaymentsMap(java.lang.String jsonMapString) Consturcts a map based of the speficied JSON string.
PaymentsMap(java.lang.String keyPath, java.lang.Object value) Constructs a map with an initial mapping of keyPath to value.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.Object keyPath) Returns true if there is a value associated with the specified key path.
java.lang.Object	get(java.lang.Object keyPath) Returns the value associated with the specified key path or null if there is no associated value.
static java.util.Map<java.lang.String,java.lang.Object>	normalize(java.util.Map<java.lang.String,java.lang.Object> m) Returns an identical copy of the map except values which JSONValue.toJSONString() would render as unquoted strings are converted to string values.
java.lang.Object	put(java.lang.String keyPath, java.lang.Object value) Associates the specified value to the specified key path.
java.lang.Object	remove(java.lang.Object keyPath) Removes the value associated with the specified key path from the map.
PaymentsMap	set(java.lang.String keyPath, java.lang.Object value) Associates the specified value to the specified key path and returns a reference to this map.

Methods inherited from class java.util.LinkedHashMap

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

Methods inherited from class java.util.HashMap

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

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

PaymentsMap

public PaymentsMap(int initialCapacity,
                   float loadFactor)

Constructs an empty map with the specified capacity and load factor.

Parameters:

initialCapacity - the initial capacity

loadFactor - the load factor

PaymentsMap

public PaymentsMap(int initialCapacity)

Constructs an empty map with the specified capacity and default load factor.

Parameters:

initialCapacity - the initial capacity

PaymentsMap

public PaymentsMap()

Constructs an empty map with the default capacity and load factor.

PaymentsMap

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

Constructs a map with the same mappings as in the specifed map.

Parameters:

map - the map whose mappings are to be placed in this map

PaymentsMap

public PaymentsMap(java.lang.String jsonMapString)

Consturcts a map based of the speficied JSON string.

Parameters:

jsonMapString - the JSON string used to construct the map

PaymentsMap

public PaymentsMap(java.lang.String keyPath,
                   java.lang.Object value)

Constructs a map with an initial mapping of keyPath to value.

Parameters:

keyPath - key path with which the specified value is to be associated.

value - value to be associated with the specified key path.

Method Detail

put

public java.lang.Object put(java.lang.String keyPath,
                            java.lang.Object value)

Associates the specified value to the specified key path.

Specified by:

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

Overrides:

put in class java.util.HashMap<java.lang.String,java.lang.Object>

Parameters:

keyPath - key path to which the specified value is to be associated.

value - the value which is to be associated with the specified key path.

Throws:

java.lang.IllegalArgumentException - if part of the key path does not match the expected type.

java.lang.IndexOutOfBoundsException - if using an array index in the key path is out of bounds.

set

public PaymentsMap set(java.lang.String keyPath,
                       java.lang.Object value)

Associates the specified value to the specified key path and returns a reference to this map.

Parameters:

keyPath - key path to which the specified value is to be associated.

value - the value which is to be associated with the specified key path.

Returns:

this map

Throws:

java.lang.IllegalArgumentException - if part of the key path does not match the expected type.

java.lang.IndexOutOfBoundsException - if using an array index in the key path is out of bounds.

get

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

Returns the value associated with the specified key path or null if there is no associated value.

Specified by:

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

Overrides:

get in class java.util.LinkedHashMap<java.lang.String,java.lang.Object>

Parameters:

keyPath - key path whose associated value is to be returned

Returns:

the value to which the specified key is mapped

Throws:

java.lang.IllegalArgumentException - if part of the key path does not match the expected type.

java.lang.IndexOutOfBoundsException - if using an array index in the key path is out of bounds.

containsKey

public boolean containsKey(java.lang.Object keyPath)

Returns true if there is a value associated with the specified key path.

Specified by:

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

Overrides:

containsKey in class java.util.HashMap<java.lang.String,java.lang.Object>

Parameters:

keyPath - key path whose associated value is to be tested

Returns:

true if this map contains an value associated with the specified key path

Throws:

java.lang.IllegalArgumentException - if part of the key path does not match the expected type.

java.lang.IndexOutOfBoundsException - if using an array index in the key path is out of bounds.

remove

public java.lang.Object remove(java.lang.Object keyPath)

Removes the value associated with the specified key path from the map.

Specified by:

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

Overrides:

remove in class java.util.HashMap<java.lang.String,java.lang.Object>

Parameters:

keyPath - key path whose associated value is to be removed

Throws:

java.lang.IllegalArgumentException - if part of the key path does not match the expected type.

java.lang.IndexOutOfBoundsException - if using an array index in the key path is out of bounds.

normalize

public static java.util.Map<java.lang.String,java.lang.Object> normalize(java.util.Map<java.lang.String,java.lang.Object> m)

Returns an identical copy of the map except values which JSONValue.toJSONString() would render as unquoted strings are converted to string values.

See https://code.google.com/p/json-simple/issues/detail?id=104