ai.grakn.engine.controller.response

Class ListResource<T>

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializable.Base

ai.grakn.engine.controller.response.ListResource<T>

Type Parameters:

T - The type of things the list contains

All Implemented Interfaces:

com.fasterxml.jackson.databind.JsonSerializable

public abstract class ListResource<T>
extends com.fasterxml.jackson.databind.JsonSerializable.Base

Wraps a list of items with a self-link and a custom named key

This uses a custom serializer and deserializer because the key() can be dynamically specified. This reduces a lot of boilerplate response interfaces.

Author:

Felix Chapman

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Constructor Summary

Constructors

Constructor and Description
ListResource()

Method Summary

Modifier and Type	Method and Description
static <T> ListResource<T>	create(Link selfLink, String key, List<T> items)
abstract List<T>	items()
abstract String	key() The key for the items in the serialized JSON object.
abstract Link	selfLink()
void	serialize(com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider serializers)
void	serializeWithType(com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider serializers, com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSer)

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializable.Base

isEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

ListResource

public ListResource()

Method Detail

selfLink

public abstract Link selfLink()

key

public abstract String key()

The key for the items in the serialized JSON object.

items

public abstract List<T> items()

create

public static <T> ListResource<T> create(Link selfLink,
                                         String key,
                                         List<T> items)

serialize

public void serialize(com.fasterxml.jackson.core.JsonGenerator gen,
                      com.fasterxml.jackson.databind.SerializerProvider serializers)
               throws IOException

Throws:

IOException

serializeWithType

public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator gen,
                              com.fasterxml.jackson.databind.SerializerProvider serializers,
                              com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSer)
                       throws IOException

Throws:

IOException