org.springframework.restdocs.payload

Interface FieldTypeResolver

public interface FieldTypeResolver

Resolves the type of a field in a request or response payload.

Since:

2.0.3

Author:

Mathias Düsterhöft, Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
static FieldTypeResolver	forContent(byte[] content, MediaType contentType) Deprecated. since 2.0.4 in favor of forContentWithDescriptors(byte[], MediaType, List)
static FieldTypeResolver	forContentWithDescriptors(byte[] content, MediaType contentType, List<FieldDescriptor> descriptors) Create a FieldTypeResolver for the given content and contentType, described by the given descriptors.
Object	resolveFieldType(FieldDescriptor fieldDescriptor) Resolves the type of the field that is described by the given fieldDescriptor based on the content of the payload.

Method Detail

forContent

@Deprecated
static FieldTypeResolver forContent(byte[] content,
                                                MediaType contentType)

Deprecated. since 2.0.4 in favor of forContentWithDescriptors(byte[], MediaType, List)

Create a FieldTypeResolver for the given content and contentType.

Parameters:

content - the payload that the FieldTypeResolver should handle

contentType - the content type of the payload

Returns:

the FieldTypeResolver

forContentWithDescriptors

static FieldTypeResolver forContentWithDescriptors(byte[] content,
                                                   MediaType contentType,
                                                   List<FieldDescriptor> descriptors)

Create a FieldTypeResolver for the given content and contentType, described by the given descriptors.

Parameters:

content - the payload that the FieldTypeResolver should handle

contentType - the content type of the payload

descriptors - the descriptors of the content

Returns:

the FieldTypeResolver

resolveFieldType

Object resolveFieldType(FieldDescriptor fieldDescriptor)

Resolves the type of the field that is described by the given fieldDescriptor based on the content of the payload.

Parameters:

fieldDescriptor - the field descriptor

Returns:

the type of the field