com.hcl.domino.json

Interface JsonDeserializer

public interface JsonDeserializer

This interface allows for deserialization of JSON into documents, both as strings and as implementation-specific Java object representations.

Implementations of this service are expected to be provided by additional integration modules, such as domino-jnx-jsonp.

Since:

1.0.9

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
JsonDeserializer	booleanValues(Object trueValue, Object falseValue) Configures the values to be stored in the target document when the deserializer encounters JSON boolean values.
static JsonDeserializer	createDeserializer() Constructs a new deserializer using the first available JSON service.
JsonDeserializer	dateTimeItems(Collection<String> dateTimeItems) Configures the deserializer to expect the named items to contain date/time values.
default Document	fromJson(Object json) Deserializes the provided implementation-specific JSON object into a document.
Document	fromJson(String json) Deserializes the provided JSON object string into a document.
JsonDeserializer	removeMissingItems(boolean removeMissingItems) Configures whether items in a document provided via target(Document) that do not exist in the incoming JSON should be removed.
JsonDeserializer	target(Database database) Sets the deserialization target to be a new document in the target database.
JsonDeserializer	target(Document document) Sets the deserialization target to be an existing document in the target database.

Method Detail

createDeserializer

static JsonDeserializer createDeserializer()

Constructs a new deserializer using the first available JSON service.

Returns:

a new JsonSerializer implementation

Throws:

IllegalStateException - if there is no registered deserializer implementation

target

JsonDeserializer target(Database database)

Sets the deserialization target to be a new document in the target database.

Documents imported this way will be returned unsaved in memory.

Parameters:

database - the database to import into

Returns:

this deserializer

target

JsonDeserializer target(Document document)

Sets the deserialization target to be an existing document in the target database.

Documents imported this way will be modified in-place in memory but not saved.

Parameters:

document - the document to write to

Returns:

this deserializer

dateTimeItems

JsonDeserializer dateTimeItems(Collection<String> dateTimeItems)

Configures the deserializer to expect the named items to contain date/time values.

This will cause such values to be parsed as date/times and ranges compatible with the output of JsonSerializer and to throw an exception when the value in the incoming JSON object is not either a valid value or empty.

Parameters:

dateTimeItems - the names of items expected to contain date/time values

Returns:

this deserializer

removeMissingItems

JsonDeserializer removeMissingItems(boolean removeMissingItems)

Configures whether items in a document provided via target(Document) that do not exist in the incoming JSON should be removed.

The default behavior is to only update items that are represented as properties in the incoming JSON.

The "Form" item and items beginning with "$" will never be removed in this way.

Parameters:

removeMissingItems - whether items not present in JSON should be removed

Returns:

this deserializer

booleanValues

JsonDeserializer booleanValues(Object trueValue,
                               Object falseValue)

Configures the values to be stored in the target document when the deserializer encounters JSON boolean values.

Parameters:

trueValue - the value used when converting true

falseValue - the value used when converting false

Returns:

this deserializer

fromJson

default Document fromJson(Object json)

Deserializes the provided implementation-specific JSON object into a document.

Parameters:

json - the implementation-specific native JSON object to deserialize

Returns:

the modified or newly-created document

Throws:

RuntimeException - an implementation-specific exception when the JSON is unprocessable as configured

fromJson

Document fromJson(String json)

Deserializes the provided JSON object string into a document.

Parameters:

json - the JSON string to deserialize

Returns:

the modified or newly-created document

Throws:

RuntimeException - an implementation-specific exception when the JSON is unprocessable as configured