com.hfg.javascript

Class JsObjMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

com.hfg.util.collection.OrderedMap<String,Object>

com.hfg.javascript.JsObjMap

All Implemented Interfaces:

JsCollection, Serializable, Cloneable, Map<String,Object>

public class JsObjMap
extends OrderedMap<String,Object>
implements JsCollection

A Javascript object (Map) container useful for creating JSON.

JSON.org

JSON RFC: http://www.ietf.org/rfc/rfc4627.txt

See Also:

Serialized Form

Nested Class Summary

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JsObjMap()
JsObjMap(CharSequence inJSONString)
JsObjMap(int inInitialCapacity)
JsObjMap(int inInitialCapacity, float inLoadFactor)
JsObjMap(Map<String,Object> inMap)

Method Summary

Modifier and Type	Method and Description
String	getString(String inKey)
Object	put(String inKey, Collection inValues)
Object	put(String inKey, JsArray inValue)
Object	put(String inKey, Object inValue)
Object	put(String inKey, Object[] inValues)
void	putUnquoted(String inKey, Object inValue) Puts the specified key / value pair into the map but does not quote the value when calling toJavascript() [Note that not quoting a string value means that the resulting serialization will no longer be valid JSON, but sending function definitions in a JSON-like format can be useful when working with javascript frameworks].
Object	remove(Object inKey)
String	toJavascript() Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.
void	toJavascript(OutputStream inStream) Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.
void	toJavascript(Writer inWriter) Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.
String	toJSON() Produces a JSON serialization of the Collection.
void	toJSON(OutputStream inStream)
void	toJSON(Writer inWriter) Produces a JSON serialization of the Collection.
String	toString()

Methods inherited from class com.hfg.util.collection.OrderedMap

clear, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, keySet, merge, putAll, putIfAbsent, values

Methods inherited from class java.util.HashMap

clone, containsKey, containsValue, get, getOrDefault, isEmpty, remove, replace, replace, replaceAll, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JsObjMap

public JsObjMap()

JsObjMap

public JsObjMap(int inInitialCapacity)

JsObjMap

public JsObjMap(int inInitialCapacity,
                float inLoadFactor)

JsObjMap

public JsObjMap(CharSequence inJSONString)

JsObjMap

public JsObjMap(Map<String,Object> inMap)

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>

toJSON

public String toJSON()

Description copied from interface: JsCollection

Produces a JSON serialization of the Collection. Ex: [ "foo", { "key1": 1.0, "key2": "Hello" } ]

Specified by:

toJSON in interface JsCollection

toJSON

public void toJSON(OutputStream inStream)

toJSON

public void toJSON(Writer inWriter)

Description copied from interface: JsCollection

Produces a JSON serialization of the Collection. Ex: [ "foo", { "key1": 1.0, "key2": "Hello" } ]

Specified by:

toJSON in interface JsCollection

Parameters:

inWriter - where to send the JSON to

toJavascript

public String toJavascript()

Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.

Specified by:

toJavascript in interface JsCollection

toJavascript

public void toJavascript(OutputStream inStream)

Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.

toJavascript

public void toJavascript(Writer inWriter)

Produces a javascript serialization that will generally be the same as produced by toJSON() except when values have been added via the putUnquoted() method.

Specified by:

toJavascript in interface JsCollection

Parameters:

inWriter - where to send the javascript to

getString

public String getString(String inKey)

putUnquoted

public void putUnquoted(String inKey,
                        Object inValue)

Puts the specified key / value pair into the map but does not quote the value when calling toJavascript() [Note that not quoting a string value means that the resulting serialization will no longer be valid JSON, but sending function definitions in a JSON-like format can be useful when working with javascript frameworks]. Numeric and boolean values should not be passed to this method as they will be handle correctly by the standard put() method.

put

public Object put(String inKey,
                  Object inValue)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class OrderedMap<String,Object>

put

public Object put(String inKey,
                  JsArray inValue)

put

public Object put(String inKey,
                  Collection inValues)

put

public Object put(String inKey,
                  Object[] inValues)

remove

public Object remove(Object inKey)

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class OrderedMap<String,Object>