org.springframework.restdocs.snippet

Class StandardWriterResolver

java.lang.Object

org.springframework.restdocs.snippet.StandardWriterResolver

All Implemented Interfaces:

WriterResolver

public class StandardWriterResolver
extends Object
implements WriterResolver

Standard implementation of WriterResolver.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
StandardWriterResolver(PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver) Creates a new StandardWriterResolver that will use the given placeholderResolver to resolve any placeholders in the operationName.

Method Summary

Modifier and Type	Method and Description
Writer	resolve(String operationName, String snippetName, RestDocumentationContext context) Returns a writer that can be used to write the snippet with the given name for the operation with the given name.
protected File	resolveFile(String outputDirectory, String fileName, RestDocumentationContext context)
void	setEncoding(String encoding) Configures the encoding that should be used by any writers produced by this resolver

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardWriterResolver

public StandardWriterResolver(PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver)

Creates a new StandardWriterResolver that will use the given placeholderResolver to resolve any placeholders in the operationName.

Parameters:

placeholderResolver - the placeholder resolver

Method Detail

resolve

public Writer resolve(String operationName,
                      String snippetName,
                      RestDocumentationContext context)
               throws IOException

Description copied from interface: WriterResolver

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

Specified by:

resolve in interface WriterResolver

Parameters:

operationName - the name of the operation that is being documented

snippetName - the name of the snippet

context - the current documentation context

Returns:

the writer

Throws:

IOException - if a writer cannot be resolved

setEncoding

public void setEncoding(String encoding)

Description copied from interface: WriterResolver

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

Specified by:

setEncoding in interface WriterResolver

Parameters:

encoding - the encoding

resolveFile

protected File resolveFile(String outputDirectory,
                           String fileName,
                           RestDocumentationContext context)