Package org.springframework.graphql.data.query

Class JsonKeysetCursorStrategy

java.lang.Object

org.springframework.graphql.data.query.JsonKeysetCursorStrategy

All Implemented Interfaces:

CursorStrategy<Map<String,Object>>

public final class JsonKeysetCursorStrategy
extends Object
implements CursorStrategy<Map<String,Object>>

Strategy to convert a keyset to and from a JSON String for use with ScrollPositionCursorStrategy.

Since:

1.2.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
JsonKeysetCursorStrategy()	Shortcut constructor that uses ServerCodecConfigurer.
JsonKeysetCursorStrategy(CodecConfigurer codecConfigurer)	Constructor with a CodecConfigurer in which to find the JSON encoder and decoder to use.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	fromCursor(String cursor)	Parse the given String cursor into a position Object.
boolean	supports(Class<?> targetType)	Whether the strategy supports the given type of position Object.
String	toCursor(Map<String,Object> keys)	Format the given position Object as a String cursor.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonKeysetCursorStrategy

public JsonKeysetCursorStrategy()

Shortcut constructor that uses ServerCodecConfigurer.

JsonKeysetCursorStrategy

public JsonKeysetCursorStrategy(CodecConfigurer codecConfigurer)

Constructor with a CodecConfigurer in which to find the JSON encoder and decoder to use.

Parameters:

codecConfigurer - the codec configurer to be checked for JSON codec

Method Details

supports

public boolean supports(Class<?> targetType)

Description copied from interface: CursorStrategy

Whether the strategy supports the given type of position Object.

Specified by:

supports in interface CursorStrategy<Map<String,Object>>

Parameters:

targetType - the type of position to be checked

toCursor

public String toCursor(Map<String,Object> keys)

Description copied from interface: CursorStrategy

Format the given position Object as a String cursor.

Specified by:

toCursor in interface CursorStrategy<Map<String,Object>>

Parameters:

keys - the position to serialize

Returns:

the created String cursor

fromCursor

public Map<String,Object> fromCursor(String cursor)

Description copied from interface: CursorStrategy

Parse the given String cursor into a position Object.

Specified by:

fromCursor in interface CursorStrategy<Map<String,Object>>

Parameters:

cursor - the cursor to parse

Returns:

the position Object