 |
 |
org.springframework.boot.web.servlet
Annotation Type ServletComponentScan
-
@Target(value=TYPE) @Retention(value=RUNTIME) @Documented @Import(value=org.springframework.boot.web.servlet.ServletComponentScanRegistrar.class) public @interface ServletComponentScan
Enables scanning for Servlet components (filters,servlets, andlisteners). Scanning is only performed when using an embedded web server.Typically, one of
value,basePackages, orbasePackageClassesshould be specified to control the packages to be scanned for components. In their absence, scanning will be performed from the package of the class with the annotation.- Since:
- 1.3.0
- Author:
- Andy Wilkinson
- See Also:
WebServlet,WebFilter,WebListener
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description Class<?>[]basePackageClassesType-safe alternative tobasePackages()for specifying the packages to scan for annotated servlet components.String[]basePackagesBase packages to scan for annotated servlet components.String[]valueAlias for thebasePackages()attribute.
-
-
-
Element Detail
-
value
@AliasFor(value="basePackages") public abstract String[] value
Alias for thebasePackages()attribute. Allows for more concise annotation declarations e.g.:@ServletComponentScan("org.my.pkg")instead of@ServletComponentScan(basePackages="org.my.pkg").- Returns:
- the base packages to scan
- Default:
- {}
-
-
-
basePackages
@AliasFor(value="value") public abstract String[] basePackages
Base packages to scan for annotated servlet components.value()is an alias for (and mutually exclusive with) this attribute.Use
basePackageClasses()for a type-safe alternative to String-based package names.- Returns:
- the base packages to scan
- Default:
- {}
-
-
-
basePackageClasses
public abstract Class<?>[] basePackageClasses
Type-safe alternative tobasePackages()for specifying the packages to scan for annotated servlet components. The package of each class specified will be scanned.- Returns:
- classes from the base packages to scan
- Default:
- {}
-
-
|