org.sdase.commons.server.starter.builder

Interface CustomConfigurationProviders.SwaggerScanningBuilder<C extends io.dropwizard.Configuration>

All Known Subinterfaces:

CustomConfigurationProviders.SwaggerDetailsBuilder<C>, CustomConfigurationProviders.SwaggerFinalBuilder<C>

All Known Implementing Classes:

SdaPlatformBundle.Builder

Enclosing interface:

CustomConfigurationProviders

public static interface CustomConfigurationProviders.SwaggerScanningBuilder<C extends io.dropwizard.Configuration>

Method Summary

Modifier and Type	Method and Description
CustomConfigurationProviders.SwaggerFinalBuilder<C>	addSwaggerResourcePackage(java.lang.String resourcePackage) Adds a package to the packages Swagger should scan to pick up resources.
default CustomConfigurationProviders.SwaggerFinalBuilder<C>	addSwaggerResourcePackageClass(java.lang.Class<?> resourcePackageClass) Adds the package of the given class to the packages Swagger should scan to pick up resources.

Method Detail

addSwaggerResourcePackage

CustomConfigurationProviders.SwaggerFinalBuilder<C> addSwaggerResourcePackage(java.lang.String resourcePackage)

Adds a package to the packages Swagger should scan to pick up resources.

Parameters:

resourcePackage - the package to be scanned; not null

Returns:

the builder

Throws:

java.lang.NullPointerException - if resourcePackage is null

java.lang.IllegalArgumentException - if resourcePackage is empty

See Also:

Swagger's BeanConfig

addSwaggerResourcePackageClass

default CustomConfigurationProviders.SwaggerFinalBuilder<C> addSwaggerResourcePackageClass(java.lang.Class<?> resourcePackageClass)

Adds the package of the given class to the packages Swagger should scan to pick up resources.

Parameters:

resourcePackageClass - the class whose package should be scanned; not null

Returns:

the builder

Throws:

java.lang.NullPointerException - if resourcePackageClass is null

See Also:

Swagger's BeanConfig