io.swagger.jaxrs.config

Class BeanConfig

java.lang.Object

io.swagger.jaxrs.config.AbstractScanner

io.swagger.jaxrs.config.BeanConfig

All Implemented Interfaces:

Scanner, SwaggerConfig

public class BeanConfig
extends AbstractScanner
implements Scanner, SwaggerConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected Reader	reader
protected javax.servlet.ServletConfig	servletConfig

Fields inherited from class io.swagger.jaxrs.config.AbstractScanner

prettyPrint

Constructor Summary

Constructors

Constructor and Description
BeanConfig()

Method Summary

Modifier and Type	Method and Description
Set<Class<?>>	classes()
Swagger	configure(Swagger swagger)
String	getBasePath()
String	getConfigId()
String	getContact()
String	getContextId()
String	getDescription()
boolean	getExpandSuperTypes()
String	getFilterClass()
String	getHost()
Info	getInfo()
String	getLicense()
String	getLicenseUrl()
String	getResourcePackage()
boolean	getScan()
String	getScannerId()
String[]	getSchemes()
Swagger	getSwagger()
String	getTermsOfServiceUrl()
String	getTitle()
String	getVersion()
boolean	isUsePathBasedConfig()
void	scanAndRead()
void	setBasePath(String basePath)
void	setConfigId(String configId)
void	setContact(String contact)
void	setContextId(String contextId)
void	setDescription(String description)
void	setExpandSuperTypes(boolean expandSuperTypes)
void	setFilterClass(String filterClass)
void	setHost(String host)
void	setInfo(Info info)
void	setLicense(String license)
void	setLicenseUrl(String licenseUrl)
void	setPrettyPrint(String prettyPrint)
void	setResourcePackage(String resourcePackage)
void	setScan()
void	setScan(boolean shouldScan)
void	setScannerId(String scannerId)
void	setSchemes(String[] schemes)
void	setServletConfig(javax.servlet.ServletConfig servletConfig)
void	setTermsOfServiceUrl(String termsOfServiceUrl)
void	setTitle(String title)
void	setUsePathBasedConfig(boolean usePathBasedConfig)
void	setVersion(String version)

Methods inherited from class io.swagger.jaxrs.config.AbstractScanner

getPrettyPrint, setPrettyPrint

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.config.Scanner

getPrettyPrint, setPrettyPrint

Field Detail

reader

protected Reader reader

servletConfig

protected javax.servlet.ServletConfig servletConfig

Constructor Detail

BeanConfig

public BeanConfig()

Method Detail

isUsePathBasedConfig

public boolean isUsePathBasedConfig()

setUsePathBasedConfig

public void setUsePathBasedConfig(boolean usePathBasedConfig)

getResourcePackage

public String getResourcePackage()

setResourcePackage

public void setResourcePackage(String resourcePackage)

getSchemes

public String[] getSchemes()

setSchemes

public void setSchemes(String[] schemes)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getTermsOfServiceUrl

public String getTermsOfServiceUrl()

setTermsOfServiceUrl

public void setTermsOfServiceUrl(String termsOfServiceUrl)

getContact

public String getContact()

setContact

public void setContact(String contact)

getLicense

public String getLicense()

setLicense

public void setLicense(String license)

getLicenseUrl

public String getLicenseUrl()

setLicenseUrl

public void setLicenseUrl(String licenseUrl)

getInfo

public Info getInfo()

setInfo

public void setInfo(Info info)

getHost

public String getHost()

setHost

public void setHost(String host)

getFilterClass

public String getFilterClass()

Specified by:

getFilterClass in interface SwaggerConfig

setFilterClass

public void setFilterClass(String filterClass)

getContextId

public String getContextId()

setContextId

public void setContextId(String contextId)

getScannerId

public String getScannerId()

setScannerId

public void setScannerId(String scannerId)

getConfigId

public String getConfigId()

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig servletConfig)

setConfigId

public void setConfigId(String configId)

getBasePath

public String getBasePath()

getExpandSuperTypes

public boolean getExpandSuperTypes()

setExpandSuperTypes

public void setExpandSuperTypes(boolean expandSuperTypes)

setBasePath

public void setBasePath(String basePath)

setPrettyPrint

public void setPrettyPrint(String prettyPrint)

getScan

public boolean getScan()

setScan

public void setScan(boolean shouldScan)

setScan

public void setScan()

scanAndRead

public void scanAndRead()

classes

public Set<Class<?>> classes()

Specified by:

classes in interface Scanner

getSwagger

public Swagger getSwagger()

configure

public Swagger configure(Swagger swagger)

Specified by:

configure in interface SwaggerConfig