org.springframework.restdocs.templates

Class StandardTemplateResourceResolver

java.lang.Object

org.springframework.restdocs.templates.StandardTemplateResourceResolver

All Implemented Interfaces:

TemplateResourceResolver

public class StandardTemplateResourceResolver
extends Object
implements TemplateResourceResolver

Standard implementation of TemplateResourceResolver.

Templates are resolved by first looking for a resource on the classpath named org/springframework/restdocs/templates/{name}.snippet. If no such resource exists default- is prepended to the name and the classpath is checked again. The built-in snippet templates are all named default- name, thereby allowing them to be overridden.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
StandardTemplateResourceResolver()

Method Summary

Modifier and Type	Method and Description
Resource	resolveTemplateResource(String name) Resolves a Resource for the template with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardTemplateResourceResolver

public StandardTemplateResourceResolver()

Method Detail

resolveTemplateResource

public Resource resolveTemplateResource(String name)

Description copied from interface: TemplateResourceResolver

Resolves a Resource for the template with the given name.

Specified by:

resolveTemplateResource in interface TemplateResourceResolver

Parameters:

name - the name of the template

Returns:

the Resource from which the template can be read