org.springframework.restdocs.request

Class QueryParametersSnippetResultHandler

java.lang.Object

org.springframework.restdocs.snippet.SnippetWritingResultHandler

org.springframework.restdocs.request.QueryParametersSnippetResultHandler

All Implemented Interfaces:

ResultHandler

public class QueryParametersSnippetResultHandler
extends SnippetWritingResultHandler

A SnippetWritingResultHandler that produces a snippet documenting the query parameters supported by a RESTful resource.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryParametersSnippetResultHandler(String outputDir, ParameterDescriptor... descriptors)

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

QueryParametersSnippetResultHandler

protected QueryParametersSnippetResultHandler(String outputDir,
                                              ParameterDescriptor... descriptors)

Method Detail

handle

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

Specified by:

handle in class SnippetWritingResultHandler

Throws:

IOException