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
Writer	resolve(String operationName, 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.
void	setEncoding(String encoding) Deprecated. since 1.1.0 in favour of configuring the encoding when to resolver is created

Method Detail

resolve

Writer resolve(String operationName,
               String snippetName,
               RestDocumentationContext restDocumentationContext)
        throws 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:

IOException - if a writer cannot be resolved

setEncoding

@Deprecated
void setEncoding(String encoding)

Deprecated. since 1.1.0 in favour of configuring the encoding when to resolver is created

Configures the encoding that should be used by any writers produced by this resolver.

Parameters:

encoding - the encoding