org.springframework.restdocs.payload

Class FieldSnippetResultHandler

java.lang.Object

org.springframework.restdocs.snippet.SnippetWritingResultHandler

org.springframework.restdocs.payload.FieldSnippetResultHandler

All Implemented Interfaces:

ResultHandler

Direct Known Subclasses:

RequestFieldSnippetResultHandler, ResponseFieldSnippetResultHandler

public abstract class FieldSnippetResultHandler
extends SnippetWritingResultHandler

A SnippetWritingResultHandler that produces a snippet documenting a RESTful resource's request or response fields.

Author:

Andreas Evers, Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
protected abstract Reader	getPayloadReader(MvcResult result)
protected void	handle(MvcResult result, DocumentationWriter writer)

Methods inherited from class org.springframework.restdocs.snippet.SnippetWritingResultHandler

handle

Methods inherited from class java.lang.Object

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

Method Detail

handle

protected void handle(MvcResult result,
                      DocumentationWriter writer)
               throws IOException

Specified by:

handle in class SnippetWritingResultHandler

Throws:

IOException

getPayloadReader

protected abstract Reader getPayloadReader(MvcResult result)
                                    throws IOException

Throws:

IOException