com.adobe.granite.rest.converter

Interface ResourceConverter<T>

All Known Implementing Classes:

AbstractPageableSirenConverter, AbstractSirenConverter

@ConsumerType
public interface ResourceConverter<T>

ResourceConverter is an interface describing a Java class that can perform Object-to-Object conversions between model data objects and a representation T of those objects that is suitable for rendering.

Implementors should ensure that a ResourceConverter can be retrieved adapting a Resource by implementing an AdapterFactory.

Method Summary

Modifier and Type	Method and Description
T	toEntity(ResourceConverterContext context) Converts a resource into an object of type T to represent an entity.
T	toSubEntity(ResourceConverterContext context) Converts a resource to an object of type T to represent a sub-entity.

Method Detail

toEntity

T toEntity(ResourceConverterContext context)
    throws ResourceConverterException

Converts a resource into an object of type T to represent an entity.

Parameters:

context - Converter context

Returns:

Converted object of type T

Throws:

ResourceConverterException - if an error occurs during conversion

toSubEntity

T toSubEntity(ResourceConverterContext context)
       throws ResourceConverterException

Converts a resource to an object of type T to represent a sub-entity. The sub-entity might only contain a subset of information and might be used to represent child elements of a collection.

Parameters:

context - Converter context

Returns:

Converted sub-object of type T

Throws:

ResourceConverterException - if an error occurs during conversion