net.eusashead.hateoas.hal.http.converter.module

Interface HalHttpMessageConverterModule

All Known Implementing Classes:

AnnotationAdapterModuleImpl, ManualAdapterModuleImpl

public interface HalHttpMessageConverterModule

Extends the functionality of the HalHttpMessageConverter by adding modules to handle specific Java types

Author:

patrickvk

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead(Class<?> type) Can this module read the supplied type?
boolean	canWrite(Class<?> type) Can this module write the supplied type?
Object	read(com.theoryinpractise.halbuilder.api.ReadableRepresentation representation, Class<?> type) Convert a HAL ReadableRepresentation to an object
com.theoryinpractise.halbuilder.api.ReadableRepresentation	write(Object target, com.theoryinpractise.halbuilder.api.RepresentationFactory factory) Convert an object to a ReadableRepresentation using the supplied RepresentationFactory

Method Detail

canRead

boolean canRead(Class<?> type)

Can this module read the supplied type?

Parameters:

type -

Returns:

canWrite

boolean canWrite(Class<?> type)

Can this module write the supplied type?

Parameters:

type -

Returns:

write

com.theoryinpractise.halbuilder.api.ReadableRepresentation write(Object target,
                                                               com.theoryinpractise.halbuilder.api.RepresentationFactory factory)

Convert an object to a ReadableRepresentation using the supplied RepresentationFactory

Parameters:

target - the Object to convert

factory - the RepresentationFactory to use

Returns:

the ReadableRepresentation of the converted object

read

Object read(com.theoryinpractise.halbuilder.api.ReadableRepresentation representation,
          Class<?> type)

Convert a HAL ReadableRepresentation to an object

Parameters:

representation - Hal ReadableRepresentation to convert

type -

Returns:

object represented by the ReadableRepresentation