From 64ea9c29f5c884d6930e5dd7a8898ca97578aec5 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Wed, 21 Nov 2018 14:17:03 +0000 Subject: [PATCH] Polish "Provide a public API for resolving the type of a field" Closes gh-549 --- .../restdocs/payload/FieldTypeResolver.java | 13 +++++++------ .../restdocs/payload/JsonContentHandler.java | 2 +- .../restdocs/payload/XmlContentHandlerTests.java | 1 - 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/FieldTypeResolver.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/FieldTypeResolver.java index af7aa859..32aa4fc0 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/FieldTypeResolver.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/FieldTypeResolver.java @@ -19,26 +19,27 @@ package org.springframework.restdocs.payload; import org.springframework.http.MediaType; /** - * Public abstraction for external access to field type determination for xml and json - * payloads. + * Resolves the type of a field in a request or response payload. * * @author Mathias Düsterhöft + * @author Andy Wilkinson * @since 2.0.3 */ public interface FieldTypeResolver { /** - * Create a FieldTypeResolver for the given content and contentType. - * @param content the payload that the {@link FieldTypeResolver} should handle + * Create a {@code FieldTypeResolver} for the given {@code content} and + * {@code contentType}. + * @param content the payload that the {@code FieldTypeResolver} should handle * @param contentType the content type of the payload - * @return the {@link FieldTypeResolver} + * @return the {@code FieldTypeResolver} */ static FieldTypeResolver forContent(byte[] content, MediaType contentType) { return ContentHandler.forContent(content, contentType); } /** - * Returns the type of the field that is described by the given + * Resolves the type of the field that is described by the given * {@code fieldDescriptor} based on the content of the payload. * @param fieldDescriptor the field descriptor * @return the type of the field diff --git a/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonContentHandler.java b/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonContentHandler.java index b4d0e1fb..08875e41 100644 --- a/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonContentHandler.java +++ b/spring-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonContentHandler.java @@ -34,7 +34,7 @@ import org.springframework.restdocs.payload.JsonFieldProcessor.ExtractedField; * @author Andy Wilkinson * @author Mathias Düsterhöft */ -class JsonContentHandler implements ContentHandler, FieldTypeResolver { +class JsonContentHandler implements ContentHandler { private final JsonFieldProcessor fieldProcessor = new JsonFieldProcessor(); diff --git a/spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/XmlContentHandlerTests.java b/spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/XmlContentHandlerTests.java index 511c8621..904093b8 100644 --- a/spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/XmlContentHandlerTests.java +++ b/spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/XmlContentHandlerTests.java @@ -30,7 +30,6 @@ import static org.springframework.restdocs.payload.PayloadDocumentation.subsecti * Tests for {@link XmlContentHandler}. * * @author Andy Wilkinson - * @author Mathias Düsterhöft */ public class XmlContentHandlerTests {