org.sdase.commons.server.swagger

Interface SwaggerBundle.InterimBuilder

All Known Subinterfaces:

SwaggerBundle.FinalBuilder

All Known Implementing Classes:

SwaggerBundle.Builder

Enclosing class:

SwaggerBundle

public static interface SwaggerBundle.InterimBuilder

Method Summary

Modifier and Type	Method and Description
SwaggerBundle.FinalBuilder	addResourcePackage(java.lang.String resourcePackage) Adds a package to the packages Swagger should scan to pick up resources.
SwaggerBundle.FinalBuilder	addResourcePackageClass(java.lang.Class<?> resourcePackageClass) Adds the package of the given class to the packages Swagger should scan to pick up resources.

Method Detail

addResourcePackage

SwaggerBundle.FinalBuilder addResourcePackage(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

addResourcePackageClass

SwaggerBundle.FinalBuilder addResourcePackageClass(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