io.swagger.jaxrs.config.ReaderConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of swagger-jaxrs Show documentation

There is a newer version: 1.6.14

package io.swagger.jaxrs.config;

import io.swagger.annotations.Api;

import java.util.Collection;

/**
 * The ReaderConfig interface defines configuration settings for
 * JAX-RS annotations reader.
 */
public interface ReaderConfig {

    /**
     * Checks if all resources, but not those with the
     * {@link Api} annotation has to be processed.
     *
     * @return true if all resource has to be processed
     */
    boolean isScanAllResources();

    /**
     * Returns paths of resources to be ignored.
     *
     * @return collection of paths
     */
    Collection getIgnoredRoutes();
}