org.springframework.restdocs.snippet

Interface WriterResolver

All Known Implementing Classes:

StandardWriterResolver

public interface WriterResolver

A WriterResolver is used to access the Writer that should be used to write a snippet for an operation that is being documented.

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method and Description
java.io.Writer	resolve(java.lang.String operationName, java.lang.String snippetName, RestDocumentationContext restDocumentationContext) Returns a writer that can be used to write the snippet with the given name for the operation with the given name.

Method Detail

resolve

java.io.Writer resolve(java.lang.String operationName,
                       java.lang.String snippetName,
                       RestDocumentationContext restDocumentationContext)
                throws java.io.IOException

Returns a writer that can be used to write the snippet with the given name for the operation with the given name.

Parameters:

operationName - the name of the operation that is being documented

snippetName - the name of the snippet

restDocumentationContext - the current documentation context

Returns:

the writer

Throws:

java.io.IOException - if a writer cannot be resolved