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

Fix Javadoc errors 

See gh-27480
This commit is contained in:
Sam Brannen 2021-09-28 11:43:40 +02:00
parent 2567b20949
commit bfdc99ab79
28 changed files with 120 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java
View File

@ -61,7 +61,7 @@ public class BeanNameAutoProxyCreator extends AbstractAutoProxyCreator {
* FactoryBean will get proxied. This default behavior applies as of Spring 2.0. * FactoryBean will get proxied. This default behavior applies as of Spring 2.0.
* If you intend to proxy a FactoryBean instance itself (a rare use case, but * If you intend to proxy a FactoryBean instance itself (a rare use case, but
* Spring 1.2's default behavior), specify the bean name of the FactoryBean * Spring 1.2's default behavior), specify the bean name of the FactoryBean
* including the factory-bean prefix "&": e.g. "&myFactoryBean". * including the factory-bean prefix "&": e.g. "&myFactoryBean".
* @see org.springframework.beans.factory.FactoryBean * @see org.springframework.beans.factory.FactoryBean
* @see org.springframework.beans.factory.BeanFactory#FACTORY_BEAN_PREFIX * @see org.springframework.beans.factory.BeanFactory#FACTORY_BEAN_PREFIX
*/ */

10
spring-beans/src/main/java/org/springframework/beans/factory/groovy/GroovyBeanDefinitionReader.java
View File

@ -75,18 +75,18 @@ import org.springframework.util.StringUtils;
* *
* def reader = new GroovyBeanDefinitionReader(myApplicationContext) * def reader = new GroovyBeanDefinitionReader(myApplicationContext)
* reader.beans { * reader.beans {
* dataSource(BasicDataSource) { // <--- invokeMethod * dataSource(BasicDataSource) { // &lt;--- invokeMethod
* driverClassName = "org.hsqldb.jdbcDriver" * driverClassName = "org.hsqldb.jdbcDriver"
* url = "jdbc:hsqldb:mem:grailsDB" * url = "jdbc:hsqldb:mem:grailsDB"
* username = "sa" // <-- setProperty * username = "sa" // &lt;-- setProperty
* password = "" * password = ""
* settings = [mynew:"setting"] * settings = [mynew:"setting"]
* } * }
* sessionFactory(SessionFactory) { * sessionFactory(SessionFactory) {
* dataSource = dataSource // <-- getProperty for retrieving references * dataSource = dataSource // &lt;-- getProperty for retrieving references
* } * }
* myService(MyService) { * myService(MyService) {
* nestedBean = { AnotherBean bean -> // <-- setProperty with closure for nested bean * nestedBean = { AnotherBean bean -&gt; // &lt;-- setProperty with closure for nested bean
* dataSource = dataSource * dataSource = dataSource
* } * }
* } * }
@ -113,7 +113,7 @@ import org.springframework.util.StringUtils;
* dataSource = dataSource * dataSource = dataSource
* } * }
* myService(MyService) { * myService(MyService) {
* nestedBean = { AnotherBean bean -> * nestedBean = { AnotherBean bean -&gt;
* dataSource = dataSource * dataSource = dataSource
* } * }
* } * }

10
spring-context/src/main/java/org/springframework/context/annotation/Configuration.java
View File

@ -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.
@ -129,7 +129,7 @@ import org.springframework.stereotype.Component;
* &#064;Configuration * &#064;Configuration
* public class AppConfig { * public class AppConfig {
* *
* &#064Autowired Environment env; * &#064;Autowired Environment env;
* *
* &#064;Bean * &#064;Bean
* public MyBean myBean() { * public MyBean myBean() {
@ -149,7 +149,7 @@ import org.springframework.stereotype.Component;
* &#064;PropertySource("classpath:/com/acme/app.properties") * &#064;PropertySource("classpath:/com/acme/app.properties")
* public class AppConfig { * public class AppConfig {
* *
* &#064Inject Environment env; * &#064;Inject Environment env;
* *
* &#064;Bean * &#064;Bean
* public MyBean myBean() { * public MyBean myBean() {
@ -170,7 +170,7 @@ import org.springframework.stereotype.Component;
* &#064;PropertySource("classpath:/com/acme/app.properties") * &#064;PropertySource("classpath:/com/acme/app.properties")
* public class AppConfig { * public class AppConfig {
* *
* &#064Value("${bean.name}") String beanName; * &#064;Value("${bean.name}") String beanName;
* *
* &#064;Bean * &#064;Bean
* public MyBean myBean() { * public MyBean myBean() {
@ -297,7 +297,7 @@ import org.springframework.stereotype.Component;
* &#064;ImportResource("classpath:/com/acme/database-config.xml") * &#064;ImportResource("classpath:/com/acme/database-config.xml")
* public class AppConfig { * public class AppConfig {
* *
* &#064Inject DataSource dataSource; // from XML * &#064;Inject DataSource dataSource; // from XML
* *
* &#064;Bean * &#064;Bean
* public MyBean myBean() { * public MyBean myBean() {

4
spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java
View File

@ -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.
@ -98,7 +98,7 @@ import java.lang.annotation.Target;
* &#064;EnableAspectJAutoProxy * &#064;EnableAspectJAutoProxy
* public class AppConfig { * public class AppConfig {
* *
* // no explicit &#064Bean definitions required * // no explicit &#064;Bean definitions required
* }</pre> * }</pre>
* *
* <b>Note: {@code @EnableAspectJAutoProxy} applies to its local application context only, * <b>Note: {@code @EnableAspectJAutoProxy} applies to its local application context only,

12
spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java
View File

@ -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.
@ -46,18 +46,18 @@ import org.springframework.lang.Nullable;
* *
* def context = new GenericGroovyApplicationContext() * def context = new GenericGroovyApplicationContext()
* context.reader.beans { * context.reader.beans {
* dataSource(BasicDataSource) { // <--- invokeMethod * dataSource(BasicDataSource) { // &lt;--- invokeMethod
* driverClassName = "org.hsqldb.jdbcDriver" * driverClassName = "org.hsqldb.jdbcDriver"
* url = "jdbc:hsqldb:mem:grailsDB" * url = "jdbc:hsqldb:mem:grailsDB"
* username = "sa" // <-- setProperty * username = "sa" // &lt;-- setProperty
* password = "" * password = ""
* settings = [mynew:"setting"] * settings = [mynew:"setting"]
* } * }
* sessionFactory(SessionFactory) { * sessionFactory(SessionFactory) {
* dataSource = dataSource // <-- getProperty for retrieving references * dataSource = dataSource // &lt;-- getProperty for retrieving references
* } * }
* myService(MyService) { * myService(MyService) {
* nestedBean = { AnotherBean bean -> // <-- setProperty with closure for nested bean * nestedBean = { AnotherBean bean -&gt; // &lt;-- setProperty with closure for nested bean
* dataSource = dataSource * dataSource = dataSource
* } * }
* } * }
@ -84,7 +84,7 @@ import org.springframework.lang.Nullable;
* dataSource = dataSource * dataSource = dataSource
* } * }
* myService(MyService) { * myService(MyService) {
* nestedBean = { AnotherBean bean -> * nestedBean = { AnotherBean bean -&gt;
* dataSource = dataSource * dataSource = dataSource
* } * }
* } * }

4
spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java
View File

@ -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.
@ -229,7 +229,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractResourceBased
* for a Locale, after merging all specified resource bundles. * for a Locale, after merging all specified resource bundles.
* Either fetches the holder from the cache or freshly loads it. * Either fetches the holder from the cache or freshly loads it.
* <p>Only used when caching resource bundle contents forever, i.e. * <p>Only used when caching resource bundle contents forever, i.e.
* with cacheSeconds < 0. Therefore, merged properties are always * with cacheSeconds &lt; 0. Therefore, merged properties are always
* cached forever. * cached forever.
*/ */
protected PropertiesHolder getMergedProperties(Locale locale) { protected PropertiesHolder getMergedProperties(Locale locale) {

4
spring-context/src/main/java/org/springframework/format/support/DefaultFormattingConversionService.java
View File

@ -37,7 +37,7 @@ import org.springframework.util.StringValueResolver;
* as {@code DefaultConversionService} exposes its own * as {@code DefaultConversionService} exposes its own
* {@link DefaultConversionService#addDefaultConverters addDefaultConverters} method. * {@link DefaultConversionService#addDefaultConverters addDefaultConverters} method.
* *
* <p>Automatically registers formatters for JSR-354 Money & Currency, JSR-310 Date-Time * <p>Automatically registers formatters for JSR-354 Money &amp; Currency, JSR-310 Date-Time
* and/or Joda-Time 2.x, depending on the presence of the corresponding API on the classpath. * and/or Joda-Time 2.x, depending on the presence of the corresponding API on the classpath.
* *
* @author Chris Beams * @author Chris Beams
@ -100,7 +100,7 @@ public class DefaultFormattingConversionService extends FormattingConversionServ
/** /**
* Add formatters appropriate for most environments: including number formatters, * Add formatters appropriate for most environments: including number formatters,
* JSR-354 Money & Currency formatters, JSR-310 Date-Time and/or Joda-Time formatters, * JSR-354 Money &amp; Currency formatters, JSR-310 Date-Time and/or Joda-Time formatters,
* depending on the presence of the corresponding API on the classpath. * depending on the presence of the corresponding API on the classpath.
* @param formatterRegistry the service to register default formatters with * @param formatterRegistry the service to register default formatters with
*/ */

6
spring-context/src/main/java/org/springframework/validation/Validator.java
View File

@ -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.
@ -33,7 +33,7 @@ package org.springframework.validation;
* wholly of whitespace), and that any password that is present is * wholly of whitespace), and that any password that is present is
* at least {@code 'MINIMUM_PASSWORD_LENGTH'} characters in length. * at least {@code 'MINIMUM_PASSWORD_LENGTH'} characters in length.
* *
* <pre class="code"> public class UserLoginValidator implements Validator { * <pre class="code">public class UserLoginValidator implements Validator {
* *
* private static final int MINIMUM_PASSWORD_LENGTH = 6; * private static final int MINIMUM_PASSWORD_LENGTH = 6;
* *
@ -46,7 +46,7 @@ package org.springframework.validation;
* ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password", "field.required"); * ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password", "field.required");
* UserLogin login = (UserLogin) target; * UserLogin login = (UserLogin) target;
* if (login.getPassword() != null * if (login.getPassword() != null
* && login.getPassword().trim().length() < MINIMUM_PASSWORD_LENGTH) { * &amp;&amp; login.getPassword().trim().length() &lt; MINIMUM_PASSWORD_LENGTH) {
* errors.rejectValue("password", "field.min.length", * errors.rejectValue("password", "field.min.length",
* new Object[]{Integer.valueOf(MINIMUM_PASSWORD_LENGTH)}, * new Object[]{Integer.valueOf(MINIMUM_PASSWORD_LENGTH)},
* "The password must be at least [" + MINIMUM_PASSWORD_LENGTH + "] characters in length."); * "The password must be at least [" + MINIMUM_PASSWORD_LENGTH + "] characters in length.");

6
spring-core/src/main/java/org/springframework/core/env/CommandLinePropertySource.java vendored
View File

@ -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.
@ -110,7 +110,7 @@ import org.springframework.util.StringUtils;
* evaluate true: * evaluate true:
* *
* <pre class="code"> * <pre class="code">
* CommandLinePropertySource<?> ps = ... * CommandLinePropertySource&lt;?&gt; ps = ...
* assert ps.containsProperty("o1") == true; * assert ps.containsProperty("o1") == true;
* assert ps.containsProperty("o2") == true; * assert ps.containsProperty("o2") == true;
* assert ps.containsProperty("o3") == false; * assert ps.containsProperty("o3") == false;
@ -149,7 +149,7 @@ import org.springframework.util.StringUtils;
* will evaluate true: * will evaluate true:
* *
* <pre class="code"> * <pre class="code">
* CommandLinePropertySource<?> ps = ... * CommandLinePropertySource&lt;?&gt; ps = ...
* assert ps.containsProperty("o1") == true; * assert ps.containsProperty("o1") == true;
* assert ps.containsProperty("o2") == true; * assert ps.containsProperty("o2") == true;
* assert ps.containsProperty("nonOptionArgs") == true; * assert ps.containsProperty("nonOptionArgs") == true;

4
spring-core/src/main/java/org/springframework/core/env/JOptCommandLinePropertySource.java vendored
View File

@ -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.
@ -42,7 +42,7 @@ import org.springframework.util.StringUtils;
* parser.accepts("option1"); * parser.accepts("option1");
* parser.accepts("option2").withRequiredArg(); * parser.accepts("option2").withRequiredArg();
* OptionSet options = parser.parse(args); * OptionSet options = parser.parse(args);
* PropertySource<?> ps = new JOptCommandLinePropertySource(options); * PropertySource&lt;?&gt; ps = new JOptCommandLinePropertySource(options);
* // ... * // ...
* }</pre> * }</pre>
* *

4
spring-core/src/main/java/org/springframework/core/env/SimpleCommandLinePropertySource.java vendored
View File

@ -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.
@ -66,7 +66,7 @@ import org.springframework.util.StringUtils;
* <h3>Typical usage</h3> * <h3>Typical usage</h3>
* <pre class="code"> * <pre class="code">
* public static void main(String[] args) { * public static void main(String[] args) {
* PropertySource<?> ps = new SimpleCommandLinePropertySource(args); * PropertySource&lt;?&gt; ps = new SimpleCommandLinePropertySource(args);
* // ... * // ...
* }</pre> * }</pre>
* *

8
spring-jms/src/main/java/org/springframework/jms/annotation/EnableJms.java
View File

@ -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.
@ -138,7 +138,7 @@ import org.springframework.context.annotation.Import;
* } * }
* *
* &#064;Bean * &#064;Bean
* public JmsListenerContainerFactory<?> myJmsListenerContainerFactory() { * public JmsListenerContainerFactory&lt;?&gt; myJmsListenerContainerFactory() {
* // factory settings * // factory settings
* } * }
* *
@ -184,7 +184,7 @@ import org.springframework.context.annotation.Import;
* } * }
* *
* &#064;Bean * &#064;Bean
* public JmsListenerEndpointRegistry<?> myJmsListenerEndpointRegistry() { * public JmsListenerEndpointRegistry&lt;?&gt; myJmsListenerEndpointRegistry() {
* // registry configuration * // registry configuration
* } * }
* *
@ -246,7 +246,7 @@ import org.springframework.context.annotation.Import;
* } * }
* *
* &#064;Bean * &#064;Bean
* public JmsListenerContainerFactory<?> anotherJmsListenerContainerFactory() { * public JmsListenerContainerFactory&lt;?&gt; anotherJmsListenerContainerFactory() {
* // ... * // ...
* } * }
* *

4
spring-messaging/src/main/java/org/springframework/messaging/handler/AbstractMessageCondition.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 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.
@ -67,7 +67,7 @@ public abstract class AbstractMessageCondition<T extends AbstractMessageConditio
/** /**
* The notation to use when printing discrete items of content. * The notation to use when printing discrete items of content.
* For example " || " for URL patterns or " && " for param expressions. * For example " || " for URL patterns or " &amp;&amp; " for param expressions.
*/ */
protected abstract String getToStringInfix(); protected abstract String getToStringInfix();

8
spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateOperations.java
View File

@ -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.
@ -606,7 +606,7 @@ public interface HibernateOperations {
* @param firstResult the index of the first result object to be retrieved * @param firstResult the index of the first result object to be retrieved
* (numbered from 0) * (numbered from 0)
* @param maxResults the maximum number of result objects to retrieve * @param maxResults the maximum number of result objects to retrieve
* (or <=0 for no limit) * (or &lt;=0 for no limit)
* @return a {@link List} containing 0 or more persistent instances * @return a {@link List} containing 0 or more persistent instances
* @throws DataAccessException in case of Hibernate errors * @throws DataAccessException in case of Hibernate errors
* @see DetachedCriteria#getExecutableCriteria(org.hibernate.Session) * @see DetachedCriteria#getExecutableCriteria(org.hibernate.Session)
@ -643,7 +643,7 @@ public interface HibernateOperations {
* @param firstResult the index of the first result object to be retrieved * @param firstResult the index of the first result object to be retrieved
* (numbered from 0) * (numbered from 0)
* @param maxResults the maximum number of result objects to retrieve * @param maxResults the maximum number of result objects to retrieve
* (or <=0 for no limit) * (or &lt;=0 for no limit)
* @return a {@link List} containing 0 or more persistent instances * @return a {@link List} containing 0 or more persistent instances
* @throws DataAccessException in case of Hibernate errors * @throws DataAccessException in case of Hibernate errors
* @see org.hibernate.criterion.Example#create(Object) * @see org.hibernate.criterion.Example#create(Object)
@ -660,7 +660,7 @@ public interface HibernateOperations {
* @param firstResult the index of the first result object to be retrieved * @param firstResult the index of the first result object to be retrieved
* (numbered from 0) * (numbered from 0)
* @param maxResults the maximum number of result objects to retrieve * @param maxResults the maximum number of result objects to retrieve
* (or <=0 for no limit) * (or &lt;=0 for no limit)
* @return a {@link List} containing 0 or more persistent instances * @return a {@link List} containing 0 or more persistent instances
* @throws DataAccessException in case of Hibernate errors * @throws DataAccessException in case of Hibernate errors
* @see org.hibernate.criterion.Example#create(Object) * @see org.hibernate.criterion.Example#create(Object)

6
spring-web/src/main/java/org/springframework/http/HttpStatus.java
View File

@ -285,21 +285,21 @@ public enum HttpStatus {
I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"), I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"),
/** /**
* @deprecated See * @deprecated See
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a> * WebDAV Draft Changes</a>
*/ */
@Deprecated @Deprecated
INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"), INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"),
/** /**
* @deprecated See * @deprecated See
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a> * WebDAV Draft Changes</a>
*/ */
@Deprecated @Deprecated
METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"), METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"),
/** /**
* @deprecated * @deprecated
* See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt"> * See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a> * WebDAV Draft Changes</a>
*/ */
@Deprecated @Deprecated

2
spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java
View File

@ -83,7 +83,7 @@ import org.springframework.util.xml.StaxUtils;
* <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>:
* support for other Java 8 types like {@link java.util.Optional}</li> * support for other Java 8 types like {@link java.util.Optional}</li>
* <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>:
* support for Java 8 Date & Time API types</li> * support for Java 8 Date &amp; Time API types</li>
* <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>:
* support for Joda-Time types</li> * support for Joda-Time types</li>
* <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>: * <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>:

84
spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java
View File

@ -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.
@ -62,54 +62,54 @@ import org.springframework.lang.Nullable;
* <p>Example usage with * <p>Example usage with
* {@link MappingJackson2HttpMessageConverter}: * {@link MappingJackson2HttpMessageConverter}:
* *
* <pre class="code"> * <pre class="code">{@code
* &lt;bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"> * <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
* &lt;property name="objectMapper"> * <property name="objectMapper">
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean" * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* p:autoDetectFields="false" * p:autoDetectFields="false"
* p:autoDetectGettersSetters="false" * p:autoDetectGettersSetters="false"
* p:annotationIntrospector-ref="jaxbAnnotationIntrospector" /> * p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
* &lt;/property> * </property>
* &lt;/bean> * </bean>
* </pre> * }</pre>
* *
* <p>Example usage with MappingJackson2JsonView: * <p>Example usage with MappingJackson2JsonView:
* *
* <pre class="code"> * <pre class="code">{@code
* &lt;bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"> * <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">
* &lt;property name="objectMapper"> * <property name="objectMapper">
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean" * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
* p:failOnEmptyBeans="false" * p:failOnEmptyBeans="false"
* p:indentOutput="true"> * p:indentOutput="true">
* &lt;property name="serializers"> * <property name="serializers">
* &lt;array> * <array>
* &lt;bean class="org.mycompany.MyCustomSerializer" /> * <bean class="org.mycompany.MyCustomSerializer" />
* &lt;/array> * </array>
* &lt;/property> * </property>
* &lt;/bean> * </bean>
* &lt;/property> * </property>
* &lt;/bean> * </bean>
* </pre> * }</pre>
* *
* <p>In case there are no specific setters provided (for some rarely used options), * <p>In case there are no specific setters provided (for some rarely used options),
* you can still use the more general methods {@link #setFeaturesToEnable} and * you can still use the more general methods {@link #setFeaturesToEnable} and
* {@link #setFeaturesToDisable}. * {@link #setFeaturesToDisable}.
* *
* <pre class="code"> * <pre class="code">{@code
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"> * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
* &lt;property name="featuresToEnable"> * <property name="featuresToEnable">
* &lt;array> * <array>
* &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/> * <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/>
* &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/> * <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/>
* &lt;/array> * </array>
* &lt;/property> * </property>
* &lt;property name="featuresToDisable"> * <property name="featuresToDisable">
* &lt;array> * <array>
* &lt;util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/> * <util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/>
* &lt;/array> * </array>
* &lt;/property> * </property>
* &lt;/bean> * </bean>
* </pre> * }</pre>
* *
* <p>It also automatically registers the following well-known modules if they are * <p>It also automatically registers the following well-known modules if they are
* detected on the classpath: * detected on the classpath:
@ -119,7 +119,7 @@ import org.springframework.lang.Nullable;
* <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>:
* support for other Java 8 types like {@link java.util.Optional}</li> * support for other Java 8 types like {@link java.util.Optional}</li>
* <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>:
* support for Java 8 Date & Time API types</li> * support for Java 8 Date &amp; Time API types</li>
* <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>: * <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>:
* support for Joda-Time types</li> * support for Joda-Time types</li>
* <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>: * <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>:
@ -129,11 +129,11 @@ import org.springframework.lang.Nullable;
* <p>In case you want to configure Jackson's {@link ObjectMapper} with a custom {@link Module}, * <p>In case you want to configure Jackson's {@link ObjectMapper} with a custom {@link Module},
* you can register one or more such Modules by class name via {@link #setModulesToInstall}: * you can register one or more such Modules by class name via {@link #setModulesToInstall}:
* *
* <pre class="code"> * <pre class="code">{@code
* &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"> * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
* &lt;property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/> * <property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/>
* &lt;/bean * </bean
* </pre> * }</pre>
* *
* <p>Compatible with Jackson 2.9 to 2.12, as of Spring 5.3. * <p>Compatible with Jackson 2.9 to 2.12, as of Spring 5.3.
* *

22
spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 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.
@ -49,7 +49,7 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding * <p>Escapes all special characters to their corresponding
* entity reference (e.g. {@code &lt;}). * entity reference (e.g. {@code &lt;}).
* <p>Reference: * <p>Reference:
@ -65,7 +65,7 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding * <p>Escapes all special characters to their corresponding
* entity reference (e.g. {@code &lt;}) at least as required by the * entity reference (e.g. {@code &lt;}) at least as required by the
* specified encoding. In other words, if a special character does * specified encoding. In other words, if a special character does
@ -98,9 +98,9 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding numeric * <p>Escapes all special characters to their corresponding numeric
* reference in decimal format (&#<i>Decimal</i>;). * reference in decimal format (&amp;#<i>Decimal</i>;).
* <p>Reference: * <p>Reference:
* <a href="https://www.w3.org/TR/html4/sgml/entities.html"> * <a href="https://www.w3.org/TR/html4/sgml/entities.html">
* https://www.w3.org/TR/html4/sgml/entities.html * https://www.w3.org/TR/html4/sgml/entities.html
@ -114,9 +114,9 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding numeric * <p>Escapes all special characters to their corresponding numeric
* reference in decimal format (&#<i>Decimal</i>;) at least as required by the * reference in decimal format (&amp;#<i>Decimal</i>;) at least as required by the
* specified encoding. In other words, if a special character does * specified encoding. In other words, if a special character does
* not have to be escaped for the given encoding, it may not be. * not have to be escaped for the given encoding, it may not be.
* <p>Reference: * <p>Reference:
@ -148,9 +148,9 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding numeric * <p>Escapes all special characters to their corresponding numeric
* reference in hex format (&#x<i>Hex</i>;). * reference in hex format (&amp;#x<i>Hex</i>;).
* <p>Reference: * <p>Reference:
* <a href="https://www.w3.org/TR/html4/sgml/entities.html"> * <a href="https://www.w3.org/TR/html4/sgml/entities.html">
* https://www.w3.org/TR/html4/sgml/entities.html * https://www.w3.org/TR/html4/sgml/entities.html
@ -164,9 +164,9 @@ public abstract class HtmlUtils {
/** /**
* Turn special characters into HTML character references. * Turn special characters into HTML character references.
* <p>Handles complete character set defined in HTML 4.01 recommendation. * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
* <p>Escapes all special characters to their corresponding numeric * <p>Escapes all special characters to their corresponding numeric
* reference in hex format (&#x<i>Hex</i>;) at least as required by the * reference in hex format (&amp;#x<i>Hex</i>;) at least as required by the
* specified encoding. In other words, if a special character does * specified encoding. In other words, if a special character does
* not have to be escaped for the given encoding, it may not be. * not have to be escaped for the given encoding, it may not be.
* <p>Reference: * <p>Reference:

6
spring-web/src/main/java/org/springframework/web/util/UriTemplate.java
View File

@ -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.
@ -92,7 +92,7 @@ public class UriTemplate implements Serializable {
* UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}"); * UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}");
* Map&lt;String, String&gt; uriVariables = new HashMap&lt;String, String&gt;(); * Map&lt;String, String&gt; uriVariables = new HashMap&lt;String, String&gt;();
* uriVariables.put("booking", "42"); * uriVariables.put("booking", "42");
* uriVariables.put("hotel", "Rest & Relax"); * uriVariables.put("hotel", "Rest &amp; Relax");
* System.out.println(template.expand(uriVariables)); * System.out.println(template.expand(uriVariables));
* </pre> * </pre>
* will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote> * will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote>
@ -113,7 +113,7 @@ public class UriTemplate implements Serializable {
* <p>Example: * <p>Example:
* <pre class="code"> * <pre class="code">
* UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}"); * UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}");
* System.out.println(template.expand("Rest & Relax", 42)); * System.out.println(template.expand("Rest &amp; Relax", 42));
* </pre> * </pre>
* will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote> * will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote>
* @param uriVariableValues the array of URI variables * @param uriVariableValues the array of URI variables

6
spring-web/src/main/java/org/springframework/web/util/UriUtils.java
View File

@ -246,15 +246,15 @@ public abstract class UriUtils {
* Encode the query parameters from the given {@code MultiValueMap} with UTF-8. * Encode the query parameters from the given {@code MultiValueMap} with UTF-8.
* <p>This can be used with {@link UriComponentsBuilder#queryParams(MultiValueMap)} * <p>This can be used with {@link UriComponentsBuilder#queryParams(MultiValueMap)}
* when building a URI from an already encoded template. * when building a URI from an already encoded template.
* <pre class="code"> * <pre class="code">{@code
* MultiValueMap&lt;String, String&gt; params = new LinkedMultiValueMap<>(2); * MultiValueMap<String, String> params = new LinkedMultiValueMap<>(2);
* // add to params... * // add to params...
* *
* ServletUriComponentsBuilder.fromCurrentRequest() * ServletUriComponentsBuilder.fromCurrentRequest()
* .queryParams(UriUtils.encodeQueryParams(params)) * .queryParams(UriUtils.encodeQueryParams(params))
* .build(true) * .build(true)
* .toUriString(); * .toUriString();
* </pre> * }</pre>
* @param params the parameters to encode * @param params the parameters to encode
* @return a new {@code MultiValueMap} with the encoded names and values * @return a new {@code MultiValueMap} with the encoded names and values
* @since 5.2.3 * @since 5.2.3

4
spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/CompositeRequestCondition.java
View File

@ -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.
@ -27,7 +27,7 @@ import org.springframework.web.server.ServerWebExchange;
/** /**
* Implements the {@link RequestCondition} contract by delegating to multiple * Implements the {@link RequestCondition} contract by delegating to multiple
* {@code RequestCondition} types and using a logical conjunction (' && ') to * {@code RequestCondition} types and using a logical conjunction ({@code ' && '}) to
* ensure all conditions match a given request. * ensure all conditions match a given request.
* *
* <p>When {@code CompositeRequestCondition} instances are combined or compared * <p>When {@code CompositeRequestCondition} instances are combined or compared

4
spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/HeadersRequestCondition.java
View File

@ -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.
@ -28,7 +28,7 @@ import org.springframework.web.cors.reactive.CorsUtils;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
/** /**
* A logical conjunction (' && ') request condition that matches a request against * A logical conjunction ({@code ' && '}) request condition that matches a request against
* a set of header expressions with syntax defined in {@link RequestMapping#headers()}. * a set of header expressions with syntax defined in {@link RequestMapping#headers()}.
* *
* <p>Expressions passed to the constructor with header names 'Accept' or * <p>Expressions passed to the constructor with header names 'Accept' or

4
spring-webflux/src/main/java/org/springframework/web/reactive/result/condition/ParamsRequestCondition.java
View File

@ -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.
@ -26,7 +26,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.server.ServerWebExchange; import org.springframework.web.server.ServerWebExchange;
/** /**
* A logical conjunction (' && ') request condition that matches a request against * A logical conjunction ({@code ' && '}) request condition that matches a request against
* a set parameter expressions with syntax defined in {@link RequestMapping#params()}. * a set parameter expressions with syntax defined in {@link RequestMapping#params()}.
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev

4
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/CompositeRequestCondition.java
View File

@ -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.
@ -29,7 +29,7 @@ import org.springframework.util.ObjectUtils;
/** /**
* Implements the {@link RequestCondition} contract by delegating to multiple * Implements the {@link RequestCondition} contract by delegating to multiple
* {@code RequestCondition} types and using a logical conjunction (' && ') to * {@code RequestCondition} types and using a logical conjunction ({@code ' && '}) to
* ensure all conditions match a given request. * ensure all conditions match a given request.
* *
* <p>When {@code CompositeRequestCondition} instances are combined or compared * <p>When {@code CompositeRequestCondition} instances are combined or compared

4
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/HeadersRequestCondition.java
View File

@ -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.
@ -29,7 +29,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.cors.CorsUtils; import org.springframework.web.cors.CorsUtils;
/** /**
* A logical conjunction (' && ') request condition that matches a request against * A logical conjunction ({@code ' && '}) request condition that matches a request against
* a set of header expressions with syntax defined in {@link RequestMapping#headers()}. * a set of header expressions with syntax defined in {@link RequestMapping#headers()}.
* *
* <p>Expressions passed to the constructor with header names 'Accept' or * <p>Expressions passed to the constructor with header names 'Accept' or

4
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/ParamsRequestCondition.java
View File

@ -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.
@ -30,7 +30,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.util.WebUtils; import org.springframework.web.util.WebUtils;
/** /**
* A logical conjunction (' && ') request condition that matches a request against * A logical conjunction ({@code ' && '}) request condition that matches a request against
* a set parameter expressions with syntax defined in {@link RequestMapping#params()}. * a set parameter expressions with syntax defined in {@link RequestMapping#params()}.
* *
* @author Arjen Poutsma * @author Arjen Poutsma

2
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java
View File

@ -413,7 +413,7 @@ public class MvcUriComponentsBuilder {
* A JSP can prepare a URL to the controller method as follows: * A JSP can prepare a URL to the controller method as follows:
* *
* <pre class="code"> * <pre class="code">
* <%@ taglib uri="http://www.springframework.org/tags" prefix="s" %> * &lt;%@ taglib uri="http://www.springframework.org/tags" prefix="s" %&gt;
* *
* &lt;a href="${s:mvcUrl('PC#getPerson').arg(0,"123").build()}"&gt;Get Person&lt;/a&gt; * &lt;a href="${s:mvcUrl('PC#getPerson').arg(0,"123").build()}"&gt;Get Person&lt;/a&gt;
* </pre> * </pre>

2
spring-webmvc/src/main/java/org/springframework/web/servlet/tags/UrlTag.java
View File

@ -313,7 +313,7 @@ public class UrlTag extends HtmlEscapingAwareTag implements ParamAware {
* @param usedParams set of parameter names that have been applied as * @param usedParams set of parameter names that have been applied as
* template params * template params
* @param includeQueryStringDelimiter true if the query string should start * @param includeQueryStringDelimiter true if the query string should start
* with a '?' instead of '&' * with a '?' instead of '&amp;'
* @return the query string * @return the query string
*/ */
protected String createQueryString(List<Param> params, Set<String> usedParams, boolean includeQueryStringDelimiter) protected String createQueryString(List<Param> params, Set<String> usedParams, boolean includeQueryStringDelimiter)