org.nuxeo.ecm.core.io.marshallers.json

Class AbstractJsonReader<EntityType>

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonReader<EntityType>

Type Parameters:

EntityType - The expected Java type.

All Implemented Interfaces:

Marshaller<EntityType>, Reader<EntityType>

Direct Known Subclasses:

DocumentPropertiesJsonReader, EntityJsonReader

@Supports(value="application/json")
public abstract class AbstractJsonReader<EntityType>
extends Object
implements Reader<EntityType>

Base class for Json Reader.

This class provides an easy way to create java object from json and also provides the current context: ctx. It provides you a JsonNode to manage the unmarshalling.

The use of this class optimize the JsonFactory usage especially when aggregating unmarshallers.

Since:

7.2

Constructor Summary

Constructors

Constructor and Description
AbstractJsonReader()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediatype) Checks if this marshaller can handle the marshalling request.
EntityType	read(Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediaType, InputStream in) Read the entity from in InputStream using mediatype format.
abstract EntityType	read(org.codehaus.jackson.JsonNode jn) Implement this method, read the entity data in the provided JsonNode and return corresponding java object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJsonReader

public AbstractJsonReader()

Method Detail

accept

public boolean accept(Class<?> clazz,
             Type genericType,
             javax.ws.rs.core.MediaType mediatype)

Description copied from interface: Marshaller

Checks if this marshaller can handle the marshalling request.

Please note it's useless to check that clazz is an instance of EntityType or if generic type and entity type are compatible (unlike JAX-RS which just checks the clazz, not the generic type). It's also useless to check Supports is compatible with mediatype. This is already done by the MarshallerRegistry

This method implementation can use injected properties. So you can check the current RenderingContext to accept or reject a marshalling request.

Specified by:

accept in interface Marshaller<EntityType>

Parameters:

clazz - The type to marshall.

genericType - The generic type to marshall.

mediatype - The managed mimetype.

Returns:

true if this converter handle the request, false otherwise.

read

public EntityType read(Class<?> clazz,
              Type genericType,
              javax.ws.rs.core.MediaType mediaType,
              InputStream in)
                throws IOException

Description copied from interface: Reader

Read the entity from in InputStream using mediatype format.

This method implementation can use injected properties.

Specified by:

read in interface Reader<EntityType>

Parameters:

clazz - The requested marshalled class.

genericType - The requested marshalled generic type.

in - The input of this marshaller.

Throws:

IOException - If some error append while reading entity from in.

read

public abstract EntityType read(org.codehaus.jackson.JsonNode jn)
                         throws IOException

Implement this method, read the entity data in the provided JsonNode and return corresponding java object.

Parameters:

jn - A ready to use JsonNode.

Returns:

The unmarshalled entity.

Throws:

IOException

Since:

7.2