capital.scalable.restdocs.section

Interface SectionSupport

All Known Implementing Classes:

AbstractJacksonFieldSnippet, AuthorizationSnippet, EmbeddedSnippet, JacksonModelAttributeSnippet, JacksonRequestFieldSnippet, JacksonResponseFieldSnippet, LinksSnippet, PathParametersSnippet, RequestHeaderSnippet, RequestParametersSnippet

public interface SectionSupport

Method Summary

Modifier and Type	Method and Description
String	getFileName() File name (= section name).
String	getHeaderKey(org.springframework.restdocs.operation.Operation operation) Section header key corresponding to entry in translation file.
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.
default boolean	isMergeable() Flag if section is mergeable with other sections with the same header

Method Detail

getFileName

String getFileName()

File name (= section name).

getHeaderKey

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

Section header key corresponding to entry in translation file.

Parameters:

operation - operation

hasContent

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

Flag if section will render non-empty content.

Parameters:

operation - operation

Returns:

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

isMergeable

default boolean isMergeable()

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

Returns:

true if this section is mergeable; false otherwise