com.microsoft.azure.cosmosdb

Class JsonSerializable

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConsistencyPolicy, DatabaseAccountLocation, ExcludedPath, IncludedPath, Index, IndexingPolicy, PartitionKeyDefinition, ReplicationPolicy, Resource, SqlParameter, SqlQuerySpec, Undefined

public class JsonSerializable
extends Object
implements Serializable

Represents a base resource that can be serialized to JSON in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonSerializable()
protected	JsonSerializable(org.json.JSONObject jsonObject) Constructor.
protected	JsonSerializable(String jsonString) Constructor.
protected	JsonSerializable(String jsonString, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	get(String propertyName) Gets a property value as Object.
Boolean	getBoolean(String propertyName) Gets a boolean value.
Collection<org.json.JSONObject>	getCollection(String propertyName) Gets a JSONObject collection.
<T> Collection<T>	getCollection(String propertyName, Class<T> c) Gets an object collection.
Double	getDouble(String propertyName) Gets a double value.
HashMap<String,Object>	getHashMap() Returns the propertybag(JSONObject) in a hashMap
Integer	getInt(String propertyName) Gets an integer value.
protected org.slf4j.Logger	getLogger()
Long	getLong(String propertyName) Gets a long value.
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper()
org.json.JSONObject	getObject(String propertyName) Gets a JSONObject.
<T> T	getObject(String propertyName, Class<T> c) Gets an object value.
Object	getObjectByPath(Collection<String> propertyNames) Gets the value of a property identified by an array of property names that forms the path.
String	getString(String propertyName) Gets a string value.
boolean	has(String propertyName) Checks whether a property exists.
void	remove(String propertyName) Removes a value by propertyName.
<T> void	set(String propertyName, T value) Sets the value of a property.
String	toJson() Converts to a JSON string.
String	toJson(SerializationFormattingPolicy formattingPolicy) Converts to a JSON string.
<T> T	toObject(Class<T> c) Converts to an Object (only POJOs and JSONObject are supported).
String	toString() Gets Simple String representation of property bag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonSerializable

protected JsonSerializable()

JsonSerializable

protected JsonSerializable(String jsonString,
                           com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Constructor.

Parameters:

jsonString - the json string that represents the JsonSerializable.

objectMapper - the custom object mapper

JsonSerializable

protected JsonSerializable(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the JsonSerializable.

JsonSerializable

protected JsonSerializable(org.json.JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the JsonSerializable.

Method Detail

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()

getLogger

protected org.slf4j.Logger getLogger()

getHashMap

public HashMap<String,Object> getHashMap()

Returns the propertybag(JSONObject) in a hashMap

Returns:

the HashMap.

has

public boolean has(String propertyName)

Checks whether a property exists.

Parameters:

propertyName - the property to look up.

Returns:

true if the property exists.

remove

public void remove(String propertyName)

Removes a value by propertyName.

Parameters:

propertyName - the property to remove.

set

public <T> void set(String propertyName,
                    T value)

Sets the value of a property.

Type Parameters:

T - the type of the object.

Parameters:

propertyName - the property to set.

value - the value of the property.

get

public Object get(String propertyName)

Gets a property value as Object.

Parameters:

propertyName - the property to get.

Returns:

the value of the property.

getString

public String getString(String propertyName)

Gets a string value.

Parameters:

propertyName - the property to get.

Returns:

the string value.

getBoolean

public Boolean getBoolean(String propertyName)

Gets a boolean value.

Parameters:

propertyName - the property to get.

Returns:

the boolean value.

getInt

public Integer getInt(String propertyName)

Gets an integer value.

Parameters:

propertyName - the property to get.

Returns:

the boolean value

getLong

public Long getLong(String propertyName)

Gets a long value.

Parameters:

propertyName - the property to get.

Returns:

the long value

getDouble

public Double getDouble(String propertyName)

Gets a double value.

Parameters:

propertyName - the property to get.

Returns:

the double value.

getObject

public <T> T getObject(String propertyName,
                       Class<T> c)

Gets an object value.

Type Parameters:

T - the type of the object.

Parameters:

propertyName - the property to get.

c - the class of the object. If c is a POJO class, it must be a member (and not an anonymous or local) and a static one.

Returns:

the object value.

getCollection

public <T> Collection<T> getCollection(String propertyName,
                                       Class<T> c)

Gets an object collection.

Type Parameters:

T - the type of the objects in the collection.

Parameters:

propertyName - the property to get

c - the class of the object. If c is a POJO class, it must be a member (and not an anonymous or local) and a static one.

Returns:

the object collection.

getObject

public org.json.JSONObject getObject(String propertyName)

Gets a JSONObject.

Parameters:

propertyName - the property to get.

Returns:

the JSONObject.

getCollection

public Collection<org.json.JSONObject> getCollection(String propertyName)

Gets a JSONObject collection.

Parameters:

propertyName - the property to get.

Returns:

the JSONObject collection.

getObjectByPath

public Object getObjectByPath(Collection<String> propertyNames)

Gets the value of a property identified by an array of property names that forms the path.

Parameters:

propertyNames - that form the path to the the property to get.

Returns:

the value of the property.

toObject

public <T> T toObject(Class<T> c)

Converts to an Object (only POJOs and JSONObject are supported).

Type Parameters:

T - the type of the object.

Parameters:

c - the class of the object, either a POJO class or JSONObject. If c is a POJO class, it must be a member (and not an anonymous or local) and a static one.

Returns:

the POJO.

toJson

public String toJson()

Converts to a JSON string.

Returns:

the JSON string.

toJson

public String toJson(SerializationFormattingPolicy formattingPolicy)

Converts to a JSON string.

Parameters:

formattingPolicy - the formatting policy to be used.

Returns:

the JSON string.

toString

public String toString()

Gets Simple String representation of property bag. For proper conversion to json and inclusion of the default values use toJson().

Overrides:

toString in class Object

Returns:

string representation of property bag.