capital.scalable.restdocs.hypermedia

Class EmbeddedSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

capital.scalable.restdocs.hypermedia.EmbeddedSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class EmbeddedSnippet
extends AbstractJacksonFieldSnippet

Constructor Summary

Constructors

Constructor and Description
EmbeddedSnippet()
EmbeddedSnippet(Type documentationType, boolean failOnUndocumentedFields)

Method Summary

Modifier and Type	Method and Description
EmbeddedSnippet	documentationType(Type documentationType)
EmbeddedSnippet	failOnUndocumentedFields(boolean failOnUndocumentedFields)
String	getHeaderKey() Section header key corresponding to entry in translation file.
protected String[]	getTranslationKeys()
protected Type	getType(org.springframework.web.method.HandlerMethod method)
protected boolean	shouldFailOnUndocumentedFields()

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

createFieldDescriptors, firstGenericType, getFileName, hasContent, isCollection

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

createModel, createModelForDescriptor, enrichModel

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

EmbeddedSnippet

public EmbeddedSnippet()

EmbeddedSnippet

public EmbeddedSnippet(Type documentationType,
                       boolean failOnUndocumentedFields)

Method Detail

documentationType

public EmbeddedSnippet documentationType(Type documentationType)

failOnUndocumentedFields

public EmbeddedSnippet failOnUndocumentedFields(boolean failOnUndocumentedFields)

getType

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

Specified by:

getType in class AbstractJacksonFieldSnippet

getHeaderKey

public String getHeaderKey()

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

shouldFailOnUndocumentedFields

protected boolean shouldFailOnUndocumentedFields()

Specified by:

shouldFailOnUndocumentedFields in class AbstractJacksonFieldSnippet

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet