org.dataconservancy.pass.client

Interface PassJsonAdapter

public interface PassJsonAdapter

Author:

Karen Hanson

Method Summary

Modifier and Type	Method and Description
byte[]	toJson(PassEntity modelObject, boolean includeContext) Pass in a PASS model object e.g.
<T extends PassEntity> T	toModel(byte[] jsonData, Class<T> valueType) Pass in the JSON data as a byte array and the model class to match it to e.g.
<T extends PassEntity> T	toModel(InputStream jsonData, Class<T> valueType) Pass in the json data as an InputStream and the model class to match it to e.g.

Method Detail

toJson

byte[] toJson(PassEntity modelObject,
              boolean includeContext)

Pass in a PASS model object e.g. Deposit, use values to produce JSON You can opt to include the context in the JSON if this is to be used with a Linked Data Platform

Parameters:

modelObject - The PASS entity.

includeContext - true if the JSON-LD context should be included in the JSON

Returns:

Serialized JSON.

toModel

<T extends PassEntity> T toModel(byte[] jsonData,
                                 Class<T> valueType)

Pass in the JSON data as a byte array and the model class to match it to e.g. Deposit.class, returns populated model

Type Parameters:

T - The PASS entity type

Parameters:

jsonData - Serialized JSON.

valueType - PASS entity class.

Returns:

The PASS entity.

toModel

<T extends PassEntity> T toModel(InputStream jsonData,
                                 Class<T> valueType)

Pass in the json data as an InputStream and the model class to match it to e.g. Deposit.class, returns populated model

Type Parameters:

T - The PASS entity type

Parameters:

jsonData - Serialized JSON.

valueType - PASS class.

Returns:

The PASS entity.