Package springfox.documentation.spring.web.plugins

Class DefaultConfiguration

java.lang.Object

springfox.documentation.spring.web.plugins.DefaultConfiguration

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<DocumentationType>, DefaultsProviderPlugin

public class DefaultConfiguration
extends java.lang.Object
implements DefaultsProviderPlugin

Constructor Summary

Constructors

Constructor	Description
DefaultConfiguration(Defaults defaults, com.fasterxml.classmate.TypeResolver typeResolver, PathProvider pathProvider)

Method Summary

Modifier and Type	Method	Description
DocumentationContextBuilder	apply(DocumentationContextBuilder builder)	Implement this method to override enrich the documentation context builder with documentation type specific defaults.
DocumentationContextBuilder	create(DocumentationType documentationType)	Use DefaultsProviderPlugin.apply(DocumentationContextBuilder) instead
boolean	supports(DocumentationType delimiter)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfiguration

public DefaultConfiguration(Defaults defaults,
                            com.fasterxml.classmate.TypeResolver typeResolver,
                            PathProvider pathProvider)

Method Detail

create

public DocumentationContextBuilder create(DocumentationType documentationType)

Description copied from interface: DefaultsProviderPlugin

Use DefaultsProviderPlugin.apply(DocumentationContextBuilder) instead

Specified by:

create in interface DefaultsProviderPlugin

Parameters:

documentationType - - creates a default DocumentationContextBuilder based on documentation type

Returns:

- returns the documentation context builder

apply

public DocumentationContextBuilder apply(DocumentationContextBuilder builder)

Description copied from interface: DefaultsProviderPlugin

Implement this method to override enrich the documentation context builder with documentation type specific defaults.

Specified by:

apply in interface DefaultsProviderPlugin

Parameters:

builder - - creates a default DocumentationContextBuilder based on documentation type

Returns:

- returns the documentation context builder

supports

public boolean supports(DocumentationType delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<DocumentationType>