springfox.documentation.spring.web.plugins

Class DocumentationPluginsBootstrapper

java.lang.Object

springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper

All Implemented Interfaces:

org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

@Component
 @Conditional(value=SpringIntegrationPluginNotPresentInClassPathCondition.class)
public class DocumentationPluginsBootstrapper
extends AbstractDocumentationPluginsBootstrapper
implements org.springframework.context.SmartLifecycle

Builds and executes all DocumentationConfigurer instances found in the application context, at the end of all phases in SmartLifecycle .

If no instances DocumentationConfigurer are found a default one is created and executed.

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description

DocumentationPluginsBootstrapper(DocumentationPluginsManager documentationPluginsManager, java.util.List<springfox.documentation.spi.service.RequestHandlerProvider> handlerProviders, DocumentationCache scanned, ApiDocumentationScanner resourceListing, com.fasterxml.classmate.TypeResolver typeResolver, springfox.documentation.spi.service.contexts.Defaults defaults, springfox.documentation.PathProvider pathProvider, org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method and Description
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	setCombiner(springfox.documentation.spi.service.RequestHandlerCombiner combiner)
void	setTypeConventions(java.util.List<springfox.documentation.schema.AlternateTypeRuleConvention> typeConventions)
void	start()
void	stop()
void	stop(java.lang.Runnable callback)

Methods inherited from class springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper

bootstrapDocumentationPlugins, buildContext, getCombiner, getDefaultConfiguration, getDocumentationPluginsManager, getHandlerProviders, getResourceListing, getScanned, getTypeConventions, scanDocumentation

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationPluginsBootstrapper

@Autowired
public DocumentationPluginsBootstrapper(DocumentationPluginsManager documentationPluginsManager,
                                                   java.util.List<springfox.documentation.spi.service.RequestHandlerProvider> handlerProviders,
                                                   DocumentationCache scanned,
                                                   ApiDocumentationScanner resourceListing,
                                                   com.fasterxml.classmate.TypeResolver typeResolver,
                                                   springfox.documentation.spi.service.contexts.Defaults defaults,
                                                   springfox.documentation.PathProvider pathProvider,
                                                   org.springframework.core.env.Environment environment)

Method Detail

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(java.lang.Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

setCombiner

@Autowired(required=false)
public void setCombiner(springfox.documentation.spi.service.RequestHandlerCombiner combiner)

Overrides:

setCombiner in class AbstractDocumentationPluginsBootstrapper

setTypeConventions

@Autowired(required=false)
public void setTypeConventions(java.util.List<springfox.documentation.schema.AlternateTypeRuleConvention> typeConventions)

Overrides:

setTypeConventions in class AbstractDocumentationPluginsBootstrapper