Browse Source

Polish Javadoc

pull/27067/head
Sam Brannen 5 years ago
parent
commit
b677206159
  1. 6
      spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/SimpleJdbcInsert.java
  2. 4
      spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/RequestPartMethodArgumentResolver.java
  3. 21
      spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestPartMethodArgumentResolver.java

6
spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/SimpleJdbcInsert.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2017 the original author or authors. * Copyright 2002-2021 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.
@ -33,10 +33,10 @@ import org.springframework.jdbc.support.KeyHolder;
* *
* <p>The meta-data processing is based on the DatabaseMetaData provided by the * <p>The meta-data processing is based on the DatabaseMetaData provided by the
* JDBC driver. As long as the JDBC driver can provide the names of the columns * JDBC driver. As long as the JDBC driver can provide the names of the columns
* for a specified table than we can rely on this auto-detection feature. If that * for a specified table then we can rely on this auto-detection feature. If that
* is not the case, then the column names must be specified explicitly. * is not the case, then the column names must be specified explicitly.
* *
* <p>The actual insert is being handled using Spring's {@link JdbcTemplate}. * <p>The actual insert is handled using Spring's {@link JdbcTemplate}.
* *
* <p>Many of the configuration methods return the current instance of the * <p>Many of the configuration methods return the current instance of the
* SimpleJdbcInsert to provide the ability to chain multiple ones together * SimpleJdbcInsert to provide the ability to chain multiple ones together

4
spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/RequestPartMethodArgumentResolver.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2020 the original author or authors. * Copyright 2002-2021 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.
@ -47,7 +47,7 @@ import org.springframework.web.server.ServerWebInputException;
* for a single value (e.g. Reactor {@code Mono}, RxJava {@code Single}). * for a single value (e.g. Reactor {@code Mono}, RxJava {@code Single}).
* *
* <p>This resolver also supports arguments of type {@link Part} which may be * <p>This resolver also supports arguments of type {@link Part} which may be
* wrapped with are reactive type for a single or multiple values. * wrapped with a reactive type for a single value or multiple values.
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @since 5.0 * @since 5.0

21
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestPartMethodArgumentResolver.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2018 the original author or authors. * Copyright 2002-2021 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.
@ -54,14 +54,17 @@ import org.springframework.web.multipart.support.RequestPartServletServerHttpReq
* 'Content-Type' of the request part in mind. This is analogous to what @{@link RequestBody} * 'Content-Type' of the request part in mind. This is analogous to what @{@link RequestBody}
* does to resolve an argument based on the content of a regular request. * does to resolve an argument based on the content of a regular request.
* *
* <p>When a parameter is not annotated or the name of the part is not specified, * <p>When a parameter is not annotated with {@code @RequestPart} or the name of
* it is derived from the name of the method argument. * the part is not specified, the request part's name is derived from the name of
* the method argument.
* *
* <p>Automatic validation may be applied if the argument is annotated with * <p>Automatic validation may be applied if the argument is annotated with
* {@code @javax.validation.Valid}, Spring's {@link org.springframework.validation.annotation.Validated} * {@code @javax.validation.Valid}, Spring's {@link org.springframework.validation.annotation.Validated}
* or custom annotations whose name starts with "Valid". In case of validation failure, * annotation, or a custom annotation whose name starts with "Valid". In case of
* a {@link MethodArgumentNotValidException} is raised and a 400 response status code returned if * validation failure, a {@link MethodArgumentNotValidException} is raised and a
* {@link org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver} is configured. * 400 response status code returned if the
* {@link org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver}
* is configured.
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @author Brian Clozel * @author Brian Clozel
@ -78,7 +81,7 @@ public class RequestPartMethodArgumentResolver extends AbstractMessageConverterM
} }
/** /**
* Constructor with converters and {@code Request~} and * Constructor with converters and {@code RequestBodyAdvice} and
* {@code ResponseBodyAdvice}. * {@code ResponseBodyAdvice}.
*/ */
public RequestPartMethodArgumentResolver(List<HttpMessageConverter<?>> messageConverters, public RequestPartMethodArgumentResolver(List<HttpMessageConverter<?>> messageConverters,
@ -89,8 +92,8 @@ public class RequestPartMethodArgumentResolver extends AbstractMessageConverterM
/** /**
* Whether the given {@linkplain MethodParameter method parameter} is a multi-part * Whether the given {@linkplain MethodParameter method parameter} is
* supported. Supports the following: * supported as multi-part. Supports the following method parameters:
* <ul> * <ul>
* <li>annotated with {@code @RequestPart} * <li>annotated with {@code @RequestPart}
* <li>of type {@link MultipartFile} unless annotated with {@code @RequestParam} * <li>of type {@link MultipartFile} unless annotated with {@code @RequestParam}

Loading…
Cancel
Save