Package net.officefloor.web.openapi.section

Class OpenApiSectionSource

java.lang.Object

net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

net.officefloor.web.openapi.section.OpenApiSectionSource

All Implemented Interfaces:

SectionSource

@PrivateSource
public class OpenApiSectionSource
extends AbstractSectionSource

Configures the Open API servicing.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

AbstractSectionSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON	Name to link the JSON servicing.
static final String	YAML	Name to link the YAML servicing.

Constructor Summary

Constructors

Constructor	Description
OpenApiSectionSource(io.swagger.v3.oas.models.OpenAPI openApi)	Initiate.

Method Summary

Modifier and Type	Method	Description
protected void	loadSpecification(AbstractSectionSource.SpecificationContext context)	Loads the SectionSourceSpecification.
void	sourceSection(SectionDesigner designer, SectionSourceContext context)	Sources the OfficeSection by constructing it via the input SectionDesigner.

Methods inherited from class net.officefloor.compile.spi.section.source.impl.AbstractSectionSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Details

JSON

public static final String JSON

Name to link the JSON servicing.

See Also:

• Constant Field Values

YAML

public static final String YAML

Name to link the YAML servicing.

See Also:

• Constant Field Values

Constructor Details

OpenApiSectionSource

public OpenApiSectionSource(io.swagger.v3.oas.models.OpenAPI openApi)

Initiate.

Parameters:

openApi - OpenAPI.

Method Details

loadSpecification

protected void loadSpecification(AbstractSectionSource.SpecificationContext context)

Description copied from class: AbstractSectionSource

Loads the SectionSourceSpecification.

Specified by:

loadSpecification in class AbstractSectionSource

Parameters:

context - AbstractSectionSource.SpecificationContext.

sourceSection

public void sourceSection(SectionDesigner designer,
 SectionSourceContext context)
                   throws Exception

Description copied from interface: SectionSource

Sources the OfficeSection by constructing it via the input SectionDesigner.

Parameters:

designer - SectionDesigner to construct the structure of the OfficeSection.

context - SectionSourceContext to source details to construct the OfficeSection.

Throws:

Exception - If fails to construct the OfficeSection.