root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Remove obsolete @⁠Contract declaration for StreamUtils.drain() 

Closes gh-34933
This commit is contained in:
Sam Brannen 2025-05-22 17:23:35 +02:00
parent d890a38f3c
commit db5809f968
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
spring-core/src/main/java/org/springframework/util/StreamUtils.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2024 the original author or authors. * Copyright 2002-2025 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -25,13 +25,14 @@ import java.io.InputStreamReader;
import java.io.OutputStream; import java.io.OutputStream;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import org.springframework.lang.Contract;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
/** /**
* Simple utility methods for dealing with streams. The copy methods of this class are * Simple utility methods for dealing with streams.
* similar to those defined in {@link FileCopyUtils} except that all affected streams are *
* left open when done. All copy methods use a block size of 8192 bytes. * <p>The copy methods of this class are similar to those defined in
* {@link FileCopyUtils} except that all affected streams are left open when done.
* All copy methods use a block size of {@value #BUFFER_SIZE} bytes.
* *
* <p>Mainly for use within the framework, but also useful for application code. * <p>Mainly for use within the framework, but also useful for application code.
* *
@ -190,14 +191,14 @@ public abstract class StreamUtils {
} }
/** /**
* Drain the remaining content of the given InputStream. * Drain the remaining content of the given {@link InputStream}.
* <p>Leaves the InputStream open when done. * <p>Leaves the {@code InputStream} open when done.
* @param in the InputStream to drain * @param in the {@code InputStream} to drain
* @return the number of bytes read * @return the number of bytes read, or {@code 0} if the supplied
* {@code InputStream} is {@code null} or empty
* @throws IOException in case of I/O errors * @throws IOException in case of I/O errors
* @since 4.3 * @since 4.3
*/ */
@Contract("null -> fail")
public static int drain(@Nullable InputStream in) throws IOException { public static int drain(@Nullable InputStream in) throws IOException {
if (in == null) { if (in == null) {
return 0; return 0;