capital.scalable.restdocs.payload

Class AbstractJacksonFieldSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

Direct Known Subclasses:

EmbeddedSnippet, JacksonRequestFieldSnippet, JacksonResponseFieldSnippet, LinksSnippet

public abstract class AbstractJacksonFieldSnippet
extends StandardTableSnippet
implements SectionSupport

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected FieldDescriptors	createFieldDescriptors(org.springframework.restdocs.operation.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected Type	firstGenericType(org.springframework.core.MethodParameter param)
String	getFileName() File name (= section name).
protected abstract Type	getType(org.springframework.web.method.HandlerMethod method)
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.
protected boolean	isCollection(Class<?> type)
protected abstract boolean	shouldFailOnUndocumentedFields()

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

createModel, createModelForDescriptor, enrichModel, 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

Methods inherited from interface capital.scalable.restdocs.section.SectionSupport

getHeaderKey

Constructor Detail

AbstractJacksonFieldSnippet

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

Method Detail

createFieldDescriptors

protected FieldDescriptors createFieldDescriptors(org.springframework.restdocs.operation.Operation operation,
                                                  org.springframework.web.method.HandlerMethod handlerMethod)

Specified by:

createFieldDescriptors in class StandardTableSnippet

firstGenericType

protected Type firstGenericType(org.springframework.core.MethodParameter param)

getType

protected abstract Type getType(org.springframework.web.method.HandlerMethod method)

shouldFailOnUndocumentedFields

protected abstract boolean shouldFailOnUndocumentedFields()

isCollection

protected boolean isCollection(Class<?> type)

getFileName

public String getFileName()

Description copied from interface: SectionSupport

File name (= section name).

Specified by:

getFileName in interface SectionSupport

hasContent

public boolean hasContent(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Flag if section will render non-empty content.

Specified by:

hasContent in interface SectionSupport

Parameters:

operation - operation

Returns:

true if snippet will return non-empty content; false otherwise