io.swagger.jaxrs.config

Class DefaultReaderConfig

java.lang.Object

io.swagger.jaxrs.config.DefaultReaderConfig

All Implemented Interfaces:

ReaderConfig

public class DefaultReaderConfig
extends Object
implements ReaderConfig

The ReaderConfig interface defines configuration settings for JAX-RS annotations reader.

Constructor Summary

Constructors

Constructor and Description
DefaultReaderConfig() Creates default configuration.
DefaultReaderConfig(ReaderConfig src) Creates a copy of passed configuration.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getIgnoredRoutes() Returns paths of resources to be ignored.
boolean	isScanAllResources() Checks if all resources, but not those with the Api annotation has to be processed.
void	setIgnoredRoutes(Collection<String> ignoredRoutes)
void	setScanAllResources(boolean scanAllResources)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReaderConfig

public DefaultReaderConfig()

Creates default configuration.

DefaultReaderConfig

public DefaultReaderConfig(ReaderConfig src)

Creates a copy of passed configuration.

Method Detail

isScanAllResources

public boolean isScanAllResources()

Description copied from interface: ReaderConfig

Checks if all resources, but not those with the Api annotation has to be processed.

Specified by:

isScanAllResources in interface ReaderConfig

Returns:

true if all resource has to be processed

setScanAllResources

public void setScanAllResources(boolean scanAllResources)

getIgnoredRoutes

public Collection<String> getIgnoredRoutes()

Description copied from interface: ReaderConfig

Returns paths of resources to be ignored.

Specified by:

getIgnoredRoutes in interface ReaderConfig

Returns:

collection of paths

setIgnoredRoutes

public void setIgnoredRoutes(Collection<String> ignoredRoutes)