Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix recent javadoc errors

Browse Source 
Issue: SPR-17174
This commit is contained in:
Juergen Hoeller
2018-08-16 19:24:38 +02:00
parent fb083a3776
commit 92228f9e64
15 changed files with 91 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerRequest.java
View File

@@ -264,7 +264,7 @@ public interface ServerRequest {
Mono<MultiValueMap<String, Part>> multipartData();
// Static methods
// Static builder methods
/**
* Create a new {@code ServerRequest} based on the given {@code ServerWebExchange} and
@@ -285,20 +285,20 @@ public interface ServerRequest {
interface Headers {
/**
* Return the list of acceptable {@linkplain MediaType media types},
* Return the list of acceptable {@code MediaType media types},
* as specified by the {@code Accept} header.
* <p>Returns an empty list when the acceptable media types are unspecified.
*/
List<MediaType> accept();
/**
* Return the list of acceptable {@linkplain Charset charsets},
* Return the list of acceptable {@code Charset charsets},
* as specified by the {@code Accept-Charset} header.
*/
List<Charset> acceptCharset();
/**
* Return the list of acceptable {@linkplain Locale.LanguageRange languages},
* Return the list of acceptable {@code Locale.LanguageRange languages},
* as specified by the {@code Accept-Language} header.
*/
List<Locale.LanguageRange> acceptLanguage();
@@ -310,7 +310,7 @@ public interface ServerRequest {
OptionalLong contentLength();
/**
* Return the {@linkplain MediaType media type} of the body, as specified
* Return the {@code MediaType media type} of the body, as specified
* by the {@code Content-Type} header.
*/
Optional<MediaType> contentType();

4
spring-webflux/src/main/java/org/springframework/web/reactive/socket/client/ReactorNettyWebSocketClient.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@@ -52,7 +52,7 @@ public class ReactorNettyWebSocketClient extends WebSocketClientSupport implemen
}
/**
* Constructor that accepts an {@link HttpClientOptions.Builder} consumer
* Constructor that accepts an {@code HttpClientOptions.Builder} consumer
* to supply to {@link HttpClient#create(Consumer)}.
*/
public ReactorNettyWebSocketClient(Consumer<? super HttpClientOptions.Builder> clientOptions) {

20
spring-webflux/src/main/java/org/springframework/web/reactive/socket/client/UndertowWebSocketClient.java
View File

@@ -66,7 +66,7 @@ public class UndertowWebSocketClient extends WebSocketClientSupport implements W
/**
* Constructor with the {@link XnioWorker} to pass to
* {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}
* {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}.
* @param worker the Xnio worker
*/
public UndertowWebSocketClient(XnioWorker worker) {
@@ -112,9 +112,10 @@ public class UndertowWebSocketClient extends WebSocketClientSupport implements W
/**
* Set the {@link io.undertow.connector.ByteBufferPool ByteBufferPool} to pass to
* {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}.
* <p>By default an indirect {@link io.undertow.server.DefaultByteBufferPool} with a buffer size
* of {@value #DEFAULT_POOL_BUFFER_SIZE} is used.
* <p>By default an indirect {@link io.undertow.server.DefaultByteBufferPool}
* with a buffer size of 8192 is used.
* @since 5.0.8
* @see #DEFAULT_POOL_BUFFER_SIZE
*/
public void setByteBufferPool(ByteBufferPool byteBufferPool) {
Assert.notNull(byteBufferPool, "ByteBufferPool must not be null");
@@ -122,8 +123,9 @@ public class UndertowWebSocketClient extends WebSocketClientSupport implements W
}
/**
* @return the {@link io.undertow.connector.ByteBufferPool} currently used
* for newly created WebSocket sessions by this client
* Return the {@link io.undertow.connector.ByteBufferPool} currently used
* for newly created WebSocket sessions by this client.
* @return the byte buffer pool
* @since 5.0.8
*/
public ByteBufferPool getByteBufferPool() {
@@ -131,17 +133,15 @@ public class UndertowWebSocketClient extends WebSocketClientSupport implements W
}
/**
* Return the configured {@code Consumer<ConnectionBuilder}.
* Return the configured <code>Consumer&lt;ConnectionBuilder&gt;</code>.
*/
public Consumer<ConnectionBuilder> getConnectionBuilderConsumer() {
return this.builderConsumer;
}
/**
* Configure the size of the {@link io.undertow.connector.ByteBufferPool
* ByteBufferPool} to pass to
* {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}.
* <p>By default the buffer size is set to {@value #DEFAULT_POOL_BUFFER_SIZE}.
* Configure the size of the {@link io.undertow.connector.ByteBufferPool} to pass
* to {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}.
* @deprecated as of 5.0.8 this method is deprecated in favor
* of {@link #setByteBufferPool(io.undertow.connector.ByteBufferPool)}
*/