io.github.swagger2markup.internal.document

Class OverviewDocument

java.lang.Object

io.github.swagger2markup.spi.MarkupComponent<OverviewDocument.Parameters>

io.github.swagger2markup.internal.document.OverviewDocument

All Implemented Interfaces:

java.io.Serializable, java.util.function.BiFunction<io.github.swagger2markup.markup.builder.MarkupDocBuilder,OverviewDocument.Parameters,io.github.swagger2markup.markup.builder.MarkupDocBuilder>, javaslang.Function2<io.github.swagger2markup.markup.builder.MarkupDocBuilder,OverviewDocument.Parameters,io.github.swagger2markup.markup.builder.MarkupDocBuilder>, javaslang.λ<io.github.swagger2markup.markup.builder.MarkupDocBuilder>

public class OverviewDocument
extends MarkupComponent<OverviewDocument.Parameters>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OverviewDocument.Parameters

Nested classes/interfaces inherited from interface javaslang.λ

javaslang.λ.Memoized

Field Summary

Fields

Modifier and Type	Field and Description
static int	SECTION_TITLE_LEVEL

Fields inherited from class io.github.swagger2markup.spi.MarkupComponent

COLON, config, context, extensionRegistry, labels, logger

Fields inherited from interface javaslang.Function2

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OverviewDocument(Swagger2MarkupConverter.Context context)

Method Summary

Modifier and Type	Method and Description
io.github.swagger2markup.markup.builder.MarkupDocBuilder	apply(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder, OverviewDocument.Parameters params) Builds the overview MarkupDocument.
static OverviewDocument.Parameters	parameters(io.swagger.models.Swagger swagger)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javaslang.Function2

andThen, apply, arity, curried, lift, memoized, of, reversed, tupled

Methods inherited from interface javaslang.λ

isMemoized

Field Detail

SECTION_TITLE_LEVEL

public static final int SECTION_TITLE_LEVEL

See Also:

Constant Field Values

Constructor Detail

OverviewDocument

public OverviewDocument(Swagger2MarkupConverter.Context context)

Method Detail

parameters

public static OverviewDocument.Parameters parameters(io.swagger.models.Swagger swagger)

apply

public io.github.swagger2markup.markup.builder.MarkupDocBuilder apply(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder,
                                                                      OverviewDocument.Parameters params)

Builds the overview MarkupDocument.

Returns:

the overview MarkupDocument