Polish @deprecated javadoc and link to replacements where available

Closes gh-6765
This commit is contained in:
Andy Wilkinson 2016-08-31 14:34:49 +01:00
parent d720645275
commit 3814e509a3
31 changed files with 38 additions and 32 deletions

View File

@ -54,7 +54,7 @@ public class InfoEndpoint extends AbstractEndpoint<Map<String, Object>> {
* Constructor provided for backward compatibility.
* @param info a map (which is added to the info)
* @param infoContributors the info contributors to use
* @deprecated as of 1.4 in favor of the constructor without the map
* @deprecated as of 1.4 in favor of {@link #InfoEndpoint(List)}
*/
@Deprecated
public InfoEndpoint(Map<String, Object> info, InfoContributor... infoContributors) {

View File

@ -41,7 +41,7 @@ import org.springframework.context.annotation.Import;
* @author Phillip Webb
* @since 1.1.0
* @see HornetQProperties
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Configuration
@AutoConfigureBefore(JmsAutoConfiguration.class)

View File

@ -27,7 +27,7 @@ import org.hornetq.jms.server.embedded.EmbeddedJMS;
* @author Phillip Webb
* @since 1.1.0
* @see HornetQAutoConfiguration
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
public interface HornetQConfigurationCustomizer {

View File

@ -30,7 +30,7 @@ import org.springframework.context.annotation.Configuration;
*
* @author Phillip Webb
* @since 1.2.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Configuration
@ConditionalOnMissingBean(ConnectionFactory.class)

View File

@ -40,7 +40,7 @@ import org.springframework.util.ClassUtils;
* @author Phillip Webb
* @author Stephane Nicoll
* @since 1.2.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
class HornetQConnectionFactoryFactory {

View File

@ -34,7 +34,7 @@ import org.springframework.boot.autoconfigure.jms.hornetq.HornetQProperties.Embe
* @author Stephane Nicoll
* @author Phillip Webb
* @since 1.1.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
class HornetQEmbeddedConfigurationFactory {

View File

@ -41,7 +41,7 @@ import org.springframework.core.annotation.AnnotationAwareOrderComparator;
* @author Phillip Webb
* @author Stephane Nicoll
* @since 1.2.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Configuration
@ConditionalOnClass(name = HornetQConnectionFactoryFactory.EMBEDDED_JMS_CLASS)

View File

@ -21,7 +21,7 @@ package org.springframework.boot.autoconfigure.jms.hornetq;
*
* @author Stephane Nicoll
* @since 1.1.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
public enum HornetQMode {

View File

@ -23,7 +23,7 @@ import org.hornetq.spi.core.naming.BindingRegistry;
*
* @author Stephane Nicoll
* @since 1.1.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
public class HornetQNoOpBindingRegistry implements BindingRegistry {

View File

@ -30,7 +30,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
*
* @author Stephane Nicoll
* @since 1.1.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@ConfigurationProperties(prefix = "spring.hornetq")
@Deprecated

View File

@ -35,7 +35,7 @@ import org.springframework.context.annotation.Primary;
*
* @author Phillip Webb
* @since 1.2.0
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Configuration
@ConditionalOnMissingBean(ConnectionFactory.class)

View File

@ -30,7 +30,7 @@ import org.springframework.util.StringUtils;
*
* @author Stéphane Lagraulet
* @author Stephane Nicoll
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
class SpringBootHornetQConnectionFactory extends HornetQConnectionFactory {

View File

@ -30,7 +30,7 @@ import org.springframework.util.StringUtils;
*
* @author Stéphane Lagraulet
* @author Stephane Nicoll
* @deprecated as of 1.4 in favor of the artemis support
* @deprecated as of 1.4 in favor of the Artemis support
*/
@Deprecated
class SpringBootHornetQXAConnectionFactory extends HornetQXAConnectionFactory {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2015 the original author or authors.
* Copyright 2012-2016 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.
@ -16,5 +16,6 @@
/**
* Auto-configuration for HornetQ.
* @deprecated as of 1.4 in favor of the Artemis support
*/
package org.springframework.boot.autoconfigure.jms.hornetq;

View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2015 the original author or authors.
* Copyright 2012-2016 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.
@ -16,5 +16,7 @@
/**
* Auto-configuration for Velocity.
* @deprecated as of 1.4 following the deprecation of Velocity support in Spring Framework
* 4.3
*/
package org.springframework.boot.autoconfigure.velocity;

View File

@ -28,6 +28,7 @@ import java.util.Set;
import org.springframework.beans.BeanUtils;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.test.context.SpringBootContextLoader;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.support.ServletContextApplicationContextInitializer;
import org.springframework.context.ApplicationContext;
@ -71,8 +72,7 @@ import org.springframework.web.context.support.GenericWebApplicationContext;
* @see org.springframework.boot.test.IntegrationTest
* @see org.springframework.boot.test.WebIntegrationTest
* @deprecated as of 1.4 in favor of {@link SpringBootTest @SpringBootTest}
* {@link org.springframework.boot.test.context.SpringBootContextLoader} can also be
* considered if absolutely necessary.
* {@link SpringBootContextLoader} can also be considered if absolutely necessary.
*/
@Deprecated
public class SpringApplicationContextLoader extends AbstractContextLoader {

View File

@ -46,7 +46,7 @@ import org.springframework.web.filter.DelegatingFilterProxy;
* @see FilterRegistrationBean
* @see DelegatingFilterProxy
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.DelegatingFilterProxyRegistrationBean
* {@link org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean}
*/
@Deprecated
public class DelegatingFilterProxyRegistrationBean

View File

@ -39,7 +39,7 @@ import org.springframework.boot.web.servlet.ServletContextInitializer;
* @see ServletContext#addFilter(String, Filter)
* @see DelegatingFilterProxyRegistrationBean
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.servlet.FilterRegistrationBean
* {@link org.springframework.boot.web.servlet.FilterRegistrationBean}
*/
@Deprecated
public class FilterRegistrationBean

View File

@ -29,7 +29,8 @@ import javax.servlet.MultipartConfigElement;
* </pre>
*
* @author Phillip Webb
* @deprecated as of 1.4 in favor of org.springframework.boot.web.MultipartConfigFactory
* @deprecated as of 1.4 in favor of
* {@link org.springframework.boot.web.servlet.MultipartConfigFactory}
*/
@Deprecated
public class MultipartConfigFactory

View File

@ -36,7 +36,7 @@ import org.springframework.web.WebApplicationInitializer;
* @author Phillip Webb
* @see WebApplicationInitializer
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.servlet.ServletContextInitializer
* {@link org.springframework.boot.web.servlet.ServletContextInitializer}
*/
@Deprecated
public interface ServletContextInitializer

View File

@ -48,7 +48,7 @@ import org.springframework.boot.web.servlet.ServletContextInitializer;
* @author Dave Syer
* @author Phillip Webb
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.ServletListenerRegistrationBean
* {@link org.springframework.boot.web.servlet.ServletListenerRegistrationBean}
*/
@Deprecated
public class ServletListenerRegistrationBean<T extends EventListener>

View File

@ -36,7 +36,8 @@ import org.springframework.boot.web.servlet.ServletContextInitializer;
* @author Phillip Webb
* @see ServletContextInitializer
* @see ServletContext#addServlet(String, Servlet)
* @deprecated as of 1.4 in favor of org.springframework.boot.web.servlet.ServletRegistrationBean
* @deprecated as of 1.4 in favor of
* {@link org.springframework.boot.web.servlet.ServletRegistrationBean}
*/
@Deprecated
public class ServletRegistrationBean

View File

@ -37,7 +37,8 @@ import org.springframework.stereotype.Component;
* @author Phillip Webb
* @author Andy Wilkinson
* @since 1.4.0
* @deprecated as of 1.4 in favor of org.springframework.boot.web.support.ErrorPageFilter
* @deprecated as of 1.4 in favor of
* {@link org.springframework.boot.web.support.ErrorPageFilter}
*/
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)

View File

@ -25,7 +25,7 @@ import org.springframework.web.filter.CharacterEncodingFilter;
* @author Phillip Webb
* @since 1.2.1
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.filter.OrderedCharacterEncodingFilter
* {@link org.springframework.boot.web.filter.OrderedCharacterEncodingFilter}
*/
@Deprecated
public class OrderedCharacterEncodingFilter

View File

@ -25,7 +25,7 @@ import org.springframework.web.filter.HiddenHttpMethodFilter;
* @author Phillip Webb
* @since 1.2.4
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.filter.OrderedHiddenHttpMethodFilter
* {@link org.springframework.boot.web.filter.OrderedHiddenHttpMethodFilter}
*/
@Deprecated
public class OrderedHiddenHttpMethodFilter

View File

@ -25,7 +25,7 @@ import org.springframework.web.filter.HttpPutFormContentFilter;
* @author Joao Pedro Evangelista
* @since 1.3.0
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.filter.OrderedHttpPutFormContentFilter
* {@link org.springframework.boot.web.filter.OrderedHttpPutFormContentFilter}
*/
@Deprecated
public class OrderedHttpPutFormContentFilter

View File

@ -25,7 +25,7 @@ import org.springframework.web.filter.RequestContextFilter;
* @author Phillip Webb
* @since 1.3.0
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.filter.OrderedRequestContextFilter
* {@link org.springframework.boot.web.filter.OrderedRequestContextFilter}
*/
@Deprecated
public class OrderedRequestContextFilter

View File

@ -39,7 +39,7 @@ import org.springframework.core.env.Environment;
* @author Phillip Webb
* @since 1.3.0
* @deprecated as of 1.4 in favor of
* org.springframework.boot.context.embedded.ServerPortInfoApplicationContextInitializer
* {@link org.springframework.boot.context.embedded.ServerPortInfoApplicationContextInitializer}
*/
@Deprecated
public class ServerPortInfoApplicationContextInitializer extends

View File

@ -26,7 +26,7 @@ import org.springframework.context.ApplicationContextInitializer;
* @author Dave Syer
* @author Phillip Webb
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.support.ServletContextApplicationContextInitializer
* {@link org.springframework.boot.web.support.ServletContextApplicationContextInitializer}
*/
@Deprecated
public class ServletContextApplicationContextInitializer extends

View File

@ -47,7 +47,7 @@ import org.springframework.web.WebApplicationInitializer;
* @author Andy Wilkinson
* @see #configure(SpringApplicationBuilder)
* @deprecated as of 1.4 in favor of
* org.springframework.boot.web.support.SpringBootServletInitializer
* {@link org.springframework.boot.web.support.SpringBootServletInitializer}
*/
@Deprecated
public abstract class SpringBootServletInitializer

View File

@ -44,7 +44,7 @@ import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
*
* @author Phillip Webb
* @deprecated as of 1.4 in favor of
* {@code @org.springframework.boot.autoconfigure.domain.EntityScan} or explicit
* {@code org.springframework.boot.autoconfigure.domain.EntityScan} or explicit
* configuration of the {@link LocalContainerEntityManagerFactoryBean} (either
* {@link LocalContainerEntityManagerFactoryBean#setPackagesToScan(String...) directly} or
* using the {@link EntityManagerFactoryBuilder.Builder#packages(Class...)