capital.scalable.restdocs.section

Class SectionSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.section.SectionSnippet

All Implemented Interfaces:

org.springframework.restdocs.snippet.Snippet

public class SectionSnippet
extends org.springframework.restdocs.snippet.TemplatedSnippet

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory	placeholderResolverFactory
protected org.springframework.util.PropertyPlaceholderHelper	propertyPlaceholderHelper
static String	SECTION
protected Collection<String>	sectionNames
protected boolean	skipEmpty

Constructor Summary

Constructors

Constructor and Description
SectionSnippet(Collection<String> sectionNames, boolean skipEmpty)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createModel(org.springframework.restdocs.operation.Operation operation)
protected Collection<capital.scalable.restdocs.section.SectionSnippet.Section>	createSections(org.springframework.restdocs.operation.Operation operation, SnippetTranslationResolver translationResolver)
protected String	resolveTitle(org.springframework.web.method.HandlerMethod handlerMethod, JavadocReader javadocReader, SnippetTranslationResolver translationResolver)

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

Field Detail

SECTION

public static final String SECTION

See Also:

Constant Field Values

placeholderResolverFactory

protected final org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory placeholderResolverFactory

propertyPlaceholderHelper

protected final org.springframework.util.PropertyPlaceholderHelper propertyPlaceholderHelper

sectionNames

protected final Collection<String> sectionNames

skipEmpty

protected final boolean skipEmpty

Constructor Detail

SectionSnippet

public SectionSnippet(Collection<String> sectionNames,
                      boolean skipEmpty)

Method Detail

createModel

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

Specified by:

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

createSections

protected Collection<capital.scalable.restdocs.section.SectionSnippet.Section> createSections(org.springframework.restdocs.operation.Operation operation,
                                                                                              SnippetTranslationResolver translationResolver)

resolveTitle

protected String resolveTitle(org.springframework.web.method.HandlerMethod handlerMethod,
                              JavadocReader javadocReader,
                              SnippetTranslationResolver translationResolver)