manifold.api.json

Class DataBindings

java.lang.Object

manifold.api.json.DataBindings

All Implemented Interfaces:

Map<String,Object>, Bindings

public class DataBindings
extends Object
implements Bindings

Similar to SimpleBindings but with extra features like equals/hashcode methods

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DataBindings() Default constructor uses a HashMap.
DataBindings(int size) Construct with initial size.
DataBindings(Map<String,Object> map) Uses provided Map to store bindings.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
boolean	equals(Object o)
Object	get(Object key) Returns the value to which this map maps the specified key.
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
Object	put(String name, Object value) Sets the specified key/value in the underlying map field.
void	putAll(Map<? extends String,?> toMerge) putAll is implemented using Map.putAll.
Object	remove(Object key) Removes the mapping for this key from this map if it is present (optional operation).
int	size()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

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

Constructor Detail

DataBindings

public DataBindings(Map<String,Object> map)

Uses provided Map to store bindings.

Parameters:

map - The Map backing this DataBindings.

Throws:

NullPointerException - if map is null

DataBindings

public DataBindings()

Default constructor uses a HashMap.

DataBindings

public DataBindings(int size)

Construct with initial size.

Parameters:

size - the initial size of the bindings

Method Detail

put

public Object put(String name,
                  Object value)

Sets the specified key/value in the underlying map field.

Specified by:

put in interface Map<String,Object>

Specified by:

put in interface Bindings

Parameters:

name - Name of value

value - Value to set.

Returns:

Previous value for the specified key. Returns null if key was previously unset.

Throws:

NullPointerException - if the name is null.

IllegalArgumentException - if the name is empty.

putAll

public void putAll(Map<? extends String,?> toMerge)

putAll is implemented using Map.putAll.

Specified by:

putAll in interface Map<String,Object>

Specified by:

putAll in interface Bindings

Parameters:

toMerge - The Map of values to add.

Throws:

NullPointerException - if toMerge map is null or if some key in the map is null.

IllegalArgumentException - if some key in the map is an empty String.

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Specified by:

containsKey in interface Map<String,Object>

Specified by:

containsKey in interface Bindings

Parameters:

key - key whose presence in this map is to be tested.

Returns:

true if this map contains a mapping for the specified key.

Throws:

NullPointerException - if key is null

ClassCastException - if key is not String

IllegalArgumentException - if key is empty String

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

get

public Object get(Object key)

Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

Specified by:

get in interface Map<String,Object>

Specified by:

get in interface Bindings

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key, or null if the map contains no mapping for this key.

Throws:

NullPointerException - if key is null

ClassCastException - if key is not String

IllegalArgumentException - if key is empty String

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

remove

public Object remove(Object key)

Removes the mapping for this key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which the map previously associated the key, or null if the map contained no mapping for this key. (A null return can also indicate that the map previously associated null with the specified key if the implementation supports null values.) The map will not contain a mapping for the specified key once the call returns.

Specified by:

remove in interface Map<String,Object>

Specified by:

remove in interface Bindings

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

Throws:

NullPointerException - if key is null

ClassCastException - if key is not String

IllegalArgumentException - if key is empty String

size

public int size()

Specified by:

size in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class Object