io.github.swagger2markup.extensions

Class DynamicOverviewDocumentExtension

java.lang.Object

io.github.swagger2markup.spi.OverviewDocumentExtension

io.github.swagger2markup.extensions.DynamicOverviewDocumentExtension

public final class DynamicOverviewDocumentExtension
extends io.github.swagger2markup.spi.OverviewDocumentExtension

Dynamically search for markup files in contentPath to append to Overview document.

Markup files are appended in the natural order of their names, for each category.

Nested Class Summary

Nested classes/interfaces inherited from class io.github.swagger2markup.spi.OverviewDocumentExtension

io.github.swagger2markup.spi.OverviewDocumentExtension.Context, io.github.swagger2markup.spi.OverviewDocumentExtension.Position

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	contentPath
protected io.github.swagger2markup.Swagger2MarkupConverter.Context	globalContext

Constructor Summary

Constructors

Constructor and Description
DynamicOverviewDocumentExtension()
DynamicOverviewDocumentExtension(java.nio.file.Path contentPath, io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage) Instantiate extension with the default extension id.
DynamicOverviewDocumentExtension(java.lang.String extensionId, java.nio.file.Path contentPath, io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage) Instantiate extension

Method Summary

Modifier and Type	Method and Description
void	apply(io.github.swagger2markup.spi.OverviewDocumentExtension.Context context)
void	init(io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext)

Methods inherited from class io.github.swagger2markup.spi.OverviewDocumentExtension

levelOffset

Methods inherited from class java.lang.Object

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

Field Detail

contentPath

protected java.nio.file.Path contentPath

globalContext

protected io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext

Constructor Detail

DynamicOverviewDocumentExtension

public DynamicOverviewDocumentExtension(java.nio.file.Path contentPath,
                                        io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage)

Instantiate extension with the default extension id.

Parameters:

contentPath - the base Path where the content is stored

extensionMarkupLanguage - the MarkupLanguage of the extension content

DynamicOverviewDocumentExtension

public DynamicOverviewDocumentExtension(java.lang.String extensionId,
                                        java.nio.file.Path contentPath,
                                        io.github.swagger2markup.markup.builder.MarkupLanguage extensionMarkupLanguage)

Instantiate extension

Parameters:

extensionId - the unique ID of the extension

contentPath - the base Path where the content is stored

extensionMarkupLanguage - the MarkupLanguage of the extension content

DynamicOverviewDocumentExtension

public DynamicOverviewDocumentExtension()

Method Detail

init

public void init(io.github.swagger2markup.Swagger2MarkupConverter.Context globalContext)

Overrides:

init in class io.github.swagger2markup.spi.OverviewDocumentExtension

apply

public void apply(io.github.swagger2markup.spi.OverviewDocumentExtension.Context context)

Specified by:

apply in class io.github.swagger2markup.spi.OverviewDocumentExtension