capital.scalable.restdocs.hypermedia

Class LinksSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

capital.scalable.restdocs.hypermedia.LinksSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class LinksSnippet
extends AbstractJacksonFieldSnippet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LinksSnippet	documentationType(Type documentationType)
LinksSnippet	failOnUndocumentedFields(boolean failOnUndocumentedFields)
String	getHeaderKey(org.springframework.restdocs.operation.Operation operation) 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, getFileName, getSkipAcessor, 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

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

isMergeable

Constructor Detail

LinksSnippet

public LinksSnippet()

LinksSnippet

public LinksSnippet(Type documentationType,
                    boolean failOnUndocumentedFields)

Method Detail

documentationType

public LinksSnippet documentationType(Type documentationType)

failOnUndocumentedFields

public LinksSnippet failOnUndocumentedFields(boolean failOnUndocumentedFields)

getType

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

Specified by:

getType 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

shouldFailOnUndocumentedFields

protected boolean shouldFailOnUndocumentedFields()

Specified by:

shouldFailOnUndocumentedFields in class AbstractJacksonFieldSnippet

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet