capital.scalable.restdocs.section

Interface SectionSupport

All Known Implementing Classes:

AuthorizationSnippet, JacksonRequestFieldSnippet, JacksonResponseFieldSnippet, PathParametersSnippet, RequestParametersSnippet

public interface SectionSupport

Method Summary

Methods

Modifier and Type	Method and Description
String	getFileName() File name (= section name).
String	getHeader() Section header.
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.

Method Detail

getFileName

String getFileName()

File name (= section name).

Returns:

file name

getHeader

String getHeader()

Section header.

Returns:

header

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