diff --git a/spring-core/src/main/java/org/springframework/util/StringUtils.java b/spring-core/src/main/java/org/springframework/util/StringUtils.java index ccaffd37ea9..c1a21478faf 100644 --- a/spring-core/src/main/java/org/springframework/util/StringUtils.java +++ b/spring-core/src/main/java/org/springframework/util/StringUtils.java @@ -75,15 +75,20 @@ public abstract class StringUtils { //--------------------------------------------------------------------- /** - * Check whether the given {@code String} is empty. + * Check whether the given object (possibly a {@code String}) is empty. + * This is effectly a shortcut for {@code !hasLength(String)}. *

This method accepts any Object as an argument, comparing it to * {@code null} and the empty String. As a consequence, this method * will never return {@code true} for a non-null non-String object. *

The Object signature is useful for general attribute handling code * that commonly deals with Strings but generally has to iterate over * Objects since attributes may e.g. be primitive value objects as well. - * @param str the candidate String + *

Note: If the object is typed to {@code String} upfront, prefer + * {@link #hasLength(String)} or {@link #hasText(String)} instead. + * @param str the candidate object (possibly a {@code String}) * @since 3.2.1 + * @see #hasLength(String) + * @see #hasText(String) */ public static boolean isEmpty(@Nullable Object str) { return (str == null || "".equals(str)); @@ -102,7 +107,8 @@ public abstract class StringUtils { * * @param str the {@code CharSequence} to check (may be {@code null}) * @return {@code true} if the {@code CharSequence} is not {@code null} and has length - * @see #hasText(String) + * @see #hasLength(String) + * @see #hasText(CharSequence) */ public static boolean hasLength(@Nullable CharSequence str) { return (str != null && str.length() > 0); @@ -136,6 +142,8 @@ public abstract class StringUtils { * @param str the {@code CharSequence} to check (may be {@code null}) * @return {@code true} if the {@code CharSequence} is not {@code null}, * its length is greater than 0, and it does not contain whitespace only + * @see #hasText(String) + * @see #hasLength(CharSequence) * @see Character#isWhitespace */ public static boolean hasText(@Nullable CharSequence str) { @@ -151,6 +159,8 @@ public abstract class StringUtils { * @return {@code true} if the {@code String} is not {@code null}, its * length is greater than 0, and it does not contain whitespace only * @see #hasText(CharSequence) + * @see #hasLength(String) + * @see Character#isWhitespace */ public static boolean hasText(@Nullable String str) { return (str != null && !str.isEmpty() && containsText(str)); diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java index 032e29f68cb..de61f26b825 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/JdbcTemplate.java @@ -576,7 +576,7 @@ public class JdbcTemplate extends JdbcAccessor implements JdbcOperations { } private String appendSql(@Nullable String sql, String statement) { - return (StringUtils.isEmpty(sql) ? statement : sql + "; " + statement); + return (StringUtils.hasLength(sql) ? sql + "; " + statement : statement); } @Override diff --git a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java index 939941539a1..1d3f6924bc0 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java +++ b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java @@ -699,7 +699,7 @@ public class HttpHeaders implements MultiValueMap, Serializable */ public Set getAllow() { String value = getFirst(ALLOW); - if (!StringUtils.isEmpty(value)) { + if (StringUtils.hasLength(value)) { String[] tokens = StringUtils.tokenizeToStringArray(value, ","); List result = new ArrayList<>(tokens.length); for (String token : tokens) { diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java index ee13343d0ea..772679ef43d 100644 --- a/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java +++ b/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java @@ -74,7 +74,7 @@ class UndertowServerHttpRequest extends AbstractServerHttpRequest { Assert.notNull(exchange, "HttpServerExchange is required."); String requestURL = exchange.getRequestURL(); String query = exchange.getQueryString(); - String requestUriAndQuery = StringUtils.isEmpty(query) ? requestURL : requestURL + "?" + query; + String requestUriAndQuery = (StringUtils.hasLength(query) ? requestURL + "?" + query : requestURL); return new URI(requestUriAndQuery); } diff --git a/spring-web/src/main/java/org/springframework/web/method/annotation/RequestParamMethodArgumentResolver.java b/spring-web/src/main/java/org/springframework/web/method/annotation/RequestParamMethodArgumentResolver.java index 5682353a8d9..0ff9a4f6488 100644 --- a/spring-web/src/main/java/org/springframework/web/method/annotation/RequestParamMethodArgumentResolver.java +++ b/spring-web/src/main/java/org/springframework/web/method/annotation/RequestParamMethodArgumentResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -213,8 +213,8 @@ public class RequestParamMethodArgumentResolver extends AbstractNamedValueMethod } RequestParam requestParam = parameter.getParameterAnnotation(RequestParam.class); - String name = (requestParam == null || StringUtils.isEmpty(requestParam.name()) ? - parameter.getParameterName() : requestParam.name()); + String name = (requestParam != null && StringUtils.hasLength(requestParam.name()) ? + requestParam.name() : parameter.getParameterName()); Assert.state(name != null, "Unresolvable parameter name"); if (value == null) { diff --git a/spring-web/src/main/java/org/springframework/web/util/DefaultUriBuilderFactory.java b/spring-web/src/main/java/org/springframework/web/util/DefaultUriBuilderFactory.java index 98b1b875e1b..428b8e5bad8 100644 --- a/spring-web/src/main/java/org/springframework/web/util/DefaultUriBuilderFactory.java +++ b/spring-web/src/main/java/org/springframework/web/util/DefaultUriBuilderFactory.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,7 +33,6 @@ import org.springframework.util.StringUtils; *

Provides options to create {@link UriBuilder} instances with a common * base URI, alternative encoding mode strategies, among others. * - * * @author Rossen Stoyanchev * @since 5.0 * @see UriComponentsBuilder @@ -222,31 +221,27 @@ public class DefaultUriBuilderFactory implements UriBuilderFactory { private final UriComponentsBuilder uriComponentsBuilder; - public DefaultUriBuilder(String uriTemplate) { this.uriComponentsBuilder = initUriComponentsBuilder(uriTemplate); } private UriComponentsBuilder initUriComponentsBuilder(String uriTemplate) { UriComponentsBuilder result; - if (StringUtils.isEmpty(uriTemplate)) { - result = baseUri != null ? baseUri.cloneBuilder() : UriComponentsBuilder.newInstance(); + if (!StringUtils.hasLength(uriTemplate)) { + result = (baseUri != null ? baseUri.cloneBuilder() : UriComponentsBuilder.newInstance()); } else if (baseUri != null) { UriComponentsBuilder builder = UriComponentsBuilder.fromUriString(uriTemplate); UriComponents uri = builder.build(); - result = uri.getHost() == null ? baseUri.cloneBuilder().uriComponents(uri) : builder; + result = (uri.getHost() == null ? baseUri.cloneBuilder().uriComponents(uri) : builder); } else { result = UriComponentsBuilder.fromUriString(uriTemplate); } - if (encodingMode.equals(EncodingMode.TEMPLATE_AND_VALUES)) { result.encode(); } - parsePathIfNecessary(result); - return result; } diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/resource/VersionResourceResolver.java b/spring-webflux/src/main/java/org/springframework/web/reactive/resource/VersionResourceResolver.java index 65e6f1284ff..acb0ce4f657 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/resource/VersionResourceResolver.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/resource/VersionResourceResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -172,7 +172,7 @@ public class VersionResourceResolver extends AbstractResourceResolver { } String candidate = versionStrategy.extractVersion(requestPath); - if (StringUtils.isEmpty(candidate)) { + if (!StringUtils.hasLength(candidate)) { return Mono.empty(); } diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java index a9e7cc90eba..e20acf8641e 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java @@ -309,7 +309,7 @@ public class RedirectView extends AbstractUrlBasedView { return false; } String targetHost = UriComponentsBuilder.fromUriString(targetUrl).build().getHost(); - if (StringUtils.isEmpty(targetHost)) { + if (!StringUtils.hasLength(targetHost)) { return false; } for (String host : this.hosts) { diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/DispatcherServlet.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/DispatcherServlet.java index e4eefbc268a..b39e5ff33f0 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/DispatcherServlet.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/DispatcherServlet.java @@ -963,11 +963,12 @@ public class DispatcherServlet extends FrameworkServlet { params = (request.getParameterMap().isEmpty() ? "" : "masked"); } - String query = StringUtils.isEmpty(request.getQueryString()) ? "" : "?" + request.getQueryString(); + String queryString = request.getQueryString(); + String queryClause = (StringUtils.hasLength(queryString) ? "?" + queryString : ""); String dispatchType = (!request.getDispatcherType().equals(DispatcherType.REQUEST) ? "\"" + request.getDispatcherType().name() + "\" dispatch for " : ""); String message = (dispatchType + request.getMethod() + " \"" + getRequestUri(request) + - query + "\", parameters={" + params + "}"); + queryClause + "\", parameters={" + params + "}"); if (traceOn) { List values = Collections.list(request.getHeaderNames()); diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java index 32e88d04ce3..7f6be987b09 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java @@ -100,8 +100,9 @@ public abstract class AbstractHandlerExceptionResolver implements HandlerExcepti /** * Set the log category for warn logging. The name will be passed to the underlying logger * implementation through Commons Logging, getting interpreted as a log category according - * to the logger's configuration. If {@code null} is passed, warn logging is turned off. - *

By default there is no warn logging although sub-classes like + * to the logger's configuration. If {@code null} or empty String is passed, warn logging + * is turned off. + *

By default there is no warn logging although subclasses like * {@link org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver} * can change that default. Specify this setting to activate warn logging into a specific * category. Alternatively, override the {@link #logException} method for custom logging. @@ -109,7 +110,7 @@ public abstract class AbstractHandlerExceptionResolver implements HandlerExcepti * @see java.util.logging.Logger#getLogger(String) */ public void setWarnLogCategory(String loggerName) { - this.warnLogger = (!StringUtils.isEmpty(loggerName) ? LogFactory.getLog(loggerName) : null); + this.warnLogger = (StringUtils.hasLength(loggerName) ? LogFactory.getLog(loggerName) : null); } /** diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java index 2450a3f5a10..9d171e8edf8 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -578,7 +578,7 @@ public class MvcUriComponentsBuilder { return "/"; } String[] paths = mapping.path(); - if (ObjectUtils.isEmpty(paths) || StringUtils.isEmpty(paths[0])) { + if (ObjectUtils.isEmpty(paths) || !StringUtils.hasLength(paths[0])) { return "/"; } if (paths.length > 1 && logger.isTraceEnabled()) { @@ -594,7 +594,7 @@ public class MvcUriComponentsBuilder { throw new IllegalArgumentException("No @RequestMapping on: " + method.toGenericString()); } String[] paths = requestMapping.path(); - if (ObjectUtils.isEmpty(paths) || StringUtils.isEmpty(paths[0])) { + if (ObjectUtils.isEmpty(paths) || !StringUtils.hasLength(paths[0])) { return "/"; } if (paths.length > 1 && logger.isTraceEnabled()) { diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/PathVariableMethodArgumentResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/PathVariableMethodArgumentResolver.java index 50652bbe903..526eb0355a2 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/PathVariableMethodArgumentResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/PathVariableMethodArgumentResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -125,7 +125,7 @@ public class PathVariableMethodArgumentResolver extends AbstractNamedValueMethod } PathVariable ann = parameter.getParameterAnnotation(PathVariable.class); - String name = (ann != null && !StringUtils.isEmpty(ann.value()) ? ann.value() : parameter.getParameterName()); + String name = (ann != null && StringUtils.hasLength(ann.value()) ? ann.value() : parameter.getParameterName()); String formatted = formatUriValue(conversionService, new TypeDescriptor(parameter.nestedIfOptional()), value); uriVariables.put(name, formatted); } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/VersionResourceResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/VersionResourceResolver.java index dbd38804b5f..4ebda707a21 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/VersionResourceResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/VersionResourceResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -168,7 +168,7 @@ public class VersionResourceResolver extends AbstractResourceResolver { } String candidateVersion = versionStrategy.extractVersion(requestPath); - if (StringUtils.isEmpty(candidateVersion)) { + if (!StringUtils.hasLength(candidateVersion)) { return null; } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/ServletUriComponentsBuilder.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/ServletUriComponentsBuilder.java index ba4911d4a1c..673517c44a9 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/ServletUriComponentsBuilder.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/ServletUriComponentsBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -206,7 +206,7 @@ public class ServletUriComponentsBuilder extends UriComponentsBuilder { String extension = null; if (this.originalPath != null) { extension = UriUtils.extractFileExtension(this.originalPath); - if (!StringUtils.isEmpty(extension)) { + if (StringUtils.hasLength(extension)) { int end = this.originalPath.length() - (extension.length() + 1); replacePath(this.originalPath.substring(0, end)); } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/RedirectView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/RedirectView.java index c6ee5ec0162..77313e7cee4 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/RedirectView.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/RedirectView.java @@ -650,7 +650,7 @@ public class RedirectView extends AbstractUrlBasedView implements SmartView { return false; } String targetHost = UriComponentsBuilder.fromUriString(targetUrl).build().getHost(); - if (StringUtils.isEmpty(targetHost)) { + if (!StringUtils.hasLength(targetHost)) { return false; } for (String host : getHosts()) { diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java index ba3d42937c0..0ff49f1549f 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/SubProtocolWebSocketHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -420,7 +420,7 @@ public class SubProtocolWebSocketHandler } SubProtocolHandler handler; - if (!StringUtils.isEmpty(protocol)) { + if (StringUtils.hasLength(protocol)) { handler = this.protocolHandlerLookup.get(protocol); if (handler == null) { throw new IllegalStateException( diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/handler/AbstractHttpSendingTransportHandler.java b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/handler/AbstractHttpSendingTransportHandler.java index 4681f53f57e..0aa17c5552a 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/handler/AbstractHttpSendingTransportHandler.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/handler/AbstractHttpSendingTransportHandler.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -118,7 +118,7 @@ public abstract class AbstractHttpSendingTransportHandler extends AbstractTransp String query = request.getURI().getQuery(); MultiValueMap params = UriComponentsBuilder.newInstance().query(query).build().getQueryParams(); String value = params.getFirst("c"); - if (StringUtils.isEmpty(value)) { + if (!StringUtils.hasLength(value)) { return null; } String result = UriUtils.decode(value, StandardCharsets.UTF_8); diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/WebSocketServerSockJsSession.java b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/WebSocketServerSockJsSession.java index fb521288a1e..35d73332b57 100644 --- a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/WebSocketServerSockJsSession.java +++ b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/session/WebSocketServerSockJsSession.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -179,7 +179,7 @@ public class WebSocketServerSockJsSession extends AbstractSockJsSession implemen public void handleMessage(TextMessage message, WebSocketSession wsSession) throws Exception { String payload = message.getPayload(); - if (StringUtils.isEmpty(payload)) { + if (!StringUtils.hasLength(payload)) { return; } String[] messages;