capital.scalable.restdocs.snippet

Class StandardTableSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

All Implemented Interfaces:

org.springframework.restdocs.snippet.Snippet

Direct Known Subclasses:

JacksonRequestFieldSnippet, JacksonResponseFieldSnippet, PathParametersSnippet, RequestHeaderSnippet, RequestParametersSnippet

public abstract class StandardTableSnippet
extends org.springframework.restdocs.snippet.TemplatedSnippet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandardTableSnippet(String snippetName, Map<String,Object> attributes)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<org.springframework.restdocs.payload.FieldDescriptor>	createFieldDescriptors(org.springframework.restdocs.operation.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected Map<String,Object>	createModel(org.springframework.restdocs.operation.Operation operation)
protected Map<String,Object>	createModelForDescriptor(org.springframework.restdocs.payload.FieldDescriptor descriptor, TemplateFormatting templateFormatting)
protected void	enrichModel(Map<String,Object> model, org.springframework.web.method.HandlerMethod handlerMethod)
protected abstract String[]	getTranslationKeys()

Methods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardTableSnippet

protected StandardTableSnippet(String snippetName,
                    Map<String,Object> attributes)

Method Detail

createModel

protected Map<String,Object> createModel(org.springframework.restdocs.operation.Operation operation)

Specified by:

createModel in class org.springframework.restdocs.snippet.TemplatedSnippet

createFieldDescriptors

protected abstract Collection<org.springframework.restdocs.payload.FieldDescriptor> createFieldDescriptors(org.springframework.restdocs.operation.Operation operation,
                                                                                      org.springframework.web.method.HandlerMethod handlerMethod)

getTranslationKeys

protected abstract String[] getTranslationKeys()

enrichModel

protected void enrichModel(Map<String,Object> model,
               org.springframework.web.method.HandlerMethod handlerMethod)

createModelForDescriptor

protected Map<String,Object> createModelForDescriptor(org.springframework.restdocs.payload.FieldDescriptor descriptor,
                                          TemplateFormatting templateFormatting)