Avoid javadoc references to deprecated types/methods

(cherry picked from commit 68997d8416)
This commit is contained in:
Juergen Hoeller 2024-12-11 16:58:37 +01:00
parent faa000f330
commit d512aafc36
5 changed files with 15 additions and 30 deletions

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2017 the original author or authors. * Copyright 2002-2024 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.
@ -22,9 +22,7 @@ import org.springframework.messaging.Message;
/** /**
* Convenient base class for {@link AsyncHandlerMethodReturnValueHandler} * Convenient base class for {@link AsyncHandlerMethodReturnValueHandler}
* implementations that support only asynchronous (Future-like) return values * implementations that support only asynchronous (Future-like) return values.
* and merely serve as adapters of such types to Spring's
* {@link org.springframework.util.concurrent.ListenableFuture ListenableFuture}.
* *
* @author Sebastien Deleuze * @author Sebastien Deleuze
* @since 4.2 * @since 4.2

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2022 the original author or authors. * Copyright 2002-2024 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.
@ -24,8 +24,6 @@ import org.springframework.lang.Nullable;
/** /**
* An extension of {@link HandlerMethodReturnValueHandler} for handling async, * An extension of {@link HandlerMethodReturnValueHandler} for handling async,
* Future-like return value types that support success and error callbacks. * Future-like return value types that support success and error callbacks.
* Essentially anything that can be adapted to a
* {@link org.springframework.util.concurrent.ListenableFuture ListenableFuture}.
* *
* <p>Implementations should consider extending the convenient base class * <p>Implementations should consider extending the convenient base class
* {@link AbstractAsyncReturnValueHandler}. * {@link AbstractAsyncReturnValueHandler}.
@ -71,6 +69,7 @@ public interface AsyncHandlerMethodReturnValueHandler extends HandlerMethodRetur
@Nullable @Nullable
default org.springframework.util.concurrent.ListenableFuture<?> toListenableFuture( default org.springframework.util.concurrent.ListenableFuture<?> toListenableFuture(
Object returnValue, MethodParameter returnType) { Object returnValue, MethodParameter returnType) {
CompletableFuture<?> result = toCompletableFuture(returnValue, returnType); CompletableFuture<?> result = toCompletableFuture(returnValue, returnType);
return (result != null ? return (result != null ?
new org.springframework.util.concurrent.CompletableToListenableFutureAdapter<>(result) : new org.springframework.util.concurrent.CompletableToListenableFutureAdapter<>(result) :

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 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.
@ -62,16 +62,9 @@ public class SimpleClientHttpRequestFactory implements ClientHttpRequestFactory
/** /**
* Indicate whether this request factory should buffer the * Indicate whether this request factory should buffer the
* {@linkplain ClientHttpRequest#getBody() request body} internally. * {@linkplain ClientHttpRequest#getBody() request body} internally.
* <p>Default is {@code true}. When sending large amounts of data via POST or PUT,
* it is recommended to change this property to {@code false}, so as not to run
* out of memory. This will result in a {@link ClientHttpRequest} that either
* streams directly to the underlying {@link HttpURLConnection} (if the
* {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length}
* is known in advance), or that will use "Chunked transfer encoding"
* (if the {@code Content-Length} is not known in advance).
* @see #setChunkSize(int) * @see #setChunkSize(int)
* @see HttpURLConnection#setFixedLengthStreamingMode(int) * @deprecated since 6.1 requests are never buffered,
* @deprecated since 6.1 requests are never buffered, as if this property is {@code false} * as if this property is {@code false}
*/ */
@Deprecated(since = "6.1", forRemoval = true) @Deprecated(since = "6.1", forRemoval = true)
public void setBufferRequestBody(boolean bufferRequestBody) { public void setBufferRequestBody(boolean bufferRequestBody) {
@ -80,11 +73,6 @@ public class SimpleClientHttpRequestFactory implements ClientHttpRequestFactory
/** /**
* Set the number of bytes to write in each chunk when not buffering request * Set the number of bytes to write in each chunk when not buffering request
* bodies locally. * bodies locally.
* <p>Note that this parameter is only used when
* {@link #setBufferRequestBody(boolean) bufferRequestBody} is set to {@code false},
* and the {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length}
* is not known in advance.
* @see #setBufferRequestBody(boolean)
*/ */
public void setChunkSize(int chunkSize) { public void setChunkSize(int chunkSize) {
this.chunkSize = chunkSize; this.chunkSize = chunkSize;

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 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.
@ -67,7 +67,7 @@ public abstract class HttpAccessor {
* @see #createRequest(URI, HttpMethod) * @see #createRequest(URI, HttpMethod)
* @see SimpleClientHttpRequestFactory * @see SimpleClientHttpRequestFactory
* @see org.springframework.http.client.HttpComponentsClientHttpRequestFactory * @see org.springframework.http.client.HttpComponentsClientHttpRequestFactory
* @see org.springframework.http.client.OkHttp3ClientHttpRequestFactory * @see org.springframework.http.client.JdkClientHttpRequestFactory
*/ */
public void setRequestFactory(ClientHttpRequestFactory requestFactory) { public void setRequestFactory(ClientHttpRequestFactory requestFactory) {
Assert.notNull(requestFactory, "ClientHttpRequestFactory must not be null"); Assert.notNull(requestFactory, "ClientHttpRequestFactory must not be null");

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2023 the original author or authors. * Copyright 2002-2024 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.
@ -116,13 +116,13 @@ public class SockJsClient implements WebSocketClient, Lifecycle {
/** /**
* The names of HTTP headers that should be copied from the handshake headers * The names of HTTP headers that should be copied from the handshake headers of each
* of each call to {@link SockJsClient#doHandshake(WebSocketHandler, WebSocketHttpHeaders, URI)} * call to {@link SockJsClient#execute(WebSocketHandler, WebSocketHttpHeaders, URI)}
* and also used with other HTTP requests issued as part of that SockJS * and also used with other HTTP requests issued as part of that SockJS connection,
* connection, e.g. the initial info request, XHR send or receive requests. * for example, the initial info request, XHR send or receive requests.
* <p>By default if this property is not set, all handshake headers are also * <p>By default if this property is not set, all handshake headers are also
* used for other HTTP requests. Set it if you want only a subset of handshake * used for other HTTP requests. Set it if you want only a subset of handshake
* headers (e.g. auth headers) to be used for other HTTP requests. * headers (for example, auth headers) to be used for other HTTP requests.
* @param httpHeaderNames the HTTP header names * @param httpHeaderNames the HTTP header names
*/ */
public void setHttpHeaderNames(@Nullable String... httpHeaderNames) { public void setHttpHeaderNames(@Nullable String... httpHeaderNames) {