Narrow auto-configure checkstyle suppressions

Closes gh-21015
This commit is contained in:
Phillip Webb 2020-12-08 17:04:03 -08:00
parent 4f95486822
commit 286ef61071
7 changed files with 33 additions and 7 deletions

View File

@ -48,6 +48,9 @@ import org.springframework.core.annotation.Order;
@Documented @Documented
public @interface AutoConfigureOrder { public @interface AutoConfigureOrder {
/**
* The default order value.
*/
int DEFAULT_ORDER = 0; int DEFAULT_ORDER = 0;
/** /**

View File

@ -83,6 +83,10 @@ import org.springframework.core.io.support.SpringFactoriesLoader;
@Import(AutoConfigurationImportSelector.class) @Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration { public @interface EnableAutoConfiguration {
/**
* Environment property that can be used to override when auto-configuration is
* enabled.
*/
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
/** /**

View File

@ -54,7 +54,10 @@ import org.springframework.core.Ordered;
@Import(CloudScanConfiguration.class) @Import(CloudScanConfiguration.class)
public class CloudServiceConnectorsAutoConfiguration { public class CloudServiceConnectorsAutoConfiguration {
// Cloud configuration needs to happen early (before data, mongo etc.) /**
* The order for cloud configuration. Cloud configurations need to happen early (so
* that they run before data, mongo, etc.).
*/
public static final int ORDER = Ordered.HIGHEST_PRECEDENCE + 20; public static final int ORDER = Ordered.HIGHEST_PRECEDENCE + 20;
private static final Log logger = LogFactory.getLog(CloudServiceConnectorsAutoConfiguration.class); private static final Log logger = LogFactory.getLog(CloudServiceConnectorsAutoConfiguration.class);

View File

@ -400,18 +400,28 @@ public final class ConditionMessage {
*/ */
public enum Style { public enum Style {
/**
* Render with normal styling.
*/
NORMAL { NORMAL {
@Override @Override
protected Object applyToItem(Object item) { protected Object applyToItem(Object item) {
return item; return item;
} }
}, },
/**
* Render with the item surrounded by quotes.
*/
QUOTE { QUOTE {
@Override @Override
protected String applyToItem(Object item) { protected String applyToItem(Object item) {
return (item != null) ? "'" + item + "'" : null; return (item != null) ? "'" + item + "'" : null;
} }
}; };
public Collection<?> applyTo(Collection<?> items) { public Collection<?> applyTo(Collection<?> items) {

View File

@ -70,13 +70,13 @@ import org.springframework.web.servlet.DispatcherServlet;
@AutoConfigureAfter(ServletWebServerFactoryAutoConfiguration.class) @AutoConfigureAfter(ServletWebServerFactoryAutoConfiguration.class)
public class DispatcherServletAutoConfiguration { public class DispatcherServletAutoConfiguration {
/* /**
* The bean name for a DispatcherServlet that will be mapped to the root URL "/" * The bean name for a DispatcherServlet that will be mapped to the root URL "/".
*/ */
public static final String DEFAULT_DISPATCHER_SERVLET_BEAN_NAME = "dispatcherServlet"; public static final String DEFAULT_DISPATCHER_SERVLET_BEAN_NAME = "dispatcherServlet";
/* /**
* The bean name for a ServletRegistrationBean for the DispatcherServlet "/" * The bean name for a ServletRegistrationBean for the DispatcherServlet "/".
*/ */
public static final String DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME = "dispatcherServletRegistration"; public static final String DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME = "dispatcherServletRegistration";

View File

@ -141,8 +141,14 @@ import org.springframework.web.servlet.view.InternalResourceViewResolver;
ValidationAutoConfiguration.class }) ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration { public class WebMvcAutoConfiguration {
/**
* The default Spring MVC view prefix.
*/
public static final String DEFAULT_PREFIX = ""; public static final String DEFAULT_PREFIX = "";
/**
* The default Spring MVC view suffix.
*/
public static final String DEFAULT_SUFFIX = ""; public static final String DEFAULT_SUFFIX = "";
private static final String[] SERVLET_LOCATIONS = { "/" }; private static final String[] SERVLET_LOCATIONS = { "/" };

View File

@ -15,8 +15,8 @@
<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="Javadoc*" /> <suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="Javadoc*" />
<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" id="mainCodeIllegalImportCheck" /> <suppress files="[\\/]src[\\/]test[\\/]java[\\/]" id="mainCodeIllegalImportCheck" />
<suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="NonEmptyAtclauseDescription" /> <suppress files="[\\/]src[\\/]test[\\/]java[\\/]" checks="NonEmptyAtclauseDescription" />
<suppress files="[\\/]autoconfigure[\\/]" checks="JavadocType" /> <suppress files="[\\/]autoconfigure[\\/].*Properties\.java" checks="JavadocType" />
<suppress files="[\\/]autoconfigure[\\/]" checks="JavadocVariable" /> <suppress files="[\\/]autoconfigure[\\/].*Properties\.java" checks="JavadocVariable" />
<suppress files="[\\/]spring-boot-docs[\\/]" checks="JavadocType" /> <suppress files="[\\/]spring-boot-docs[\\/]" checks="JavadocType" />
<suppress files="[\\/]spring-boot-smoke-tests[\\/]" checks="JavadocType" /> <suppress files="[\\/]spring-boot-smoke-tests[\\/]" checks="JavadocType" />
<suppress files="[\\/]spring-boot-smoke-tests[\\/]" checks="ImportControl" /> <suppress files="[\\/]spring-boot-smoke-tests[\\/]" checks="ImportControl" />