capital.scalable.restdocs.payload

Class JacksonModelAttributeSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

capital.scalable.restdocs.payload.JacksonModelAttributeSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class JacksonModelAttributeSnippet
extends AbstractJacksonFieldSnippet

Constructor Summary

Constructors

Constructor and Description
JacksonModelAttributeSnippet()
JacksonModelAttributeSnippet(Collection<org.springframework.web.method.support.HandlerMethodArgumentResolver> handlerMethodArgumentResolvers, boolean failOnUndocumentedFields)

Method Summary

Modifier and Type	Method and Description
protected void	enrichModel(Map<String,Object> model, org.springframework.web.method.HandlerMethod handlerMethod, FieldDescriptors fieldDescriptors, SnippetTranslationResolver translationResolver)
String	getHeaderKey(org.springframework.restdocs.operation.Operation operation) Section header key corresponding to entry in translation file.
protected com.fasterxml.jackson.annotation.JsonProperty.Access	getSkipAcessor()
protected String[]	getTranslationKeys()
protected Type[]	getType(org.springframework.web.method.HandlerMethod method)
boolean	isMergeable() Flag if section is mergeable with other sections with the same header
protected boolean	isRequestMethodGet(org.springframework.web.method.HandlerMethod method)
protected boolean	shouldFailOnUndocumentedFields()

Methods inherited from class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

createFieldDescriptors, getFileName, hasContent, isCollection

Methods inherited from class capital.scalable.restdocs.snippet.StandardTableSnippet

createModel, createModelForDescriptor

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

JacksonModelAttributeSnippet

public JacksonModelAttributeSnippet()

JacksonModelAttributeSnippet

public JacksonModelAttributeSnippet(Collection<org.springframework.web.method.support.HandlerMethodArgumentResolver> handlerMethodArgumentResolvers,
                                    boolean failOnUndocumentedFields)

Method Detail

getType

protected Type[] getType(org.springframework.web.method.HandlerMethod method)

Specified by:

getType in class AbstractJacksonFieldSnippet

isRequestMethodGet

protected boolean isRequestMethodGet(org.springframework.web.method.HandlerMethod method)

enrichModel

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

Overrides:

enrichModel in class StandardTableSnippet

shouldFailOnUndocumentedFields

protected boolean shouldFailOnUndocumentedFields()

Specified by:

shouldFailOnUndocumentedFields in class AbstractJacksonFieldSnippet

getHeaderKey

public String getHeaderKey(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

Parameters:

operation - operation

isMergeable

public boolean isMergeable()

Description copied from interface: SectionSupport

Flag if section is mergeable with other sections with the same header

Returns:

true if this section is mergeable; false otherwise

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet

getSkipAcessor

protected com.fasterxml.jackson.annotation.JsonProperty.Access getSkipAcessor()

Overrides:

getSkipAcessor in class AbstractJacksonFieldSnippet