org.springframework.restdocs.snippet

Class SnippetWritingResultHandler

java.lang.Object

org.springframework.restdocs.snippet.SnippetWritingResultHandler

All Implemented Interfaces:

ResultHandler

Direct Known Subclasses:

FieldSnippetResultHandler, LinkSnippetResultHandler, QueryParametersSnippetResultHandler

public abstract class SnippetWritingResultHandler
extends Object
implements ResultHandler

Base class for a ResultHandler that writes a documentation snippet

Author:

Andy Wilkinson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnippetWritingResultHandler(String outputDir, String fileName)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SnippetWritingResultHandler

protected SnippetWritingResultHandler(String outputDir,
                                      String fileName)

Method Detail

handle

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

Throws:

IOException

handle

public void handle(MvcResult result)
            throws IOException

Specified by:

handle in interface ResultHandler

Throws:

IOException