capital.scalable.restdocs.section

Class SectionBuilder

java.lang.Object

capital.scalable.restdocs.section.SectionBuilder

public class SectionBuilder
extends Object

Builder for configuring a section snippet.

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	DEFAULT_SNIPPETS

Constructor Summary

Constructors

Constructor and Description
SectionBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
SectionSnippet	build()
SectionBuilder	skipEmpty(boolean skipEmpty) If snippet would not generate any output (e.g.
SectionBuilder	snippetNames(List<String> snippetNames) List of snippet names to use in the specified order.
SectionBuilder	snippetNames(String... snippetNames) Array of snippet names to use in the specified order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SNIPPETS

public static final Collection<String> DEFAULT_SNIPPETS

Constructor Detail

SectionBuilder

public SectionBuilder()

Method Detail

snippetNames

public SectionBuilder snippetNames(List<String> snippetNames)

List of snippet names to use in the specified order.

Parameters:

snippetNames - snippet names to use; if not specified, DEFAULT_SNIPPETS will be used

Returns:

this

snippetNames

public SectionBuilder snippetNames(String... snippetNames)

Array of snippet names to use in the specified order.

Parameters:

snippetNames - snippet names to use; if not specified, DEFAULT_SNIPPETS will be used

Returns:

this

skipEmpty

public SectionBuilder skipEmpty(boolean skipEmpty)

If snippet would not generate any output (e.g. endpoint has no path parameters), than this snippet would not be included in the section.

Parameters:

skipEmpty - true if snippets with no content should not be included in the section; false otherwise (default)

Returns:

this

build

public SectionSnippet build()