From 8941e2876eb4dcaae86b52cfc2e4345ed5886bba Mon Sep 17 00:00:00 2001 From: Yanming Zhou Date: Thu, 26 Sep 2024 14:03:46 +0200 Subject: [PATCH] Replace 'e.g.' with 'for example' in documentation and comments Closes gh-33515 --- CONTRIBUTING.md | 2 +- .../core/aop/ataspectj/introductions.adoc | 2 +- .../pages/core/aop/introduction-defn.adoc | 2 +- .../pages/core/beans/annotation-config.adoc | 2 +- .../core/beans/context-introduction.adoc | 4 +-- .../ROOT/pages/core/beans/factory-nature.adoc | 6 ++-- .../java/composing-configuration-classes.adoc | 2 +- .../ROOT/pages/core/databuffer-codec.adoc | 4 +-- .../pages/core/validation/beans-beans.adoc | 2 +- .../ROOT/pages/core/validation/format.adoc | 2 +- .../ROOT/pages/core/validation/validator.adoc | 2 +- .../ROOT/pages/data-access/jdbc/advanced.adoc | 2 +- .../pages/data-access/jdbc/connections.adoc | 2 +- .../ROOT/pages/data-access/orm/jpa.adoc | 4 +-- .../modules/ROOT/pages/data-access/r2dbc.adoc | 6 ++-- .../transaction/declarative/annotations.adoc | 4 +-- .../declarative/tx-decl-explained.adoc | 2 +- .../pages/integration/cache/annotations.adoc | 4 +-- .../ROOT/pages/integration/rest-clients.adoc | 4 +-- .../ROOT/pages/integration/scheduling.adoc | 2 +- .../modules/ROOT/pages/languages/dynamic.adoc | 4 +-- .../modules/ROOT/pages/overview.adoc | 2 +- .../modules/ROOT/pages/rsocket.adoc | 10 +++--- .../pages/testing/spring-mvc-test-client.adoc | 2 +- .../ROOT/pages/testing/webtestclient.adoc | 4 +-- .../modules/ROOT/pages/web/integration.adoc | 2 +- .../web/webflux-webclient/client-context.adoc | 4 +-- .../web/webflux/ann-rest-exceptions.adoc | 4 +-- .../ROOT/pages/web/webflux/config.adoc | 2 +- .../ann-methods/modelattrib-method-args.adoc | 4 +-- .../controller/ann-requestmapping.adoc | 2 +- .../pages/web/webflux/dispatcher-handler.adoc | 2 +- .../pages/web/webflux/reactive-spring.adoc | 8 ++--- .../modules/ROOT/pages/web/webmvc-cors.adoc | 2 +- .../web/webmvc/mvc-ann-rest-exceptions.adoc | 2 +- .../webmvc/mvc-config/static-resources.adoc | 2 +- .../mvc-controller/ann-exceptionhandler.adoc | 4 +-- .../ann-methods/modelattrib-method-args.adoc | 2 +- .../ann-methods/responsebody.adoc | 2 +- .../ann-methods/responseentity.adoc | 4 +-- .../ann-methods/return-types.adoc | 6 ++-- .../ann-methods/typeconversion.adoc | 2 +- .../mvc-controller/ann-requestmapping.adoc | 4 +-- .../web/webmvc/mvc-servlet/viewresolver.adoc | 2 +- .../ROOT/pages/web/websocket/server.adoc | 2 +- .../ROOT/partials/web/forwarded-headers.adoc | 6 ++-- .../ROOT/partials/web/websocket-intro.adoc | 2 +- .../intercept/ConstructorInterceptor.java | 2 +- .../intercept/MethodInterceptor.java | 2 +- .../org/springframework/aop/Pointcut.java | 2 +- ...nnotationAwareAspectJAutoProxyCreator.java | 2 +- .../aspectj/annotation/AspectMetadata.java | 2 +- .../AbstractAdvisingBeanPostProcessor.java | 2 +- .../AbstractSingletonProxyFactoryBean.java | 2 +- .../framework/ReflectiveMethodInvocation.java | 2 +- .../autoproxy/AbstractAutoProxyCreator.java | 6 ++-- .../framework/autoproxy/AutoProxyUtils.java | 2 +- .../autoproxy/BeanNameAutoProxyCreator.java | 4 +-- .../AsyncExecutionAspectSupport.java | 2 +- .../AsyncExecutionInterceptor.java | 2 +- .../ConcurrencyThrottleInterceptor.java | 2 +- .../ExposeInvocationInterceptor.java | 2 +- .../support/AbstractRegexpMethodPointcut.java | 2 +- .../springframework/aop/support/AopUtils.java | 2 +- .../aop/support/ControlFlowPointcutTests.java | 2 +- .../AbstractNestablePropertyAccessor.java | 2 +- .../beans/BeanInfoFactory.java | 2 +- .../org/springframework/beans/BeanUtils.java | 8 ++--- .../beans/CachedIntrospectionResults.java | 4 +-- .../beans/ExtendedBeanInfo.java | 2 +- .../beans/FatalBeanException.java | 2 +- .../factory/BeanDefinitionStoreException.java | 2 +- .../beans/factory/BeanFactory.java | 2 +- .../beans/factory/InitializingBean.java | 2 +- .../beans/factory/ObjectProvider.java | 4 +-- .../factory/SmartInitializingSingleton.java | 2 +- .../BeanFactoryAnnotationUtils.java | 6 ++-- .../ParameterResolutionDelegate.java | 2 +- .../config/AutowireCapableBeanFactory.java | 10 +++--- .../config/ConfigurableBeanFactory.java | 4 +-- .../ConfigurableListableBeanFactory.java | 6 ++-- .../config/CustomEditorConfigurer.java | 2 +- .../factory/config/DependencyDescriptor.java | 4 +-- .../DestructionAwareBeanPostProcessor.java | 2 +- .../config/FieldRetrievingFactoryBean.java | 4 +-- .../config/PlaceholderConfigurerSupport.java | 2 +- .../config/PropertyPathFactoryBean.java | 4 +-- .../config/PropertyPlaceholderConfigurer.java | 2 +- .../beans/factory/config/Scope.java | 4 +-- .../beans/factory/config/YamlProcessor.java | 2 +- .../config/YamlPropertiesFactoryBean.java | 2 +- .../factory/parsing/ComponentDefinition.java | 2 +- .../AbstractAutowireCapableBeanFactory.java | 6 ++-- .../support/AbstractBeanDefinition.java | 6 ++-- .../factory/support/AbstractBeanFactory.java | 6 ++-- .../support/AutowireCandidateResolver.java | 2 +- .../beans/factory/support/AutowireUtils.java | 8 ++--- .../factory/support/ConstructorResolver.java | 4 +-- .../support/DefaultListableBeanFactory.java | 14 ++++---- .../support/DefaultSingletonBeanRegistry.java | 6 ++-- .../support/FactoryBeanRegistrySupport.java | 2 +- .../support/GenericBeanDefinition.java | 2 +- ...ricTypeAwareAutowireCandidateResolver.java | 4 +-- .../beans/factory/support/NullBean.java | 2 +- .../PropertiesBeanDefinitionReader.java | 14 ++++---- .../beans/factory/support/RegisteredBean.java | 2 +- .../factory/support/RootBeanDefinition.java | 8 ++--- .../support/ScopeNotActiveException.java | 2 +- .../DefaultBeanDefinitionDocumentReader.java | 2 +- .../propertyeditors/CharacterEditor.java | 2 +- .../beans/propertyeditors/CharsetEditor.java | 2 +- .../propertyeditors/InputStreamEditor.java | 2 +- .../beans/propertyeditors/LocaleEditor.java | 2 +- .../beans/propertyeditors/ReaderEditor.java | 2 +- .../StringArrayPropertyEditor.java | 4 +-- .../propertyeditors/StringTrimmerEditor.java | 4 +-- .../beans/factory/xml/spring-beans.dtd | 4 +-- .../beans/factory/xml/spring-beans.xsd | 20 +++++------ .../beans/factory/xml/spring-tool.xsd | 2 +- .../beans/factory/xml/spring-util.xsd | 8 ++--- .../cache/jcache/config/JCacheConfigurer.java | 2 +- .../mail/javamail/JavaMailSenderImpl.java | 2 +- .../mail/javamail/MimeMessageHelper.java | 14 ++++---- .../quartz/SchedulerAccessorBean.java | 2 +- .../quartz/SchedulerFactoryBean.java | 2 +- .../springframework/mail/javamail/mime.types | 2 +- .../java/org/springframework/cache/Cache.java | 6 ++-- .../cache/annotation/Cacheable.java | 4 +-- .../cache/annotation/CachingConfigurer.java | 4 +-- .../cache/annotation/EnableCaching.java | 2 +- .../cache/interceptor/CacheAspectSupport.java | 2 +- .../NameMatchCacheOperationSource.java | 2 +- .../context/ApplicationContext.java | 2 +- .../springframework/context/Lifecycle.java | 2 +- .../context/LifecycleProcessor.java | 4 +-- .../context/MessageSource.java | 4 +-- .../context/PayloadApplicationEvent.java | 2 +- .../context/SmartLifecycle.java | 2 +- .../AnnotatedBeanDefinitionReader.java | 8 ++--- .../AnnotationBeanNameGenerator.java | 2 +- .../annotation/AnnotationConfigRegistry.java | 2 +- .../context/annotation/Bean.java | 2 +- .../ClassPathBeanDefinitionScanner.java | 2 +- .../CommonAnnotationBeanPostProcessor.java | 2 +- .../context/annotation/ComponentScan.java | 4 +-- .../context/annotation/Configuration.java | 4 +-- ...onfigurationClassBeanDefinitionReader.java | 2 +- .../ConfigurationClassEnhancer.java | 4 +-- .../ConfigurationClassPostProcessor.java | 2 +- .../annotation/EnableAspectJAutoProxy.java | 2 +- .../annotation/EnableLoadTimeWeaving.java | 2 +- .../Jsr330ScopeMetadataResolver.java | 2 +- .../annotation/ParserStrategyUtils.java | 4 +-- .../context/annotation/Profile.java | 2 +- .../context/annotation/PropertySource.java | 2 +- .../AbstractApplicationEventMulticaster.java | 2 +- .../event/ApplicationEventMulticaster.java | 4 +-- .../ApplicationListenerMethodAdapter.java | 2 +- .../context/event/EventListener.java | 2 +- .../SimpleApplicationEventMulticaster.java | 4 +-- .../support/AbstractApplicationContext.java | 6 ++-- .../support/AbstractMessageSource.java | 2 +- .../AbstractResourceBasedMessageSource.java | 6 ++-- .../AbstractXmlApplicationContext.java | 2 +- .../support/ApplicationObjectSupport.java | 4 +-- .../ClassPathXmlApplicationContext.java | 2 +- .../FileSystemXmlApplicationContext.java | 2 +- .../support/GenericApplicationContext.java | 8 ++--- .../GenericGroovyApplicationContext.java | 2 +- .../support/MessageSourceAccessor.java | 4 +-- .../PostProcessorRegistrationDelegate.java | 2 +- .../PropertySourcesPlaceholderConfigurer.java | 2 +- ...ReloadableResourceBundleMessageSource.java | 4 +-- .../format/annotation/DateTimeFormat.java | 2 +- .../format/annotation/NumberFormat.java | 2 +- .../standard/DateTimeFormatterUtils.java | 2 +- .../datetime/standard/DurationFormatter.java | 2 +- .../InstrumentationLoadTimeWeaver.java | 2 +- .../ReflectiveLoadTimeWeaver.java | 2 +- .../AbstractReflectiveMBeanInfoAssembler.java | 2 +- .../jmx/export/naming/KeyNamingStrategy.java | 2 +- .../jndi/JndiLocatorDelegate.java | 2 +- .../jndi/JndiLocatorSupport.java | 6 ++-- .../jndi/JndiObjectFactoryBean.java | 10 +++--- .../jndi/JndiObjectLocator.java | 2 +- .../springframework/jndi/JndiTemplate.java | 2 +- .../scheduling/TaskScheduler.java | 24 ++++++------- .../annotation/EnableScheduling.java | 2 +- .../ScheduledAnnotationBeanPostProcessor.java | 4 +-- .../ExecutorConfigurationSupport.java | 2 +- .../concurrent/SimpleAsyncTaskScheduler.java | 6 ++-- .../concurrent/ThreadPoolTaskExecutor.java | 2 +- .../concurrent/ThreadPoolTaskScheduler.java | 2 +- .../config/TaskExecutorFactoryBean.java | 2 +- .../support/ScheduledMethodRunnable.java | 2 +- .../scripting/ScriptFactory.java | 2 +- .../support/StandardScriptEvaluator.java | 4 +-- .../stereotype/Controller.java | 2 +- .../ui/context/ThemeSource.java | 2 +- .../support/ResourceBundleThemeSource.java | 2 +- .../ui/context/support/package-info.java | 2 +- .../validation/BindingResult.java | 2 +- .../DefaultBindingErrorProcessor.java | 2 +- .../DefaultMessageCodesResolver.java | 6 ++-- .../springframework/validation/Errors.java | 10 +++--- .../validation/MessageCodeFormatter.java | 8 ++--- .../validation/ObjectError.java | 4 +-- .../springframework/validation/Validator.java | 2 +- .../validation/annotation/Validated.java | 2 +- .../MethodValidationAdapter.java | 2 +- .../MethodValidationInterceptor.java | 2 +- .../MethodValidationPostProcessor.java | 2 +- .../SpringConstraintValidatorFactory.java | 2 +- .../SpringValidatorAdapter.java | 2 +- .../validation/method/MethodValidator.java | 2 +- .../method/ParameterValidationResult.java | 4 +-- .../context/config/spring-context.xsd | 2 +- .../scheduling/config/spring-task.xsd | 4 +-- .../scripting/config/spring-lang.xsd | 2 +- ...alidConfigurationClassDefinitionTests.java | 2 +- .../event/ApplicationContextEventTests.java | 2 +- .../jndi/SimpleNamingContextBuilder.java | 8 ++--- .../springframework/asm/AnnotationWriter.java | 6 ++-- .../org/springframework/asm/ClassReader.java | 4 +-- .../org/springframework/asm/ClassVisitor.java | 6 ++-- .../org/springframework/asm/MethodWriter.java | 2 +- .../springframework/asm/TypeReference.java | 2 +- .../cglib/core/AbstractClassGenerator.java | 2 +- .../cglib/proxy/InterfaceMaker.java | 2 +- .../org/springframework/core/Conventions.java | 8 ++--- .../core/DecoratingClassLoader.java | 4 +-- .../core/InfrastructureProxy.java | 2 +- .../springframework/core/MethodParameter.java | 12 +++---- .../core/ParameterizedTypeReference.java | 2 +- .../core/ReactiveAdapterRegistry.java | 2 +- .../core/ReactiveTypeDescriptor.java | 2 +- .../springframework/core/ResolvableType.java | 4 +-- .../core/SerializableTypeWrapper.java | 4 +-- .../core/SmartClassLoader.java | 4 +-- .../core/SpringProperties.java | 2 +- .../core/annotation/AnnotationUtils.java | 10 +++--- .../core/annotation/OrderUtils.java | 2 +- .../SynthesizingMethodParameter.java | 4 +-- .../core/codec/AbstractDataBufferDecoder.java | 6 ++-- .../springframework/core/codec/Encoder.java | 2 +- .../org/springframework/core/codec/Hints.java | 2 +- .../core/codec/ResourceDecoder.java | 2 +- .../core/convert/Property.java | 12 +++---- .../support/DefaultConversionService.java | 4 +-- .../core/env/AbstractEnvironment.java | 2 +- .../core/env/CommandLinePropertySource.java | 6 ++-- .../core/env/CompositePropertySource.java | 2 +- .../core/env/ConfigurableEnvironment.java | 2 +- .../core/env/StandardEnvironment.java | 2 +- .../core/io/AbstractResource.java | 2 +- .../core/io/ContextResource.java | 4 +-- .../core/io/DefaultResourceLoader.java | 4 +-- .../core/io/FileSystemResource.java | 6 ++-- .../springframework/core/io/PathResource.java | 6 ++-- .../core/io/ResourceEditor.java | 4 +-- .../core/io/ResourceLoader.java | 8 ++--- .../springframework/core/io/UrlResource.java | 10 +++--- .../io/buffer/DataBufferLimitException.java | 4 +-- .../core/io/buffer/LimitedDataBufferList.java | 2 +- .../io/support/LocalizedResourceHelper.java | 2 +- .../PathMatchingResourcePatternResolver.java | 6 ++-- .../io/support/PropertiesLoaderSupport.java | 4 +-- .../io/support/PropertySourceFactory.java | 2 +- .../support/ResourceArrayPropertyEditor.java | 4 +-- .../core/log/LogDelegateFactory.java | 2 +- .../core/task/VirtualThreadTaskExecutor.java | 4 +-- .../core/type/AnnotatedTypeMetadata.java | 8 ++--- .../springframework/lang/package-info.java | 4 +-- .../objenesis/SpringObjenesis.java | 2 +- .../springframework/util/AntPathMatcher.java | 4 +-- .../org/springframework/util/ClassUtils.java | 12 +++---- .../util/ConcurrentReferenceHashMap.java | 2 +- .../util/CustomizableThreadCreator.java | 2 +- .../springframework/util/MethodInvoker.java | 4 +-- .../org/springframework/util/MimeType.java | 4 +-- .../org/springframework/util/StringUtils.java | 34 +++++++++---------- .../util/SystemPropertyUtils.java | 2 +- .../springframework/util/backoff/BackOff.java | 2 +- .../annotation/MergedAnnotationsTests.java | 2 +- .../expression/spel/CodeFlow.java | 10 +++--- .../spel/ast/ConstructorReference.java | 2 +- .../expression/spel/ast/InlineList.java | 2 +- .../expression/spel/ast/InlineMap.java | 2 +- .../expression/spel/ast/OpDec.java | 2 +- .../expression/spel/ast/OpInc.java | 2 +- .../expression/spel/ast/Operator.java | 4 +-- .../expression/spel/ast/OperatorMatches.java | 2 +- .../InternalSpelExpressionParser.java | 2 +- .../expression/spel/standard/Token.java | 2 +- .../support/ReflectiveMethodResolver.java | 4 +-- .../support/ReflectivePropertyAccessor.java | 2 +- .../spel/support/SimpleEvaluationContext.java | 2 +- .../apache/commons/logging/LogAdapter.java | 2 +- .../apache/commons/logging/LogFactory.java | 4 +-- .../commons/logging/impl/package-info.java | 2 +- .../jdbc/core/JdbcOperations.java | 8 ++--- .../jdbc/core/JdbcTemplate.java | 4 +-- .../jdbc/core/ParameterDisposer.java | 2 +- .../jdbc/core/StatementCreatorUtils.java | 6 ++-- .../NamedParameterJdbcOperations.java | 4 +-- .../jdbc/core/simple/JdbcClient.java | 4 +-- .../support/JdbcBeanDefinitionReader.java | 2 +- .../jdbc/core/support/SqlBinaryValue.java | 4 +-- .../jdbc/core/support/SqlCharacterValue.java | 4 +-- .../DataSourceTransactionManager.java | 6 ++-- .../jdbc/datasource/DataSourceUtils.java | 10 +++--- .../IsolationLevelDataSourceAdapter.java | 2 +- .../LazyConnectionDataSourceProxy.java | 4 +-- .../jdbc/datasource/ShardingKeyProvider.java | 2 +- .../SingleConnectionDataSource.java | 2 +- .../TransactionAwareDataSourceProxy.java | 2 +- .../IsolationLevelDataSourceRouter.java | 4 +-- .../jdbc/support/JdbcTransactionManager.java | 2 +- .../jdbc/support/JdbcUtils.java | 12 +++---- .../SQLErrorCodeSQLExceptionTranslator.java | 4 +-- .../jdbc/support/SQLErrorCodesFactory.java | 2 +- .../SQLStateSQLExceptionTranslator.java | 4 +-- .../jdbc/support/lob/DefaultLobHandler.java | 4 +-- .../jdbc/support/lob/LobHandler.java | 2 +- .../jdbc/config/spring-jdbc.xsd | 2 +- .../config/AbstractJmsListenerEndpoint.java | 4 +-- .../connection/ConnectionFactoryUtils.java | 2 +- .../DelegatingConnectionFactory.java | 2 +- .../jms/connection/JmsResourceHolder.java | 2 +- .../connection/SingleConnectionFactory.java | 2 +- ...ransactionAwareConnectionFactoryProxy.java | 2 +- .../AbstractMessageListenerContainer.java | 8 ++--- ...stractPollingMessageListenerContainer.java | 4 +-- .../DefaultMessageListenerContainer.java | 8 ++--- .../SimpleMessageListenerContainer.java | 6 ++-- .../DefaultJmsActivationSpecFactory.java | 10 +++--- .../endpoint/JmsActivationSpecConfig.java | 6 ++-- .../endpoint/JmsMessageEndpointFactory.java | 2 +- .../endpoint/JmsMessageEndpointManager.java | 4 +-- .../StandardJmsActivationSpecFactory.java | 8 ++--- .../jms/support/JmsHeaderMapper.java | 2 +- .../jms/support/JmsHeaders.java | 2 +- .../jms/support/SimpleJmsHeaderMapper.java | 4 +-- .../MappingJackson2MessageConverter.java | 4 +-- .../converter/MessagingMessageConverter.java | 2 +- .../converter/SmartMessageConverter.java | 4 +-- .../springframework/jms/config/spring-jms.xsd | 16 ++++----- .../AbstractJsonMessageConverter.java | 2 +- .../converter/AbstractMessageConverter.java | 4 +-- .../converter/SmartMessageConverter.java | 8 ++--- .../core/AbstractMessageSendingTemplate.java | 2 +- .../core/CachingDestinationResolverProxy.java | 2 +- .../handler/AbstractMessageCondition.java | 2 +- .../messaging/handler/HandlerMethod.java | 4 +-- .../messaging/handler/MessageCondition.java | 2 +- .../handler/annotation/MessageMapping.java | 8 ++--- ...tractNamedValueMethodArgumentResolver.java | 2 +- .../MessageMappingMessageHandler.java | 2 +- ...tractNamedValueMethodArgumentResolver.java | 2 +- .../MessageMethodArgumentResolver.java | 2 +- .../PayloadMethodArgumentResolver.java | 2 +- ...bstractExceptionHandlerMethodResolver.java | 2 +- .../AbstractMethodMessageHandler.java | 2 +- .../invocation/InvocableHandlerMethod.java | 2 +- .../AbstractMethodMessageHandler.java | 10 +++--- .../reactive/InvocableHandlerMethod.java | 2 +- .../invocation/reactive/InvocableHelper.java | 2 +- .../DefaultRSocketRequesterBuilder.java | 4 +-- .../messaging/rsocket/RSocketRequester.java | 2 +- .../rsocket/annotation/ConnectMapping.java | 4 +-- .../RSocketFrameTypeMessageCondition.java | 2 +- .../support/RSocketMessageHandler.java | 2 +- .../messaging/simp/SimpAttributes.java | 2 +- .../simp/SimpAttributesContextHolder.java | 2 +- .../simp/SimpMessageHeaderAccessor.java | 2 +- .../simp/SimpMessageSendingOperations.java | 4 +-- .../messaging/simp/SimpSessionScope.java | 2 +- .../simp/annotation/SubscribeMapping.java | 10 +++--- .../SimpAnnotationMethodMessageHandler.java | 6 ++-- .../broker/AbstractBrokerMessageHandler.java | 8 ++--- .../broker/SimpleBrokerMessageHandler.java | 4 +-- .../AbstractMessageBrokerConfiguration.java | 2 +- .../simp/config/MessageBrokerRegistry.java | 4 +-- .../config/StompBrokerRelayRegistration.java | 10 +++--- .../simp/stomp/BufferingStompDecoder.java | 2 +- .../stomp/StompBrokerRelayMessageHandler.java | 10 +++--- .../simp/stomp/StompHeaderAccessor.java | 2 +- .../user/DefaultUserDestinationResolver.java | 14 ++++---- .../simp/user/MultiServerUserRegistry.java | 4 +-- .../simp/user/UserDestinationResult.java | 4 +-- .../tcp/reactor/TcpMessageCodec.java | 2 +- .../HibernateTransactionManager.java | 4 +-- .../hibernate5/LocalSessionFactoryBean.java | 6 ++-- .../LocalSessionFactoryBuilder.java | 6 ++-- .../orm/hibernate5/SpringBeanContainer.java | 2 +- .../jpa/AbstractEntityManagerFactoryBean.java | 6 ++-- .../orm/jpa/EntityManagerFactoryUtils.java | 10 +++--- .../springframework/orm/jpa/JpaDialect.java | 2 +- .../orm/jpa/JpaVendorAdapter.java | 4 +-- ...ocalContainerEntityManagerFactoryBean.java | 4 +-- .../DefaultPersistenceUnitManager.java | 4 +-- ...ersistenceAnnotationBeanPostProcessor.java | 2 +- .../jpa/vendor/AbstractJpaVendorAdapter.java | 2 +- .../jpa/vendor/HibernateJpaVendorAdapter.java | 4 +-- .../connection/SingleConnectionFactory.java | 2 +- .../r2dbc/core/DatabaseClient.java | 4 +-- .../reactive/MockClientHttpRequest.java | 2 +- .../mock/web/MockHttpServletRequest.java | 2 +- .../test/context/ContextLoader.java | 2 +- .../test/context/TestContextManager.java | 2 +- .../test/context/TestPropertySource.java | 4 +-- .../test/context/cache/ContextCache.java | 2 +- .../test/context/jdbc/Sql.java | 2 +- .../AbstractDelegatingSmartContextLoader.java | 4 +-- .../AnnotationConfigContextLoaderUtils.java | 2 +- ...endencyInjectionTestExecutionListener.java | 2 +- .../support/TestPropertySourceUtils.java | 2 +- .../TransactionalTestExecutionListener.java | 2 +- .../util/TestContextResourceUtils.java | 2 +- .../test/context/web/WebAppConfiguration.java | 2 +- .../test/util/XpathExpectationsHelper.java | 2 +- .../web/reactive/server/ExchangeResult.java | 2 +- .../reactive/server/MockServerConfigurer.java | 2 +- .../web/reactive/server/WebTestClient.java | 12 +++---- .../web/reactive/server/WiretapConnector.java | 2 +- .../web/servlet/assertj/MockMvcTester.java | 2 +- .../servlet/client/MockMvcWebTestClient.java | 2 +- .../request/MockMvcRequestBuilders.java | 2 +- .../setup/ConfigurableMockMvcBuilder.java | 2 +- .../web/servlet/setup/MockMvcConfigurer.java | 4 +-- .../servlet/setup/MockMvcFilterDecorator.java | 6 ++-- .../setup/StandaloneMockMvcBuilder.java | 2 +- ...figClassesWithoutAtConfigurationTests.java | 4 +-- .../dao/DataAccessException.java | 2 +- .../dao/DataIntegrityViolationException.java | 2 +- .../dao/DataRetrievalFailureException.java | 2 +- .../PessimisticLockingFailureException.java | 2 +- ...enceExceptionTranslationPostProcessor.java | 2 +- .../GenericMessageEndpointFactory.java | 4 +-- .../GenericMessageEndpointManager.java | 4 +-- .../support/LocalConnectionFactoryBean.java | 2 +- .../PlatformTransactionManager.java | 2 +- .../transaction/TransactionExecution.java | 2 +- .../AnnotationTransactionAttributeSource.java | 2 +- .../EnableTransactionManagement.java | 2 +- .../transaction/annotation/Transactional.java | 4 +-- .../event/TransactionalEventListener.java | 2 +- .../DefaultTransactionAttribute.java | 2 +- .../MethodMapTransactionAttributeSource.java | 2 +- .../NameMatchTransactionAttributeSource.java | 2 +- .../interceptor/TransactionAspectSupport.java | 6 ++-- .../TransactionProxyFactoryBean.java | 2 +- .../jta/JtaTransactionManager.java | 6 ++-- .../jta/SpringJtaSynchronizationAdapter.java | 2 +- .../AbstractReactiveTransactionManager.java | 6 ++-- .../reactive/TransactionCallback.java | 4 +-- .../reactive/TransactionSynchronization.java | 2 +- .../TransactionSynchronizationManager.java | 4 +-- .../reactive/TransactionalEventPublisher.java | 2 +- .../AbstractPlatformTransactionManager.java | 12 +++---- .../support/ResourceHolderSupport.java | 4 +-- .../support/ResourceTransactionManager.java | 2 +- .../support/TransactionCallback.java | 4 +-- .../TransactionCallbackWithoutResult.java | 2 +- .../support/TransactionSynchronization.java | 4 +-- .../TransactionSynchronizationManager.java | 4 +-- .../http/ContentDisposition.java | 2 +- .../org/springframework/http/HttpHeaders.java | 2 +- .../org/springframework/http/HttpMethod.java | 2 +- .../springframework/http/HttpStatusCode.java | 2 +- .../org/springframework/http/MediaType.java | 2 +- .../springframework/http/MediaTypeEditor.java | 2 +- .../springframework/http/ProblemDetail.java | 2 +- .../http/ReactiveHttpOutputMessage.java | 2 +- .../springframework/http/ResponseCookie.java | 2 +- .../springframework/http/ResponseEntity.java | 2 +- .../http/client/MultipartBodyBuilder.java | 4 +-- .../http/codec/CodecConfigurer.java | 8 ++--- .../KotlinSerializationBinaryDecoder.java | 2 +- .../KotlinSerializationStringDecoder.java | 2 +- .../http/codec/multipart/Part.java | 2 +- .../converter/FormHttpMessageConverter.java | 2 +- .../AbstractJsonHttpMessageConverter.java | 2 +- .../json/GsonHttpMessageConverter.java | 2 +- .../json/Jackson2ObjectMapperBuilder.java | 2 +- .../server/ServletServerHttpResponse.java | 2 +- .../reactive/ContextPathCompositeHandler.java | 2 +- .../reactive/ServletHttpHandlerAdapter.java | 4 +-- .../springframework/web/ErrorResponse.java | 8 ++--- .../web/WebApplicationInitializer.java | 2 +- ...ractMappingContentNegotiationStrategy.java | 6 ++-- .../ContentNegotiationManagerFactoryBean.java | 4 +-- .../bind/MissingRequestValueException.java | 2 +- ...ServletRequestParameterPropertyValues.java | 2 +- .../web/bind/WebDataBinder.java | 8 ++--- .../web/bind/annotation/CrossOrigin.java | 2 +- .../web/bind/annotation/ExceptionHandler.java | 2 +- .../web/bind/annotation/MatrixVariable.java | 2 +- .../web/bind/annotation/ModelAttribute.java | 2 +- .../web/bind/annotation/PathVariable.java | 2 +- .../web/bind/annotation/RequestMapping.java | 10 +++--- .../web/bind/annotation/RequestPart.java | 2 +- .../web/bind/annotation/SessionAttribute.java | 2 +- .../bind/annotation/SessionAttributes.java | 4 +-- .../support/DefaultDataBinderFactory.java | 2 +- .../web/bind/support/SessionStatus.java | 2 +- .../SpringWebConstraintValidatorFactory.java | 2 +- .../bind/support/WebRequestDataBinder.java | 2 +- .../web/client/RestClient.java | 8 ++--- .../web/client/RestOperations.java | 6 ++-- .../web/context/ContextLoader.java | 4 +-- .../request/AsyncWebRequestInterceptor.java | 2 +- .../request/RequestContextListener.java | 4 +-- .../DeferredResultProcessingInterceptor.java | 2 +- .../async/StandardServletAsyncWebRequest.java | 2 +- .../request/async/WebAsyncManager.java | 2 +- ...tractRefreshableWebApplicationContext.java | 2 +- ...AnnotationConfigWebApplicationContext.java | 2 +- .../support/ServletContextResource.java | 2 +- .../support/StaticWebApplicationContext.java | 2 +- .../support/XmlWebApplicationContext.java | 2 +- .../web/cors/CorsConfiguration.java | 16 ++++----- .../web/filter/CorsFilter.java | 2 +- .../web/filter/ForwardedHeaderFilter.java | 6 ++-- .../web/filter/OncePerRequestFilter.java | 4 +-- .../web/filter/RequestContextFilter.java | 4 +-- .../web/filter/ShallowEtagHeaderFilter.java | 2 +- .../web/filter/UrlHandlerFilter.java | 4 +-- .../web/method/ControllerAdviceBean.java | 2 +- .../web/method/HandlerMethod.java | 4 +-- .../web/method/HandlerTypePredicate.java | 4 +-- .../ExceptionHandlerMethodResolver.java | 4 +-- .../support/InvocableHandlerMethod.java | 2 +- .../method/support/ModelAndViewContainer.java | 6 ++-- .../web/multipart/MultipartFile.java | 2 +- .../MultipartHttpServletRequest.java | 2 +- .../MissingServletRequestPartException.java | 2 +- .../multipart/support/MultipartFilter.java | 2 +- .../StandardMultipartHttpServletRequest.java | 6 ++-- .../StandardServletMultipartResolver.java | 2 +- .../server/MissingRequestValueException.java | 4 +-- .../web/server/ResponseStatusException.java | 4 +-- .../web/server/ServerWebInputException.java | 2 +- .../handler/ExceptionHandlingWebHandler.java | 2 +- .../session/InMemoryWebSessionStore.java | 2 +- .../web/service/annotation/HttpExchange.java | 2 +- .../AbstractNamedValueArgumentResolver.java | 2 +- .../service/invoker/HttpRequestValues.java | 2 +- .../invoker/RequestParamArgumentResolver.java | 2 +- .../invoker/RequestPartArgumentResolver.java | 2 +- .../util/ContentCachingRequestWrapper.java | 2 +- .../util/ContentCachingResponseWrapper.java | 2 +- .../web/util/HierarchicalUriComponents.java | 2 +- .../springframework/web/util/HtmlUtils.java | 4 +-- .../web/util/IntrospectorCleanupListener.java | 2 +- .../web/util/ServletContextPropertyUtils.java | 2 +- .../springframework/web/util/UriBuilder.java | 2 +- .../springframework/web/util/UriTemplate.java | 2 +- .../springframework/web/util/UriUtils.java | 6 ++-- .../web/util/UrlPathHelper.java | 12 +++---- .../web/util/WebAppRootListener.java | 2 +- .../springframework/web/util/WebUtils.java | 2 +- .../pattern/InternalPathPatternParser.java | 2 +- .../web/util/pattern/PathPatternParser.java | 2 +- .../codec/CancelWithoutDemandCodecTests.java | 10 +++--- .../reactive/ChannelSendOperatorTests.java | 2 +- .../web/context/support/Spr8510Tests.java | 2 +- .../ModelAttributeMethodProcessorTests.java | 2 +- .../reactive/MockClientHttpRequest.java | 2 +- .../AbstractHttpHandlerIntegrationTests.java | 2 +- .../servlet/MockHttpServletRequest.java | 2 +- .../web/reactive/HandlerResult.java | 2 +- .../accept/ParameterContentTypeResolver.java | 2 +- .../RequestedContentTypeResolverBuilder.java | 2 +- .../web/reactive/config/CorsRegistration.java | 2 +- .../config/ResourceHandlerRegistry.java | 4 +-- .../reactive/config/ViewResolverRegistry.java | 4 +-- .../config/WebFluxConfigurationSupport.java | 2 +- .../reactive/config/WebFluxConfigurer.java | 2 +- .../web/reactive/function/BodyExtractors.java | 2 +- .../reactive/function/client/WebClient.java | 6 ++-- .../function/server/EntityResponse.java | 2 +- .../function/server/ServerRequest.java | 2 +- .../function/server/ServerResponse.java | 2 +- .../handler/AbstractUrlHandlerMapping.java | 8 ++--- .../handler/SimpleUrlHandlerMapping.java | 4 +-- .../AbstractFileNameVersionStrategy.java | 2 +- .../AbstractPrefixVersionStrategy.java | 2 +- .../resource/ContentVersionStrategy.java | 2 +- .../resource/CssLinkResourceTransformer.java | 4 +-- .../resource/EncodedResourceResolver.java | 2 +- .../resource/FixedVersionStrategy.java | 2 +- .../resource/LiteWebJarsResourceResolver.java | 2 +- .../resource/PathResourceResolver.java | 2 +- .../resource/ResourceTransformerChain.java | 2 +- .../resource/ResourceTransformerSupport.java | 4 +-- .../reactive/resource/ResourceWebHandler.java | 2 +- .../resource/VersionResourceResolver.java | 6 ++-- .../resource/WebJarsResourceResolver.java | 2 +- .../result/condition/MediaTypeExpression.java | 2 +- .../result/condition/RequestCondition.java | 2 +- .../condition/RequestConditionHolder.java | 2 +- .../result/method/InvocableHandlerMethod.java | 4 +-- .../method/SyncInvocableHandlerMethod.java | 2 +- ...AbstractMessageReaderArgumentResolver.java | 2 +- .../AbstractMessageWriterResultHandler.java | 2 +- .../RequestMappingHandlerAdapter.java | 2 +- .../RequestPartMethodArgumentResolver.java | 2 +- .../ResponseEntityExceptionHandler.java | 2 +- .../result/view/AbstractUrlBasedView.java | 2 +- .../web/reactive/result/view/BindStatus.java | 8 ++--- .../reactive/result/view/RequestContext.java | 8 ++--- .../result/view/UrlBasedViewResolver.java | 2 +- .../view/ViewResolutionResultHandler.java | 6 ++-- .../view/freemarker/FreeMarkerConfigurer.java | 2 +- .../web/reactive/socket/CloseStatus.java | 10 +++--- .../web/reactive/socket/WebSocketMessage.java | 4 +-- .../AbstractListenerWebSocketSession.java | 2 +- .../result/view/freemarker/spring.ftl | 4 +-- .../web/servlet/AsyncHandlerInterceptor.java | 2 +- .../web/servlet/DispatcherServlet.java | 6 ++-- .../springframework/web/servlet/FlashMap.java | 6 ++-- .../web/servlet/FrameworkServlet.java | 8 ++--- .../web/servlet/HandlerInterceptor.java | 2 +- .../annotation/AsyncSupportConfigurer.java | 2 +- .../config/annotation/CorsRegistration.java | 2 +- .../config/annotation/EnableWebMvc.java | 6 ++-- .../ResourceHandlerRegistration.java | 4 +-- .../annotation/ResourceHandlerRegistry.java | 4 +-- .../annotation/ViewResolverRegistry.java | 4 +-- .../WebMvcConfigurationSupport.java | 8 ++--- .../config/annotation/WebMvcConfigurer.java | 2 +- .../function/DefaultServerRequest.java | 2 +- .../web/servlet/function/EntityResponse.java | 2 +- .../web/servlet/function/ServerRequest.java | 4 +-- .../web/servlet/function/ServerResponse.java | 2 +- ...bstractHandlerMethodExceptionResolver.java | 2 +- .../handler/AbstractHandlerMethodMapping.java | 2 +- .../handler/SimpleUrlHandlerMapping.java | 2 +- .../servlet/i18n/CookieLocaleResolver.java | 8 ++--- .../servlet/i18n/SessionLocaleResolver.java | 2 +- .../mvc/ServletForwardingController.java | 2 +- .../mvc/ServletWrappingController.java | 2 +- .../ResponseStatusExceptionResolver.java | 4 +-- .../mvc/condition/MediaTypeExpression.java | 2 +- .../condition/PatternsRequestCondition.java | 2 +- .../mvc/condition/RequestCondition.java | 2 +- .../mvc/condition/RequestConditionHolder.java | 2 +- ...essageConverterMethodArgumentResolver.java | 4 +-- ...stractMessageConverterMethodProcessor.java | 2 +- .../ExceptionHandlerExceptionResolver.java | 2 +- .../method/annotation/RequestBodyAdvice.java | 8 ++--- .../RequestMappingHandlerAdapter.java | 2 +- .../ResponseEntityExceptionHandler.java | 2 +- .../ServletInvocableHandlerMethod.java | 8 ++--- .../ServletModelAttributeMethodProcessor.java | 2 +- .../ViewNameMethodReturnValueHandler.java | 2 +- .../DefaultHandlerExceptionResolver.java | 4 +-- .../resource/AbstractVersionStrategy.java | 4 +-- .../resource/ContentVersionStrategy.java | 2 +- .../resource/CssLinkResourceTransformer.java | 4 +-- .../resource/EncodedResourceResolver.java | 2 +- .../resource/FixedVersionStrategy.java | 2 +- .../resource/LiteWebJarsResourceResolver.java | 2 +- .../resource/PathResourceResolver.java | 2 +- .../resource/ResourceHttpRequestHandler.java | 6 ++-- .../resource/ResourceTransformerChain.java | 2 +- .../resource/ResourceTransformerSupport.java | 4 +-- .../resource/VersionResourceResolver.java | 6 ++-- .../resource/WebJarsResourceResolver.java | 2 +- .../web/servlet/support/BindStatus.java | 8 ++--- .../web/servlet/support/RequestContext.java | 8 ++--- .../support/ServletUriComponentsBuilder.java | 4 +-- .../servlet/support/WebContentGenerator.java | 2 +- .../web/servlet/tags/BindTag.java | 4 +-- .../web/servlet/tags/EscapeBodyTag.java | 4 +-- .../servlet/tags/HtmlEscapingAwareTag.java | 2 +- .../web/servlet/tags/MessageTag.java | 2 +- .../web/servlet/tags/NestedPathTag.java | 4 +-- .../web/servlet/tags/TransformTag.java | 4 +-- .../servlet/theme/CookieThemeResolver.java | 2 +- .../servlet/theme/SessionThemeResolver.java | 2 +- .../view/AbstractCachingViewResolver.java | 4 +-- .../servlet/view/AbstractTemplateView.java | 4 +-- .../servlet/view/AbstractUrlBasedView.java | 2 +- .../web/servlet/view/AbstractView.java | 2 +- .../view/InternalResourceViewResolver.java | 2 +- .../web/servlet/view/JstlView.java | 2 +- .../servlet/view/UrlBasedViewResolver.java | 8 ++--- .../view/document/AbstractPdfStamperView.java | 2 +- .../src/main/resources/META-INF/spring.tld | 2 +- .../web/servlet/config/spring-mvc.xsd | 18 +++++----- .../web/servlet/view/freemarker/spring.ftl | 4 +-- ...nnotationControllerHandlerMethodTests.java | 2 +- .../web/servlet/tags/form/SelectTagTests.java | 2 +- .../web/socket/CloseStatus.java | 14 ++++---- .../web/socket/WebSocketExtension.java | 2 +- .../MessageBrokerBeanDefinitionParser.java | 4 +-- .../config/WebSocketMessageBrokerStats.java | 2 +- .../annotation/SockJsServiceRegistration.java | 4 +-- .../WebSocketMessageBrokerConfigurer.java | 4 +-- .../WebSocketTransportRegistration.java | 2 +- .../SessionLimitExceededException.java | 2 +- .../messaging/AbstractSubProtocolEvent.java | 2 +- .../socket/messaging/SessionConnectEvent.java | 2 +- .../messaging/SessionDisconnectEvent.java | 2 +- .../messaging/SessionSubscribeEvent.java | 2 +- .../messaging/SessionUnsubscribeEvent.java | 2 +- .../messaging/StompSubProtocolHandler.java | 4 +-- .../messaging/SubProtocolErrorHandler.java | 4 +-- .../SubProtocolWebSocketHandler.java | 6 ++-- .../support/AbstractHandshakeHandler.java | 2 +- .../SockJsTransportFailureException.java | 2 +- .../sockjs/client/JettyXhrTransport.java | 2 +- .../socket/sockjs/client/SockJsClient.java | 4 +-- .../sockjs/client/UndertowXhrTransport.java | 2 +- .../sockjs/support/AbstractSockJsService.java | 8 ++--- .../TransportHandlingSockJsService.java | 4 +-- ...AbstractHttpReceivingTransportHandler.java | 2 +- .../handler/SockJsWebSocketHandler.java | 2 +- .../session/AbstractHttpSockJsSession.java | 8 ++--- .../web/socket/config/spring-websocket.xsd | 20 +++++------ 722 files changed, 1290 insertions(+), 1290 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93e430897e83..857d5b521504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,7 +86,7 @@ multiple edits or corrections of the same logical change. See for an overview of streamlining the commit history. 1. Format commit messages using 55 characters for the subject line, 72 characters per line -for the description, followed by the issue fixed, e.g. `Closes gh-22276`. See the +for the description, followed by the issue fixed, for example, `Closes gh-22276`. See the [Commit Guidelines section of Pro Git](https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines) for best practices around commit messages, and use `git log` to see some examples. diff --git a/framework-docs/modules/ROOT/pages/core/aop/ataspectj/introductions.adoc b/framework-docs/modules/ROOT/pages/core/aop/ataspectj/introductions.adoc index 73173a038924..3244d288f9f9 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/ataspectj/introductions.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/ataspectj/introductions.adoc @@ -9,7 +9,7 @@ You can make an introduction by using the `@DeclareParents` annotation. This ann is used to declare that matching types have a new parent (hence the name). For example, given an interface named `UsageTracked` and an implementation of that interface named `DefaultUsageTracked`, the following aspect declares that all implementors of service -interfaces also implement the `UsageTracked` interface (e.g. for statistics via JMX): +interfaces also implement the `UsageTracked` interface (for example, for statistics via JMX): [tabs] ====== diff --git a/framework-docs/modules/ROOT/pages/core/aop/introduction-defn.adoc b/framework-docs/modules/ROOT/pages/core/aop/introduction-defn.adoc index 128d6cb42884..2c87464cb608 100644 --- a/framework-docs/modules/ROOT/pages/core/aop/introduction-defn.adoc +++ b/framework-docs/modules/ROOT/pages/core/aop/introduction-defn.adoc @@ -65,7 +65,7 @@ with less potential for errors. For example, you do not need to invoke the `proc method on the `JoinPoint` used for around advice, and, hence, you cannot fail to invoke it. All advice parameters are statically typed so that you work with advice parameters of -the appropriate type (e.g. the type of the return value from a method execution) rather +the appropriate type (for example, the type of the return value from a method execution) rather than `Object` arrays. The concept of join points matched by pointcuts is the key to AOP, which distinguishes diff --git a/framework-docs/modules/ROOT/pages/core/beans/annotation-config.adoc b/framework-docs/modules/ROOT/pages/core/beans/annotation-config.adoc index f364ae8ed1af..33e48c41a236 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/annotation-config.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/annotation-config.adoc @@ -20,7 +20,7 @@ can be found in the xref:core/beans/standard-annotations.adoc[relevant section]. [NOTE] ==== Annotation injection is performed before external property injection. Thus, external -configuration (e.g. XML-specified bean properties) effectively overrides the annotations +configuration (for example, XML-specified bean properties) effectively overrides the annotations for properties when wired through mixed approaches. ==== diff --git a/framework-docs/modules/ROOT/pages/core/beans/context-introduction.adoc b/framework-docs/modules/ROOT/pages/core/beans/context-introduction.adoc index c3108040c343..38feeee01119 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/context-introduction.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/context-introduction.adoc @@ -484,7 +484,7 @@ You can register as many event listeners as you wish, but note that, by default, This means that the `publishEvent()` method blocks until all listeners have finished processing the event. One advantage of this synchronous and single-threaded approach is that, when a listener receives an event, it operates inside the transaction context of the publisher if a transaction context is available. -If another strategy for event publication becomes necessary, e.g. asynchronous event processing by default, +If another strategy for event publication becomes necessary, for example, asynchronous event processing by default, see the javadoc for Spring's {spring-framework-api}/context/event/ApplicationEventMulticaster.html[`ApplicationEventMulticaster`] interface and {spring-framework-api}/context/event/SimpleApplicationEventMulticaster.html[`SimpleApplicationEventMulticaster`] implementation for configuration options which can be applied to a custom "applicationEventMulticaster" bean definition. @@ -864,7 +864,7 @@ Finally, as with classic `ApplicationListener` implementations, the actual multi happens via a context-wide `ApplicationEventMulticaster` at runtime. By default, this is a `SimpleApplicationEventMulticaster` with synchronous event publication in the caller thread. This can be replaced/customized through an "applicationEventMulticaster" bean definition, -e.g. for processing all events asynchronously and/or for handling listener exceptions: +for example, for processing all events asynchronously and/or for handling listener exceptions: [source,java,indent=0,subs="verbatim,quotes"] ---- diff --git a/framework-docs/modules/ROOT/pages/core/beans/factory-nature.adoc b/framework-docs/modules/ROOT/pages/core/beans/factory-nature.adoc index 9614299fc60b..f6d310715a8d 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/factory-nature.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/factory-nature.adoc @@ -144,7 +144,7 @@ based on the given configuration but no further activity with external bean acce Otherwise there is a risk for an initialization deadlock. For a scenario where expensive post-initialization activity is to be triggered, -e.g. asynchronous database preparation steps, your bean should either implement +for example, asynchronous database preparation steps, your bean should either implement `SmartInitializingSingleton.afterSingletonsInstantiated()` or rely on the context refresh event: implementing `ApplicationListener` or declaring its annotation equivalent `@EventListener(ContextRefreshedEvent.class)`. @@ -607,7 +607,7 @@ bean creation phase and its subsequent initial publication, they need to be decl `volatile` or guarded by a common lock whenever accessed. Note that concurrent access to such configuration state in singleton bean instances, -e.g. for controller instances or repository instances, is perfectly thread-safe after +for example, for controller instances or repository instances, is perfectly thread-safe after such safe initial publication from the container side. This includes common singleton `FactoryBean` instances which are processed within the general singleton lock as well. @@ -617,7 +617,7 @@ structures (or in `volatile` fields for simple cases) as per common Java guideli Deeper `Lifecycle` integration as shown above involves runtime-mutable state such as a `runnable` field which will have to be declared as `volatile`. While the common -lifecycle callbacks follow a certain order, e.g. a start callback is guaranteed to +lifecycle callbacks follow a certain order, for example, a start callback is guaranteed to only happen after full initialization and a stop callback only after an initial start, there is a special case with the common stop before destroy arrangement: It is strongly recommended that the internal state in any such bean also allows for an immediate diff --git a/framework-docs/modules/ROOT/pages/core/beans/java/composing-configuration-classes.adoc b/framework-docs/modules/ROOT/pages/core/beans/java/composing-configuration-classes.adoc index 5a487ab64796..0ef19ea633c3 100644 --- a/framework-docs/modules/ROOT/pages/core/beans/java/composing-configuration-classes.adoc +++ b/framework-docs/modules/ROOT/pages/core/beans/java/composing-configuration-classes.adoc @@ -219,7 +219,7 @@ parameter-based injection, as in the preceding example. Avoid access to locally defined beans within a `@PostConstruct` method on the same configuration class. This effectively leads to a circular reference since non-static `@Bean` methods semantically require a fully initialized configuration class instance to be called on. With circular references -disallowed (e.g. in Spring Boot 2.6+), this may trigger a `BeanCurrentlyInCreationException`. +disallowed (for example, in Spring Boot 2.6+), this may trigger a `BeanCurrentlyInCreationException`. Also, be particularly careful with `BeanPostProcessor` and `BeanFactoryPostProcessor` definitions through `@Bean`. Those should usually be declared as `static @Bean` methods, not triggering the diff --git a/framework-docs/modules/ROOT/pages/core/databuffer-codec.adoc b/framework-docs/modules/ROOT/pages/core/databuffer-codec.adoc index 120d345bc1d1..d25bd9769899 100644 --- a/framework-docs/modules/ROOT/pages/core/databuffer-codec.adoc +++ b/framework-docs/modules/ROOT/pages/core/databuffer-codec.adoc @@ -29,7 +29,7 @@ a `DataBuffer` implementation and that does not involve allocation. Note that WebFlux applications do not create a `DataBufferFactory` directly but instead access it through the `ServerHttpResponse` or the `ClientHttpRequest` on the client side. -The type of factory depends on the underlying client or server, e.g. +The type of factory depends on the underlying client or server, for example, `NettyDataBufferFactory` for Reactor Netty, `DefaultDataBufferFactory` for others. @@ -82,7 +82,7 @@ to use the convenience methods in `DataBufferUtils` that apply release or retain `DataBufferUtils` offers a number of utility methods to operate on data buffers: -* Join a stream of data buffers into a single buffer possibly with zero copy, e.g. via +* Join a stream of data buffers into a single buffer possibly with zero copy, for example, via composite buffers, if that's supported by the underlying byte buffer API. * Turn `InputStream` or NIO `Channel` into `Flux`, and vice versa a `Publisher` into `OutputStream` or NIO `Channel`. diff --git a/framework-docs/modules/ROOT/pages/core/validation/beans-beans.adoc b/framework-docs/modules/ROOT/pages/core/validation/beans-beans.adoc index d6a89e761f92..d522a57c990e 100644 --- a/framework-docs/modules/ROOT/pages/core/validation/beans-beans.adoc +++ b/framework-docs/modules/ROOT/pages/core/validation/beans-beans.adoc @@ -38,7 +38,7 @@ manner, but through a nested property path. That means constructor binding creat the target object and any objects it contains. Constructor binding supports `List`, `Map`, and array arguments either converted from -a single string, e.g. comma-separated list, or based on indexed keys such as +a single string, for example, comma-separated list, or based on indexed keys such as `accounts[2].name` or `account[KEY].name`. Binding and conversion errors are reflected in the `BindingResult` of the `DataBinder`. diff --git a/framework-docs/modules/ROOT/pages/core/validation/format.adoc b/framework-docs/modules/ROOT/pages/core/validation/format.adoc index c9929f91cbf1..bcc66585724c 100644 --- a/framework-docs/modules/ROOT/pages/core/validation/format.adoc +++ b/framework-docs/modules/ROOT/pages/core/validation/format.adoc @@ -318,7 +318,7 @@ Kotlin:: The `FormatterRegistry` is an SPI for registering formatters and converters. `FormattingConversionService` is an implementation of `FormatterRegistry` suitable for most environments. You can programmatically or declaratively configure this variant -as a Spring bean, e.g. by using `FormattingConversionServiceFactoryBean`. Because this +as a Spring bean, for example, by using `FormattingConversionServiceFactoryBean`. Because this implementation also implements `ConversionService`, you can directly configure it for use with Spring's `DataBinder` and the Spring Expression Language (SpEL). diff --git a/framework-docs/modules/ROOT/pages/core/validation/validator.adoc b/framework-docs/modules/ROOT/pages/core/validation/validator.adoc index 96844141b803..5fdb92e10c2c 100644 --- a/framework-docs/modules/ROOT/pages/core/validation/validator.adoc +++ b/framework-docs/modules/ROOT/pages/core/validation/validator.adoc @@ -200,7 +200,7 @@ not involving a binding process. As of 6.1, this has been simplified through a n `Validator.validateObject(Object)` method which is available by default now, returning a simple ´Errors` representation which can be inspected: typically calling `hasErrors()` or the new `failOnError` method for turning the error summary message into an exception -(e.g. `validator.validateObject(myObject).failOnError(IllegalArgumentException::new)`). +(for example, `validator.validateObject(myObject).failOnError(IllegalArgumentException::new)`). diff --git a/framework-docs/modules/ROOT/pages/data-access/jdbc/advanced.adoc b/framework-docs/modules/ROOT/pages/data-access/jdbc/advanced.adoc index fc249a2d9363..91786b3dbdee 100644 --- a/framework-docs/modules/ROOT/pages/data-access/jdbc/advanced.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/jdbc/advanced.adoc @@ -223,7 +223,7 @@ As of 6.1.2, Spring bypasses the default `getParameterType` resolution on Postgr MS SQL Server. This is a common optimization to avoid further roundtrips to the DBMS just for parameter type resolution which is known to make a very significant difference on PostgreSQL and MS SQL Server specifically, in particular for batch operations. If you -happen to see a side effect e.g. when setting a byte array to null without specific type +happen to see a side effect, for example, when setting a byte array to null without specific type indication, you may explicitly set the `spring.jdbc.getParameterType.ignore=false` flag as a system property (see above) to restore full `getParameterType` resolution. diff --git a/framework-docs/modules/ROOT/pages/data-access/jdbc/connections.adoc b/framework-docs/modules/ROOT/pages/data-access/jdbc/connections.adoc index ddd2103ec673..d862ef883869 100644 --- a/framework-docs/modules/ROOT/pages/data-access/jdbc/connections.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/jdbc/connections.adoc @@ -177,7 +177,7 @@ corresponding `DataSource` proxy class for the target connection pool: see This is particularly useful for potentially empty transactions without actual statement execution (never fetching an actual resource in such a scenario), and also in front of a routing `DataSource` which means to take the transaction-synchronized read-only flag -and/or isolation level into account (e.g. `IsolationLevelDataSourceRouter`). +and/or isolation level into account (for example, `IsolationLevelDataSourceRouter`). `LazyConnectionDataSourceProxy` also provides special support for a read-only connection pool to use during a read-only transaction, avoiding the overhead of switching the JDBC diff --git a/framework-docs/modules/ROOT/pages/data-access/orm/jpa.adoc b/framework-docs/modules/ROOT/pages/data-access/orm/jpa.adoc index c4e97272b887..131e884d496d 100644 --- a/framework-docs/modules/ROOT/pages/data-access/orm/jpa.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/orm/jpa.adoc @@ -175,7 +175,7 @@ a context-wide `LoadTimeWeaver` by using the `@EnableLoadTimeWeaving` annotation `context:load-time-weaver` XML element. Such a global weaver is automatically picked up by all JPA `LocalContainerEntityManagerFactoryBean` instances. The following example shows the preferred way of setting up a load-time weaver, delivering auto-detection -of the platform (e.g. Tomcat's weaving-capable class loader or Spring's JVM agent) +of the platform (for example, Tomcat's weaving-capable class loader or Spring's JVM agent) and automatic propagation of the weaver to all weaver-aware beans: [source,xml,indent=0,subs="verbatim,quotes"] @@ -469,7 +469,7 @@ a non-invasiveness perspective and can feel more natural to JPA developers. What about providing JPA resources via constructors and other `@Autowired` injection points? `EntityManagerFactory` can easily be injected via constructors and `@Autowired` fields/methods -as long as the target is defined as a bean, e.g. via `LocalContainerEntityManagerFactoryBean`. +as long as the target is defined as a bean, for example, via `LocalContainerEntityManagerFactoryBean`. The injection point matches the original `EntityManagerFactory` definition by type as-is. However, an `@PersistenceContext`-style shared `EntityManager` reference is not available for diff --git a/framework-docs/modules/ROOT/pages/data-access/r2dbc.adoc b/framework-docs/modules/ROOT/pages/data-access/r2dbc.adoc index bb18d976aa0d..c27fd7ec4519 100644 --- a/framework-docs/modules/ROOT/pages/data-access/r2dbc.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/r2dbc.adoc @@ -469,10 +469,10 @@ Kotlin:: NOTE: R2DBC itself does not support Collection-like values. Nevertheless, expanding a given `List` in the example above works for named parameters -in Spring's R2DBC support, e.g. for use in `IN` clauses as shown above. -However, inserting or updating array-typed columns (e.g. in Postgres) +in Spring's R2DBC support, for example, for use in `IN` clauses as shown above. +However, inserting or updating array-typed columns (for example, in Postgres) requires an array type that is supported by the underlying R2DBC driver: -typically a Java array, e.g. `String[]` to update a `text[]` column. +typically a Java array, for example, `String[]` to update a `text[]` column. Do not pass `Collection` or the like as an array parameter. [[r2dbc-DatabaseClient-filter]] diff --git a/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/annotations.adoc b/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/annotations.adoc index 384eb7548001..f6e75c09c35e 100644 --- a/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/annotations.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/annotations.adoc @@ -250,7 +250,7 @@ the proxy are intercepted. This means that self-invocation (in effect, a method the target object calling another method of the target object) does not lead to an actual transaction at runtime even if the invoked method is marked with `@Transactional`. Also, the proxy must be fully initialized to provide the expected behavior, so you should not -rely on this feature in your initialization code -- e.g. in a `@PostConstruct` method. +rely on this feature in your initialization code -- for example, in a `@PostConstruct` method. Consider using AspectJ mode (see the `mode` attribute in the following table) if you expect self-invocations to be wrapped with transactions as well. In this case, there is @@ -564,7 +564,7 @@ transaction definitions from a base class as well. This effectively overrides the default transaction manager choice for any unqualified base class methods. Last but not least, such a type-level bean qualifier can serve multiple purposes, -e.g. with a value of "order" it can be used for autowiring purposes (identifying +for example, with a value of "order" it can be used for autowiring purposes (identifying the order repository) as well as transaction manager selection, as long as the target beans for autowiring as well as the associated transaction manager definitions declare the same qualifier value. Such a qualifier value only needs diff --git a/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/tx-decl-explained.adoc b/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/tx-decl-explained.adoc index e27f496de9fe..afece4181a30 100644 --- a/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/tx-decl-explained.adoc +++ b/framework-docs/modules/ROOT/pages/data-access/transaction/declarative/tx-decl-explained.adoc @@ -41,7 +41,7 @@ operations need to execute within the same Reactor context in the same reactive When configured with a `ReactiveTransactionManager`, all transaction-demarcated methods are expected to return a reactive pipeline. Void methods or regular return types need -to be associated with a regular `PlatformTransactionManager`, e.g. through the +to be associated with a regular `PlatformTransactionManager`, for example, through the `transactionManager` attribute of the corresponding `@Transactional` declarations. ==== diff --git a/framework-docs/modules/ROOT/pages/integration/cache/annotations.adoc b/framework-docs/modules/ROOT/pages/integration/cache/annotations.adoc index fd9254d15428..61ecce6957ed 100644 --- a/framework-docs/modules/ROOT/pages/integration/cache/annotations.adoc +++ b/framework-docs/modules/ROOT/pages/integration/cache/annotations.adoc @@ -501,12 +501,12 @@ Placing this annotation on the class does not turn on any caching operation. An operation-level customization always overrides a customization set on `@CacheConfig`. Therefore, this gives three levels of customizations for each cache operation: -* Globally configured, e.g. through `CachingConfigurer`: see next section. +* Globally configured, for example, through `CachingConfigurer`: see next section. * At the class level, using `@CacheConfig`. * At the operation level. NOTE: Provider-specific settings are typically available on the `CacheManager` bean, -e.g. on `CaffeineCacheManager`. These are effectively also global. +for example, on `CaffeineCacheManager`. These are effectively also global. [[cache-annotation-enable]] diff --git a/framework-docs/modules/ROOT/pages/integration/rest-clients.adoc b/framework-docs/modules/ROOT/pages/integration/rest-clients.adoc index 1163ab59bed6..ccdefbd1fc69 100644 --- a/framework-docs/modules/ROOT/pages/integration/rest-clients.adoc +++ b/framework-docs/modules/ROOT/pages/integration/rest-clients.adoc @@ -433,7 +433,7 @@ If no request factory is specified when the `RestClient` was built, it will use Otherwise, if the `java.net.http` module is loaded, it will use Java's `HttpClient`. Finally, it will resort to the simple default. -TIP: Note that the `SimpleClientHttpRequestFactory` may raise an exception when accessing the status of a response that represents an error (e.g. 401). +TIP: Note that the `SimpleClientHttpRequestFactory` may raise an exception when accessing the status of a response that represents an error (for example, 401). If this is an issue, use any of the alternative request factories. [[rest-webclient]] @@ -966,7 +966,7 @@ method parameters: | `@RequestPart` | Add a request part, which may be a String (form field), `Resource` (file part), - Object (entity to be encoded, e.g. as JSON), `HttpEntity` (part content and headers), + Object (entity to be encoded, for example, as JSON), `HttpEntity` (part content and headers), a Spring `Part`, or Reactive Streams `Publisher` of any of the above. | `MultipartFile` diff --git a/framework-docs/modules/ROOT/pages/integration/scheduling.adoc b/framework-docs/modules/ROOT/pages/integration/scheduling.adoc index 557239daddaa..d3ea3bfb7ddd 100644 --- a/framework-docs/modules/ROOT/pages/integration/scheduling.adoc +++ b/framework-docs/modules/ROOT/pages/integration/scheduling.adoc @@ -483,7 +483,7 @@ seconds: ==== When destroying the annotated bean or closing the application context, Spring Framework cancels scheduled tasks, which includes the next scheduled subscription to the `Publisher` as well -as any past subscription that is still currently active (e.g. for long-running publishers +as any past subscription that is still currently active (for example, for long-running publishers or even infinite publishers). ==== diff --git a/framework-docs/modules/ROOT/pages/languages/dynamic.adoc b/framework-docs/modules/ROOT/pages/languages/dynamic.adoc index fed4d8574e70..c0b5ccec7ca1 100644 --- a/framework-docs/modules/ROOT/pages/languages/dynamic.adoc +++ b/framework-docs/modules/ROOT/pages/languages/dynamic.adoc @@ -10,7 +10,7 @@ objects. Spring's scripting support primarily targets Groovy and BeanShell. Beyond those specifically supported languages, the JSR-223 scripting mechanism is supported for integration with any JSR-223 capable language provider (as of Spring 4.2), -e.g. JRuby. +for example, JRuby. You can find fully working examples of where this dynamic language support can be immediately useful in xref:languages/dynamic.adoc#dynamic-language-scenarios[Scenarios]. @@ -179,7 +179,7 @@ Each of the supported languages has a corresponding `` element: * `` (Groovy) * `` (BeanShell) -* `` (JSR-223, e.g. with JRuby) +* `` (JSR-223, for example, with JRuby) The exact attributes and child elements that are available for configuration depends on exactly which language the bean has been defined in (the language-specific sections diff --git a/framework-docs/modules/ROOT/pages/overview.adoc b/framework-docs/modules/ROOT/pages/overview.adoc index 118f591087b2..da80bf35094d 100644 --- a/framework-docs/modules/ROOT/pages/overview.adoc +++ b/framework-docs/modules/ROOT/pages/overview.adoc @@ -73,7 +73,7 @@ developers may choose to use instead of the Spring-specific mechanisms provided by the Spring Framework. Originally, those were based on common `javax` packages. As of Spring Framework 6.0, Spring has been upgraded to the Jakarta EE 9 level -(e.g. Servlet 5.0+, JPA 3.0+), based on the `jakarta` namespace instead of the +(for example, Servlet 5.0+, JPA 3.0+), based on the `jakarta` namespace instead of the traditional `javax` packages. With EE 9 as the minimum and EE 10 supported already, Spring is prepared to provide out-of-the-box support for the further evolution of the Jakarta EE APIs. Spring Framework 6.0 is fully compatible with Tomcat 10.1, diff --git a/framework-docs/modules/ROOT/pages/rsocket.adoc b/framework-docs/modules/ROOT/pages/rsocket.adoc index 1e668e886178..52e42adf8001 100644 --- a/framework-docs/modules/ROOT/pages/rsocket.adoc +++ b/framework-docs/modules/ROOT/pages/rsocket.adoc @@ -113,7 +113,7 @@ a natural fit to use `Flux` and `Mono` with declarative operators and transparen pressure support. The API in RSocket Java is intentionally minimal and basic. It focuses on protocol -features and leaves the application programming model (e.g. RPC codegen vs other) as a +features and leaves the application programming model (for example, RPC codegen vs other) as a higher level, independent concern. The main contract @@ -271,7 +271,7 @@ Kotlin:: ---- ====== -`RSocketStrategies` is designed for re-use. In some scenarios, e.g. client and server in +`RSocketStrategies` is designed for re-use. In some scenarios, for example, client and server in the same application, it may be preferable to declare it in Spring configuration. @@ -361,7 +361,7 @@ Kotlin:: ====== For the above you may also need to use `setHandlerPredicate` in `RSocketMessageHandler` to -switch to a different strategy for detecting client responders, e.g. based on a custom +switch to a different strategy for detecting client responders, for example, based on a custom annotation such as `@RSocketClientResponder` vs the default `@Controller`. This is necessary in scenarios with client and server, or multiple clients in the same application. @@ -798,7 +798,7 @@ use the following method arguments: | Requester for making requests to the remote end. | `@DestinationVariable` -| Value extracted from the route based on variables in the mapping pattern, e.g. +| Value extracted from the route based on variables in the mapping pattern, for example, pass:q[`@MessageMapping("find.radar.{id}")`]. | `@Header` @@ -955,7 +955,7 @@ xref:rsocket.adoc#rsocket-requester-server[Server Requester] for details. Responders must interpret metadata. {rsocket-protocol-extensions}/CompositeMetadata.md[Composite metadata] allows independently -formatted metadata values (e.g. for routing, security, tracing) each with its own mime +formatted metadata values (for example, for routing, security, tracing) each with its own mime type. Applications need a way to configure metadata mime types to support, and a way to access extracted values. diff --git a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-client.adoc b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-client.adoc index 7dc725694eff..55738c214f7d 100644 --- a/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-client.adoc +++ b/framework-docs/modules/ROOT/pages/testing/spring-mvc-test-client.adoc @@ -193,7 +193,7 @@ Then we define expectations with two kinds of responses: * a response obtained through a call to the `/quoteOfTheDay` endpoint In the second case, the request is executed through the `ClientHttpRequestFactory` that was -captured earlier. This generates a response that could e.g. come from an actual remote server, +captured earlier. This generates a response that could, for example, come from an actual remote server, depending on how the `RestTemplate` was originally configured. [[spring-mvc-test-client-static-imports]] diff --git a/framework-docs/modules/ROOT/pages/testing/webtestclient.adoc b/framework-docs/modules/ROOT/pages/testing/webtestclient.adoc index f6011d58f2ac..019d842bce75 100644 --- a/framework-docs/modules/ROOT/pages/testing/webtestclient.adoc +++ b/framework-docs/modules/ROOT/pages/testing/webtestclient.adoc @@ -403,7 +403,7 @@ Java:: .expectStatus().isOk() .expectBody(Person.class) .consumeWith(result -> { - // custom assertions (e.g. AssertJ)... + // custom assertions (for example, AssertJ)... }); ---- @@ -416,7 +416,7 @@ Kotlin:: .expectStatus().isOk() .expectBody() .consumeWith { - // custom assertions (e.g. AssertJ)... + // custom assertions (for example, AssertJ)... } ---- ====== diff --git a/framework-docs/modules/ROOT/pages/web/integration.adoc b/framework-docs/modules/ROOT/pages/web/integration.adoc index 55276ff2bcb2..ed280eb57b1d 100644 --- a/framework-docs/modules/ROOT/pages/web/integration.adoc +++ b/framework-docs/modules/ROOT/pages/web/integration.adoc @@ -103,7 +103,7 @@ on its specific integration strategies. JavaServer Faces (JSF) is the JCP's standard component-based, event-driven web user interface framework. It is an official part of the Jakarta EE umbrella but also -individually usable, e.g. through embedding Mojarra or MyFaces within Tomcat. +individually usable, for example, through embedding Mojarra or MyFaces within Tomcat. Please note that recent versions of JSF became closely tied to CDI infrastructure in application servers, with some new JSF functionality only working in such an diff --git a/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-context.adoc b/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-context.adoc index 523e711c6e83..eb2619849e4a 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-context.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux-webclient/client-context.adoc @@ -3,8 +3,8 @@ xref:web/webflux-webclient/client-attributes.adoc[Attributes] provide a convenient way to pass information to the filter chain but they only influence the current request. If you want to pass information that -propagates to additional requests that are nested, e.g. via `flatMap`, or executed after, -e.g. via `concatMap`, then you'll need to use the Reactor `Context`. +propagates to additional requests that are nested, for example, via `flatMap`, or executed after, +for example, via `concatMap`, then you'll need to use the Reactor `Context`. The Reactor `Context` needs to be populated at the end of a reactive chain in order to apply to all operations. For example: diff --git a/framework-docs/modules/ROOT/pages/web/webflux/ann-rest-exceptions.adoc b/framework-docs/modules/ROOT/pages/web/webflux/ann-rest-exceptions.adoc index e75be6630c42..d1c10148fdb1 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/ann-rest-exceptions.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/ann-rest-exceptions.adoc @@ -64,7 +64,7 @@ this `Map`. You can also extend `ProblemDetail` to add dedicated non-standard properties. The copy constructor in `ProblemDetail` allows a subclass to make it easy to be created -from an existing `ProblemDetail`. This could be done centrally, e.g. from an +from an existing `ProblemDetail`. This could be done centrally, for example, from an `@ControllerAdvice` such as `ResponseEntityExceptionHandler` that re-creates the `ProblemDetail` of an exception into a subclass with the additional non-standard fields. @@ -107,7 +107,7 @@ Message codes and arguments for each error are also resolved via `MessageSource` | `MissingRequestValueException` | (default) -| `+{0}+` a label for the value (e.g. "request header", "cookie value", ...), `+{1}+` the value name +| `+{0}+` a label for the value (for example, "request header", "cookie value", ...), `+{1}+` the value name | `NotAcceptableStatusException` | (default) diff --git a/framework-docs/modules/ROOT/pages/web/webflux/config.adoc b/framework-docs/modules/ROOT/pages/web/webflux/config.adoc index 6d8ecdef137f..d242342f8acc 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/config.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/config.adoc @@ -657,7 +657,7 @@ include the version of the jar and can also match against incoming URLs without -- for example, from `/webjars/jquery/jquery.min.js` to `/webjars/jquery/1.2.0/jquery.min.js`. TIP: The Java configuration based on `ResourceHandlerRegistry` provides further options -for fine-grained control, e.g. last-modified behavior and optimized resource resolution. +for fine-grained control, for example, last-modified behavior and optimized resource resolution. diff --git a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/modelattrib-method-args.adoc b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/modelattrib-method-args.adoc index 1a675b6d91b2..24999a0e1726 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/modelattrib-method-args.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-methods/modelattrib-method-args.adoc @@ -82,10 +82,10 @@ parameters. While `@BindParam` is supported out of the box, you can also use a different annotation by setting a `DataBinder.NameResolver` on `DataBinder` Constructor binding supports `List`, `Map`, and array arguments either converted from -a single string, e.g. comma-separated list, or based on indexed keys such as +a single string, for example, comma-separated list, or based on indexed keys such as `accounts[2].name` or `account[KEY].name`. -WebFlux, unlike Spring MVC, supports reactive types in the model, e.g. `Mono`. +WebFlux, unlike Spring MVC, supports reactive types in the model, for example, `Mono`. You can declare a `@ModelAttribute` argument with or without a reactive type wrapper, and it will be resolved accordingly to the actual value. diff --git a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-requestmapping.adoc b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-requestmapping.adoc index 98387cd2d938..4f24f6052725 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-requestmapping.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/controller/ann-requestmapping.adoc @@ -343,7 +343,7 @@ You can declare a shared `produces` attribute at the class level. Unlike most ot mapping attributes, however, when used at the class level, a method-level `produces` attribute overrides rather than extend the class level declaration. -TIP: `MediaType` provides constants for commonly used media types -- e.g. +TIP: `MediaType` provides constants for commonly used media types -- for example, `APPLICATION_JSON_VALUE`, `APPLICATION_XML_VALUE`. diff --git a/framework-docs/modules/ROOT/pages/web/webflux/dispatcher-handler.adoc b/framework-docs/modules/ROOT/pages/web/webflux/dispatcher-handler.adoc index e5f907d2dd80..8a17248f5ee1 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/dispatcher-handler.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/dispatcher-handler.adoc @@ -170,7 +170,7 @@ A `HandlerAdapter` may expose its exception handling mechanism as a A `HandlerAdapter` may also choose to implement `DispatchExceptionHandler`. In that case `DispatcherHandler` will apply it to exceptions that arise before a handler is mapped, -e.g. during handler mapping, or earlier, e.g. in a `WebFilter`. +for example, during handler mapping, or earlier, for example, in a `WebFilter`. See also xref:web/webflux/controller/ann-exceptions.adoc[Exceptions] in the "`Annotated Controller`" section or xref:web/webflux/reactive-spring.adoc#webflux-exception-handler[Exceptions] in the WebHandler API section. diff --git a/framework-docs/modules/ROOT/pages/web/webflux/reactive-spring.adoc b/framework-docs/modules/ROOT/pages/web/webflux/reactive-spring.adoc index f4c827d525c4..ec038f2366f2 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux/reactive-spring.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux/reactive-spring.adoc @@ -468,7 +468,7 @@ to encode and decode HTTP message content. * An `Encoder` can be wrapped with `EncoderHttpMessageWriter` to adapt it for use in a web application, while a `Decoder` can be wrapped with `DecoderHttpMessageReader`. * {spring-framework-api}/core/io/buffer/DataBuffer.html[`DataBuffer`] abstracts different -byte buffer representations (e.g. Netty `ByteBuf`, `java.nio.ByteBuffer`, etc.) and is +byte buffer representations (for example, Netty `ByteBuf`, `java.nio.ByteBuffer`, etc.) and is what all codecs work on. See xref:core/databuffer-codec.adoc[Data Buffers and Codecs] in the "Spring Core" section for more on this topic. @@ -493,8 +493,8 @@ The `Jackson2Decoder` works as follows: * Jackson's asynchronous, non-blocking parser is used to aggregate a stream of byte chunks into ``TokenBuffer``'s each representing a JSON object. * Each `TokenBuffer` is passed to Jackson's `ObjectMapper` to create a higher level object. -* When decoding to a single-value publisher (e.g. `Mono`), there is one `TokenBuffer`. -* When decoding to a multi-value publisher (e.g. `Flux`), each `TokenBuffer` is passed to +* When decoding to a single-value publisher (for example, `Mono`), there is one `TokenBuffer`. +* When decoding to a multi-value publisher (for example, `Flux`), each `TokenBuffer` is passed to the `ObjectMapper` as soon as enough bytes are received for a fully formed object. The input content can be a JSON array, or any https://en.wikipedia.org/wiki/JSON_streaming[line-delimited JSON] format such as NDJSON, @@ -502,7 +502,7 @@ JSON Lines, or JSON Text Sequences. The `Jackson2Encoder` works as follows: -* For a single value publisher (e.g. `Mono`), simply serialize it through the +* For a single value publisher (for example, `Mono`), simply serialize it through the `ObjectMapper`. * For a multi-value publisher with `application/json`, by default collect the values with `Flux#collectToList()` and then serialize the resulting collection. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc-cors.adoc b/framework-docs/modules/ROOT/pages/web/webmvc-cors.adoc index 80f486b6684b..1dfa7da19d65 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc-cors.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc-cors.adoc @@ -88,7 +88,7 @@ class- or method-level `@CrossOrigin` annotations (other handlers can implement The rules for combining global and local configuration are generally additive -- for example, all global and all local origins. For those attributes where only a single value can be -accepted, e.g. `allowCredentials` and `maxAge`, the local overrides the global value. See +accepted, for example, `allowCredentials` and `maxAge`, the local overrides the global value. See {spring-framework-api}/web/cors/CorsConfiguration.html#combine-org.springframework.web.cors.CorsConfiguration-[`CorsConfiguration#combine(CorsConfiguration)`] for more details. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-ann-rest-exceptions.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-ann-rest-exceptions.adoc index adc8da9c8e0b..7ba90e555ef9 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-ann-rest-exceptions.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-ann-rest-exceptions.adoc @@ -64,7 +64,7 @@ this `Map`. You can also extend `ProblemDetail` to add dedicated non-standard properties. The copy constructor in `ProblemDetail` allows a subclass to make it easy to be created -from an existing `ProblemDetail`. This could be done centrally, e.g. from an +from an existing `ProblemDetail`. This could be done centrally, for example, from an `@ControllerAdvice` such as `ResponseEntityExceptionHandler` that re-creates the `ProblemDetail` of an exception into a subclass with the additional non-standard fields. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/static-resources.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/static-resources.adoc index 008832cfd954..362adf674df0 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/static-resources.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/static-resources.adoc @@ -58,7 +58,7 @@ include the version of the jar and can also match against incoming URLs without -- for example, from `/webjars/jquery/jquery.min.js` to `/webjars/jquery/1.2.0/jquery.min.js`. TIP: The Java configuration based on `ResourceHandlerRegistry` provides further options -for fine-grained control, e.g. last-modified behavior and optimized resource resolution. +for fine-grained control, for example, last-modified behavior and optimized resource resolution. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-exceptionhandler.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-exceptionhandler.adoc index 08c7961c15b0..e13037ded80d 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-exceptionhandler.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-exceptionhandler.adoc @@ -13,8 +13,8 @@ include-code::./SimpleController[indent=0] [[mvc-ann-exceptionhandler-exc]] == Exception Mapping -The exception may match against a top-level exception being propagated (e.g. a direct -`IOException` being thrown) or against a nested cause within a wrapper exception (e.g. +The exception may match against a top-level exception being propagated (for example, a direct +`IOException` being thrown) or against a nested cause within a wrapper exception (for example, an `IOException` wrapped inside an `IllegalStateException`). As of 5.3, this can match at arbitrary cause levels, whereas previously only an immediate cause was considered. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/modelattrib-method-args.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/modelattrib-method-args.adoc index c40040241754..7a04b5ba7f13 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/modelattrib-method-args.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/modelattrib-method-args.adoc @@ -117,7 +117,7 @@ parameters. While `@BindParam` is supported out of the box, you can also use a different annotation by setting a `DataBinder.NameResolver` on `DataBinder` Constructor binding supports `List`, `Map`, and array arguments either converted from -a single string, e.g. comma-separated list, or based on indexed keys such as +a single string, for example, comma-separated list, or based on indexed keys such as `accounts[2].name` or `account[KEY].name`. In some cases, you may want access to a model attribute without data binding. For such diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responsebody.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responsebody.adoc index 51d0188a4b98..8d2d827cee38 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responsebody.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responsebody.adoc @@ -42,7 +42,7 @@ content of the provided resource to the response `OutputStream`. Note that the `InputStream` should be lazily retrieved by the `Resource` handle in order to reliably close it after it has been copied to the response. If you are using `InputStreamResource` for such a purpose, make sure to construct it with an on-demand `InputStreamSource` -(e.g. through a lambda expression that retrieves the actual `InputStream`). +(for example, through a lambda expression that retrieves the actual `InputStream`). You can use `@ResponseBody` with reactive types. See xref:web/webmvc/mvc-ann-async.adoc[Asynchronous Requests] and xref:web/webmvc/mvc-ann-async.adoc#mvc-ann-async-reactive-types[Reactive Types] for more details. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responseentity.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responseentity.adoc index 89f4715aa32a..f61a9878b1f5 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responseentity.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/responseentity.adoc @@ -33,14 +33,14 @@ Kotlin:: ====== The body will usually be provided as a value object to be rendered to a corresponding -response representation (e.g. JSON) by one of the registered `HttpMessageConverters`. +response representation (for example, JSON) by one of the registered `HttpMessageConverters`. A `ResponseEntity` can be returned for file content, copying the `InputStream` content of the provided resource to the response `OutputStream`. Note that the `InputStream` should be lazily retrieved by the `Resource` handle in order to reliably close it after it has been copied to the response. If you are using `InputStreamResource` for such a purpose, make sure to construct it with an on-demand `InputStreamSource` -(e.g. through a lambda expression that retrieves the actual `InputStream`). Also, custom +(for example, through a lambda expression that retrieves the actual `InputStream`). Also, custom subclasses of `InputStreamResource` are only supported in combination with a custom `contentLength()` implementation which avoids consuming the stream for that purpose. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/return-types.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/return-types.adoc index 189bf5e0f8f5..557de2db3ca2 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/return-types.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/return-types.adoc @@ -93,9 +93,9 @@ supported for all return values. `ResponseEntity`. See xref:web/webmvc/mvc-ann-async.adoc[Asynchronous Requests] and xref:web/webmvc/mvc-ann-async.adoc#mvc-ann-async-http-streaming[HTTP Streaming]. | Reactor and other reactive types registered via `ReactiveAdapterRegistry` -| A single value type, e.g. `Mono`, is comparable to returning `DeferredResult`. - A multi-value type, e.g. `Flux`, may be treated as a stream depending on the requested - media type, e.g. "text/event-stream", "application/json+stream", or otherwise is +| A single value type, for example, `Mono`, is comparable to returning `DeferredResult`. + A multi-value type, for example, `Flux`, may be treated as a stream depending on the requested + media type, for example, "text/event-stream", "application/json+stream", or otherwise is collected to a List and rendered as a single value. See xref:web/webmvc/mvc-ann-async.adoc[Asynchronous Requests] and xref:web/webmvc/mvc-ann-async.adoc#mvc-ann-async-reactive-types[Reactive Types]. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/typeconversion.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/typeconversion.adoc index fbaf33f89955..76f10b3d40e8 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/typeconversion.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-methods/typeconversion.adoc @@ -26,7 +26,7 @@ method intends to accept a null value as well, either declare your argument as ` or mark it as `required=false` in the corresponding `@RequestParam`, etc. annotation. This is a best practice and the recommended solution for regressions encountered in a 5.3 upgrade. -Alternatively, you may specifically handle e.g. the resulting `MissingPathVariableException` +Alternatively, you may specifically handle, for example, the resulting `MissingPathVariableException` in the case of a required `@PathVariable`. A null value after conversion will be treated like an empty original value, so the corresponding `Missing...Exception` variants will be thrown. ==== diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc index 14d6d7ce860f..f929e6ab955a 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-controller/ann-requestmapping.adoc @@ -105,7 +105,7 @@ default from version 6.0. See xref:web/webmvc/mvc-config/path-matching.adoc[MVC customizations of path matching options. `PathPattern` supports the same pattern syntax as `AntPathMatcher`. In addition, it also -supports the capturing pattern, e.g. `+{*spring}+`, for matching 0 or more path segments +supports the capturing pattern, for example, `+{*spring}+`, for matching 0 or more path segments at the end of a path. `PathPattern` also restricts the use of `+**+` for matching multiple path segments such that it's only allowed at the end of a pattern. This eliminates many cases of ambiguity when choosing the best matching pattern for a given request. @@ -272,7 +272,7 @@ To completely disable the use of path extensions in versions prior to 5.3, set t * `favorPathExtension(false)`, see xref:web/webmvc/mvc-config/content-negotiation.adoc[ContentNegotiationConfigurer] Having a way to request content types other than through the `"Accept"` header can still -be useful, e.g. when typing a URL in a browser. A safe alternative to path extensions is +be useful, for example, when typing a URL in a browser. A safe alternative to path extensions is to use the query parameter strategy. If you must use file extensions, consider restricting them to a list of explicitly registered extensions through the `mediaTypes` property of xref:web/webmvc/mvc-config/content-negotiation.adoc[ContentNegotiationConfigurer]. diff --git a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/viewresolver.adoc b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/viewresolver.adoc index 27daeeb49137..e7e5dad266f3 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/viewresolver.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet/viewresolver.adoc @@ -47,7 +47,7 @@ The following table provides more details on the `ViewResolver` hierarchy: | Implementation of the `ViewResolver` interface that interprets a view name as a bean name in the current application context. This is a very flexible variant which allows for mixing and matching different view types based on distinct view names. - Each such `View` can be defined as a bean e.g. in XML or in configuration classes. + Each such `View` can be defined as a bean, for example, in XML or in configuration classes. |=== diff --git a/framework-docs/modules/ROOT/pages/web/websocket/server.adoc b/framework-docs/modules/ROOT/pages/web/websocket/server.adoc index 5d5bbf5fa6fa..13c005fedf34 100644 --- a/framework-docs/modules/ROOT/pages/web/websocket/server.adoc +++ b/framework-docs/modules/ROOT/pages/web/websocket/server.adoc @@ -29,7 +29,7 @@ WebSocket support does not depend on Spring MVC. It is relatively simple to integrate a `WebSocketHandler` into other HTTP-serving environments with the help of {spring-framework-api}/web/socket/server/support/WebSocketHttpRequestHandler.html[`WebSocketHttpRequestHandler`]. -When using the `WebSocketHandler` API directly vs indirectly, e.g. through the +When using the `WebSocketHandler` API directly vs indirectly, for example, through the xref:web/websocket/stomp.adoc[STOMP] messaging, the application must synchronize the sending of messages since the underlying standard WebSocket session (JSR-356) does not allow concurrent sending. One option is to wrap the `WebSocketSession` with diff --git a/framework-docs/modules/ROOT/partials/web/forwarded-headers.adoc b/framework-docs/modules/ROOT/partials/web/forwarded-headers.adoc index 9ba46a5f832a..a56c0d1893ed 100644 --- a/framework-docs/modules/ROOT/partials/web/forwarded-headers.adoc +++ b/framework-docs/modules/ROOT/partials/web/forwarded-headers.adoc @@ -38,7 +38,7 @@ to inform the server that the original port was `443`. ==== X-Forwarded-Proto While not standard, https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto[`X-Forwarded-Proto: (https|http)`] -is a de-facto standard header that is used to communicate the original protocol (e.g. https / https) +is a de-facto standard header that is used to communicate the original protocol (for example, https / https) to a downstream server. For example, if a request of `https://example.com/resource` is sent to a proxy which forwards the request to `http://localhost:8080/resource`, then a header of `X-Forwarded-Proto: https` can be sent to inform the server that the original protocol was `https`. @@ -48,7 +48,7 @@ a proxy which forwards the request to `http://localhost:8080/resource`, then a h ==== X-Forwarded-Ssl While not standard, `X-Forwarded-Ssl: (on|off)` is a de-facto standard header that is used to communicate the -original protocol (e.g. https / https) to a downstream server. For example, if a request of +original protocol (for example, https / https) to a downstream server. For example, if a request of `https://example.com/resource` is sent to a proxy which forwards the request to `http://localhost:8080/resource`, then a header of `X-Forwarded-Ssl: on` to inform the server that the original protocol was `https`. @@ -103,7 +103,7 @@ applications on the same server. However, this should not be visible in URL path the public API where applications may use different subdomains that provides benefits such as: -* Added security, e.g. same origin policy +* Added security, for example, same origin policy * Independent scaling of applications (different domain points to different IP address) ==== diff --git a/framework-docs/modules/ROOT/partials/web/websocket-intro.adoc b/framework-docs/modules/ROOT/partials/web/websocket-intro.adoc index 8598a214be91..60c972a4147c 100644 --- a/framework-docs/modules/ROOT/partials/web/websocket-intro.adoc +++ b/framework-docs/modules/ROOT/partials/web/websocket-intro.adoc @@ -46,7 +46,7 @@ A complete introduction of how WebSockets work is beyond the scope of this docum See RFC 6455, the WebSocket chapter of HTML5, or any of the many introductions and tutorials on the Web. -Note that, if a WebSocket server is running behind a web server (e.g. nginx), you +Note that, if a WebSocket server is running behind a web server (for example, nginx), you likely need to configure it to pass WebSocket upgrade requests on to the WebSocket server. Likewise, if the application runs in a cloud environment, check the instructions of the cloud provider related to WebSocket support. diff --git a/spring-aop/src/main/java/org/aopalliance/intercept/ConstructorInterceptor.java b/spring-aop/src/main/java/org/aopalliance/intercept/ConstructorInterceptor.java index 08b02a502fa2..a814d1f8a7e8 100644 --- a/spring-aop/src/main/java/org/aopalliance/intercept/ConstructorInterceptor.java +++ b/spring-aop/src/main/java/org/aopalliance/intercept/ConstructorInterceptor.java @@ -23,7 +23,7 @@ * *

The user should implement the {@link * #construct(ConstructorInvocation)} method to modify the original - * behavior. E.g. the following class implements a singleton + * behavior. For example, the following class implements a singleton * interceptor (allows only one unique instance for the intercepted * class): * diff --git a/spring-aop/src/main/java/org/aopalliance/intercept/MethodInterceptor.java b/spring-aop/src/main/java/org/aopalliance/intercept/MethodInterceptor.java index 9188e25e1d0d..a601fba50c6d 100644 --- a/spring-aop/src/main/java/org/aopalliance/intercept/MethodInterceptor.java +++ b/spring-aop/src/main/java/org/aopalliance/intercept/MethodInterceptor.java @@ -24,7 +24,7 @@ * are nested "on top" of the target. * *

The user should implement the {@link #invoke(MethodInvocation)} - * method to modify the original behavior. E.g. the following class + * method to modify the original behavior. For example, the following class * implements a tracing interceptor (traces all the calls on the * intercepted method(s)): * diff --git a/spring-aop/src/main/java/org/springframework/aop/Pointcut.java b/spring-aop/src/main/java/org/springframework/aop/Pointcut.java index ffcf92ef316c..fc860df1c360 100644 --- a/spring-aop/src/main/java/org/springframework/aop/Pointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/Pointcut.java @@ -21,7 +21,7 @@ * *

A pointcut is composed of a {@link ClassFilter} and a {@link MethodMatcher}. * Both these basic terms and a Pointcut itself can be combined to build up combinations - * (e.g. through {@link org.springframework.aop.support.ComposablePointcut}). + * (for example, through {@link org.springframework.aop.support.ComposablePointcut}). * * @author Rod Johnson * @see ClassFilter diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AnnotationAwareAspectJAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AnnotationAwareAspectJAutoProxyCreator.java index 45ea4983644c..926392693e31 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AnnotationAwareAspectJAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AnnotationAwareAspectJAutoProxyCreator.java @@ -103,7 +103,7 @@ protected boolean isInfrastructureClass(Class beanClass) { // broad an impact. Instead we now override isInfrastructureClass to avoid proxying // aspects. I'm not entirely happy with that as there is no good reason not // to advise aspects, except that it causes advice invocation to go through a - // proxy, and if the aspect implements e.g the Ordered interface it will be + // proxy, and if the aspect implements, for example, the Ordered interface it will be // proxied by that interface and fail at runtime as the advice method is not // defined on the interface. We could potentially relax the restriction about // not advising aspects in the future. diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectMetadata.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectMetadata.java index a70aed625cc9..2775bc9fd32c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectMetadata.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectMetadata.java @@ -160,7 +160,7 @@ public String getAspectName() { /** * Return a Spring pointcut expression for a singleton aspect. - * (e.g. {@code Pointcut.TRUE} if it's a singleton). + * (for example, {@code Pointcut.TRUE} if it's a singleton). */ public Pointcut getPerClausePointcut() { return this.perClausePointcut; diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AbstractAdvisingBeanPostProcessor.java b/spring-aop/src/main/java/org/springframework/aop/framework/AbstractAdvisingBeanPostProcessor.java index 1b021c7cd8d3..95eeda4a7a83 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AbstractAdvisingBeanPostProcessor.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AbstractAdvisingBeanPostProcessor.java @@ -135,7 +135,7 @@ else if (advised.getTargetSource() == AdvisedSupport.EMPTY_TARGET_SOURCE && * Check whether the given bean is eligible for advising with this * post-processor's {@link Advisor}. *

Delegates to {@link #isEligible(Class)} for target class checking. - * Can be overridden e.g. to specifically exclude certain beans by name. + * Can be overridden, for example, to specifically exclude certain beans by name. *

Note: Only called for regular bean instances but not for existing * proxy instances which implement {@link Advised} and allow for adding * the local {@link Advisor} to the existing proxy's {@link Advisor} chain. diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AbstractSingletonProxyFactoryBean.java b/spring-aop/src/main/java/org/springframework/aop/framework/AbstractSingletonProxyFactoryBean.java index cf40782c784a..fa1642835c0e 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AbstractSingletonProxyFactoryBean.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AbstractSingletonProxyFactoryBean.java @@ -91,7 +91,7 @@ public void setProxyInterfaces(Class[] proxyInterfaces) { /** * Set additional interceptors (or advisors) to be applied before the - * implicit transaction interceptor, e.g. a PerformanceMonitorInterceptor. + * implicit transaction interceptor, for example, a PerformanceMonitorInterceptor. *

You may specify any AOP Alliance MethodInterceptors or other * Spring AOP Advices, as well as Spring AOP Advisors. * @see org.springframework.aop.interceptor.PerformanceMonitorInterceptor diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/ReflectiveMethodInvocation.java b/spring-aop/src/main/java/org/springframework/aop/framework/ReflectiveMethodInvocation.java index cc29883d590a..b5ad8c36f1e0 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/ReflectiveMethodInvocation.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/ReflectiveMethodInvocation.java @@ -47,7 +47,7 @@ * *

NOTE: This class is considered internal and should not be * directly accessed. The sole reason for it being public is compatibility - * with existing framework integrations (e.g. Pitchfork). For any other + * with existing framework integrations (for example, Pitchfork). For any other * purposes, use the {@link ProxyMethodInvocation} interface instead. * * @author Rod Johnson diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java index 599ccf6de9ed..ffdf6173f126 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java @@ -71,7 +71,7 @@ * Instead of x repetitive proxy definitions for x target beans, you can register * one single such post processor with the bean factory to achieve the same effect. * - *

Subclasses can apply any strategy to decide if a bean is to be proxied, e.g. by type, + *

Subclasses can apply any strategy to decide if a bean is to be proxied, for example, by type, * by name, by definition details, etc. They can also return additional interceptors that * should just be applied to the specific bean instance. A simple concrete implementation is * {@link BeanNameAutoProxyCreator}, identifying the beans to be proxied via given names. @@ -403,7 +403,7 @@ protected boolean isInfrastructureClass(Class beanClass) { /** * Subclasses should override this method to return {@code true} if the * given bean should not be considered for auto-proxying by this post-processor. - *

Sometimes we need to be able to avoid this happening, e.g. if it will lead to + *

Sometimes we need to be able to avoid this happening, for example, if it will lead to * a circular reference or if the existing target instance needs to be preserved. * This implementation returns {@code false} unless the bean name indicates an * "original instance" according to {@code AutowireCapableBeanFactory} conventions. @@ -619,7 +619,7 @@ protected void customizeProxyFactory(ProxyFactory proxyFactory) { /** * Return whether the given bean is to be proxied, what additional - * advices (e.g. AOP Alliance interceptors) and advisors to apply. + * advices (for example, AOP Alliance interceptors) and advisors to apply. * @param beanClass the class of the bean to advise * @param beanName the name of the bean * @param customTargetSource the TargetSource returned by the diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AutoProxyUtils.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AutoProxyUtils.java index 1de9382a2e2c..92c25b432d5d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AutoProxyUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AutoProxyUtils.java @@ -47,7 +47,7 @@ public abstract class AutoProxyUtils { /** * Bean definition attribute that indicates the original target class of an - * auto-proxied bean, e.g. to be used for the introspection of annotations + * auto-proxied bean, for example, to be used for the introspection of annotations * on the target class behind an interface-based proxy. * @since 4.2.3 * @see #determineTargetClass diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java index c9ea561366a4..27aa0547363c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanNameAutoProxyCreator.java @@ -54,13 +54,13 @@ public class BeanNameAutoProxyCreator extends AbstractAutoProxyCreator { /** * Set the names of the beans that should automatically get wrapped with proxies. - * A name can specify a prefix to match by ending with "*", e.g. "myBean,tx*" + * A name can specify a prefix to match by ending with "*", for example, "myBean,tx*" * will match the bean named "myBean" and all beans whose name start with "tx". *

NOTE: In case of a FactoryBean, only the objects created by the * 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 * 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 "&": for example, "&myFactoryBean". * @see org.springframework.beans.factory.FactoryBean * @see org.springframework.beans.factory.BeanFactory#FACTORY_BEAN_PREFIX */ diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java index a9b63d90091e..07c37c3cd741 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java @@ -52,7 +52,7 @@ *

Provides support for executor qualification on a method-by-method basis. * {@code AsyncExecutionAspectSupport} objects must be constructed with a default {@code * Executor}, but each individual method may further qualify a specific {@code Executor} - * bean to be used when executing it, e.g. through an annotation attribute. + * bean to be used when executing it, for example, through an annotation attribute. * * @author Chris Beams * @author Juergen Hoeller diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionInterceptor.java index 049cd3b623cd..933375922447 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionInterceptor.java @@ -148,7 +148,7 @@ protected String getExecutorQualifier(Method method) { /** * This implementation searches for a unique {@link org.springframework.core.task.TaskExecutor} * bean in the context, or for an {@link Executor} bean named "taskExecutor" otherwise. - * If neither of the two is resolvable (e.g. if no {@code BeanFactory} was configured at all), + * If neither of the two is resolvable (for example, if no {@code BeanFactory} was configured at all), * this implementation falls back to a newly created {@link SimpleAsyncTaskExecutor} instance * for local use if no default could be found. * @see #DEFAULT_TASK_EXECUTOR_BEAN_NAME diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/ConcurrencyThrottleInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/ConcurrencyThrottleInterceptor.java index dd802ce813bd..3e6e6e9b7c5b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/ConcurrencyThrottleInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/ConcurrencyThrottleInterceptor.java @@ -31,7 +31,7 @@ *

Can be applied to methods of local services that involve heavy use * of system resources, in a scenario where it is more efficient to * throttle concurrency for a specific service rather than restricting - * the entire thread pool (e.g. the web container's thread pool). + * the entire thread pool (for example, the web container's thread pool). * *

The default concurrency limit of this interceptor is 1. * Specify the "concurrencyLimit" bean property to change this value. diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeInvocationInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeInvocationInterceptor.java index 9822374da1a3..18c9caf1ea87 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeInvocationInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeInvocationInterceptor.java @@ -30,7 +30,7 @@ /** * Interceptor that exposes the current {@link org.aopalliance.intercept.MethodInvocation} * as a thread-local object. We occasionally need to do this; for example, when a pointcut - * (e.g. an AspectJ expression pointcut) needs to know the full invocation context. + * (for example, an AspectJ expression pointcut) needs to know the full invocation context. * *

Don't use this interceptor unless this is really necessary. Target objects should * not normally know about Spring AOP, as this creates a dependency on Spring API. diff --git a/spring-aop/src/main/java/org/springframework/aop/support/AbstractRegexpMethodPointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/AbstractRegexpMethodPointcut.java index 30fead6732fe..acb56fd468d2 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/AbstractRegexpMethodPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/AbstractRegexpMethodPointcut.java @@ -29,7 +29,7 @@ * Abstract base regular expression pointcut bean. JavaBean properties are: *

    *
  • pattern: regular expression for the fully-qualified method names to match. - * The exact regexp syntax will depend on the subclass (e.g. Perl5 regular expressions) + * The exact regexp syntax will depend on the subclass (for example, Perl5 regular expressions) *
  • patterns: alternative property taking a String array of patterns. * The result will be the union of these patterns. *
diff --git a/spring-aop/src/main/java/org/springframework/aop/support/AopUtils.java b/spring-aop/src/main/java/org/springframework/aop/support/AopUtils.java index ee1c342318d3..38eba72e6d7a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/AopUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/AopUtils.java @@ -194,7 +194,7 @@ public static boolean isFinalizeMethod(@Nullable Method method) { /** * Given a method, which may come from an interface, and a target class used * in the current AOP invocation, find the corresponding target method if there - * is one. E.g. the method may be {@code IFoo.bar()} and the target class + * is one. For example, the method may be {@code IFoo.bar()} and the target class * may be {@code DefaultFoo}. In this case, the method may be * {@code DefaultFoo.bar()}. This enables attributes on that method to be found. *

NOTE: In contrast to {@link org.springframework.util.ClassUtils#getMostSpecificMethod}, diff --git a/spring-aop/src/test/java/org/springframework/aop/support/ControlFlowPointcutTests.java b/spring-aop/src/test/java/org/springframework/aop/support/ControlFlowPointcutTests.java index 65c08b8725f5..a291b4a6e6a1 100644 --- a/spring-aop/src/test/java/org/springframework/aop/support/ControlFlowPointcutTests.java +++ b/spring-aop/src/test/java/org/springframework/aop/support/ControlFlowPointcutTests.java @@ -93,7 +93,7 @@ void controlFlowPointcutIsExtensible() { /** * Check that we can use a cflow pointcut in conjunction with - * a static pointcut: e.g. all setter methods that are invoked under + * a static pointcut: for example, all setter methods that are invoked under * a particular class. This greatly reduces the number of calls * to the cflow pointcut, meaning that it's not so prohibitively * expensive. diff --git a/spring-beans/src/main/java/org/springframework/beans/AbstractNestablePropertyAccessor.java b/spring-beans/src/main/java/org/springframework/beans/AbstractNestablePropertyAccessor.java index 04fc76399ad1..6f2e5eff3384 100644 --- a/spring-beans/src/main/java/org/springframework/beans/AbstractNestablePropertyAccessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/AbstractNestablePropertyAccessor.java @@ -474,7 +474,7 @@ private void processLocalProperty(PropertyTokenHolder tokens, PropertyValue pv) else { Throwable cause = ex.getTargetException(); if (cause instanceof UndeclaredThrowableException) { - // May happen e.g. with Groovy-generated methods + // May happen, for example, with Groovy-generated methods cause = cause.getCause(); } throw new MethodInvocationException(propertyChangeEvent, cause); diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanInfoFactory.java b/spring-beans/src/main/java/org/springframework/beans/BeanInfoFactory.java index 3ad632b25439..395035467132 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanInfoFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanInfoFactory.java @@ -23,7 +23,7 @@ /** * Strategy interface for creating {@link BeanInfo} instances for Spring beans. - * Can be used to plug in custom bean property resolution strategies (e.g. for other + * Can be used to plug in custom bean property resolution strategies (for example, for other * languages on the JVM) or more efficient {@link BeanInfo} retrieval algorithms. * *

BeanInfoFactories are instantiated by the {@link CachedIntrospectionResults}, diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java b/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java index cedf0408f2a3..3450320d861d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java @@ -125,7 +125,7 @@ public static T instantiate(Class clazz) throws BeanInstantiationExceptio * The cause may notably indicate a {@link NoSuchMethodException} if no * primary/default constructor was found, a {@link NoClassDefFoundError} * or other {@link LinkageError} in case of an unresolvable class definition - * (e.g. due to a missing dependency at runtime), or an exception thrown + * (for example, due to a missing dependency at runtime), or an exception thrown * from the constructor invocation itself. * @see Constructor#newInstance */ @@ -248,7 +248,7 @@ else if (ctors.length == 0) { // No public constructors -> check non-public ctors = clazz.getDeclaredConstructors(); if (ctors.length == 1) { - // A single non-public constructor, e.g. from a non-public record type + // A single non-public constructor, for example, from a non-public record type return (Constructor) ctors[0]; } } @@ -538,7 +538,7 @@ public static PropertyDescriptor findPropertyForMethod(Method method, Class c /** * Find a JavaBeans PropertyEditor following the 'Editor' suffix convention - * (e.g. "mypackage.MyDomainClass" → "mypackage.MyDomainClassEditor"). + * (for example, "mypackage.MyDomainClass" → "mypackage.MyDomainClassEditor"). *

Compatible to the standard JavaBeans convention as implemented by * {@link java.beans.PropertyEditorManager} but isolated from the latter's * registered default editors for primitive types. @@ -560,7 +560,7 @@ public static PropertyEditor findEditorByConvention(@Nullable Class targetTyp } } catch (Throwable ex) { - // e.g. AccessControlException on Google App Engine + // for example, AccessControlException on Google App Engine return null; } } diff --git a/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java b/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java index 21acc8141be7..f29a9d30407d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java +++ b/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java @@ -107,7 +107,7 @@ public final class CachedIntrospectionResults { * Accept the given ClassLoader as cache-safe, even if its classes would * not qualify as cache-safe in this CachedIntrospectionResults class. *

This configuration method is only relevant in scenarios where the Spring - * classes reside in a 'common' ClassLoader (e.g. the system ClassLoader) + * classes reside in a 'common' ClassLoader (for example, the system ClassLoader) * whose lifecycle is not coupled to the application. In such a scenario, * CachedIntrospectionResults would by default not cache any of the application's * classes, since they would create a leak in the common ClassLoader. @@ -290,7 +290,7 @@ private CachedIntrospectionResults(Class beanClass) throws BeansException { currClass = currClass.getSuperclass(); } - // Check for record-style accessors without prefix: e.g. "lastName()" + // Check for record-style accessors without prefix: for example, "lastName()" // - accessor method directly referring to instance field of same name // - same convention for component accessors of Java 15 record classes introspectPlainAccessors(beanClass, readMethodNames); diff --git a/spring-beans/src/main/java/org/springframework/beans/ExtendedBeanInfo.java b/spring-beans/src/main/java/org/springframework/beans/ExtendedBeanInfo.java index 804ef9d21b31..5cd244f80f9c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/ExtendedBeanInfo.java +++ b/spring-beans/src/main/java/org/springframework/beans/ExtendedBeanInfo.java @@ -41,7 +41,7 @@ import org.springframework.util.ObjectUtils; /** - * Decorator for a standard {@link BeanInfo} object, e.g. as created by + * Decorator for a standard {@link BeanInfo} object, for example, as created by * {@link Introspector#getBeanInfo(Class)}, designed to discover and register * static and/or non-void returning setter methods. For example: * diff --git a/spring-beans/src/main/java/org/springframework/beans/FatalBeanException.java b/spring-beans/src/main/java/org/springframework/beans/FatalBeanException.java index 7c6e1d941cb5..78d9e5c62f39 100644 --- a/spring-beans/src/main/java/org/springframework/beans/FatalBeanException.java +++ b/spring-beans/src/main/java/org/springframework/beans/FatalBeanException.java @@ -20,7 +20,7 @@ /** * Thrown on an unrecoverable problem encountered in the - * beans packages or sub-packages, e.g. bad class or field. + * beans packages or sub-packages, for example, bad class or field. * * @author Rod Johnson */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanDefinitionStoreException.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanDefinitionStoreException.java index d807d5f90179..f97c34b086e2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanDefinitionStoreException.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanDefinitionStoreException.java @@ -21,7 +21,7 @@ /** * Exception thrown when a BeanFactory encounters an invalid bean definition: - * e.g. in case of incomplete or contradictory bean metadata. + * for example, in case of incomplete or contradictory bean metadata. * * @author Rod Johnson * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactory.java index 8973cf271e5e..fb1f3ffd9df2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactory.java @@ -36,7 +36,7 @@ * singleton in the scope of the factory). Which type of instance will be returned * depends on the bean factory configuration: the API is the same. Since Spring * 2.0, further scopes are available depending on the concrete application - * context (e.g. "request" and "session" scopes in a web environment). + * context (for example, "request" and "session" scopes in a web environment). * *

The point of this approach is that the BeanFactory is a central registry * of application components, and centralizes configuration of application diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/InitializingBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/InitializingBean.java index 940c2dd922a9..a062dc9e1aa9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/InitializingBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/InitializingBean.java @@ -18,7 +18,7 @@ /** * Interface to be implemented by beans that need to react once all their properties - * have been set by a {@link BeanFactory}: e.g. to perform custom initialization, + * have been set by a {@link BeanFactory}: for example, to perform custom initialization, * or merely to check that all mandatory properties have been set. * *

An alternative to implementing {@code InitializingBean} is specifying a custom diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectProvider.java b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectProvider.java index 465162e0ba27..44e3b55f7df5 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectProvider.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectProvider.java @@ -38,10 +38,10 @@ * iteration and allows for collection-style {@link #stream} access. * *

As of 6.2, this interface declares default implementations for all methods. - * This makes it easier to implement in a custom fashion, e.g. for unit tests. + * This makes it easier to implement in a custom fashion, for example, for unit tests. * For typical purposes, implement {@link #stream()} to enable all other methods. * Alternatively, you may implement the specific methods that your callers expect, - * e.g. just {@link #getObject()} or {@link #getIfAvailable()}. + * for example, just {@link #getObject()} or {@link #getIfAvailable()}. * * @author Juergen Hoeller * @since 4.3 diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/SmartInitializingSingleton.java b/spring-beans/src/main/java/org/springframework/beans/factory/SmartInitializingSingleton.java index 3df636346b9c..fa26c908f18c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/SmartInitializingSingleton.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/SmartInitializingSingleton.java @@ -21,7 +21,7 @@ * during {@link BeanFactory} bootstrap. This interface can be implemented by * singleton beans in order to perform some initialization after the regular * singleton instantiation algorithm, avoiding side effects with accidental early - * initialization (e.g. from {@link ListableBeanFactory#getBeansOfType} calls). + * initialization (for example, from {@link ListableBeanFactory#getBeansOfType} calls). * In that sense, it is an alternative to {@link InitializingBean} which gets * triggered right at the end of a bean's local construction phase. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/BeanFactoryAnnotationUtils.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/BeanFactoryAnnotationUtils.java index 4036b74f59db..7df476fe5404 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/BeanFactoryAnnotationUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/BeanFactoryAnnotationUtils.java @@ -50,7 +50,7 @@ public abstract class BeanFactoryAnnotationUtils { /** * Retrieve all beans of type {@code T} from the given {@code BeanFactory} declaring a - * qualifier (e.g. via {@code } or {@code @Qualifier}) matching the given + * qualifier (for example, via {@code } or {@code @Qualifier}) matching the given * qualifier, or having a bean name matching the given qualifier. * @param beanFactory the factory to get the target beans from (also searching ancestors) * @param beanType the type of beans to retrieve @@ -75,7 +75,7 @@ public static Map qualifiedBeansOfType( /** * Obtain a bean of type {@code T} from the given {@code BeanFactory} declaring a - * qualifier (e.g. via {@code } or {@code @Qualifier}) matching the given + * qualifier (for example, via {@code } or {@code @Qualifier}) matching the given * qualifier, or having a bean name matching the given qualifier. * @param beanFactory the factory to get the target bean from (also searching ancestors) * @param beanType the type of bean to retrieve @@ -109,7 +109,7 @@ else if (beanFactory.containsBean(qualifier)) { /** * Obtain a bean of type {@code T} from the given {@code BeanFactory} declaring a qualifier - * (e.g. {@code } or {@code @Qualifier}) matching the given qualifier). + * (for example, {@code } or {@code @Qualifier}) matching the given qualifier). * @param bf the factory to get the target bean from * @param beanType the type of bean to retrieve * @param qualifier the qualifier for selecting between multiple bean matches diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/ParameterResolutionDelegate.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/ParameterResolutionDelegate.java index f8f7b0dce6f4..a9dee0daa727 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/ParameterResolutionDelegate.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/ParameterResolutionDelegate.java @@ -153,7 +153,7 @@ public static Object resolveDependency( * an empty {@code AnnotatedElement}. *

WARNING

*

The {@code AnnotatedElement} returned by this method should never be cast and - * treated as a {@code Parameter} since the metadata (e.g., {@link Parameter#getName()}, + * treated as a {@code Parameter} since the metadata (for example, {@link Parameter#getName()}, * {@link Parameter#getType()}, etc.) will not match those for the declared parameter * at the given index in an inner class constructor. * @return the supplied {@code parameter} or the effective {@code Parameter} diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/AutowireCapableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/AutowireCapableBeanFactory.java index efda24780820..cd7044c89f46 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/AutowireCapableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/AutowireCapableBeanFactory.java @@ -105,7 +105,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Suffix for the "original instance" convention when initializing an existing * bean instance: to be appended to the fully-qualified bean class name, - * e.g. "com.mypackage.MyClass.ORIGINAL", in order to enforce the given instance + * for example, "com.mypackage.MyClass.ORIGINAL", in order to enforce the given instance * to be returned, i.e. no proxies etc. * @since 5.1 * @see #initializeBean(Object, String) @@ -128,7 +128,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { * Constructor resolution is based on Kotlin primary / single public / single non-public, * with a fallback to the default constructor in ambiguous scenarios, also influenced * by {@link SmartInstantiationAwareBeanPostProcessor#determineCandidateConstructors} - * (e.g. for annotation-driven constructor selection). + * (for example, for annotation-driven constructor selection). * @param beanClass the class of the bean to create * @return the new bean instance * @throws BeansException if instantiation or wiring failed @@ -137,7 +137,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Populate the given bean instance through applying after-instantiation callbacks - * and bean property post-processing (e.g. for annotation-driven injection). + * and bean property post-processing (for example, for annotation-driven injection). *

Note: This is essentially intended for (re-)populating annotated fields and * methods, either for new instances or for deserialized instances. It does * not imply traditional by-name or by-type autowiring of properties; @@ -196,7 +196,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { * Instantiate a new bean instance of the given class with the specified autowire * strategy. All constants defined in this interface are supported here. * Can also be invoked with {@code AUTOWIRE_NO} in order to just apply - * before-instantiation callbacks (e.g. for annotation-driven injection). + * before-instantiation callbacks (for example, for annotation-driven injection). *

Does not apply standard {@link BeanPostProcessor BeanPostProcessors} * callbacks or perform any further initialization of the bean. This interface * offers distinct, fine-grained operations for those purposes, for example @@ -223,7 +223,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Autowire the bean properties of the given bean instance by name or type. * Can also be invoked with {@code AUTOWIRE_NO} in order to just apply - * after-instantiation callbacks (e.g. for annotation-driven injection). + * after-instantiation callbacks (for example, for annotation-driven injection). *

Does not apply standard {@link BeanPostProcessor BeanPostProcessors} * callbacks or perform any further initialization of the bean. This interface * offers distinct, fine-grained operations for those purposes, for example diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableBeanFactory.java index 8b46ee31b230..af9616b44a17 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableBeanFactory.java @@ -241,7 +241,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single boolean hasEmbeddedValueResolver(); /** - * Resolve the given embedded value, e.g. an annotation attribute. + * Resolve the given embedded value, for example, an annotation attribute. * @param value the value to resolve * @return the resolved value (may be the original value as-is) * @since 3.0 @@ -255,7 +255,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single *

Note: Post-processors submitted here will be applied in the order of * registration; any ordering semantics expressed through implementing the * {@link org.springframework.core.Ordered} interface will be ignored. Note - * that autodetected post-processors (e.g. as beans in an ApplicationContext) + * that autodetected post-processors (for example, as beans in an ApplicationContext) * will always be applied after programmatically registered ones. * @param beanPostProcessor the post-processor to register */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableListableBeanFactory.java index 249d6bc31d1b..fe451841ab42 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConfigurableListableBeanFactory.java @@ -66,13 +66,13 @@ public interface ConfigurableListableBeanFactory * Register a special dependency type with corresponding autowired value. *

This is intended for factory/context references that are supposed * to be autowirable but are not defined as beans in the factory: - * e.g. a dependency of type ApplicationContext resolved to the + * for example, a dependency of type ApplicationContext resolved to the * ApplicationContext instance that the bean is living in. *

Note: There are no such default types registered in a plain BeanFactory, * not even for the BeanFactory interface itself. * @param dependencyType the dependency type to register. This will typically * be a base interface such as BeanFactory, with extensions of it resolved - * as well if declared as an autowiring dependency (e.g. ListableBeanFactory), + * as well if declared as an autowiring dependency (for example, ListableBeanFactory), * as long as the given value actually implements the extended interface. * @param autowiredValue the corresponding autowired value. This may also be an * implementation of the {@link org.springframework.beans.factory.ObjectFactory} @@ -126,7 +126,7 @@ boolean isAutowireCandidate(String beanName, DependencyDescriptor descriptor) * Clear the merged bean definition cache, removing entries for beans * which are not considered eligible for full metadata caching yet. *

Typically triggered after changes to the original bean definitions, - * e.g. after applying a {@link BeanFactoryPostProcessor}. Note that metadata + * for example, after applying a {@link BeanFactoryPostProcessor}. Note that metadata * for beans which have already been created at this point will be kept around. * @since 4.2 * @see #getBeanDefinition diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/CustomEditorConfigurer.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/CustomEditorConfigurer.java index 9250915504c1..64963ead5435 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/CustomEditorConfigurer.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/CustomEditorConfigurer.java @@ -76,7 +76,7 @@ * *

* Also supports "java.lang.String[]"-style array class names and primitive - * class names (e.g. "boolean"). Delegates to {@link ClassUtils} for actual + * class names (for example, "boolean"). Delegates to {@link ClassUtils} for actual * class name resolution. * *

NOTE: Custom property editors registered with this configurer do diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/DependencyDescriptor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/DependencyDescriptor.java index 260f7807ea51..6617e8504ca8 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/DependencyDescriptor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/DependencyDescriptor.java @@ -180,7 +180,7 @@ public boolean isRequired() { /** * Check whether the underlying field is annotated with any variant of a - * {@code Nullable} annotation, e.g. {@code jakarta.annotation.Nullable} or + * {@code Nullable} annotation, for example, {@code jakarta.annotation.Nullable} or * {@code edu.umd.cs.findbugs.annotations.Nullable}. */ private boolean hasNullableAnnotation() { @@ -381,7 +381,7 @@ public Class getDependencyType() { /** * Determine whether this dependency supports lazy resolution, - * e.g. through extra proxying. The default is {@code true}. + * for example, through extra proxying. The default is {@code true}. * @since 6.1.2 * @see org.springframework.beans.factory.support.AutowireCandidateResolver#getLazyResolutionProxyIfNecessary */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java index dd1c542a689b..a8ba25030aff 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java @@ -31,7 +31,7 @@ public interface DestructionAwareBeanPostProcessor extends BeanPostProcessor { /** * Apply this BeanPostProcessor to the given bean instance before its - * destruction, e.g. invoking custom destruction callbacks. + * destruction, for example, invoking custom destruction callbacks. *

Like DisposableBean's {@code destroy} and a custom destroy method, this * callback will only apply to beans which the container fully manages the * lifecycle for. This is usually the case for singletons and scoped beans. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/FieldRetrievingFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/FieldRetrievingFactoryBean.java index 75cc184f3c04..6c132145b3bd 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/FieldRetrievingFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/FieldRetrievingFactoryBean.java @@ -140,7 +140,7 @@ public String getTargetField() { /** * Set a fully qualified static field name to retrieve, - * e.g. "example.MyExampleClass.MY_EXAMPLE_FIELD". + * for example, "example.MyExampleClass.MY_EXAMPLE_FIELD". * Convenient alternative to specifying targetClass and targetField. * @see #setTargetClass * @see #setTargetField @@ -190,7 +190,7 @@ public void afterPropertiesSet() throws ClassNotFoundException, NoSuchFieldExcep if (lastDotIndex == -1 || lastDotIndex == this.staticField.length()) { throw new IllegalArgumentException( "staticField must be a fully qualified class plus static field name: " + - "e.g. 'example.MyExampleClass.MY_EXAMPLE_FIELD'"); + "for example, 'example.MyExampleClass.MY_EXAMPLE_FIELD'"); } String className = this.staticField.substring(0, lastDotIndex); String fieldName = this.staticField.substring(lastDotIndex + 1); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java index fe6ac67ef80e..6e37fc17fb46 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java @@ -180,7 +180,7 @@ public void setTrimValues(boolean trimValues) { /** * Set a value that should be treated as {@code null} when resolved - * as a placeholder value: e.g. "" (empty String) or "null". + * as a placeholder value: for example, "" (empty String) or "null". *

Note that this will only apply to full property values, * not to parts of concatenated values. *

By default, no such null value is defined. This means that diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPathFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPathFactoryBean.java index 4af0a37f886a..b22e52be3d26 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPathFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPathFactoryBean.java @@ -121,7 +121,7 @@ public void setTargetObject(Object targetObject) { * Specify the name of a target bean to apply the property path to. * Alternatively, specify a target object directly. * @param targetBeanName the bean name to be looked up in the - * containing bean factory (e.g. "testBean") + * containing bean factory (for example, "testBean") * @see #setTargetObject */ public void setTargetBeanName(String targetBeanName) { @@ -131,7 +131,7 @@ public void setTargetBeanName(String targetBeanName) { /** * Specify the property path to apply to the target. * @param propertyPath the property path, potentially nested - * (e.g. "age" or "spouse.age") + * (for example, "age" or "spouse.age") */ public void setPropertyPath(String propertyPath) { this.propertyPath = StringUtils.trimAllWhitespace(propertyPath); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java index 6e23f7fdeca5..51d9124850ca 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java @@ -93,7 +93,7 @@ public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport /** * Set the system property mode by the name of the corresponding constant, - * e.g. "SYSTEM_PROPERTIES_MODE_OVERRIDE". + * for example, "SYSTEM_PROPERTIES_MODE_OVERRIDE". * @param constantName name of the constant * @see #setSystemPropertiesMode */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/Scope.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/Scope.java index 9606eb87264b..8073dda0d912 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/Scope.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/Scope.java @@ -31,7 +31,7 @@ *

{@link org.springframework.context.ApplicationContext} implementations * such as a {@link org.springframework.web.context.WebApplicationContext} * may register additional standard scopes specific to their environment, - * e.g. {@link org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST "request"} + * for example, {@link org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST "request"} * and {@link org.springframework.web.context.WebApplicationContext#SCOPE_SESSION "session"}, * based on this Scope SPI. * @@ -125,7 +125,7 @@ public interface Scope { /** * Resolve the contextual object for the given key, if any. - * E.g. the HttpServletRequest object for key "request". + * For example, the HttpServletRequest object for key "request". * @param key the contextual key * @return the corresponding object, or {@code null} if none found * @throws IllegalStateException if the underlying scope is not currently active diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java index 1b1fae321279..472188fd389f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java @@ -77,7 +77,7 @@ public abstract class YamlProcessor { * A map of document matchers allowing callers to selectively use only * some of the documents in a YAML resource. In YAML documents are * separated by {@code ---} lines, and each document is converted - * to properties before the match is made. E.g. + * to properties before the match is made. For example, *

 	 * environment: dev
 	 * url: https://dev.bar.com
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.java
index 0c70f097d7c0..5c09abda686f 100644
--- a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.java
+++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlPropertiesFactoryBean.java
@@ -32,7 +32,7 @@
  * has a lot of similar features.
  *
  * 

Note: All exposed values are of type {@code String} for access through - * the common {@link Properties#getProperty} method (e.g. in configuration property + * the common {@link Properties#getProperty} method (for example, in configuration property * resolution through {@link PropertyResourceConfigurer#setProperties(Properties)}). * If this is not desirable, use {@link YamlMapFactoryBean} instead. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java index 33ec279f9c24..692a5f515fb7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java @@ -28,7 +28,7 @@ * it is now possible for a single logical configuration entity, in this case an XML tag, to * create multiple {@link BeanDefinition BeanDefinitions} and {@link BeanReference RuntimeBeanReferences} * in order to provide more succinct configuration and greater convenience to end users. As such, it can - * no longer be assumed that each configuration entity (e.g. XML tag) maps to one {@link BeanDefinition}. + * no longer be assumed that each configuration entity (for example, XML tag) maps to one {@link BeanDefinition}. * For tool vendors and other users who wish to present visualization or support for configuring Spring * applications it is important that there is some mechanism in place to tie the {@link BeanDefinition BeanDefinitions} * in the {@link org.springframework.beans.factory.BeanFactory} back to the configuration data in a way diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java index d1ade588ec12..64cf81be30a6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java @@ -205,7 +205,7 @@ public InstantiationStrategy getInstantiationStrategy() { /** * Set the ParameterNameDiscoverer to use for resolving method parameter - * names if needed (e.g. for constructor names). + * names if needed (for example, for constructor names). *

Default is a {@link DefaultParameterNameDiscoverer}. */ public void setParameterNameDiscoverer(@Nullable ParameterNameDiscoverer parameterNameDiscoverer) { @@ -539,7 +539,7 @@ protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable O /** * Actually create the specified bean. Pre-creation processing has already happened - * at this point, e.g. checking {@code postProcessBeforeInstantiation} callbacks. + * at this point, for example, checking {@code postProcessBeforeInstantiation} callbacks. *

Differentiates between default bean instantiation, use of a * factory method, and autowiring a constructor. * @param beanName the name of the bean @@ -821,7 +821,7 @@ protected Class getTypeForFactoryMethod(String beanName, RootBeanDefinition m return cachedReturnType.resolve(); } catch (LinkageError err) { - // E.g. a NoClassDefFoundError for a generic method return type + // For example, a NoClassDefFoundError for a generic method return type if (logger.isDebugEnabled()) { logger.debug("Failed to resolve type for factory method of bean '" + beanName + "': " + (uniqueCandidate != null ? uniqueCandidate : commonType), err); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java index bd6d6caac5f4..ab66ca7c8f39 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java @@ -1075,7 +1075,7 @@ public String getInitMethodName() { * Specify whether the configured initializer method is the default. *

The default value is {@code true} for a locally specified init method * but switched to {@code false} for a shared setting in a defaults section - * (e.g. {@code bean init-method} versus {@code beans default-init-method} + * (for example, {@code bean init-method} versus {@code beans default-init-method} * level in XML) which might not apply to all contained bean definitions. * @see #setInitMethodName * @see #applyDefaults @@ -1135,7 +1135,7 @@ public String getDestroyMethodName() { * Specify whether the configured destroy method is the default. *

The default value is {@code true} for a locally specified destroy method * but switched to {@code false} for a shared setting in a defaults section - * (e.g. {@code bean destroy-method} versus {@code beans default-destroy-method} + * (for example, {@code bean destroy-method} versus {@code beans default-destroy-method} * level in XML) which might not apply to all contained bean definitions. * @see #setDestroyMethodName * @see #applyDefaults @@ -1241,7 +1241,7 @@ public String getResourceDescription() { } /** - * Set the originating (e.g. decorated) BeanDefinition, if any. + * Set the originating (for example, decorated) BeanDefinition, if any. */ public void setOriginatingBeanDefinition(BeanDefinition originatingBd) { this.resource = new BeanDefinitionResource(originatingBd); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java index eeaeb2ced51a..60029e60a954 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java @@ -147,7 +147,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp @Nullable private TypeConverter typeConverter; - /** String resolvers to apply e.g. to annotation attribute values. */ + /** String resolvers to apply, for example, to annotation attribute values. */ private final List embeddedValueResolvers = new CopyOnWriteArrayList<>(); /** BeanPostProcessors to apply. */ @@ -1511,7 +1511,7 @@ protected void clearMergedBeanDefinition(String beanName) { * Clear the merged bean definition cache, removing entries for beans * which are not considered eligible for full metadata caching yet. *

Typically triggered after changes to the original bean definitions, - * e.g. after applying a {@code BeanFactoryPostProcessor}. Note that metadata + * for example, after applying a {@code BeanFactoryPostProcessor}. Note that metadata * for beans which have already been created at this point will be kept around. * @since 4.2 */ @@ -1570,7 +1570,7 @@ private Class doResolveBeanClass(RootBeanDefinition mbd, Class... typesToM if (!ObjectUtils.isEmpty(typesToMatch)) { // When just doing type checks (i.e. not creating an actual instance yet), - // use the specified temporary class loader (e.g. in a weaving scenario). + // use the specified temporary class loader (for example, in a weaving scenario). ClassLoader tempClassLoader = getTempClassLoader(); if (tempClassLoader != null) { dynamicLoader = tempClassLoader; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateResolver.java index d69daa2e4118..c078572af5ab 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateResolver.java @@ -50,7 +50,7 @@ default boolean isAutowireCandidate(BeanDefinitionHolder bdHolder, DependencyDes *

The default implementation checks {@link DependencyDescriptor#isRequired()}. * @param descriptor the descriptor for the target method parameter or field * @return whether the descriptor is marked as required or possibly indicating - * non-required status some other way (e.g. through a parameter annotation) + * non-required status some other way (for example, through a parameter annotation) * @since 5.0 * @see DependencyDescriptor#isRequired() */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireUtils.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireUtils.java index 6baa1fd13880..1a6f0c87533c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireUtils.java @@ -122,7 +122,7 @@ public static boolean isSetterDefinedInInterface(PropertyDescriptor pd, Set req * the given {@code method} does not declare any {@linkplain * Method#getTypeParameters() formal type variables} *

  • the {@linkplain Method#getReturnType() standard return type}, if the - * target return type cannot be inferred (e.g., due to type erasure)
  • + * target return type cannot be inferred (for example, due to type erasure) *
  • {@code null}, if the length of the given arguments array is shorter * than the length of the {@linkplain * Method#getGenericParameterTypes() formal argument list} for the given @@ -182,8 +182,8 @@ public static Class resolveReturnTypeForFactoryMethod( Type[] methodParameterTypes = method.getGenericParameterTypes(); Assert.isTrue(args.length == methodParameterTypes.length, "Argument array does not match parameter count"); - // Ensure that the type variable (e.g., T) is declared directly on the method - // itself (e.g., via ), not on the enclosing class or interface. + // Ensure that the type variable (for example, T) is declared directly on the method + // itself (for example, via ), not on the enclosing class or interface. boolean locallyDeclaredTypeVariableMatchesReturnType = false; for (TypeVariable currentTypeVariable : declaredTypeVariables) { if (currentTypeVariable.equals(genericReturnType)) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ConstructorResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ConstructorResolver.java index be9b6cf1feca..39d0323db4a1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ConstructorResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ConstructorResolver.java @@ -918,7 +918,7 @@ Object resolveAutowiredArgument(DependencyDescriptor descriptor, Class paramT catch (NoSuchBeanDefinitionException ex) { if (fallback) { // Single constructor or factory method -> let's return an empty array/collection - // for e.g. a vararg or a non-null List/Set/Map parameter. + // for example, a vararg or a non-null List/Set/Map parameter. if (paramType.isArray()) { return Array.newInstance(paramType.componentType(), 0); } @@ -1323,7 +1323,7 @@ else if (ctors.length == 0) { // No public constructors -> check non-public ctors = clazz.getDeclaredConstructors(); if (ctors.length == 1) { - // A single non-public constructor, e.g. from a non-public record type + // A single non-public constructor, for example, from a non-public record type return ctors; } } diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java index e5b789543cf9..7c9847761a04 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java @@ -349,7 +349,7 @@ public void copyConfigurationFrom(ConfigurableBeanFactory otherFactory) { this.dependencyComparator = otherListableFactory.dependencyComparator; // A clone of the AutowireCandidateResolver since it is potentially BeanFactoryAware setAutowireCandidateResolver(otherListableFactory.getAutowireCandidateResolver().cloneIfNecessary()); - // Make resolvable dependencies (e.g. ResourceLoader) available here as well + // Make resolvable dependencies (for example, ResourceLoader) available here as well this.resolvableDependencies.putAll(otherListableFactory.resolvableDependencies); } } @@ -772,7 +772,7 @@ public A findAnnotationOnBean( } if (containsBeanDefinition(beanName)) { RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName); - // Check raw bean class, e.g. in case of a proxy. + // Check raw bean class, for example, in case of a proxy. if (bd.hasBeanClass() && bd.getFactoryMethodName() == null) { Class beanClass = bd.getBeanClass(); if (beanClass != beanType) { @@ -811,7 +811,7 @@ public Set findAllAnnotationsOnBean( } if (containsBeanDefinition(beanName)) { RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName); - // Check raw bean class, e.g. in case of a proxy. + // Check raw bean class, for example, in case of a proxy. if (bd.hasBeanClass() && bd.getFactoryMethodName() == null) { Class beanClass = bd.getBeanClass(); if (beanClass != beanType) { @@ -1211,7 +1211,7 @@ private void logBeanDefinitionOverriding(String beanName, BeanDefinition beanDef boolean explicitBeanOverride = (this.allowBeanDefinitionOverriding != null); if (existingDefinition.getRole() < beanDefinition.getRole()) { - // e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE + // for example, was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE if (logger.isInfoEnabled()) { logger.info("Overriding user-defined bean definition for bean '" + beanName + "' with a framework-generated bean definition: replacing [" + @@ -1290,7 +1290,7 @@ protected void resetBeanDefinition(String beanName) { // Remove corresponding bean from singleton cache, if any. Shouldn't usually // be necessary, rather just meant for overriding a context's default beans - // (e.g. the default StaticMessageSource in a StaticApplicationContext). + // (for example, the default StaticMessageSource in a StaticApplicationContext). destroySingleton(beanName); // Remove a cached primary marker for the given bean. @@ -1521,7 +1521,7 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str InjectionPoint previousInjectionPoint = ConstructorResolver.setCurrentInjectionPoint(descriptor); try { - // Step 1: pre-resolved shortcut for single bean match, e.g. from @Autowired + // Step 1: pre-resolved shortcut for single bean match, for example, from @Autowired Object shortcut = descriptor.resolveShortcut(this); if (shortcut != null) { return shortcut; @@ -1529,7 +1529,7 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str Class type = descriptor.getDependencyType(); - // Step 2: pre-defined value or expression, e.g. from @Value + // Step 2: pre-defined value or expression, for example, from @Value Object value = getAutowireCandidateResolver().getSuggestedValue(descriptor); if (value != null) { if (value instanceof String strValue) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultSingletonBeanRegistry.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultSingletonBeanRegistry.java index c9d443973779..187f22cb54ef 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultSingletonBeanRegistry.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultSingletonBeanRegistry.java @@ -157,7 +157,7 @@ protected void addSingleton(String beanName, Object singletonObject) { /** * Add the given singleton factory for building the specified singleton * if necessary. - *

    To be called for early exposure purposes, e.g. to be able to + *

    To be called for early exposure purposes, for example, to be able to * resolve circular references. * @param beanName the name of the bean * @param singletonFactory the factory for the singleton object @@ -340,7 +340,7 @@ protected Boolean isCurrentThreadAllowedToHoldSingletonLock() { /** * Register an exception that happened to get suppressed during the creation of a - * singleton bean instance, e.g. a temporary circular reference resolution problem. + * singleton bean instance, for example, a temporary circular reference resolution problem. *

    The default implementation preserves any given exception in this registry's * collection of suppressed exceptions, up to a limit of 100 exceptions, adding * them as related causes to an eventual top-level {@link BeanCreationException}. @@ -451,7 +451,7 @@ public void registerDisposableBean(String beanName, DisposableBean bean) { /** * Register a containment relationship between two beans, - * e.g. between an inner bean and its containing outer bean. + * for example, between an inner bean and its containing outer bean. *

    Also registers the containing bean as dependent on the contained bean * in terms of destruction order. * @param containedBeanName the name of the contained (inner) bean diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/FactoryBeanRegistrySupport.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/FactoryBeanRegistrySupport.java index bab9915aaf25..7f4a3375419a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/FactoryBeanRegistrySupport.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/FactoryBeanRegistrySupport.java @@ -122,7 +122,7 @@ protected Object getObjectFromFactoryBean(FactoryBean factory, String beanNam if (object == null) { object = doGetObjectFromFactoryBean(factory, beanName); // Only post-process and store if not put there already during getObject() call above - // (e.g. because of circular reference processing triggered by custom getBean calls) + // (for example, because of circular reference processing triggered by custom getBean calls) Object alreadyThere = this.factoryBeanObjectCache.get(beanName); if (alreadyThere != null) { object = alreadyThere; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericBeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericBeanDefinition.java index 8381b7b20f24..570957cf99a5 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericBeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericBeanDefinition.java @@ -27,7 +27,7 @@ * parent bean definition can be flexibly configured through the "parentName" property. * *

    In general, use this {@code GenericBeanDefinition} class for the purpose of - * registering declarative bean definitions (e.g. XML definitions which a bean + * registering declarative bean definitions (for example, XML definitions which a bean * post-processor might operate on, potentially even reconfiguring the parent name). * Use {@code RootBeanDefinition}/{@code ChildBeanDefinition} where parent/child * relationships happen to be pre-determined, and prefer {@link RootBeanDefinition} diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java index 12c9dbb09ddf..f422594f701e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java @@ -33,7 +33,7 @@ /** * Basic {@link AutowireCandidateResolver} that performs a full generic type * match with the candidate's type if the dependency is declared as a generic type - * (e.g. {@code Repository}). + * (for example, {@code Repository}). * *

    This is the base class for * {@link org.springframework.beans.factory.annotation.QualifierAnnotationAutowireCandidateResolver}, @@ -147,7 +147,7 @@ protected boolean checkGenericTypeMatch(BeanDefinitionHolder bdHolder, Dependenc } if (descriptor.fallbackMatchAllowed()) { - // Fallback matches allow unresolvable generics, e.g. plain HashMap to Map; + // Fallback matches allow unresolvable generics, for example, plain HashMap to Map; // and pragmatically also java.util.Properties to any Map (since despite formally being a // Map, java.util.Properties is usually perceived as a Map). if (targetType.hasUnresolvableGenerics()) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/NullBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/NullBean.java index 7905acc09554..ab847865b5e0 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/NullBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/NullBean.java @@ -20,7 +20,7 @@ import org.springframework.lang.Nullable; /** - * Internal representation of a null bean instance, e.g. for a {@code null} value + * Internal representation of a null bean instance, for example, for a {@code null} value * returned from {@link FactoryBean#getObject()} or from a factory method. * *

    Each such null bean is represented by a dedicated {@code NullBean} instance diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/PropertiesBeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/PropertiesBeanDefinitionReader.java index ebd2b6a1aa6f..37f90946393a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/PropertiesBeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/PropertiesBeanDefinitionReader.java @@ -128,7 +128,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader /** * Property suffix for references to other beans in the current - * BeanFactory: e.g. {@code owner.dog(ref)=fido}. + * BeanFactory: for example, {@code owner.dog(ref)=fido}. * Whether this is a reference to a singleton or a prototype * will depend on the definition of the target bean. */ @@ -165,7 +165,7 @@ public PropertiesBeanDefinitionReader(BeanDefinitionRegistry registry) { * Set the default parent bean for this bean factory. * If a child bean definition handled by this factory provides neither * a parent nor a class attribute, this default value gets used. - *

    Can be used e.g. for view definition files, to define a parent + *

    Can be used, for example, for view definition files, to define a parent * with a default view class and common attributes for all views. * View definitions that define their own parent or carry their own * class can still override this. @@ -219,7 +219,7 @@ public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreExce /** * Load bean definitions from the specified properties file. * @param resource the resource descriptor for the properties file - * @param prefix a filter within the keys in the map: e.g. 'beans.' + * @param prefix a filter within the keys in the map: for example, 'beans.' * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors @@ -243,7 +243,7 @@ public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefin * Load bean definitions from the specified properties file. * @param encodedResource the resource descriptor for the properties file, * allowing to specify an encoding to use for parsing the file - * @param prefix a filter within the keys in the map: e.g. 'beans.' + * @param prefix a filter within the keys in the map: for example, 'beans.' * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors @@ -294,7 +294,7 @@ public int registerBeanDefinitions(ResourceBundle rb) throws BeanDefinitionStore *

    Similar syntax as for a Map. This method is useful to enable * standard Java internationalization support. * @param rb the ResourceBundle to load from - * @param prefix a filter within the keys in the map: e.g. 'beans.' + * @param prefix a filter within the keys in the map: for example, 'beans.' * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors @@ -331,7 +331,7 @@ public int registerBeanDefinitions(Map map) throws BeansException { * @param map a map of {@code name} to {@code property} (String or Object). Property * values will be strings if coming from a Properties file etc. Property names * (keys) must be Strings. Class keys must be Strings. - * @param prefix a filter within the keys in the map: e.g. 'beans.' + * @param prefix a filter within the keys in the map: for example, 'beans.' * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeansException in case of loading or parsing errors @@ -346,7 +346,7 @@ public int registerBeanDefinitions(Map map, @Nullable String prefix) throw * @param map a map of {@code name} to {@code property} (String or Object). Property * values will be strings if coming from a Properties file etc. Property names * (keys) must be Strings. Class keys must be Strings. - * @param prefix a filter within the keys in the map: e.g. 'beans.' + * @param prefix a filter within the keys in the map: for example, 'beans.' * (can be empty or {@code null}) * @param resourceDescription description of the resource that the * Map came from (for logging purposes) diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java index f59b5cb2643f..3f3b25cc5ab1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java @@ -266,7 +266,7 @@ public String toString() { * Descriptor for how a bean should be instantiated. While the {@code targetClass} * is usually the declaring class of the {@code executable} (in case of a constructor * or a locally declared factory method), there are cases where retaining the actual - * concrete class is necessary (e.g. for an inherited factory method). + * concrete class is necessary (for example, for an inherited factory method). * @since 6.1.7 * @param executable the {@link Executable} ({@link java.lang.reflect.Constructor} * or {@link java.lang.reflect.Method}) to invoke diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/RootBeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/RootBeanDefinition.java index 4b1598e06e7b..67aad00a312e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/RootBeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/RootBeanDefinition.java @@ -37,18 +37,18 @@ /** * A root bean definition represents the merged bean definition at runtime * that backs a specific bean in a Spring BeanFactory. It might have been created - * from multiple original bean definitions that inherit from each other, e.g. + * from multiple original bean definitions that inherit from each other, for example, * {@link GenericBeanDefinition GenericBeanDefinitions} from XML declarations. * A root bean definition is essentially the 'unified' bean definition view at runtime. * *

    Root bean definitions may also be used for registering individual bean * definitions in the configuration phase. This is particularly applicable for - * programmatic definitions derived from factory methods (e.g. {@code @Bean} methods) - * and instance suppliers (e.g. lambda expressions) which come with extra type metadata + * programmatic definitions derived from factory methods (for example, {@code @Bean} methods) + * and instance suppliers (for example, lambda expressions) which come with extra type metadata * (see {@link #setTargetType(ResolvableType)}/{@link #setResolvedFactoryMethod(Method)}). * *

    Note: The preferred choice for bean definitions derived from declarative sources - * (e.g. XML definitions) is the flexible {@link GenericBeanDefinition} variant. + * (for example, XML definitions) is the flexible {@link GenericBeanDefinition} variant. * GenericBeanDefinition comes with the advantage that it allows for dynamically * defining parent dependencies, not 'hard-coding' the role as a root bean definition, * even supporting parent relationship changes in the bean post-processor phase. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ScopeNotActiveException.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ScopeNotActiveException.java index bb7cddaf2a21..32049b11d3d7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ScopeNotActiveException.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ScopeNotActiveException.java @@ -20,7 +20,7 @@ /** * A subclass of {@link BeanCreationException} which indicates that the target scope - * is not active, e.g. in case of request or session scope. + * is not active, for example, in case of request or session scope. * * @author Juergen Hoeller * @since 5.3 diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java index 0e556b94bc8f..b75e54893a74 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultBeanDefinitionDocumentReader.java @@ -213,7 +213,7 @@ protected void importBeanDefinitionResource(Element ele) { return; } - // Resolve system properties: e.g. "${user.dir}" + // Resolve system properties: for example, "${user.dir}" location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location); Set actualResources = new LinkedHashSet<>(4); diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharacterEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharacterEditor.java index ec7c7d4c9b2c..727be75c8694 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharacterEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharacterEditor.java @@ -30,7 +30,7 @@ * {@link org.springframework.beans.BeanWrapperImpl} will register this * editor by default. * - *

    Also supports conversion from a Unicode character sequence; e.g. + *

    Also supports conversion from a Unicode character sequence; for example, * {@code u0041} ('A'). * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharsetEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharsetEditor.java index ef772db749cb..5fb86ae962ad 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharsetEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CharsetEditor.java @@ -26,7 +26,7 @@ * String representations into Charset objects and back. * *

    Expects the same syntax as Charset's {@link java.nio.charset.Charset#name()}, - * e.g. {@code UTF-8}, {@code ISO-8859-16}, etc. + * for example, {@code UTF-8}, {@code ISO-8859-16}, etc. * * @author Arjen Poutsma * @author Sam Brannen diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputStreamEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputStreamEditor.java index fca24a5418ef..303067c5e253 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputStreamEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputStreamEditor.java @@ -27,7 +27,7 @@ /** * One-way PropertyEditor which can convert from a text String to a * {@code java.io.InputStream}, interpreting the given String as a - * Spring resource location (e.g. a URL String). + * Spring resource location (for example, a URL String). * *

    Supports Spring-style URL notation: any fully qualified standard URL * ("file:", "http:", etc.) and Spring's special "classpath:" pseudo-URL. diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/LocaleEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/LocaleEditor.java index c2c415deab55..85eedaac60a2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/LocaleEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/LocaleEditor.java @@ -24,7 +24,7 @@ * Editor for {@code java.util.Locale}, to directly populate a Locale property. * *

    Expects the same syntax as Locale's {@code toString()}, i.e. language + - * optionally country + optionally variant, separated by "_" (e.g. "en", "en_US"). + * optionally country + optionally variant, separated by "_" (for example, "en", "en_US"). * Also accepts spaces as separators, as an alternative to underscores. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ReaderEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ReaderEditor.java index a388932bfca0..46171fb4b774 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ReaderEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ReaderEditor.java @@ -28,7 +28,7 @@ /** * One-way PropertyEditor which can convert from a text String to a * {@code java.io.Reader}, interpreting the given String as a Spring - * resource location (e.g. a URL String). + * resource location (for example, a URL String). * *

    Supports Spring-style URL notation: any fully qualified standard URL * ("file:", "http:", etc.) and Spring's special "classpath:" pseudo-URL. diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java index e278c8721b65..7149e931df03 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java @@ -97,7 +97,7 @@ public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull, boo * @param separator the separator to use for splitting a {@link String} * @param charsToDelete a set of characters to delete, in addition to * trimming an input String. Useful for deleting unwanted line breaks: - * e.g. "\r\n\f" will delete all new lines and line feeds in a String. + * for example, "\r\n\f" will delete all new lines and line feeds in a String. * @param emptyArrayAsNull {@code true} if an empty String array * is to be transformed into {@code null} */ @@ -110,7 +110,7 @@ public StringArrayPropertyEditor(String separator, @Nullable String charsToDelet * @param separator the separator to use for splitting a {@link String} * @param charsToDelete a set of characters to delete, in addition to * trimming an input String. Useful for deleting unwanted line breaks: - * e.g. "\r\n\f" will delete all new lines and line feeds in a String. + * for example, "\r\n\f" will delete all new lines and line feeds in a String. * @param emptyArrayAsNull {@code true} if an empty String array * is to be transformed into {@code null} * @param trimValues {@code true} if the values in the parsed arrays diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringTrimmerEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringTrimmerEditor.java index 0fbbfd327ba7..d97037c56364 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringTrimmerEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringTrimmerEditor.java @@ -25,7 +25,7 @@ * Property editor that trims Strings. * *

    Optionally allows transforming an empty string into a {@code null} value. - * Needs to be explicitly registered, e.g. for command binding. + * Needs to be explicitly registered, for example, for command binding. * * @author Juergen Hoeller * @see org.springframework.validation.DataBinder#registerCustomEditor @@ -52,7 +52,7 @@ public StringTrimmerEditor(boolean emptyAsNull) { * Create a new StringTrimmerEditor. * @param charsToDelete a set of characters to delete, in addition to * trimming an input String. Useful for deleting unwanted line breaks: - * e.g. "\r\n\f" will delete all new lines and line feeds in a String. + * for example, "\r\n\f" will delete all new lines and line feeds in a String. * @param emptyAsNull {@code true} if an empty String is to be * transformed into {@code null} */ diff --git a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.dtd b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.dtd index 05525e411cda..27b7b3434714 100644 --- a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.dtd +++ b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.dtd @@ -343,14 +343,14 @@ diff --git a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.xsd b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.xsd index f716a59f9199..a27c3e9f80e2 100644 --- a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.xsd +++ b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-beans.xsd @@ -90,7 +90,7 @@ elements followed, etc. If none of the specified profiles are active at time of parsing, then the entire element and its contents will be ignored. - If a profile is prefixed with the NOT operator '!', e.g. + If a profile is prefixed with the NOT operator '!', for example, @@ -152,8 +152,8 @@ @@ -308,7 +308,7 @@ Singletons are most commonly used, and are ideal for multi-threaded service objects. Further scopes, such as "request" or "session", might - be supported by extended bean factories (e.g. in a web environment). + be supported by extended bean factories (for example, in a web environment). Inner bean definitions inherit the scope of their containing bean definition, unless explicitly specified: The inner bean will be a @@ -341,7 +341,7 @@ Hence, it needs to be specified per concrete bean definition. It can be shared through the 'default-lazy-init' attribute at the 'beans' level and potentially inherited from outer 'beans' defaults in case of nested - 'beans' sections (e.g. with different profiles). + 'beans' sections (for example, with different profiles). ]]> @@ -389,7 +389,7 @@ Hence, it needs to be specified per concrete bean definition. It can be shared through the 'default-autowire' attribute at the 'beans' level and potentially inherited from outer 'beans' defaults in case of nested - 'beans' sections (e.g. with different profiles). + 'beans' sections (for example, with different profiles). ]]> @@ -595,7 +595,7 @@ @@ -604,7 +604,7 @@ @@ -613,7 +613,7 @@ @@ -899,7 +899,7 @@ diff --git a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-tool.xsd b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-tool.xsd index 9d84906adead..c0738e49fc0a 100644 --- a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-tool.xsd +++ b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-tool.xsd @@ -104,7 +104,7 @@ diff --git a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-util.xsd b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-util.xsd index 533a0c3a8dea..1794e524eb5c 100644 --- a/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-util.xsd +++ b/spring-beans/src/main/resources/org/springframework/beans/factory/xml/spring-util.xsd @@ -69,7 +69,7 @@ which will be returned by all calls to getBean with the given id), or "prototype" (independent instance resulting from each call to getBean). Default is "singleton". Further scopes, such as "request" or "session", - might be supported by extended bean factories (e.g. in a web environment). + might be supported by extended bean factories (for example, in a web environment). ]]> @@ -110,7 +110,7 @@ which will be returned by all calls to getBean with the given id), or "prototype" (independent instance resulting from each call to getBean). Default is "singleton". Further scopes, such as "request" or "session", - might be supported by extended bean factories (e.g. in a web environment). + might be supported by extended bean factories (for example, in a web environment). ]]> @@ -151,7 +151,7 @@ which will be returned by all calls to getBean with the given id), or "prototype" (independent instance resulting from each call to getBean). Default is "singleton". Further scopes, such as "request" or "session", - might be supported by extended bean factories (e.g. in a web environment). + might be supported by extended bean factories (for example, in a web environment). ]]> @@ -209,7 +209,7 @@ which will be returned by all calls to getBean with the given id), or "prototype" (independent instance resulting from each call to getBean). Default is "singleton". Further scopes, such as "request" or "session", - might be supported by extended bean factories (e.g. in a web environment). + might be supported by extended bean factories (for example, in a web environment). ]]> diff --git a/spring-context-support/src/main/java/org/springframework/cache/jcache/config/JCacheConfigurer.java b/spring-context-support/src/main/java/org/springframework/cache/jcache/config/JCacheConfigurer.java index 12f3d4fb7864..2690c1ac37bd 100644 --- a/spring-context-support/src/main/java/org/springframework/cache/jcache/config/JCacheConfigurer.java +++ b/spring-context-support/src/main/java/org/springframework/cache/jcache/config/JCacheConfigurer.java @@ -42,7 +42,7 @@ public interface JCacheConfigurer extends CachingConfigurer { /** * Return the {@link CacheResolver} bean to use to resolve exception caches for * annotation-driven cache management. Implementations must explicitly declare - * {@link org.springframework.context.annotation.Bean @Bean}, e.g. + * {@link org.springframework.context.annotation.Bean @Bean}, for example, *

     	 * @Configuration
     	 * @EnableCaching
    diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSenderImpl.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSenderImpl.java
    index adc888dae95f..333da35987bb 100644
    --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSenderImpl.java
    +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSenderImpl.java
    @@ -484,7 +484,7 @@ protected Transport connectTransport() throws MessagingException {
     	/**
     	 * Obtain a Transport object from the given JavaMail Session,
     	 * using the configured protocol.
    -	 * 

    Can be overridden in subclasses, e.g. to return a mock Transport object. + *

    Can be overridden in subclasses, for example, to return a mock Transport object. * @see jakarta.mail.Session#getTransport(String) * @see #getSession() * @see #getProtocol() diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessageHelper.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessageHelper.java index 04b126ea5e32..302a401f7310 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessageHelper.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessageHelper.java @@ -897,7 +897,7 @@ private void setHtmlTextToMimePart(MimePart mimePart, String text) throws Messag *

    NOTE: Invoke {@code addInline} after {@link #setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param dataSource the {@code jakarta.activation.DataSource} to take * the content from, determining the InputStream and the content type @@ -919,7 +919,7 @@ public void addInline(String contentId, DataSource dataSource) throws MessagingE *

    NOTE: Invoke {@code addInline} after {@link #setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param inlineFilename the fileName to use for the inline element's part * @param dataSource the {@code jakarta.activation.DataSource} to take @@ -959,7 +959,7 @@ public void addInline(String contentId, @Nullable String inlineFilename, DataSou *

    NOTE: Invoke {@code addInline} after {@link #setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param file the File resource to take the content from * @throws MessagingException in case of errors @@ -986,7 +986,7 @@ public void addInline(String contentId, File file) throws MessagingException { *

    NOTE: Invoke {@code addInline} after {@link #setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param resource the resource to take the content from * @throws MessagingException in case of errors @@ -1013,7 +1013,7 @@ public void addInline(String contentId, Resource resource) throws MessagingExcep *

    NOTE: Invoke {@code addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param inputStreamSource the resource to take the content from * @param contentType the content type to use for the element @@ -1042,7 +1042,7 @@ public void addInline(String contentId, InputStreamSource inputStreamSource, Str *

    NOTE: Invoke {@code addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param inlineFilename the file name to use for the inline element * @param inputStreamSource the resource to take the content from @@ -1072,7 +1072,7 @@ public void addInline(String contentId, String inlineFilename, InputStreamSource *

    NOTE: Invoke {@code addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param contentId the content ID to use. Will end up as "Content-ID" header - * in the body part, surrounded by angle brackets: e.g. "myId" → "<myId>". + * in the body part, surrounded by angle brackets: for example, "myId" → "<myId>". * Can be referenced in HTML source via src="cid:myId" expressions. * @param inlineFilename the fileName to use for the inline element's part * @param inputStreamSource the resource to take the content from diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessorBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessorBean.java index ea136c6e4fb1..83a8b47112d0 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessorBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessorBean.java @@ -54,7 +54,7 @@ public class SchedulerAccessorBean extends SchedulerAccessor implements BeanFact * Specify the Quartz {@link Scheduler} to operate on via its scheduler name in the Spring * application context or also in the Quartz {@link org.quartz.impl.SchedulerRepository}. *

    Schedulers can be registered in the repository through custom bootstrapping, - * e.g. via the {@link org.quartz.impl.StdSchedulerFactory} or + * for example, via the {@link org.quartz.impl.StdSchedulerFactory} or * {@link org.quartz.impl.DirectSchedulerFactory} factory classes. * However, in general, it's preferable to use Spring's {@link SchedulerFactoryBean} * which includes the job/trigger/listener capabilities of this accessor as well. diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java index 937240d1a78f..ddc740a25b28 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java @@ -319,7 +319,7 @@ public void setTaskExecutor(Executor taskExecutor) { * It is therefore strongly recommended to perform all operations on * the Scheduler within Spring-managed (or plain JTA) transactions. * Else, database locking will not properly work and might even break - * (e.g. if trying to obtain a lock on Oracle without a transaction). + * (for example, if trying to obtain a lock on Oracle without a transaction). *

    Supports both transactional and non-transactional DataSource access. * With a non-XA DataSource and local Spring transactions, a single DataSource * argument is sufficient. In case of an XA DataSource and global JTA transactions, diff --git a/spring-context-support/src/main/resources/org/springframework/mail/javamail/mime.types b/spring-context-support/src/main/resources/org/springframework/mail/javamail/mime.types index f325ad37d8b5..7ce3bd4ab30b 100644 --- a/spring-context-support/src/main/resources/org/springframework/mail/javamail/mime.types +++ b/spring-context-support/src/main/resources/org/springframework/mail/javamail/mime.types @@ -262,7 +262,7 @@ application/astound asn # SPECIAL EMBEDDED OBJECT -# OLE script e.g. Visual Basic (Ncompass) +# OLE script, for example, Visual Basic (Ncompass) application/x-olescript axs # OLE Object (Microsoft/NCompass) application/x-oleobject ods diff --git a/spring-context/src/main/java/org/springframework/cache/Cache.java b/spring-context/src/main/java/org/springframework/cache/Cache.java index 3df983a9a268..171616604d39 100644 --- a/spring-context/src/main/java/org/springframework/cache/Cache.java +++ b/spring-context/src/main/java/org/springframework/cache/Cache.java @@ -114,7 +114,7 @@ public interface Cache { * but is allowed to return a completed {@link CompletableFuture} if the * corresponding value is immediately available. *

    Can return {@code null} if the cache can immediately determine that - * it contains no mapping for this key (e.g. through an in-memory key map). + * it contains no mapping for this key (for example, through an in-memory key map). * Otherwise, the cached value will be returned in the {@link CompletableFuture}, * with {@code null} indicating a late-determined cache miss. A nested * {@link ValueWrapper} potentially indicates a nullable cached value; @@ -200,7 +200,7 @@ default CompletableFuture retrieve(Object key, Supplier

    * except that the action is performed atomically. While all out-of-the-box * {@link CacheManager} implementations are able to perform the put atomically, - * the operation may also be implemented in two steps, e.g. with a check for + * the operation may also be implemented in two steps, for example, with a check for * presence and a subsequent put, in a non-atomic way. Check the documentation * of the native cache implementation that you are using for more details. *

    The default implementation delegates to {@link #get(Object)} and @@ -245,7 +245,7 @@ default ValueWrapper putIfAbsent(Object key, @Nullable Object value) { *

    The default implementation delegates to {@link #evict(Object)}, * returning {@code false} for not-determined prior presence of the key. * Cache providers and in particular cache decorators are encouraged - * to perform immediate eviction if possible (e.g. in case of generally + * to perform immediate eviction if possible (for example, in case of generally * deferred cache operations within a transaction) and to reliably * determine prior presence of the given key. * @param key the key whose mapping is to be removed from the cache diff --git a/spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java b/spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java index 456d8762dddc..2d7e41468c76 100644 --- a/spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java +++ b/spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java @@ -78,9 +78,9 @@ * will all receive a put/evict request for the same newly cached value. *

    Note that asynchronous/reactive cache access may not fully consult all * specified caches, depending on the target cache. In the case of late-determined - * cache misses (e.g. with Redis), further caches will not get consulted anymore. + * cache misses (for example, with Redis), further caches will not get consulted anymore. * As a consequence, specifying multiple cache names in an async cache mode setup - * only makes sense with early-determined cache misses (e.g. with Caffeine). + * only makes sense with early-determined cache misses (for example, with Caffeine). * @since 4.2 * @see #value * @see CacheConfig#cacheNames diff --git a/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java b/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java index 85c372dfeb3c..d3f3145367e5 100644 --- a/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java +++ b/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java @@ -47,7 +47,7 @@ public interface CachingConfigurer { * {@link CacheResolver} directly. *

    Implementations must explicitly declare * {@link org.springframework.context.annotation.Bean @Bean} so that - * the cache manager participates in the lifecycle of the context, e.g. + * the cache manager participates in the lifecycle of the context, for example, *

     	 * @Configuration
     	 * @EnableCaching
    @@ -75,7 +75,7 @@ default CacheManager cacheManager() {
     	 * the cache manager is ignored.
     	 * 

    Implementations must explicitly declare * {@link org.springframework.context.annotation.Bean @Bean} so that - * the cache resolver participates in the lifecycle of the context, e.g. + * the cache resolver participates in the lifecycle of the context, for example, *

     	 * @Configuration
     	 * @EnableCaching
    diff --git a/spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java b/spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java
    index 75ad63f82747..1989a29f89fa 100644
    --- a/spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java
    +++ b/spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java
    @@ -176,7 +176,7 @@
     	 * For example, other beans marked with Spring's {@code @Transactional} annotation will
     	 * be upgraded to subclass proxying at the same time. This approach has no negative
     	 * impact in practice unless one is explicitly expecting one type of proxy vs another,
    -	 * e.g. in tests.
    +	 * for example, in tests.
     	 */
     	boolean proxyTargetClass() default false;
     
    diff --git a/spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java b/spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java
    index 1e0881ff2204..5febd332b538 100644
    --- a/spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java
    +++ b/spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java
    @@ -107,7 +107,7 @@ public abstract class CacheAspectSupport extends AbstractCacheInvoker
     	 * 

    Switch this flag to "true" in order to ignore Reactive Streams Publishers and * process them as regular return values through synchronous caching, restoring 6.0 * behavior. Note that this is not recommended and only works in very limited - * scenarios, e.g. with manual {@code Mono.cache()}/{@code Flux.cache()} calls. + * scenarios, for example, with manual {@code Mono.cache()}/{@code Flux.cache()} calls. * @since 6.1.3 * @see org.reactivestreams.Publisher */ diff --git a/spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java b/spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java index a06cb8cf4bed..67644f5e92a2 100644 --- a/spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java +++ b/spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java @@ -52,7 +52,7 @@ public class NameMatchCacheOperationSource implements CacheOperationSource, Seri /** * Set a name/attribute map, consisting of method names - * (e.g. "myMethod") and CacheOperation instances + * (for example, "myMethod") and CacheOperation instances * (or Strings to be converted to CacheOperation instances). * @see CacheOperation */ diff --git a/spring-context/src/main/java/org/springframework/context/ApplicationContext.java b/spring-context/src/main/java/org/springframework/context/ApplicationContext.java index 35c667cec610..ed5270db78df 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationContext.java @@ -107,7 +107,7 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact * @return the AutowireCapableBeanFactory for this context * @throws IllegalStateException if the context does not support the * {@link AutowireCapableBeanFactory} interface, or does not hold an - * autowire-capable bean factory yet (e.g. if {@code refresh()} has + * autowire-capable bean factory yet (for example, if {@code refresh()} has * never been called), or if the context has been closed already * @see ConfigurableApplicationContext#refresh() * @see ConfigurableApplicationContext#getBeanFactory() diff --git a/spring-context/src/main/java/org/springframework/context/Lifecycle.java b/spring-context/src/main/java/org/springframework/context/Lifecycle.java index 99ba5211ee36..9f7a7c0fa1bd 100644 --- a/spring-context/src/main/java/org/springframework/context/Lifecycle.java +++ b/spring-context/src/main/java/org/springframework/context/Lifecycle.java @@ -25,7 +25,7 @@ *

    Can be implemented by both components (typically a Spring bean defined in a * Spring context) and containers (typically a Spring {@link ApplicationContext} * itself). Containers will propagate start/stop signals to all components that - * apply within each container, e.g. for a stop/restart scenario at runtime. + * apply within each container, for example, for a stop/restart scenario at runtime. * *

    Can be used for direct invocations or for management operations via JMX. * In the latter case, the {@link org.springframework.jmx.export.MBeanExporter} diff --git a/spring-context/src/main/java/org/springframework/context/LifecycleProcessor.java b/spring-context/src/main/java/org/springframework/context/LifecycleProcessor.java index 6be0e0e5996d..a96a63753420 100644 --- a/spring-context/src/main/java/org/springframework/context/LifecycleProcessor.java +++ b/spring-context/src/main/java/org/springframework/context/LifecycleProcessor.java @@ -26,12 +26,12 @@ public interface LifecycleProcessor extends Lifecycle { /** - * Notification of context refresh, e.g. for auto-starting components. + * Notification of context refresh, for example, for auto-starting components. */ void onRefresh(); /** - * Notification of context close phase, e.g. for auto-stopping components. + * Notification of context close phase, for example, for auto-stopping components. */ void onClose(); diff --git a/spring-context/src/main/java/org/springframework/context/MessageSource.java b/spring-context/src/main/java/org/springframework/context/MessageSource.java index 54f5ea88ed05..fd7ecbe23baf 100644 --- a/spring-context/src/main/java/org/springframework/context/MessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/MessageSource.java @@ -41,7 +41,7 @@ public interface MessageSource { /** * Try to resolve the message. Return default message if no message was found. - * @param code the message code to look up, e.g. 'calculator.noRateSet'. + * @param code the message code to look up, for example, 'calculator.noRateSet'. * MessageSource users are encouraged to base message names on qualified class * or package names, avoiding potential conflicts and ensuring maximum clarity. * @param args an array of arguments that will be filled in for params within @@ -59,7 +59,7 @@ public interface MessageSource { /** * Try to resolve the message. Treat as an error if the message can't be found. - * @param code the message code to look up, e.g. 'calculator.noRateSet'. + * @param code the message code to look up, for example, 'calculator.noRateSet'. * MessageSource users are encouraged to base message names on qualified class * or package names, avoiding potential conflicts and ensuring maximum clarity. * @param args an array of arguments that will be filled in for params within diff --git a/spring-context/src/main/java/org/springframework/context/PayloadApplicationEvent.java b/spring-context/src/main/java/org/springframework/context/PayloadApplicationEvent.java index 5f3f0a6c959a..c737fc876404 100644 --- a/spring-context/src/main/java/org/springframework/context/PayloadApplicationEvent.java +++ b/spring-context/src/main/java/org/springframework/context/PayloadApplicationEvent.java @@ -56,7 +56,7 @@ public PayloadApplicationEvent(Object source, T payload) { * @param source the object on which the event initially occurred (never {@code null}) * @param payload the payload object (never {@code null}) * @param payloadType the type object of payload object (can be {@code null}). - * Note that this is meant to indicate the payload type (e.g. {@code String}), + * Note that this is meant to indicate the payload type (for example, {@code String}), * not the full event type (such as {@code PayloadApplicationEvent<<String>}). * @since 6.0 */ diff --git a/spring-context/src/main/java/org/springframework/context/SmartLifecycle.java b/spring-context/src/main/java/org/springframework/context/SmartLifecycle.java index 7567e0f4982c..204f75e61477 100644 --- a/spring-context/src/main/java/org/springframework/context/SmartLifecycle.java +++ b/spring-context/src/main/java/org/springframework/context/SmartLifecycle.java @@ -73,7 +73,7 @@ public interface SmartLifecycle extends Lifecycle, Phased { * {@code SmartLifecycle} beans into a later startup phase and an earlier * shutdown phase. *

    Note that certain {@code SmartLifecycle} components come with a different - * default phase: e.g. executors/schedulers with {@code Integer.MAX_VALUE / 2}. + * default phase: for example, executors/schedulers with {@code Integer.MAX_VALUE / 2}. * @since 5.1 * @see #getPhase() * @see org.springframework.scheduling.concurrent.ExecutorConfigurationSupport#DEFAULT_PHASE diff --git a/spring-context/src/main/java/org/springframework/context/annotation/AnnotatedBeanDefinitionReader.java b/spring-context/src/main/java/org/springframework/context/annotation/AnnotatedBeanDefinitionReader.java index eb3ea0aead76..6b156b4ebb66 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/AnnotatedBeanDefinitionReader.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/AnnotatedBeanDefinitionReader.java @@ -60,7 +60,7 @@ public class AnnotatedBeanDefinitionReader { /** * Create a new {@code AnnotatedBeanDefinitionReader} for the given registry. - *

    If the registry is {@link EnvironmentCapable}, e.g. is an {@code ApplicationContext}, + *

    If the registry is {@link EnvironmentCapable}, for example, is an {@code ApplicationContext}, * the {@link Environment} will be inherited, otherwise a new * {@link StandardEnvironment} will be created and used. * @param registry the {@code BeanFactory} to load bean definitions into, @@ -130,7 +130,7 @@ public void setScopeMetadataResolver(@Nullable ScopeMetadataResolver scopeMetada *

    Calls to {@code register} are idempotent; adding the same * component class more than once has no additional effect. * @param componentClasses one or more component classes, - * e.g. {@link Configuration @Configuration} classes + * for example, {@link Configuration @Configuration} classes */ public void register(Class... componentClasses) { for (Class componentClass : componentClasses) { @@ -224,7 +224,7 @@ public void registerBean(Class beanClass, @Nullable String name, @Nullabl * @param supplier a callback for creating an instance of the bean * (may be {@code null}) * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.2 */ public void registerBean(Class beanClass, @Nullable String name, @Nullable Supplier supplier, @@ -243,7 +243,7 @@ public void registerBean(Class beanClass, @Nullable String name, @Nullabl * @param supplier a callback for creating an instance of the bean * (may be {@code null}) * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.0 */ private void doRegisterBean(Class beanClass, @Nullable String name, diff --git a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationBeanNameGenerator.java b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationBeanNameGenerator.java index 4f0f8a7e62b5..3361f0560e57 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationBeanNameGenerator.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationBeanNameGenerator.java @@ -241,7 +241,7 @@ protected String buildDefaultBeanName(BeanDefinition definition, BeanDefinitionR /** * Derive a default bean name from the given bean definition. *

    The default implementation simply builds a decapitalized version - * of the short class name: e.g. "mypackage.MyJdbcDao" → "myJdbcDao". + * of the short class name: for example, "mypackage.MyJdbcDao" → "myJdbcDao". *

    Note that inner classes will thus have names of the form * "outerClassName.InnerClassName", which because of the period in the * name may be an issue if you are autowiring by name. diff --git a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigRegistry.java b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigRegistry.java index 45355379340d..4cac35bb999a 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigRegistry.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigRegistry.java @@ -30,7 +30,7 @@ public interface AnnotationConfigRegistry { *

    Calls to {@code register} are idempotent; adding the same * component class more than once has no additional effect. * @param componentClasses one or more component classes, - * e.g. {@link Configuration @Configuration} classes + * for example, {@link Configuration @Configuration} classes */ void register(Class... componentClasses); diff --git a/spring-context/src/main/java/org/springframework/context/annotation/Bean.java b/spring-context/src/main/java/org/springframework/context/annotation/Bean.java index e83557c9cd44..7f068fef659e 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/Bean.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/Bean.java @@ -300,7 +300,7 @@ * method (i.e., detection occurs reflectively against the bean instance itself at * creation time). *

    To disable destroy method inference for a particular {@code @Bean}, specify an - * empty string as the value, e.g. {@code @Bean(destroyMethod="")}. Note that the + * empty string as the value, for example, {@code @Bean(destroyMethod="")}. Note that the * {@link org.springframework.beans.factory.DisposableBean} callback interface will * nevertheless get detected and the corresponding destroy method invoked: In other * words, {@code destroyMethod=""} only affects custom close/shutdown methods and diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ClassPathBeanDefinitionScanner.java b/spring-context/src/main/java/org/springframework/context/annotation/ClassPathBeanDefinitionScanner.java index 7aa22b2eb7ad..a68de8cacb99 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ClassPathBeanDefinitionScanner.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ClassPathBeanDefinitionScanner.java @@ -312,7 +312,7 @@ protected void postProcessBeanDefinition(AbstractBeanDefinition beanDefinition, /** * Register the specified bean with the given registry. - *

    Can be overridden in subclasses, e.g. to adapt the registration + *

    Can be overridden in subclasses, for example, to adapt the registration * process or to register further bean definitions for each scanned bean. * @param definitionHolder the bean definition plus bean name for the bean * @param registry the BeanDefinitionRegistry to register the bean with diff --git a/spring-context/src/main/java/org/springframework/context/annotation/CommonAnnotationBeanPostProcessor.java b/spring-context/src/main/java/org/springframework/context/annotation/CommonAnnotationBeanPostProcessor.java index a72b7f9b1c00..2d684f9875b3 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/CommonAnnotationBeanPostProcessor.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/CommonAnnotationBeanPostProcessor.java @@ -81,7 +81,7 @@ * {@link org.springframework.beans.factory.config.BeanPostProcessor} implementation * that supports common Java annotations out of the box, in particular the common * annotations in the {@code jakarta.annotation} package. These common Java - * annotations are supported in many Jakarta EE technologies (e.g. JSF and JAX-RS). + * annotations are supported in many Jakarta EE technologies (for example, JSF and JAX-RS). * *

    This post-processor includes support for the {@link jakarta.annotation.PostConstruct} * and {@link jakarta.annotation.PreDestroy} annotations - as init annotation diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ComponentScan.java b/spring-context/src/main/java/org/springframework/context/annotation/ComponentScan.java index 0437a3c325e3..d25e5fb4928e 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ComponentScan.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ComponentScan.java @@ -42,7 +42,7 @@ *

    Note that the {@code } element has an * {@code annotation-config} attribute; however, this annotation does not. This is because * in almost all cases when using {@code @ComponentScan}, default annotation config - * processing (e.g. processing {@code @Autowired} and friends) is assumed. Furthermore, + * processing (for example, processing {@code @Autowired} and friends) is assumed. Furthermore, * when using {@link AnnotationConfigApplicationContext}, annotation config processors are * always registered, meaning that any attempt to disable them at the * {@code @ComponentScan} level would be ignored. @@ -103,7 +103,7 @@ * within the Spring container. *

    The default value of the {@link BeanNameGenerator} interface itself indicates * that the scanner used to process this {@code @ComponentScan} annotation should - * use its inherited bean name generator, e.g. the default + * use its inherited bean name generator, for example, the default * {@link AnnotationBeanNameGenerator} or any custom instance supplied to the * application context at bootstrap time. * @see AnnotationConfigApplicationContext#setBeanNameGenerator(BeanNameGenerator) diff --git a/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java b/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java index b93f1159dd94..96314a730230 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/Configuration.java @@ -443,14 +443,14 @@ /** * Specify whether {@code @Bean} methods should get proxied in order to enforce - * bean lifecycle behavior, e.g. to return shared singleton bean instances even + * bean lifecycle behavior, for example, to return shared singleton bean instances even * in case of direct {@code @Bean} method calls in user code. This feature * requires method interception, implemented through a runtime-generated CGLIB * subclass which comes with limitations such as the configuration class and * its methods not being allowed to declare {@code final}. *

    The default is {@code true}, allowing for 'inter-bean references' via direct * method calls within the configuration class as well as for external calls to - * this configuration's {@code @Bean} methods, e.g. from another configuration class. + * this configuration's {@code @Bean} methods, for example, from another configuration class. * If this is not needed since each of this particular configuration's {@code @Bean} * methods is self-contained and designed as a plain factory method for container use, * switch this flag to {@code false} in order to avoid CGLIB subclass processing. diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java index 722c35baf0d0..bf0887ed9c28 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java @@ -201,7 +201,7 @@ private void loadBeanDefinitionsForBeanMethod(BeanMethod beanMethod) { this.registry.registerAlias(beanName, alias); } - // Has this effectively been overridden before (e.g. via XML)? + // Has this effectively been overridden before (for example, via XML)? if (isOverriddenByExistingDefinition(beanMethod, beanName)) { if (beanName.equals(beanMethod.getConfigurationClass().getBeanName())) { throw new BeanDefinitionStoreException(beanMethod.getConfigurationClass().getResource().getDescription(), diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassEnhancer.java b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassEnhancer.java index 21392d5fc7cc..113e0d3007d2 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassEnhancer.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassEnhancer.java @@ -102,7 +102,7 @@ public Class enhance(Class configClass, @Nullable ClassLoader classLoader) if (logger.isDebugEnabled()) { logger.debug(String.format("Ignoring request to enhance %s as it has " + "already been enhanced. This usually indicates that more than one " + - "ConfigurationClassPostProcessor has been registered (e.g. via " + + "ConfigurationClassPostProcessor has been registered (for example, via " + "). This is harmless, but you may " + "want check your configuration and remove one CCPP if possible", configClass.getName())); @@ -164,7 +164,7 @@ private Class createClass(Enhancer enhancer) { /** * Marker interface to be implemented by all @Configuration CGLIB subclasses. * Facilitates idempotent behavior for {@link ConfigurationClassEnhancer#enhance} - * through checking to see if candidate classes are already assignable to it, e.g. + * through checking to see if candidate classes are already assignable to it, for example, * have already been enhanced. *

    Also extends {@link BeanFactoryAware}, as all enhanced {@code @Configuration} * classes require access to the {@link BeanFactory} that created them. diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java index 5fe5d1bc5efc..52823f67fa30 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java @@ -229,7 +229,7 @@ public void setMetadataReaderFactory(MetadataReaderFactory metadataReaderFactory * class names instead of standard component overriding). *

    Note that this strategy does not apply to {@link Bean} methods. *

    This setter is typically only appropriate when configuring the post-processor as a - * standalone bean definition in XML, e.g. not using the dedicated {@code AnnotationConfig*} + * standalone bean definition in XML, for example, not using the dedicated {@code AnnotationConfig*} * application contexts or the {@code } element. Any bean name * generator specified against the application context will take precedence over any set here. * @since 3.1.1 diff --git a/spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java b/spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java index 62cb6404c493..e14729c06e92 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/EnableAspectJAutoProxy.java @@ -103,7 +103,7 @@ * * Note: {@code @EnableAspectJAutoProxy} applies to its local application context only, * allowing for selective proxying of beans at different levels. Please redeclare - * {@code @EnableAspectJAutoProxy} in each individual context, e.g. the common root web + * {@code @EnableAspectJAutoProxy} in each individual context, for example, the common root web * application context and any separate {@code DispatcherServlet} application contexts, * if you need to apply its behavior at multiple levels. * diff --git a/spring-context/src/main/java/org/springframework/context/annotation/EnableLoadTimeWeaving.java b/spring-context/src/main/java/org/springframework/context/annotation/EnableLoadTimeWeaving.java index 506a45c6607c..b0c3aea5fc40 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/EnableLoadTimeWeaving.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/EnableLoadTimeWeaving.java @@ -92,7 +92,7 @@ *

    * *

    The code example differs from the XML example in that it actually instantiates the - * {@code MyLoadTimeWeaver} type, meaning that it can also configure the instance, e.g. + * {@code MyLoadTimeWeaver} type, meaning that it can also configure the instance, for example, * calling the {@code #addClassTransformer} method. This demonstrates how the code-based * configuration approach is more flexible through direct programmatic access. * diff --git a/spring-context/src/main/java/org/springframework/context/annotation/Jsr330ScopeMetadataResolver.java b/spring-context/src/main/java/org/springframework/context/annotation/Jsr330ScopeMetadataResolver.java index b3e1c6736ef1..06ab3313eccc 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/Jsr330ScopeMetadataResolver.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/Jsr330ScopeMetadataResolver.java @@ -73,7 +73,7 @@ public final void registerScope(String annotationType, String scopeName) { /** * Resolve the given annotation type into a named Spring scope. *

    The default implementation simply checks against registered scopes. - * Can be overridden for custom mapping rules, e.g. naming conventions. + * Can be overridden for custom mapping rules, for example, naming conventions. * @param annotationType the JSR-330 annotation type * @return the Spring scope name */ diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ParserStrategyUtils.java b/spring-context/src/main/java/org/springframework/context/annotation/ParserStrategyUtils.java index 8decf18cfad3..adbfbecb457f 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ParserStrategyUtils.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ParserStrategyUtils.java @@ -34,8 +34,8 @@ import org.springframework.util.Assert; /** - * Common delegate code for the handling of parser strategies, e.g. - * {@code TypeFilter}, {@code ImportSelector}, {@code ImportBeanDefinitionRegistrar} + * Common delegate code for the handling of parser strategies, for example, + * {@code TypeFilter}, {@code ImportSelector}, {@code ImportBeanDefinitionRegistrar}. * * @author Juergen Hoeller * @author Phillip Webb diff --git a/spring-context/src/main/java/org/springframework/context/annotation/Profile.java b/spring-context/src/main/java/org/springframework/context/annotation/Profile.java index b128bf9208c0..9575ef1aa8fc 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/Profile.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/Profile.java @@ -63,7 +63,7 @@ * details about supported formats. * *

    This is analogous to the behavior in Spring XML: if the {@code profile} attribute of - * the {@code beans} element is supplied e.g., {@code }, the + * the {@code beans} element is supplied, for example, {@code }, the * {@code beans} element will not be parsed unless at least profile 'p1' or 'p2' has been * activated. Likewise, if a {@code @Component} or {@code @Configuration} class is marked * with {@code @Profile({"p1", "p2"})}, that class will not be registered or processed unless diff --git a/spring-context/src/main/java/org/springframework/context/annotation/PropertySource.java b/spring-context/src/main/java/org/springframework/context/annotation/PropertySource.java index d6e5dc4339ab..c45ab857dbb2 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/PropertySource.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/PropertySource.java @@ -222,7 +222,7 @@ boolean ignoreResourceNotFound() default false; /** - * A specific character encoding for the given resources, e.g. "UTF-8". + * A specific character encoding for the given resources, for example, "UTF-8". * @since 4.3 */ String encoding() default ""; diff --git a/spring-context/src/main/java/org/springframework/context/event/AbstractApplicationEventMulticaster.java b/spring-context/src/main/java/org/springframework/context/event/AbstractApplicationEventMulticaster.java index 14f8c44e950a..c552e5791593 100644 --- a/spring-context/src/main/java/org/springframework/context/event/AbstractApplicationEventMulticaster.java +++ b/spring-context/src/main/java/org/springframework/context/event/AbstractApplicationEventMulticaster.java @@ -298,7 +298,7 @@ private Collection> retrieveApplicationListeners( else { // Remove non-matching listeners that originally came from // ApplicationListenerDetector, possibly ruled out by additional - // BeanDefinition metadata (e.g. factory method generics) above. + // BeanDefinition metadata (for example, factory method generics) above. Object listener = beanFactory.getSingleton(listenerBeanName); if (retriever != null) { filteredListeners.remove(listener); diff --git a/spring-context/src/main/java/org/springframework/context/event/ApplicationEventMulticaster.java b/spring-context/src/main/java/org/springframework/context/event/ApplicationEventMulticaster.java index a57899969d7f..cfbdd769a22d 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ApplicationEventMulticaster.java +++ b/spring-context/src/main/java/org/springframework/context/event/ApplicationEventMulticaster.java @@ -73,12 +73,12 @@ public interface ApplicationEventMulticaster { /** * Remove all matching listeners from the set of registered * {@code ApplicationListener} instances (which includes adapter classes - * such as {@link ApplicationListenerMethodAdapter}, e.g. for annotated + * such as {@link ApplicationListenerMethodAdapter}, for example, for annotated * {@link EventListener} methods). *

    Note: This just applies to instance registrations, not to listeners * registered by bean name. * @param predicate the predicate to identify listener instances to remove, - * e.g. checking {@link SmartApplicationListener#getListenerId()} + * for example, checking {@link SmartApplicationListener#getListenerId()} * @since 5.3.5 * @see #addApplicationListener(ApplicationListener) * @see #removeApplicationListener(ApplicationListener) diff --git a/spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java b/spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java index a717216728a0..a72d1a01fe2b 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java +++ b/spring-context/src/main/java/org/springframework/context/event/ApplicationListenerMethodAdapter.java @@ -455,7 +455,7 @@ private void assertTargetBean(Method method, Object targetBean, @Nullable Object String msg = "The event listener method class '" + methodDeclaringClass.getName() + "' is not an instance of the actual bean class '" + targetBeanClass.getName() + "'. If the bean requires proxying " + - "(e.g. due to @Transactional), please use class-based proxying."; + "(for example, due to @Transactional), please use class-based proxying."; throw new IllegalStateException(getInvocationErrorMessage(targetBean, msg, args)); } } diff --git a/spring-context/src/main/java/org/springframework/context/event/EventListener.java b/spring-context/src/main/java/org/springframework/context/event/EventListener.java index 71652574b403..8ee83d9e454e 100644 --- a/spring-context/src/main/java/org/springframework/context/event/EventListener.java +++ b/spring-context/src/main/java/org/springframework/context/event/EventListener.java @@ -142,7 +142,7 @@ /** * An optional identifier for the listener, defaulting to the fully-qualified - * signature of the declaring method (e.g. "mypackage.MyClass.myMethod()"). + * signature of the declaring method (for example, "mypackage.MyClass.myMethod()"). * @since 5.3.5 * @see SmartApplicationListener#getListenerId() * @see ApplicationEventMulticaster#removeApplicationListeners(Predicate) diff --git a/spring-context/src/main/java/org/springframework/context/event/SimpleApplicationEventMulticaster.java b/spring-context/src/main/java/org/springframework/context/event/SimpleApplicationEventMulticaster.java index a9a067a92791..d2fe7feb5c05 100644 --- a/spring-context/src/main/java/org/springframework/context/event/SimpleApplicationEventMulticaster.java +++ b/spring-context/src/main/java/org/springframework/context/event/SimpleApplicationEventMulticaster.java @@ -86,7 +86,7 @@ public SimpleApplicationEventMulticaster(BeanFactory beanFactory) { * unless the TaskExecutor explicitly supports this. *

    {@link ApplicationListener} instances which declare no support for asynchronous * execution ({@link ApplicationListener#supportsAsyncExecution()} always run within - * the original thread which published the event, e.g. the transaction-synchronized + * the original thread which published the event, for example, the transaction-synchronized * {@link org.springframework.transaction.event.TransactionalApplicationListener}. * @since 2.0 * @see org.springframework.core.task.SyncTaskExecutor @@ -117,7 +117,7 @@ protected Executor getTaskExecutor() { * and logs exceptions (a la * {@link org.springframework.scheduling.support.TaskUtils#LOG_AND_SUPPRESS_ERROR_HANDLER}) * or an implementation that logs exceptions while nevertheless propagating them - * (e.g. {@link org.springframework.scheduling.support.TaskUtils#LOG_AND_PROPAGATE_ERROR_HANDLER}). + * (for example, {@link org.springframework.scheduling.support.TaskUtils#LOG_AND_PROPAGATE_ERROR_HANDLER}). * @since 4.1 */ public void setErrorHandler(@Nullable ErrorHandler errorHandler) { diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java index cf320c12ff76..1ed265a35f8c 100644 --- a/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java @@ -118,7 +118,7 @@ * {@link org.springframework.core.io.DefaultResourceLoader}. * Consequently treats non-URL resource paths as class path resources * (supporting full class path resource names that include the package path, - * e.g. "mypackage/myresource.dat"), unless the {@link #getResourceByPath} + * for example, "mypackage/myresource.dat"), unless the {@link #getResourceByPath} * method is overridden in a subclass. * * @author Rod Johnson @@ -791,7 +791,7 @@ protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory b PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors()); // Detect a LoadTimeWeaver and prepare for weaving, if found in the meantime - // (e.g. through an @Bean method registered by ConfigurationClassPostProcessor) + // (for example, through an @Bean method registered by ConfigurationClassPostProcessor) if (!NativeDetector.inNativeImage() && beanFactory.getTempClassLoader() == null && beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) { beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory)); @@ -1083,7 +1083,7 @@ public void run() { /** * Determine whether an active startup/shutdown thread is currently stuck, - * e.g. through a {@code System.exit} call in a user component. + * for example, through a {@code System.exit} call in a user component. */ private boolean isStartupShutdownThreadStuck() { Thread activeThread = this.startupShutdownThread; diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java b/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java index 2f3840ed486a..cb51fe9def12 100644 --- a/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/support/AbstractMessageSource.java @@ -87,7 +87,7 @@ public MessageSource getParentMessageSource() { /** * Specify locale-independent common messages, with the message code as key * and the full message String (may contain argument placeholders) as value. - *

    May also link to an externally defined Properties object, e.g. defined + *

    May also link to an externally defined Properties object, for example, defined * through a {@link org.springframework.beans.factory.config.PropertiesFactoryBean}. */ public void setCommonMessages(@Nullable Properties commonMessages) { diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractResourceBasedMessageSource.java b/spring-context/src/main/java/org/springframework/context/support/AbstractResourceBasedMessageSource.java index 0d633af00716..0a0f8bd0be35 100644 --- a/spring-context/src/main/java/org/springframework/context/support/AbstractResourceBasedMessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/support/AbstractResourceBasedMessageSource.java @@ -54,7 +54,7 @@ public abstract class AbstractResourceBasedMessageSource extends AbstractMessage * Set a single basename, following the basic ResourceBundle convention * of not specifying file extension or language codes. The resource location * format is up to the specific {@code MessageSource} implementation. - *

    Regular and XMl properties files are supported: e.g. "messages" will find + *

    Regular and XMl properties files are supported: for example, "messages" will find * a "messages.properties", "messages_en.properties" etc arrangement as well * as "messages.xml", "messages_en.xml" etc. * @param basename the single basename @@ -70,7 +70,7 @@ public void setBasename(String basename) { * Set an array of basenames, each following the basic ResourceBundle convention * of not specifying file extension or language codes. The resource location * format is up to the specific {@code MessageSource} implementation. - *

    Regular and XMl properties files are supported: e.g. "messages" will find + *

    Regular and XMl properties files are supported: for example, "messages" will find * a "messages.properties", "messages_en.properties" etc arrangement as well * as "messages.xml", "messages_en.xml" etc. *

    The associated resource bundles will be checked sequentially when resolving @@ -142,7 +142,7 @@ protected String getDefaultEncoding() { /** * Set whether to fall back to the system Locale if no files for a specific * Locale have been found. Default is "true"; if this is turned off, the only - * fallback will be the default file (e.g. "messages.properties" for + * fallback will be the default file (for example, "messages.properties" for * basename "messages"). *

    Falling back to the system Locale is the default behavior of * {@code java.util.ResourceBundle}. However, this is often not desirable diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractXmlApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/AbstractXmlApplicationContext.java index c21002abd2cc..961704adcfa9 100644 --- a/spring-context/src/main/java/org/springframework/context/support/AbstractXmlApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/AbstractXmlApplicationContext.java @@ -98,7 +98,7 @@ protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throw /** * Initialize the bean definition reader used for loading the bean definitions * of this context. The default implementation sets the validating flag. - *

    Can be overridden in subclasses, e.g. for turning off XML validation + *

    Can be overridden in subclasses, for example, for turning off XML validation * or using a different {@link BeanDefinitionDocumentReader} implementation. * @param reader the bean definition reader used by this context * @see XmlBeanDefinitionReader#setValidating diff --git a/spring-context/src/main/java/org/springframework/context/support/ApplicationObjectSupport.java b/spring-context/src/main/java/org/springframework/context/support/ApplicationObjectSupport.java index 9e298434699e..73d37a4aa261 100644 --- a/spring-context/src/main/java/org/springframework/context/support/ApplicationObjectSupport.java +++ b/spring-context/src/main/java/org/springframework/context/support/ApplicationObjectSupport.java @@ -28,13 +28,13 @@ /** * Convenient superclass for application objects that want to be aware of - * the application context, e.g. for custom lookup of collaborating beans + * the application context, for example, for custom lookup of collaborating beans * or for context-specific resource access. It saves the application * context reference and provides an initialization callback method. * Furthermore, it offers numerous convenience methods for message lookup. * *

    There is no requirement to subclass this class: It just makes things - * a little easier if you need access to the context, e.g. for access to + * a little easier if you need access to the context, for example, for access to * file resources or to the message source. Note that many application * objects do not need to be aware of the application context at all, * as they can receive collaborating beans via bean references. diff --git a/spring-context/src/main/java/org/springframework/context/support/ClassPathXmlApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/ClassPathXmlApplicationContext.java index 9b72875faa8d..57fa66128529 100644 --- a/spring-context/src/main/java/org/springframework/context/support/ClassPathXmlApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/ClassPathXmlApplicationContext.java @@ -26,7 +26,7 @@ /** * Standalone XML application context, taking the context definition files * from the class path, interpreting plain paths as class path resource names - * that include the package path (e.g. "mypackage/myresource.txt"). Useful for + * that include the package path (for example, "mypackage/myresource.txt"). Useful for * test harnesses as well as for application contexts embedded within JARs. * *

    The config location defaults can be overridden via {@link #getConfigLocations}, diff --git a/spring-context/src/main/java/org/springframework/context/support/FileSystemXmlApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/FileSystemXmlApplicationContext.java index e6abe2b0f121..c9166da80182 100644 --- a/spring-context/src/main/java/org/springframework/context/support/FileSystemXmlApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/FileSystemXmlApplicationContext.java @@ -25,7 +25,7 @@ /** * Standalone XML application context, taking the context definition files * from the file system or from URLs, interpreting plain paths as relative - * file system locations (e.g. "mydir/myfile.txt"). Useful for test harnesses + * file system locations (for example, "mydir/myfile.txt"). Useful for test harnesses * as well as for standalone environments. * *

    NOTE: Plain paths will always be interpreted as relative diff --git a/spring-context/src/main/java/org/springframework/context/support/GenericApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/GenericApplicationContext.java index ab6a509b4b00..ae747074c5c8 100644 --- a/spring-context/src/main/java/org/springframework/context/support/GenericApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/GenericApplicationContext.java @@ -510,7 +510,7 @@ public void registerBean(@Nullable String beanName, Class beanClass, Obje * @param beanClass the class of the bean (resolving a public constructor * to be autowired, possibly simply the default constructor) * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.0 * @see #registerBean(String, Class, Supplier, BeanDefinitionCustomizer...) */ @@ -525,7 +525,7 @@ public final void registerBean(Class beanClass, BeanDefinitionCustomizer. * @param beanClass the class of the bean (resolving a public constructor * to be autowired, possibly simply the default constructor) * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.0 * @see #registerBean(String, Class, Supplier, BeanDefinitionCustomizer...) */ @@ -543,7 +543,7 @@ public final void registerBean( * @param beanClass the class of the bean * @param supplier a callback for creating an instance of the bean * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.0 * @see #registerBean(String, Class, Supplier, BeanDefinitionCustomizer...) */ @@ -565,7 +565,7 @@ public final void registerBean( * @param supplier a callback for creating an instance of the bean (in case * of {@code null}, resolving a public constructor to be autowired instead) * @param customizers one or more callbacks for customizing the factory's - * {@link BeanDefinition}, e.g. setting a lazy-init or primary flag + * {@link BeanDefinition}, for example, setting a lazy-init or primary flag * @since 5.0 */ public void registerBean(@Nullable String beanName, Class beanClass, diff --git a/spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java index ac1569e319da..e164165074d3 100644 --- a/spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/GenericGroovyApplicationContext.java @@ -66,7 +66,7 @@ *

    * *

    Alternatively, load a Groovy bean definition script like the following - * from an external resource (e.g. an "applicationContext.groovy" file): + * from an external resource (for example, an "applicationContext.groovy" file): * *

      * import org.hibernate.SessionFactory
    diff --git a/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java b/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java
    index 6c36abd36e0e..ba3f7b7c9b01 100644
    --- a/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java
    +++ b/spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java
    @@ -170,7 +170,7 @@ public String getMessage(String code, @Nullable Object[] args, Locale locale) th
     	}
     
     	/**
    -	 * Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance)
    +	 * Retrieve the given MessageSourceResolvable (for example, an ObjectError instance)
     	 * in the default Locale.
     	 * @param resolvable the MessageSourceResolvable
     	 * @return the message
    @@ -181,7 +181,7 @@ public String getMessage(MessageSourceResolvable resolvable) throws NoSuchMessag
     	}
     
     	/**
    -	 * Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance)
    +	 * Retrieve the given MessageSourceResolvable (for example, an ObjectError instance)
     	 * in the given Locale.
     	 * @param resolvable the MessageSourceResolvable
     	 * @param locale the Locale in which to do lookup
    diff --git a/spring-context/src/main/java/org/springframework/context/support/PostProcessorRegistrationDelegate.java b/spring-context/src/main/java/org/springframework/context/support/PostProcessorRegistrationDelegate.java
    index 7735045a9808..af7d0871ae8f 100644
    --- a/spring-context/src/main/java/org/springframework/context/support/PostProcessorRegistrationDelegate.java
    +++ b/spring-context/src/main/java/org/springframework/context/support/PostProcessorRegistrationDelegate.java
    @@ -204,7 +204,7 @@ else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
     		invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);
     
     		// Clear cached merged bean definitions since the post-processors might have
    -		// modified the original metadata, e.g. replacing placeholders in values...
    +		// modified the original metadata, for example, replacing placeholders in values...
     		beanFactory.clearMetadataCache();
     	}
     
    diff --git a/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java b/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java
    index 1035e175e610..31d1652542b8 100644
    --- a/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java
    +++ b/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java
    @@ -48,7 +48,7 @@
      * {@code PropertyPlaceholderConfigurer} to ensure backward compatibility. See the spring-context
      * XSD documentation for complete details.
      *
    - * 

    Any local properties (e.g. those added via {@link #setProperties}, {@link #setLocations} + *

    Any local properties (for example, those added via {@link #setProperties}, {@link #setLocations} * et al.) are added as a {@code PropertySource}. Search precedence of local properties is * based on the value of the {@link #setLocalOverride localOverride} property, which is by * default {@code false} meaning that local properties are to be searched last, after all diff --git a/spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java b/spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java index a254cbd9fa76..3f70d049435e 100644 --- a/spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/support/ReloadableResourceBundleMessageSource.java @@ -63,7 +63,7 @@ * other than "-1" (caching forever) might not work reliably in this case. * *

    For a typical web application, message files could be placed in {@code WEB-INF}: - * e.g. a "WEB-INF/messages" basename would find a "WEB-INF/messages.properties", + * for example, a "WEB-INF/messages" basename would find a "WEB-INF/messages.properties", * "WEB-INF/messages_en.properties" etc arrangement as well as "WEB-INF/messages.xml", * "WEB-INF/messages_en.xml" etc. Note that message definitions in a previous * resource bundle will override ones in a later bundle, due to sequential lookup. @@ -137,7 +137,7 @@ public void setFileExtensions(List fileExtensions) { *

    Only applies to classic properties files, not to XML files. * @param fileEncodings a Properties with filenames as keys and charset * names as values. Filenames have to match the basename syntax, - * with optional locale-specific components: e.g. "WEB-INF/messages" + * with optional locale-specific components: for example, "WEB-INF/messages" * or "WEB-INF/messages_en". * @see #setBasenames * @see org.springframework.util.PropertiesPersister#load diff --git a/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java b/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java index 435ad2b7ec24..501a874cf185 100644 --- a/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java +++ b/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java @@ -99,7 +99,7 @@ * a style or ISO format. *

    Note: This pattern follows the original {@link java.text.SimpleDateFormat} style, * as also supported by Joda-Time, with strict parsing semantics towards overflows - * (e.g. rejecting a Feb 29 value for a non-leap-year). As a consequence, 'yy' + * (for example, rejecting a Feb 29 value for a non-leap-year). As a consequence, 'yy' * characters indicate a year in the traditional style, not a "year-of-era" as in the * {@link java.time.format.DateTimeFormatter} specification (i.e. 'yy' turns into 'uu' * when going through a {@code DateTimeFormatter} with strict resolution mode). diff --git a/spring-context/src/main/java/org/springframework/format/annotation/NumberFormat.java b/spring-context/src/main/java/org/springframework/format/annotation/NumberFormat.java index 536a9cdce150..ce0676bf96ec 100644 --- a/spring-context/src/main/java/org/springframework/format/annotation/NumberFormat.java +++ b/spring-context/src/main/java/org/springframework/format/annotation/NumberFormat.java @@ -74,7 +74,7 @@ enum Style { /** * The default format for the annotated type: typically 'number' but possibly - * 'currency' for a money type (e.g. {@code javax.money.MonetaryAmount}). + * 'currency' for a money type (for example, {@code javax.money.MonetaryAmount}). * @since 4.2 */ DEFAULT, diff --git a/spring-context/src/main/java/org/springframework/format/datetime/standard/DateTimeFormatterUtils.java b/spring-context/src/main/java/org/springframework/format/datetime/standard/DateTimeFormatterUtils.java index 3aff5d779dd2..b519b922fe56 100644 --- a/spring-context/src/main/java/org/springframework/format/datetime/standard/DateTimeFormatterUtils.java +++ b/spring-context/src/main/java/org/springframework/format/datetime/standard/DateTimeFormatterUtils.java @@ -39,7 +39,7 @@ abstract class DateTimeFormatterUtils { */ static DateTimeFormatter createStrictDateTimeFormatter(String pattern) { // Using strict resolution to align with Joda-Time and standard DateFormat behavior: - // otherwise, an overflow like e.g. Feb 29 for a non-leap-year wouldn't get rejected. + // otherwise, an overflow like, for example, Feb 29 for a non-leap-year wouldn't get rejected. // However, with strict resolution, a year digit needs to be specified as 'u'... String patternToUse = StringUtils.replace(pattern, "yy", "uu"); return DateTimeFormatter.ofPattern(patternToUse).withResolverStyle(ResolverStyle.STRICT); diff --git a/spring-context/src/main/java/org/springframework/format/datetime/standard/DurationFormatter.java b/spring-context/src/main/java/org/springframework/format/datetime/standard/DurationFormatter.java index ede1291d4d6a..ee9a53a36cb0 100644 --- a/spring-context/src/main/java/org/springframework/format/datetime/standard/DurationFormatter.java +++ b/spring-context/src/main/java/org/springframework/format/datetime/standard/DurationFormatter.java @@ -50,7 +50,7 @@ public class DurationFormatter implements Formatter { /** * Create a {@code DurationFormatter} in a specific {@link DurationFormat.Style}. - *

    When a unit is needed but cannot be determined (e.g. printing a Duration in the + *

    When a unit is needed but cannot be determined (for example, printing a Duration in the * {@code SIMPLE} style), {@code DurationFormat.Unit#MILLIS} is used. */ public DurationFormatter(DurationFormat.Style style) { diff --git a/spring-context/src/main/java/org/springframework/instrument/classloading/InstrumentationLoadTimeWeaver.java b/spring-context/src/main/java/org/springframework/instrument/classloading/InstrumentationLoadTimeWeaver.java index 47bedbc67df1..b3b57cab0554 100644 --- a/spring-context/src/main/java/org/springframework/instrument/classloading/InstrumentationLoadTimeWeaver.java +++ b/spring-context/src/main/java/org/springframework/instrument/classloading/InstrumentationLoadTimeWeaver.java @@ -35,7 +35,7 @@ * follows where spring-instrument-{version}.jar is a JAR file * containing the {@link InstrumentationSavingAgent} class shipped with Spring * and where {version} is the release version of the Spring - * Framework (e.g., {@code 5.1.5.RELEASE}). + * Framework (for example, {@code 5.1.5.RELEASE}). * *

    -javaagent:path/to/spring-instrument-{version}.jar * diff --git a/spring-context/src/main/java/org/springframework/instrument/classloading/ReflectiveLoadTimeWeaver.java b/spring-context/src/main/java/org/springframework/instrument/classloading/ReflectiveLoadTimeWeaver.java index 6830b8983072..1d01c3d96755 100644 --- a/spring-context/src/main/java/org/springframework/instrument/classloading/ReflectiveLoadTimeWeaver.java +++ b/spring-context/src/main/java/org/springframework/instrument/classloading/ReflectiveLoadTimeWeaver.java @@ -53,7 +53,7 @@ * web application). There is no direct API dependency between this LoadTimeWeaver * adapter and the underlying ClassLoader, just a 'loose' method contract. * - *

    This is the LoadTimeWeaver to use e.g. with the Resin application server + *

    This is the LoadTimeWeaver to use, for example, with the Resin application server * version 3.1+. * * @author Costin Leau diff --git a/spring-context/src/main/java/org/springframework/jmx/export/assembler/AbstractReflectiveMBeanInfoAssembler.java b/spring-context/src/main/java/org/springframework/jmx/export/assembler/AbstractReflectiveMBeanInfoAssembler.java index ce7da5dc2328..11902dea7329 100644 --- a/spring-context/src/main/java/org/springframework/jmx/export/assembler/AbstractReflectiveMBeanInfoAssembler.java +++ b/spring-context/src/main/java/org/springframework/jmx/export/assembler/AbstractReflectiveMBeanInfoAssembler.java @@ -266,7 +266,7 @@ protected boolean isExposeClassDescriptor() { /** * Set the ParameterNameDiscoverer to use for resolving method parameter - * names if needed (e.g. for parameter names of MBean operation methods). + * names if needed (for example, for parameter names of MBean operation methods). *

    Default is a {@link DefaultParameterNameDiscoverer}. */ public void setParameterNameDiscoverer(@Nullable ParameterNameDiscoverer parameterNameDiscoverer) { diff --git a/spring-context/src/main/java/org/springframework/jmx/export/naming/KeyNamingStrategy.java b/spring-context/src/main/java/org/springframework/jmx/export/naming/KeyNamingStrategy.java index 70243a86c15a..60edf694fb34 100644 --- a/spring-context/src/main/java/org/springframework/jmx/export/naming/KeyNamingStrategy.java +++ b/spring-context/src/main/java/org/springframework/jmx/export/naming/KeyNamingStrategy.java @@ -82,7 +82,7 @@ public class KeyNamingStrategy implements ObjectNamingStrategy, InitializingBean /** - * Set local properties, containing object name mappings, e.g. via + * Set local properties, containing object name mappings, for example, via * the "props" tag in XML bean definitions. These can be considered * defaults, to be overridden by properties loaded from files. */ diff --git a/spring-context/src/main/java/org/springframework/jndi/JndiLocatorDelegate.java b/spring-context/src/main/java/org/springframework/jndi/JndiLocatorDelegate.java index 640bdc81f28f..c46b2fa94038 100644 --- a/spring-context/src/main/java/org/springframework/jndi/JndiLocatorDelegate.java +++ b/spring-context/src/main/java/org/springframework/jndi/JndiLocatorDelegate.java @@ -34,7 +34,7 @@ public class JndiLocatorDelegate extends JndiLocatorSupport { /** * System property that instructs Spring to ignore a default JNDI environment, i.e. * to always return {@code false} from {@link #isDefaultJndiEnvironmentAvailable()}. - *

    The default is "false", allowing for regular default JNDI access e.g. in + *

    The default is "false", allowing for regular default JNDI access, for example, in * {@link JndiPropertySource}. Switching this flag to {@code true} is an optimization * for scenarios where nothing is ever to be found for such JNDI fallback searches * to begin with, avoiding the repeated JNDI lookup overhead. diff --git a/spring-context/src/main/java/org/springframework/jndi/JndiLocatorSupport.java b/spring-context/src/main/java/org/springframework/jndi/JndiLocatorSupport.java index 5b901f6c415d..7e255cc688c7 100644 --- a/spring-context/src/main/java/org/springframework/jndi/JndiLocatorSupport.java +++ b/spring-context/src/main/java/org/springframework/jndi/JndiLocatorSupport.java @@ -30,7 +30,7 @@ * by Jakarta EE applications when accessing a locally mapped (ENC - Environmental * Naming Context) resource. If it doesn't, the "java:comp/env/" prefix will * be prepended if the "resourceRef" property is true (the default is - * false) and no other scheme (e.g. "java:") is given. + * false) and no other scheme (for example, "java:") is given. * * @author Juergen Hoeller * @since 1.1 @@ -51,7 +51,7 @@ public abstract class JndiLocatorSupport extends JndiAccessor { * Set whether the lookup occurs in a Jakarta EE container, i.e. if the prefix * "java:comp/env/" needs to be added if the JNDI name doesn't already * contain it. Default is "false". - *

    Note: Will only get applied if no other scheme (e.g. "java:") is given. + *

    Note: Will only get applied if no other scheme (for example, "java:") is given. */ public void setResourceRef(boolean resourceRef) { this.resourceRef = resourceRef; @@ -117,7 +117,7 @@ protected T lookup(String jndiName, @Nullable Class requiredType) throws /** * Convert the given JNDI name into the actual JNDI name to use. *

    The default implementation applies the "java:comp/env/" prefix if - * "resourceRef" is "true" and no other scheme (e.g. "java:") is given. + * "resourceRef" is "true" and no other scheme (for example, "java:") is given. * @param jndiName the original JNDI name * @return the JNDI name to use * @see #CONTAINER_PREFIX diff --git a/spring-context/src/main/java/org/springframework/jndi/JndiObjectFactoryBean.java b/spring-context/src/main/java/org/springframework/jndi/JndiObjectFactoryBean.java index b56ce01e0bca..bba7d9b44a2d 100644 --- a/spring-context/src/main/java/org/springframework/jndi/JndiObjectFactoryBean.java +++ b/spring-context/src/main/java/org/springframework/jndi/JndiObjectFactoryBean.java @@ -41,11 +41,11 @@ /** * {@link org.springframework.beans.factory.FactoryBean} that looks up a * JNDI object. Exposes the object found in JNDI for bean references, - * e.g. for data access object's "dataSource" property in case of a + * for example, for data access object's "dataSource" property in case of a * {@link javax.sql.DataSource}. * *

    The typical usage will be to register this as singleton factory - * (e.g. for a certain JNDI-bound DataSource) in an application context, + * (for example, for a certain JNDI-bound DataSource) in an application context, * and give bean references to application services that need it. * *

    The default behavior is to look up the JNDI object on startup and cache it. @@ -54,12 +54,12 @@ * a "proxyInterface" in such a scenario, since the actual JNDI object type is not * known in advance. * - *

    Of course, bean classes in a Spring environment may look up e.g. a DataSource + *

    Of course, bean classes in a Spring environment may look up, for example, a DataSource * from JNDI themselves. This class simply enables central configuration of the * JNDI name, and easy switching to non-JNDI alternatives. The latter is * particularly convenient for test setups, reuse in standalone clients, etc. * - *

    Note that switching to e.g. DriverManagerDataSource is just a matter of + *

    Note that switching to, for example, DriverManagerDataSource is just a matter of * configuration: Simply replace the definition of this FactoryBean with a * {@link org.springframework.jdbc.datasource.DriverManagerDataSource} definition! * @@ -152,7 +152,7 @@ public void setCache(boolean cache) { *

    Default is "false", i.e. to only expose the JNDI context for object lookup. * Switch this flag to "true" in order to expose the JNDI environment (including * the authorization context) for each method invocation, as needed by WebLogic - * for JNDI-obtained factories (e.g. JDBC DataSource, JMS ConnectionFactory) + * for JNDI-obtained factories (for example, JDBC DataSource, JMS ConnectionFactory) * with authorization requirements. */ public void setExposeAccessContext(boolean exposeAccessContext) { diff --git a/spring-context/src/main/java/org/springframework/jndi/JndiObjectLocator.java b/spring-context/src/main/java/org/springframework/jndi/JndiObjectLocator.java index ff2a0ffb5a0d..1bdecce4b925 100644 --- a/spring-context/src/main/java/org/springframework/jndi/JndiObjectLocator.java +++ b/spring-context/src/main/java/org/springframework/jndi/JndiObjectLocator.java @@ -32,7 +32,7 @@ * accessing a locally mapped (Environmental Naming Context) resource. If it * doesn't, the "java:comp/env/" prefix will be prepended if the "resourceRef" * property is true (the default is false) and no other scheme - * (e.g. "java:") is given. + * (for example, "java:") is given. * *

    Subclasses may invoke the {@link #lookup()} method whenever it is appropriate. * Some classes might do this on initialization, while others might do it diff --git a/spring-context/src/main/java/org/springframework/jndi/JndiTemplate.java b/spring-context/src/main/java/org/springframework/jndi/JndiTemplate.java index e372ce48c059..e08829e70c73 100644 --- a/spring-context/src/main/java/org/springframework/jndi/JndiTemplate.java +++ b/spring-context/src/main/java/org/springframework/jndi/JndiTemplate.java @@ -127,7 +127,7 @@ public void releaseContext(@Nullable Context ctx) { /** * Create a new JNDI initial context. Invoked by {@link #getContext}. *

    The default implementation use this template's environment settings. - * Can be subclassed for custom contexts, e.g. for testing. + * Can be subclassed for custom contexts, for example, for testing. * @return the initial Context instance * @throws NamingException in case of initialization errors */ diff --git a/spring-context/src/main/java/org/springframework/scheduling/TaskScheduler.java b/spring-context/src/main/java/org/springframework/scheduling/TaskScheduler.java index a9a9d4949a56..a25739772fea 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/TaskScheduler.java +++ b/spring-context/src/main/java/org/springframework/scheduling/TaskScheduler.java @@ -66,13 +66,13 @@ default Clock getClock() { * {@link ScheduledFuture} gets cancelled. * @param task the Runnable to execute whenever the trigger fires * @param trigger an implementation of the {@link Trigger} interface, - * e.g. a {@link org.springframework.scheduling.support.CronTrigger} object + * for example, a {@link org.springframework.scheduling.support.CronTrigger} object * wrapping a cron expression * @return a {@link ScheduledFuture} representing pending execution of the task, * or {@code null} if the given Trigger object never fires (i.e. returns * {@code null} from {@link Trigger#nextExecution}) * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @see org.springframework.scheduling.support.CronTrigger */ @Nullable @@ -87,7 +87,7 @@ default Clock getClock() { * (if this is in the past, the task will be executed immediately, i.e. as soon as possible) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @since 5.0 */ ScheduledFuture schedule(Runnable task, Instant startTime); @@ -101,7 +101,7 @@ default Clock getClock() { * (if this is in the past, the task will be executed immediately, i.e. as soon as possible) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @deprecated as of 6.0, in favor of {@link #schedule(Runnable, Instant)} */ @Deprecated(since = "6.0") @@ -120,7 +120,7 @@ default ScheduledFuture schedule(Runnable task, Date startTime) { * @param period the interval between successive executions of the task * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @since 5.0 */ ScheduledFuture scheduleAtFixedRate(Runnable task, Instant startTime, Duration period); @@ -136,7 +136,7 @@ default ScheduledFuture schedule(Runnable task, Date startTime) { * @param period the interval between successive executions of the task (in milliseconds) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @deprecated as of 6.0, in favor of {@link #scheduleAtFixedRate(Runnable, Instant, Duration)} */ @Deprecated(since = "6.0") @@ -153,7 +153,7 @@ default ScheduledFuture scheduleAtFixedRate(Runnable task, Date startTime, lo * @param period the interval between successive executions of the task * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @since 5.0 */ ScheduledFuture scheduleAtFixedRate(Runnable task, Duration period); @@ -167,7 +167,7 @@ default ScheduledFuture scheduleAtFixedRate(Runnable task, Date startTime, lo * @param period the interval between successive executions of the task (in milliseconds) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @deprecated as of 6.0, in favor of {@link #scheduleAtFixedRate(Runnable, Duration)} */ @Deprecated(since = "6.0") @@ -187,7 +187,7 @@ default ScheduledFuture scheduleAtFixedRate(Runnable task, long period) { * @param delay the delay between the completion of one execution and the start of the next * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @since 5.0 */ ScheduledFuture scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay); @@ -205,7 +205,7 @@ default ScheduledFuture scheduleAtFixedRate(Runnable task, long period) { * (in milliseconds) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @deprecated as of 6.0, in favor of {@link #scheduleWithFixedDelay(Runnable, Instant, Duration)} */ @Deprecated(since = "6.0") @@ -222,7 +222,7 @@ default ScheduledFuture scheduleWithFixedDelay(Runnable task, Date startTime, * @param delay the delay between the completion of one execution and the start of the next * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @since 5.0 */ ScheduledFuture scheduleWithFixedDelay(Runnable task, Duration delay); @@ -237,7 +237,7 @@ default ScheduledFuture scheduleWithFixedDelay(Runnable task, Date startTime, * (in milliseconds) * @return a {@link ScheduledFuture} representing pending execution of the task * @throws org.springframework.core.task.TaskRejectedException if the given task was not accepted - * for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) + * for internal reasons (for example, a pool overload handling policy or a pool shutdown in progress) * @deprecated as of 6.0, in favor of {@link #scheduleWithFixedDelay(Runnable, Duration)} */ @Deprecated(since = "6.0") diff --git a/spring-context/src/main/java/org/springframework/scheduling/annotation/EnableScheduling.java b/spring-context/src/main/java/org/springframework/scheduling/annotation/EnableScheduling.java index 0d49e240d5df..36e902cab712 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/annotation/EnableScheduling.java +++ b/spring-context/src/main/java/org/springframework/scheduling/annotation/EnableScheduling.java @@ -184,7 +184,7 @@ * *

    Note: {@code @EnableScheduling} applies to its local application context only, * allowing for selective scheduling of beans at different levels. Please redeclare - * {@code @EnableScheduling} in each individual context, e.g. the common root web + * {@code @EnableScheduling} in each individual context, for example, the common root web * application context and any separate {@code DispatcherServlet} application contexts, * if you need to apply its behavior at multiple levels. * diff --git a/spring-context/src/main/java/org/springframework/scheduling/annotation/ScheduledAnnotationBeanPostProcessor.java b/spring-context/src/main/java/org/springframework/scheduling/annotation/ScheduledAnnotationBeanPostProcessor.java index d49e4c69dfbe..17178ba0f32e 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/annotation/ScheduledAnnotationBeanPostProcessor.java +++ b/spring-context/src/main/java/org/springframework/scheduling/annotation/ScheduledAnnotationBeanPostProcessor.java @@ -91,7 +91,7 @@ * *

    Autodetects any {@link SchedulingConfigurer} instances in the container, * allowing for customization of the scheduler to be used or for fine-grained - * control over task registration (e.g. registration of {@link Trigger} tasks). + * control over task registration (for example, registration of {@link Trigger} tasks). * See the {@link EnableScheduling @EnableScheduling} javadocs for complete usage * details. * @@ -664,7 +664,7 @@ public void onApplicationEvent(ApplicationContextEvent event) { if (event instanceof ContextRefreshedEvent) { // Running in an ApplicationContext -> register tasks this late... // giving other ContextRefreshedEvent listeners a chance to perform - // their work at the same time (e.g. Spring Batch's job registration). + // their work at the same time (for example, Spring Batch's job registration). finishRegistration(); } else if (event instanceof ContextClosedEvent) { diff --git a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ExecutorConfigurationSupport.java b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ExecutorConfigurationSupport.java index 2bb0c6666fac..1cfbb58c1c40 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ExecutorConfigurationSupport.java +++ b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ExecutorConfigurationSupport.java @@ -182,7 +182,7 @@ public void setAcceptTasksAfterContextClose(boolean acceptTasksAfterContextClose *

    Note that Spring's container shutdown continues while ongoing tasks * are being completed. If you want this executor to block and wait for the * termination of tasks before the rest of the container continues to shut - * down - e.g. in order to keep up other resources that your tasks may need -, + * down - for example, in order to keep up other resources that your tasks may need -, * set the {@link #setAwaitTerminationSeconds "awaitTerminationSeconds"} * property instead of or in addition to this property. * @see java.util.concurrent.ExecutorService#shutdown() diff --git a/spring-context/src/main/java/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.java b/spring-context/src/main/java/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.java index abf72504df69..00329bdbe5a3 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.java +++ b/spring-context/src/main/java/org/springframework/scheduling/concurrent/SimpleAsyncTaskScheduler.java @@ -70,7 +70,7 @@ * consider setting {@link #setVirtualThreads} to {@code true}. * *

    Extends {@link SimpleAsyncTaskExecutor} and can serve as a fully capable - * replacement for it, e.g. as a single shared instance serving as a + * replacement for it, for example, as a single shared instance serving as a * {@link org.springframework.core.task.TaskExecutor} as well as a {@link TaskScheduler}. * This is generally not the case with other executor/scheduler implementations * which tend to have specific constraints for the scheduler thread pool, @@ -78,13 +78,13 @@ * *

    NOTE: This scheduler variant does not track the actual completion of tasks * but rather just the hand-off to an execution thread. As a consequence, - * a {@link ScheduledFuture} handle (e.g. from {@link #schedule(Runnable, Instant)}) + * a {@link ScheduledFuture} handle (for example, from {@link #schedule(Runnable, Instant)}) * represents that hand-off rather than the actual completion of the provided task * (or series of repeated tasks). * *

    As an alternative to the built-in thread-per-task capability, this scheduler * can also be configured with a separate target executor for scheduled task - * execution through {@link #setTargetTaskExecutor}: e.g. pointing to a shared + * execution through {@link #setTargetTaskExecutor}: for example, pointing to a shared * {@link ThreadPoolTaskExecutor} bean. This is still rather different from a * {@link ThreadPoolTaskScheduler} setup since it always uses a single scheduler * thread while dynamically dispatching to the target thread pool which may have diff --git a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.java b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.java index 70783b24b9ed..0890d8e7651b 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.java +++ b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.java @@ -44,7 +44,7 @@ * JavaBean that allows for configuring a {@link java.util.concurrent.ThreadPoolExecutor} * in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" * properties) and exposing it as a Spring {@link org.springframework.core.task.TaskExecutor}. - * This class is also well suited for management and monitoring (e.g. through JMX), + * This class is also well suited for management and monitoring (for example, through JMX), * providing several useful attributes: "corePoolSize", "maxPoolSize", "keepAliveSeconds" * (all supporting updates at runtime); "poolSize", "activeCount" (for introspection only). * diff --git a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.java b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.java index 04329cc8cb04..3cc17d0ef5ff 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.java +++ b/spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskScheduler.java @@ -59,7 +59,7 @@ *

    This is Spring's traditional scheduler variant, staying as close as possible to * {@link java.util.concurrent.ScheduledExecutorService} semantics. Task execution happens * on the scheduler thread(s) rather than on separate execution threads. As a consequence, - * a {@link ScheduledFuture} handle (e.g. from {@link #schedule(Runnable, Instant)}) + * a {@link ScheduledFuture} handle (for example, from {@link #schedule(Runnable, Instant)}) * represents the actual completion of the provided task (or series of repeated tasks). * * @author Juergen Hoeller diff --git a/spring-context/src/main/java/org/springframework/scheduling/config/TaskExecutorFactoryBean.java b/spring-context/src/main/java/org/springframework/scheduling/config/TaskExecutorFactoryBean.java index abb3f7315e3e..b065156dd0ee 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/config/TaskExecutorFactoryBean.java +++ b/spring-context/src/main/java/org/springframework/scheduling/config/TaskExecutorFactoryBean.java @@ -137,7 +137,7 @@ private void determinePoolSizeRange(ThreadPoolTaskExecutor executor) { } catch (NumberFormatException ex) { throw new IllegalArgumentException("Invalid pool-size value [" + this.poolSize + "]: only single " + - "maximum integer (e.g. \"5\") and minimum-maximum range (e.g. \"3-5\") are supported", ex); + "maximum integer (for example, \"5\") and minimum-maximum range (for example, \"3-5\") are supported", ex); } } } diff --git a/spring-context/src/main/java/org/springframework/scheduling/support/ScheduledMethodRunnable.java b/spring-context/src/main/java/org/springframework/scheduling/support/ScheduledMethodRunnable.java index 0f0b5d200e89..87412218f902 100644 --- a/spring-context/src/main/java/org/springframework/scheduling/support/ScheduledMethodRunnable.java +++ b/spring-context/src/main/java/org/springframework/scheduling/support/ScheduledMethodRunnable.java @@ -59,7 +59,7 @@ public class ScheduledMethodRunnable implements SchedulingAwareRunnable { * @param target the target instance to call the method on * @param method the target method to call * @param qualifier a qualifier associated with this Runnable, - * e.g. for determining a scheduler to run this scheduled method on + * for example, for determining a scheduler to run this scheduled method on * @param observationRegistrySupplier a supplier for the observation registry to use * @since 6.1 */ diff --git a/spring-context/src/main/java/org/springframework/scripting/ScriptFactory.java b/spring-context/src/main/java/org/springframework/scripting/ScriptFactory.java index 02a76cece6de..5c535c36f04c 100644 --- a/spring-context/src/main/java/org/springframework/scripting/ScriptFactory.java +++ b/spring-context/src/main/java/org/springframework/scripting/ScriptFactory.java @@ -100,7 +100,7 @@ Class getScriptedObjectType(ScriptSource scriptSource) throws IOException, ScriptCompilationException; /** - * Determine whether a refresh is required (e.g. through + * Determine whether a refresh is required (for example, through * ScriptSource's {@code isModified()} method). * @param scriptSource the actual ScriptSource to retrieve * the script source text from (never {@code null}) diff --git a/spring-context/src/main/java/org/springframework/scripting/support/StandardScriptEvaluator.java b/spring-context/src/main/java/org/springframework/scripting/support/StandardScriptEvaluator.java index 7dcdaa4a20a1..d907574ef2c7 100644 --- a/spring-context/src/main/java/org/springframework/scripting/support/StandardScriptEvaluator.java +++ b/spring-context/src/main/java/org/springframework/scripting/support/StandardScriptEvaluator.java @@ -80,7 +80,7 @@ public StandardScriptEvaluator(ScriptEngineManager scriptEngineManager) { /** - * Set the name of the language meant for evaluating the scripts (e.g. "Groovy"). + * Set the name of the language meant for evaluating the scripts (for example, "Groovy"). *

    This is effectively an alias for {@link #setEngineName "engineName"}, * potentially (but not yet) providing common abbreviations for certain languages * beyond what the JSR-223 script engine factory exposes. @@ -91,7 +91,7 @@ public void setLanguage(String language) { } /** - * Set the name of the script engine for evaluating the scripts (e.g. "Groovy"), + * Set the name of the script engine for evaluating the scripts (for example, "Groovy"), * as exposed by the JSR-223 script engine factory. * @since 4.2.2 * @see #setLanguage diff --git a/spring-context/src/main/java/org/springframework/stereotype/Controller.java b/spring-context/src/main/java/org/springframework/stereotype/Controller.java index a991c31142ee..871f6d9e6ea2 100644 --- a/spring-context/src/main/java/org/springframework/stereotype/Controller.java +++ b/spring-context/src/main/java/org/springframework/stereotype/Controller.java @@ -25,7 +25,7 @@ import org.springframework.core.annotation.AliasFor; /** - * Indicates that an annotated class is a "Controller" (e.g. a web controller). + * Indicates that an annotated class is a "Controller" (for example, a web controller). * *

    This annotation serves as a specialization of {@link Component @Component}, * allowing for implementation classes to be autodetected through classpath scanning. diff --git a/spring-context/src/main/java/org/springframework/ui/context/ThemeSource.java b/spring-context/src/main/java/org/springframework/ui/context/ThemeSource.java index e5374da4a1d1..15bf064d4687 100644 --- a/spring-context/src/main/java/org/springframework/ui/context/ThemeSource.java +++ b/spring-context/src/main/java/org/springframework/ui/context/ThemeSource.java @@ -34,7 +34,7 @@ public interface ThemeSource { /** * Return the Theme instance for the given theme name. *

    The returned Theme will resolve theme-specific messages, codes, - * file paths, etc (e.g. CSS and image files in a web environment). + * file paths, etc (for example, CSS and image files in a web environment). * @param themeName the name of the theme * @return the corresponding Theme, or {@code null} if none defined. * Note that, by convention, a ThemeSource should at least be able to diff --git a/spring-context/src/main/java/org/springframework/ui/context/support/ResourceBundleThemeSource.java b/spring-context/src/main/java/org/springframework/ui/context/support/ResourceBundleThemeSource.java index 2e858a355c6b..f93bdf7e4da8 100644 --- a/spring-context/src/main/java/org/springframework/ui/context/support/ResourceBundleThemeSource.java +++ b/spring-context/src/main/java/org/springframework/ui/context/support/ResourceBundleThemeSource.java @@ -89,7 +89,7 @@ public ThemeSource getParentThemeSource() { /** * Set the prefix that gets applied to the ResourceBundle basenames, * i.e. the theme names. - * E.g.: basenamePrefix="test.", themeName="theme" → basename="test.theme". + * For example: basenamePrefix="test.", themeName="theme" → basename="test.theme". *

    Note that ResourceBundle names are effectively classpath locations: As a * consequence, the JDK's standard ResourceBundle treats dots as package separators. * This means that "test.theme" is effectively equivalent to "test/theme", diff --git a/spring-context/src/main/java/org/springframework/ui/context/support/package-info.java b/spring-context/src/main/java/org/springframework/ui/context/support/package-info.java index da2a5b2411b7..9a6e0876238f 100644 --- a/spring-context/src/main/java/org/springframework/ui/context/support/package-info.java +++ b/spring-context/src/main/java/org/springframework/ui/context/support/package-info.java @@ -1,6 +1,6 @@ /** * Classes supporting the org.springframework.ui.context package. - * Provides support classes for specialized UI contexts, e.g. for web UIs. + * Provides support classes for specialized UI contexts, for example, for web UIs. */ @NonNullApi @NonNullFields diff --git a/spring-context/src/main/java/org/springframework/validation/BindingResult.java b/spring-context/src/main/java/org/springframework/validation/BindingResult.java index 987414db36ce..ed3e3a1d70ff 100644 --- a/spring-context/src/main/java/org/springframework/validation/BindingResult.java +++ b/spring-context/src/main/java/org/springframework/validation/BindingResult.java @@ -31,7 +31,7 @@ *

    Serves as result holder for a {@link DataBinder}, obtained via * the {@link DataBinder#getBindingResult()} method. BindingResult * implementations can also be used directly, for example to invoke - * a {@link Validator} on it (e.g. as part of a unit test). + * a {@link Validator} on it (for example, as part of a unit test). * * @author Juergen Hoeller * @since 2.0 diff --git a/spring-context/src/main/java/org/springframework/validation/DefaultBindingErrorProcessor.java b/spring-context/src/main/java/org/springframework/validation/DefaultBindingErrorProcessor.java index 7d5bf02f9802..34f49f9a4db0 100644 --- a/spring-context/src/main/java/org/springframework/validation/DefaultBindingErrorProcessor.java +++ b/spring-context/src/main/java/org/springframework/validation/DefaultBindingErrorProcessor.java @@ -66,7 +66,7 @@ public void processMissingFieldError(String missingField, BindingResult bindingR @Override public void processPropertyAccessException(PropertyAccessException ex, BindingResult bindingResult) { - // Create field error with the code of the exception, e.g. "typeMismatch". + // Create field error with the code of the exception, for example, "typeMismatch". String field = ex.getPropertyName(); Assert.state(field != null, "No field in exception"); String[] codes = bindingResult.resolveMessageCodes(ex.getErrorCode(), field); diff --git a/spring-context/src/main/java/org/springframework/validation/DefaultMessageCodesResolver.java b/spring-context/src/main/java/org/springframework/validation/DefaultMessageCodesResolver.java index 47bf72dd7b2e..a18554a5543f 100644 --- a/spring-context/src/main/java/org/springframework/validation/DefaultMessageCodesResolver.java +++ b/spring-context/src/main/java/org/springframework/validation/DefaultMessageCodesResolver.java @@ -81,7 +81,7 @@ * {@link MessageCodeFormatter format}. * *

    In order to group all codes into a specific category within your resource bundles, - * e.g. "validation.typeMismatch.name" instead of the default "typeMismatch.name", + * for example, "validation.typeMismatch.name" instead of the default "typeMismatch.name", * consider specifying a {@link #setPrefix prefix} to be applied. * * @author Juergen Hoeller @@ -216,7 +216,7 @@ protected String postProcessMessageCode(String code) { public enum Format implements MessageCodeFormatter { /** - * Prefix the error code at the beginning of the generated message code. e.g.: + * Prefix the error code at the beginning of the generated message code. for example: * {@code errorCode + "." + object name + "." + field} */ PREFIX_ERROR_CODE { @@ -227,7 +227,7 @@ public String format(String errorCode, @Nullable String objectName, @Nullable St }, /** - * Postfix the error code at the end of the generated message code. e.g.: + * Postfix the error code at the end of the generated message code. for example: * {@code object name + "." + field + "." + errorCode} */ POSTFIX_ERROR_CODE { diff --git a/spring-context/src/main/java/org/springframework/validation/Errors.java b/spring-context/src/main/java/org/springframework/validation/Errors.java index 18b77f1cfbfb..a7292a5af9dc 100644 --- a/spring-context/src/main/java/org/springframework/validation/Errors.java +++ b/spring-context/src/main/java/org/springframework/validation/Errors.java @@ -28,9 +28,9 @@ * Stores and exposes information about data-binding and validation errors * for a specific object. * - *

    Field names are typically properties of the target object (e.g. "name" + *

    Field names are typically properties of the target object (for example, "name" * when binding to a customer object). Implementations may also support nested - * fields in case of nested objects (e.g. "address.street"), in conjunction + * fields in case of nested objects (for example, "address.street"), in conjunction * with subtree navigation via {@link #setNestedPath}: for example, an * {@code AddressValidator} may validate "address", not being aware that this * is a nested object of a top-level customer object. @@ -69,7 +69,7 @@ public interface Errors { *

    The default implementation throws {@code UnsupportedOperationException} * since not all {@code Errors} implementations support nested paths. * @param nestedPath nested path within this object, - * e.g. "address" (defaults to "", {@code null} is also acceptable). + * for example, "address" (defaults to "", {@code null} is also acceptable). * Can end with a dot: both "address" and "address." are valid. * @see #getNestedPath() */ @@ -218,7 +218,7 @@ default void addAllErrors(Errors errors) { /** * Throw the mapped exception with a message summarizing the recorded errors. * @param messageToException a function mapping the message to the exception, - * e.g. {@code IllegalArgumentException::new} or {@code IllegalStateException::new} + * for example, {@code IllegalArgumentException::new} or {@code IllegalStateException::new} * @param the exception type to be thrown * @since 6.1 * @see #toString() @@ -392,7 +392,7 @@ default Class getFieldType(String field) { /** * Return a summary of the recorded errors, - * e.g. for inclusion in an exception message. + * for example, for inclusion in an exception message. * @see #failOnError(Function) */ @Override diff --git a/spring-context/src/main/java/org/springframework/validation/MessageCodeFormatter.java b/spring-context/src/main/java/org/springframework/validation/MessageCodeFormatter.java index e8db79267b81..48d918e9da15 100644 --- a/spring-context/src/main/java/org/springframework/validation/MessageCodeFormatter.java +++ b/spring-context/src/main/java/org/springframework/validation/MessageCodeFormatter.java @@ -32,10 +32,10 @@ public interface MessageCodeFormatter { /** * Build and return a message code consisting of the given fields, * usually delimited by {@link DefaultMessageCodesResolver#CODE_SEPARATOR}. - * @param errorCode e.g.: "typeMismatch" - * @param objectName e.g.: "user" - * @param field e.g. "age" - * @return concatenated message code, e.g.: "typeMismatch.user.age" + * @param errorCode for example: "typeMismatch" + * @param objectName for example: "user" + * @param field for example, "age" + * @return concatenated message code, for example: "typeMismatch.user.age" * @see DefaultMessageCodesResolver.Format */ String format(String errorCode, @Nullable String objectName, @Nullable String field); diff --git a/spring-context/src/main/java/org/springframework/validation/ObjectError.java b/spring-context/src/main/java/org/springframework/validation/ObjectError.java index 53aee336d350..b8187d34739e 100644 --- a/spring-context/src/main/java/org/springframework/validation/ObjectError.java +++ b/spring-context/src/main/java/org/springframework/validation/ObjectError.java @@ -94,7 +94,7 @@ public void wrap(Object source) { * (typically {@link org.springframework.beans.PropertyAccessException}) * or a Bean Validation {@link jakarta.validation.ConstraintViolation}. *

    The cause of the outermost exception will be introspected as well, - * e.g. the underlying conversion exception or exception thrown from a setter + * for example, the underlying conversion exception or exception thrown from a setter * (instead of having to unwrap the {@code PropertyAccessException} in turn). * @return the source object of the given type * @throws IllegalArgumentException if no such source object is available @@ -119,7 +119,7 @@ else if (this.source instanceof Throwable throwable) { * (typically {@link org.springframework.beans.PropertyAccessException}) * or a Bean Validation {@link jakarta.validation.ConstraintViolation}. *

    The cause of the outermost exception will be introspected as well, - * e.g. the underlying conversion exception or exception thrown from a setter + * for example, the underlying conversion exception or exception thrown from a setter * (instead of having to unwrap the {@code PropertyAccessException} in turn). * @return whether this error has been caused by a source object of the given type * @since 5.0.4 diff --git a/spring-context/src/main/java/org/springframework/validation/Validator.java b/spring-context/src/main/java/org/springframework/validation/Validator.java index bea33261aeb7..1aa251a368a3 100644 --- a/spring-context/src/main/java/org/springframework/validation/Validator.java +++ b/spring-context/src/main/java/org/springframework/validation/Validator.java @@ -96,7 +96,7 @@ public interface Validator { * Validate the given {@code target} object individually. *

    Delegates to the common {@link #validate(Object, Errors)} method. * The returned {@link Errors errors} instance can be used to report - * any resulting validation errors for the specific target object, e.g. + * any resulting validation errors for the specific target object, for example, * {@code if (validator.validateObject(target).hasErrors()) ...} or * {@code validator.validateObject(target).failOnError(IllegalStateException::new));}. *

    Note: This validation call comes with limitations in the {@link Errors} diff --git a/spring-context/src/main/java/org/springframework/validation/annotation/Validated.java b/spring-context/src/main/java/org/springframework/validation/annotation/Validated.java index 02a651ac8fef..d42286a00872 100644 --- a/spring-context/src/main/java/org/springframework/validation/annotation/Validated.java +++ b/spring-context/src/main/java/org/springframework/validation/annotation/Validated.java @@ -27,7 +27,7 @@ * specification of validation groups. Designed for convenient use with * Spring's JSR-303 support but not JSR-303 specific. * - *

    Can be used e.g. with Spring MVC handler methods arguments. + *

    Can be used, for example, with Spring MVC handler methods arguments. * Supported through {@link org.springframework.validation.SmartValidator}'s * validation hint concept, with validation group classes acting as hint objects. * diff --git a/spring-context/src/main/java/org/springframework/validation/beanvalidation/MethodValidationAdapter.java b/spring-context/src/main/java/org/springframework/validation/beanvalidation/MethodValidationAdapter.java index d6db452e21e5..f65fb56b7f40 100644 --- a/spring-context/src/main/java/org/springframework/validation/beanvalidation/MethodValidationAdapter.java +++ b/spring-context/src/main/java/org/springframework/validation/beanvalidation/MethodValidationAdapter.java @@ -195,7 +195,7 @@ public ParameterNameDiscoverer getParameterNameDiscoverer() { *

  • {@link Conventions#getVariableNameForReturnType(Method, Class, Object)} * for a return type * - * If a name cannot be determined, e.g. a return value with insufficient + * If a name cannot be determined, for example, a return value with insufficient * type information, then it defaults to one of: * * - *

    NOTE: When using controller interfaces (e.g. for AOP proxying), + *

    NOTE: When using controller interfaces (for example, for AOP proxying), * make sure to consistently put all your mapping annotations - such as * {@code @MessageMapping} and {@code @SubscribeMapping} - on * the controller interface rather than on the implementation class. diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/AbstractNamedValueMethodArgumentResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/AbstractNamedValueMethodArgumentResolver.java index 0eff066952ed..1a169e7294d9 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/AbstractNamedValueMethodArgumentResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/AbstractNamedValueMethodArgumentResolver.java @@ -33,7 +33,7 @@ import org.springframework.util.ClassUtils; /** - * Abstract base class to resolve method arguments from a named value, e.g. + * Abstract base class to resolve method arguments from a named value, for example, * message headers or destination variables. Named values could have one or more * of a name, a required flag, and a default value. * diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/MessageMappingMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/MessageMappingMessageHandler.java index c4872d1825f0..850fefbf1759 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/MessageMappingMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/reactive/MessageMappingMessageHandler.java @@ -170,7 +170,7 @@ protected RouteMatcher obtainRouteMatcher() { /** * Configure a {@link ConversionService} to use for type conversion of - * String based values, e.g. in destination variables or headers. + * String based values, for example, in destination variables or headers. *

    By default {@link DefaultFormattingConversionService} is used. * @param conversionService the conversion service to use */ diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/AbstractNamedValueMethodArgumentResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/AbstractNamedValueMethodArgumentResolver.java index 42be3068e938..fd17f5e1f7ec 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/AbstractNamedValueMethodArgumentResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/AbstractNamedValueMethodArgumentResolver.java @@ -34,7 +34,7 @@ import org.springframework.util.ClassUtils; /** - * Abstract base class to resolve method arguments from a named value, e.g. + * Abstract base class to resolve method arguments from a named value, for example, * message headers or destination variables. Named values could have one or more * of a name, a required flag, and a default value. * diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolver.java index 022d1f3f1a99..46f5c77884f1 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/MessageMethodArgumentResolver.java @@ -99,7 +99,7 @@ public Object resolveArgument(MethodParameter parameter, Message message) thr * Resolve the target class to convert the payload to. *

    By default this is the generic type declared in the {@code Message} * method parameter but that can be overridden to select a more specific - * target type after also taking into account the "Content-Type", e.g. + * target type after also taking into account the "Content-Type", for example, * return {@code String} if target type is {@code Object} and * {@code "Content-Type:text/**"}. * @param parameter the target method parameter diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/PayloadMethodArgumentResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/PayloadMethodArgumentResolver.java index 10014be62df9..e38629fbeeae 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/PayloadMethodArgumentResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/annotation/support/PayloadMethodArgumentResolver.java @@ -186,7 +186,7 @@ else if (payload instanceof Optional optional) { * Resolve the target class to convert the payload to. *

    By default this is simply {@link MethodParameter#getParameterType()} * but that can be overridden to select a more specific target type after - * also taking into account the "Content-Type", e.g. return {@code String} + * also taking into account the "Content-Type", for example, return {@code String} * if target type is {@code Object} and {@code "Content-Type:text/**"}. * @param parameter the target method parameter * @param message the message being processed diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractExceptionHandlerMethodResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractExceptionHandlerMethodResolver.java index 86d7471d2698..1c5b1593c847 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractExceptionHandlerMethodResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractExceptionHandlerMethodResolver.java @@ -112,7 +112,7 @@ public Method resolveMethod(Throwable exception) { /** * Find a {@link Method} to handle the given exception type. This can be - * useful if an {@link Exception} instance is not available (e.g. for tools). + * useful if an {@link Exception} instance is not available (for example, for tools). *

    Uses {@link ExceptionDepthComparator} if more than one match is found. * @param exceptionType the exception type * @return a Method to handle the exception, or {@code null} if none found diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractMethodMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractMethodMessageHandler.java index 6b99dc410cc2..e39b235f918f 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractMethodMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/AbstractMethodMessageHandler.java @@ -415,7 +415,7 @@ protected Log getHandlerMethodLogger() { /** * Subclasses can invoke this method to populate the MessagingAdviceBean cache - * (e.g. to support "global" {@code @MessageExceptionHandler}). + * (for example, to support "global" {@code @MessageExceptionHandler}). * @since 4.2 */ protected void registerExceptionHandlerAdvice( diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/InvocableHandlerMethod.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/InvocableHandlerMethod.java index 40d2ac4ad4a8..cc74ad6ed900 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/InvocableHandlerMethod.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/InvocableHandlerMethod.java @@ -86,7 +86,7 @@ public void setMessageMethodArgumentResolvers(HandlerMethodArgumentResolverCompo /** * Set the ParameterNameDiscoverer for resolving parameter names when needed - * (e.g. default request attribute name). + * (for example, default request attribute name). *

    Default is a {@link org.springframework.core.DefaultParameterNameDiscoverer}. */ public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) { diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/AbstractMethodMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/AbstractMethodMessageHandler.java index e6e182b6f4c2..c8731bfc49d2 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/AbstractMethodMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/AbstractMethodMessageHandler.java @@ -114,7 +114,7 @@ public abstract class AbstractMethodMessageHandler * Configure a predicate for selecting which Spring beans to check for the * presence of message handler methods. *

    This is not set by default. However, subclasses may initialize it to - * some default strategy (e.g. {@code @Controller} classes). + * some default strategy (for example, {@code @Controller} classes). * @see #setHandlers(List) */ public void setHandlerPredicate(@Nullable Predicate> handlerPredicate) { @@ -210,7 +210,7 @@ public String getBeanName() { /** * Subclasses can invoke this method to populate the MessagingAdviceBean cache - * (e.g. to support "global" {@code @MessageExceptionHandler}). + * (for example, to support "global" {@code @MessageExceptionHandler}). */ protected void registerExceptionHandlerAdvice( MessagingAdviceBean bean, AbstractExceptionHandlerMethodResolver resolver) { @@ -227,7 +227,7 @@ public Map getHandlerMethods() { /** * Return a read-only multi-value map with a direct lookup of mappings, - * (e.g. for non-pattern destinations). + * (for example, for non-pattern destinations). */ public MultiValueMap getDestinationLookup() { return CollectionUtils.unmodifiableMultiValueMap(CollectionUtils.toMultiValueMap(this.destinationLookup)); @@ -419,7 +419,7 @@ private HandlerMethod createHandlerMethod(Object handler, Method method) { * This method is invoked just before mappings are added. It allows * subclasses to update the mapping with the {@link HandlerMethod} in mind. * This can be useful when the method signature is used to refine the - * mapping, e.g. based on the cardinality of input and output. + * mapping, for example, based on the cardinality of input and output. *

    By default this method returns the mapping that is passed in. * @param mapping the mapping to be added * @param handlerMethod the target handler for the mapping @@ -547,7 +547,7 @@ protected void handleNoMatch(@Nullable RouteMatcher.Route destination, Message getResolvers() { /** * Set the ParameterNameDiscoverer for resolving parameter names when needed - * (e.g. default request attribute name). + * (for example, default request attribute name). *

    Default is a {@link DefaultParameterNameDiscoverer}. */ public void setParameterNameDiscoverer(ParameterNameDiscoverer nameDiscoverer) { diff --git a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/InvocableHelper.java b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/InvocableHelper.java index 411a295bf588..ccb9c3c198b3 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/InvocableHelper.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/handler/invocation/reactive/InvocableHelper.java @@ -114,7 +114,7 @@ public ReactiveAdapterRegistry getReactiveAdapterRegistry() { } /** - * Method to populate the MessagingAdviceBean cache (e.g. to support "global" + * Method to populate the MessagingAdviceBean cache (for example, to support "global" * {@code @MessageExceptionHandler}). */ public void registerExceptionHandlerAdvice( diff --git a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/DefaultRSocketRequesterBuilder.java b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/DefaultRSocketRequesterBuilder.java index 377700688731..e3a045d7f20a 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/DefaultRSocketRequesterBuilder.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/DefaultRSocketRequesterBuilder.java @@ -245,13 +245,13 @@ private MimeType getDataMimeType(RSocketStrategies strategies) { if (this.dataMimeType != null) { return this.dataMimeType; } - // First non-basic Decoder (e.g. CBOR, Protobuf) + // First non-basic Decoder (for example, CBOR, Protobuf) for (Decoder candidate : strategies.decoders()) { if (!isCoreCodec(candidate) && !candidate.getDecodableMimeTypes().isEmpty()) { return getMimeType(candidate); } } - // First core decoder (e.g. String) + // First core decoder (for example, String) for (Decoder decoder : strategies.decoders()) { if (!decoder.getDecodableMimeTypes().isEmpty()) { return getMimeType(decoder); diff --git a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java index 36576f28f905..2c946d5c3137 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/RSocketRequester.java @@ -90,7 +90,7 @@ public interface RSocketRequester extends Disposable { /** * Begin to specify a new request with the given route to a remote handler. - *

    The route can be a template with placeholders, e.g. + *

    The route can be a template with placeholders, for example, * {@code "flight.{code}"} in which case the supplied route variables are * formatted via {@code toString()} and expanded into the template. * If a formatted variable contains a "." it is replaced with the escape diff --git a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/ConnectMapping.java b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/ConnectMapping.java index 8fb2de46c2cf..da56a2b4768c 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/ConnectMapping.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/ConnectMapping.java @@ -32,7 +32,7 @@ * {@link org.springframework.messaging.handler.annotation.MessageMapping @MessageMapping} * for a combined route pattern. It supports the same arguments as * {@code @MessageMapping} but the return value must be {@code void}. On a - * server, handling can be asynchronous (e.g. {@code Mono}), in which + * server, handling can be asynchronous (for example, {@code Mono}), in which * case the connection is accepted if and when the {@code Mono} completes. * On the client side this method is only a callback and does not affect the * establishment of the connection. @@ -40,7 +40,7 @@ *

    Note: an {@code @ConnectMapping} method may start * requests to the remote through an * {@link org.springframework.messaging.rsocket.RSocketRequester RSocketRequester} - * method argument, but it must do so independent of the handling thread (e.g. + * method argument, but it must do so independent of the handling thread (for example, * via subscribing on a different thread). * * @author Rossen Stoyanchev diff --git a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/support/RSocketFrameTypeMessageCondition.java b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/support/RSocketFrameTypeMessageCondition.java index 96eea1f3c993..e8167a3f1402 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/support/RSocketFrameTypeMessageCondition.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/rsocket/annotation/support/RSocketFrameTypeMessageCondition.java @@ -66,7 +66,7 @@ public class RSocketFrameTypeMessageCondition extends AbstractMessageConditionNote that the given handlers do not need to have any stereotype * annotations such as {@code @Controller} which helps to avoid overlap with * server side handlers that may be used in the same application. However, - * for more advanced scenarios, e.g. discovering handlers through a custom + * for more advanced scenarios, for example, discovering handlers through a custom * stereotype annotation, consider declaring {@code RSocketMessageHandler} * as a bean, and then obtain the responder from it. * @param strategies the strategies to set on the created diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributes.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributes.java index 31370f4b139a..8946b6db20c6 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributes.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributes.java @@ -28,7 +28,7 @@ /** * A wrapper class for access to attributes associated with a SiMP session - * (e.g. WebSocket session). + * (for example, WebSocket session). * * @author Rossen Stoyanchev * @since 4.1 diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributesContextHolder.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributesContextHolder.java index 7b3f2ce2d2c0..6474d56afce7 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributesContextHolder.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpAttributesContextHolder.java @@ -21,7 +21,7 @@ import org.springframework.messaging.Message; /** - * Holder class to expose SiMP attributes associated with a session (e.g. WebSocket) + * Holder class to expose SiMP attributes associated with a session (for example, WebSocket) * in the form of a thread-bound {@link SimpAttributes} object. * * @author Rossen Stoyanchev diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageHeaderAccessor.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageHeaderAccessor.java index 2fad880906cc..015db5c8dc37 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageHeaderAccessor.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageHeaderAccessor.java @@ -32,7 +32,7 @@ /** * A base class for working with message headers in simple messaging protocols that * support basic messaging patterns. Provides uniform access to specific values common - * across protocols such as a destination, message type (e.g. publish, subscribe, etc), + * across protocols such as a destination, message type (for example, publish, subscribe, etc), * session ID, and others. * *

    Use one of the static factory methods in this class, then call getters and setters, diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageSendingOperations.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageSendingOperations.java index 3f2e4a04c099..e1cac48b59b8 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageSendingOperations.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessageSendingOperations.java @@ -55,11 +55,11 @@ public interface SimpMessageSendingOperations extends MessageSendingOperationsBy default headers are interpreted as native headers (e.g. STOMP) and + *

    By default headers are interpreted as native headers (for example, STOMP) and * are saved under a special key in the resulting Spring * {@link org.springframework.messaging.Message Message}. In effect when the * message leaves the application, the provided headers are included with it - * and delivered to the destination (e.g. the STOMP client or broker). + * and delivered to the destination (for example, the STOMP client or broker). *

    If the map already contains the key * {@link org.springframework.messaging.support.NativeMessageHeaderAccessor#NATIVE_HEADERS "nativeHeaders"} * or was prepared with diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpSessionScope.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpSessionScope.java index 1bf7a42a4c2c..e6a4a947161e 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpSessionScope.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpSessionScope.java @@ -22,7 +22,7 @@ /** * A {@link Scope} implementation exposing the attributes of a SiMP session - * (e.g. WebSocket session). + * (for example, WebSocket session). * *

    Relies on a thread-bound {@link SimpAttributes} instance exported by * {@link org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler}. diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/SubscribeMapping.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/SubscribeMapping.java index 2e1ac02b67d0..9229e87308c3 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/SubscribeMapping.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/SubscribeMapping.java @@ -28,7 +28,7 @@ /** * Annotation for mapping subscription messages onto specific handler methods based * on the destination of a subscription. Supported with STOMP over WebSocket only - * (e.g. STOMP SUBSCRIBE frame). + * (for example, STOMP SUBSCRIBE frame). * *

    This is a method-level annotation that can be combined with a type-level * {@link org.springframework.messaging.handler.annotation.MessageMapping @MessageMapping}. @@ -43,7 +43,7 @@ * user and does not pass through the message broker. This is useful for * implementing a request-reply pattern. * - *

    NOTE: When using controller interfaces (e.g. for AOP proxying), + *

    NOTE: When using controller interfaces (for example, for AOP proxying), * make sure to consistently put all your mapping annotations - such as * {@code @MessageMapping} and {@code @SubscribeMapping} - on * the controller interface rather than on the implementation class. @@ -62,9 +62,9 @@ /** * Destination-based mapping expressed by this annotation. - *

    This is the destination of the STOMP message (e.g. {@code "/positions"}). - * Ant-style path patterns (e.g. {@code "/price.stock.*"}) and path template - * variables (e.g. "/price.stock.{ticker}") are also supported. + *

    This is the destination of the STOMP message (for example, {@code "/positions"}). + * Ant-style path patterns (for example, {@code "/price.stock.*"}) and path template + * variables (for example, "/price.stock.{ticker}") are also supported. */ String[] value() default {}; diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java index 24cf98c31858..707b953e3f0f 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SimpAnnotationMethodMessageHandler.java @@ -131,8 +131,8 @@ public class SimpAnnotationMethodMessageHandler extends AbstractMethodMessageHan /** * Create an instance of SimpAnnotationMethodMessageHandler with the given * message channels and broker messaging template. - * @param clientInboundChannel the channel for receiving messages from clients (e.g. WebSocket clients) - * @param clientOutboundChannel the channel for messages to clients (e.g. WebSocket clients) + * @param clientInboundChannel the channel for receiving messages from clients (for example, WebSocket clients) + * @param clientOutboundChannel the channel for messages to clients (for example, WebSocket clients) * @param brokerTemplate a messaging template to send application messages to the broker */ public SimpAnnotationMethodMessageHandler(SubscribableChannel clientInboundChannel, @@ -159,7 +159,7 @@ public SimpAnnotationMethodMessageHandler(SubscribableChannel clientInboundChann * therefore a slash is automatically appended where missing to ensure a * proper prefix-based match (i.e. matching complete segments). *

    Note however that the remaining portion of a destination after the - * prefix may use a different separator (e.g. commonly "." in messaging) + * prefix may use a different separator (for example, commonly "." in messaging) * depending on the configured {@code PathMatcher}. */ @Override diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java index 4107ad4e3555..7c17734e0652 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java @@ -87,8 +87,8 @@ public abstract class AbstractBrokerMessageHandler /** * Constructor with no destination prefixes (matches all destinations). - * @param inboundChannel the channel for receiving messages from clients (e.g. WebSocket clients) - * @param outboundChannel the channel for sending messages to clients (e.g. WebSocket clients) + * @param inboundChannel the channel for receiving messages from clients (for example, WebSocket clients) + * @param outboundChannel the channel for sending messages to clients (for example, WebSocket clients) * @param brokerChannel the channel for the application to send messages to the broker */ public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel, MessageChannel outboundChannel, @@ -99,8 +99,8 @@ public AbstractBrokerMessageHandler(SubscribableChannel inboundChannel, MessageC /** * Constructor with destination prefixes to match to destinations of messages. - * @param inboundChannel the channel for receiving messages from clients (e.g. WebSocket clients) - * @param outboundChannel the channel for sending messages to clients (e.g. WebSocket clients) + * @param inboundChannel the channel for receiving messages from clients (for example, WebSocket clients) + * @param outboundChannel the channel for sending messages to clients (for example, WebSocket clients) * @param brokerChannel the channel for the application to send messages to the broker * @param destinationPrefixes prefixes to use to filter out messages */ diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/SimpleBrokerMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/SimpleBrokerMessageHandler.java index d6e4fcdb85ee..80bcfe99e473 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/SimpleBrokerMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/SimpleBrokerMessageHandler.java @@ -84,8 +84,8 @@ public class SimpleBrokerMessageHandler extends AbstractBrokerMessageHandler { /** * Create a SimpleBrokerMessageHandler instance with the given message channels * and destination prefixes. - * @param clientInboundChannel the channel for receiving messages from clients (e.g. WebSocket clients) - * @param clientOutboundChannel the channel for sending messages to clients (e.g. WebSocket clients) + * @param clientInboundChannel the channel for receiving messages from clients (for example, WebSocket clients) + * @param clientOutboundChannel the channel for sending messages to clients (for example, WebSocket clients) * @param brokerChannel the channel for the application to send messages to the broker * @param destinationPrefixes prefixes to use to filter out messages */ diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/AbstractMessageBrokerConfiguration.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/AbstractMessageBrokerConfiguration.java index 2a9747f536be..9c505329dc65 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/AbstractMessageBrokerConfiguration.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/AbstractMessageBrokerConfiguration.java @@ -91,7 +91,7 @@ * into any application component to send messages. * *

    Subclasses are responsible for the parts of the configuration that feed messages - * to and from the client inbound/outbound channels (e.g. STOMP over WebSocket). + * to and from the client inbound/outbound channels (for example, STOMP over WebSocket). * * @author Rossen Stoyanchev * @author Brian Clozel diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/MessageBrokerRegistry.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/MessageBrokerRegistry.java index 6ad9a2fa46e6..45caca7de75f 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/MessageBrokerRegistry.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/MessageBrokerRegistry.java @@ -77,7 +77,7 @@ public MessageBrokerRegistry(SubscribableChannel clientInboundChannel, MessageCh /** * Enable a simple message broker and configure one or more prefixes to filter - * destinations targeting the broker (e.g. destinations prefixed with "/topic"). + * destinations targeting the broker (for example, destinations prefixed with "/topic"). */ public SimpleBrokerRegistration enableSimpleBroker(String... destinationPrefixes) { this.simpleBrokerRegistration = new SimpleBrokerRegistration( @@ -127,7 +127,7 @@ protected String getUserRegistryBroadcast() { * Configure one or more prefixes to filter destinations targeting application * annotated methods. For example destinations prefixed with "/app" may be * processed by annotated methods while other destinations may target the - * message broker (e.g. "/topic", "/queue"). + * message broker (for example, "/topic", "/queue"). *

    When messages are processed, the matching prefix is removed from the destination * in order to form the lookup path. This means annotations should not contain the * destination prefix. diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/StompBrokerRelayRegistration.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/StompBrokerRelayRegistration.java index 526c4cf4fd73..417a4dcab50c 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/config/StompBrokerRelayRegistration.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/config/StompBrokerRelayRegistration.java @@ -123,7 +123,7 @@ public StompBrokerRelayRegistration setClientPasscode(String passcode) { /** * Set the login for the shared "system" connection used to send messages to * the STOMP broker from within the application, i.e. messages not associated - * with a specific client session (e.g. REST/HTTP request handling method). + * with a specific client session (for example, REST/HTTP request handling method). *

    By default this is set to "guest". */ public StompBrokerRelayRegistration setSystemLogin(String login) { @@ -135,7 +135,7 @@ public StompBrokerRelayRegistration setSystemLogin(String login) { /** * Set the passcode for the shared "system" connection used to send messages to * the STOMP broker from within the application, i.e. messages not associated - * with a specific client session (e.g. REST/HTTP request handling method). + * with a specific client session (for example, REST/HTTP request handling method). *

    By default this is set to "guest". */ public StompBrokerRelayRegistration setSystemPasscode(String passcode) { @@ -194,7 +194,7 @@ public StompBrokerRelayRegistration setTcpClient(TcpOperations tcpClient } /** - * Some STOMP clients (e.g. stomp-js) always send heartbeats at a fixed rate + * Some STOMP clients (for example, stomp-js) always send heartbeats at a fixed rate * but others (Spring STOMP client) do so only when no other messages are * sent. However messages with a non-broker {@link #getDestinationPrefixes() * destination prefix} aren't forwarded and as a result the broker may deem @@ -228,7 +228,7 @@ public StompBrokerRelayRegistration setAutoStartup(boolean autoStartup) { * a chance to try. *

    By default this is not set. * @param destination the destination to broadcast unresolved messages to, - * e.g. "/topic/unresolved-user-destination" + * for example, "/topic/unresolved-user-destination" */ public StompBrokerRelayRegistration setUserDestinationBroadcast(String destination) { this.userDestinationBroadcast = destination; @@ -247,7 +247,7 @@ protected String getUserDestinationBroadcast() { * users connected to other servers. *

    By default this is not set. * @param destination the destination for broadcasting user registry details, - * e.g. "/topic/simp-user-registry". + * for example, "/topic/simp-user-registry". */ public StompBrokerRelayRegistration setUserRegistryBroadcast(String destination) { this.userRegistryBroadcast = destination; diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/BufferingStompDecoder.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/BufferingStompDecoder.java index eccfc807bf8c..b7c9e1e32238 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/BufferingStompDecoder.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/BufferingStompDecoder.java @@ -35,7 +35,7 @@ * is not enough data still, continues to buffer. * *

    A single instance of this decoder can be invoked repeatedly to read all - * messages from a single stream (e.g. WebSocket session) as long as decoding + * messages from a single stream (for example, WebSocket session) as long as decoding * does not fail. If there is an exception, StompDecoder instance should not * be used any more as its internal state is not guaranteed to be consistent. * It is expected that the underlying session is closed at that point. diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.java index 43fcf18d0376..811157d51a28 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompBrokerRelayMessageHandler.java @@ -157,8 +157,8 @@ public class StompBrokerRelayMessageHandler extends AbstractBrokerMessageHandler /** * Create a StompBrokerRelayMessageHandler instance with the given message channels * and destination prefixes. - * @param inboundChannel the channel for receiving messages from clients (e.g. WebSocket clients) - * @param outboundChannel the channel for sending messages to clients (e.g. WebSocket clients) + * @param inboundChannel the channel for receiving messages from clients (for example, WebSocket clients) + * @param outboundChannel the channel for sending messages to clients (for example, WebSocket clients) * @param brokerChannel the channel for the application to send messages to the broker * @param destinationPrefixes the broker supported destination prefixes; destinations * that do not match the given prefix are ignored. @@ -241,7 +241,7 @@ public String getClientPasscode() { /** * Set the login for the shared "system" connection used to send messages to * the STOMP broker from within the application, i.e. messages not associated - * with a specific client session (e.g. REST/HTTP request handling method). + * with a specific client session (for example, REST/HTTP request handling method). *

    By default this is set to "guest". */ public void setSystemLogin(String systemLogin) { @@ -259,7 +259,7 @@ public String getSystemLogin() { /** * Set the passcode for the shared "system" connection used to send messages to * the STOMP broker from within the application, i.e. messages not associated - * with a specific client session (e.g. REST/HTTP request handling method). + * with a specific client session (for example, REST/HTTP request handling method). *

    By default this is set to "guest". */ public void setSystemPasscode(String systemPasscode) { @@ -317,7 +317,7 @@ public long getSystemHeartbeatReceiveInterval() { * Configure one more destinations to subscribe to on the shared "system" * connection along with MessageHandler's to handle received messages. *

    This is for internal use in a multi-application server scenario where - * servers forward messages to each other (e.g. unresolved user destinations). + * servers forward messages to each other (for example, unresolved user destinations). * @param subscriptions the destinations to subscribe to. */ public void setSystemSubscriptions(@Nullable Map subscriptions) { diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompHeaderAccessor.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompHeaderAccessor.java index 799364ccafa9..44fec8110a4f 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompHeaderAccessor.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompHeaderAccessor.java @@ -46,7 +46,7 @@ * {@link org.springframework.messaging.support.NativeMessageHeaderAccessor} * while the parent class {@link SimpMessageHeaderAccessor} manages common * processing headers some of which are based on STOMP headers - * (e.g. destination, content-type, etc). + * (for example, destination, content-type, etc). * *

    An instance of this class can also be created by wrapping an existing * {@code Message}. That message may have been created with the more generic diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolver.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolver.java index 891e17c3d518..822864ae09b4 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolver.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/DefaultUserDestinationResolver.java @@ -37,14 +37,14 @@ * A default implementation of {@code UserDestinationResolver} that relies * on a {@link SimpUserRegistry} to find active sessions for a user. * - *

    When a user attempts to subscribe, e.g. to "/user/queue/position-updates", + *

    When a user attempts to subscribe, for example, to "/user/queue/position-updates", * the "/user" prefix is removed and a unique suffix added based on the session - * id, e.g. "/queue/position-updates-useri9oqdfzo" to ensure different users can + * id, for example, "/queue/position-updates-useri9oqdfzo" to ensure different users can * subscribe to the same logical destination without colliding. * - *

    When sending to a user, e.g. "/user/{username}/queue/position-updates", the + *

    When sending to a user, for example, "/user/{username}/queue/position-updates", the * "/user/{username}" prefix is removed and a suffix based on active session id's - * is added, e.g. "/queue/position-updates-useri9oqdfzo". + * is added, for example, "/queue/position-updates-useri9oqdfzo". * * @author Rossen Stoyanchev * @author Brian Clozel @@ -239,7 +239,7 @@ protected boolean checkDestination(String destination, String requiredPrefix) { * @param sourceDestination the source destination from the input message. * @param actualDestination a subset of the destination without any user prefix. * @param sessionId the id of an active user session, never {@code null}. - * @param user the target user, possibly {@code null}, e.g if not authenticated. + * @param user the target user, possibly {@code null},, for example, if not authenticated. * @return a target destination, or {@code null} if none */ @SuppressWarnings("unused") @@ -283,14 +283,14 @@ public ParseResult(String sourceDest, String actualDest, String subscribeDest, } /** - * The destination from the source message, e.g. "/user/{user}/queue/position-updates". + * The destination from the source message, for example, "/user/{user}/queue/position-updates". */ public String getSourceDestination() { return this.sourceDestination; } /** - * The actual destination, without any user prefix, e.g. "/queue/position-updates". + * The actual destination, without any user prefix, for example, "/queue/position-updates". */ public String getActualDestination() { return this.actualDestination; diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/MultiServerUserRegistry.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/MultiServerUserRegistry.java index 8f1c23339c52..14d4c21df46f 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/MultiServerUserRegistry.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/MultiServerUserRegistry.java @@ -59,7 +59,7 @@ public class MultiServerUserRegistry implements SimpUserRegistry, SmartApplicati private final boolean delegateApplicationEvents; - /* Cross-server session lookup (e.g. same user connected to multiple servers) */ + /* Cross-server session lookup (for example, same user connected to multiple servers) */ private final SessionLookup sessionLookup = new SessionLookup(); @@ -278,7 +278,7 @@ private static class TransferSimpUser implements SimpUser { // User sessions from "this" registry only (i.e. one server) private final Set sessions; - // Cross-server session lookup (e.g. user connected to multiple servers) + // Cross-server session lookup (for example, user connected to multiple servers) @Nullable private SessionLookup sessionLookup; diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/UserDestinationResult.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/UserDestinationResult.java index 04da7a13f654..aa74978e1f17 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/user/UserDestinationResult.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/user/UserDestinationResult.java @@ -82,7 +82,7 @@ public String getSourceDestination() { /** * The target destinations that the source destination was translated to, - * one per active user session, e.g. "/queue/position-updates-useri9oqdfzo". + * one per active user session, for example, "/queue/position-updates-useri9oqdfzo". * @return the target destinations, never {@code null} but possibly an empty * set if there are no active sessions for the user. */ @@ -91,7 +91,7 @@ public Set getTargetDestinations() { } /** - * The user destination in the form expected when a client subscribes, e.g. + * The user destination in the form expected when a client subscribes, for example, * "/user/queue/position-updates". * @return the subscribe form of the "user" destination, never {@code null}. */ diff --git a/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/TcpMessageCodec.java b/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/TcpMessageCodec.java index 8cae457de132..732e8237447b 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/TcpMessageCodec.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/TcpMessageCodec.java @@ -23,7 +23,7 @@ /** * Contract to encode and decode a {@link Message} to and from a {@link ByteBuffer} - * allowing a higher-level protocol (e.g. STOMP over TCP) to plug in. + * allowing a higher-level protocol (for example, STOMP over TCP) to plug in. * * @author Rossen Stoyanchev * @since 6.0 diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java index 681a8136e4d3..fd52e4e4e280 100644 --- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java +++ b/spring-orm/src/main/java/org/springframework/orm/hibernate5/HibernateTransactionManager.java @@ -290,7 +290,7 @@ public void setAllowResultAccessAfterCompletion(boolean allowResultAccessAfterCo * {@link TransactionSynchronizationManager} * check preceding it). *

    Default is "false", i.e. using a Spring-managed Session: taking the current - * thread-bound Session if available (e.g. in an Open-Session-in-View scenario), + * thread-bound Session if available (for example, in an Open-Session-in-View scenario), * creating a new Session for the current transaction otherwise. *

    Switch this flag to "true" in order to enforce use of a Hibernate-managed Session. * Note that this requires {@link SessionFactory#getCurrentSession()} @@ -313,7 +313,7 @@ public void setHibernateManagedSession(boolean hibernateManagedSession) { /** * Specify a callback for customizing every Hibernate {@code Session} resource * created for a new transaction managed by this {@code HibernateTransactionManager}. - *

    This enables convenient customizations for application purposes, e.g. + *

    This enables convenient customizations for application purposes, for example, * setting Hibernate filters. * @since 5.3 * @see Session#enableFilter diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBean.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBean.java index ddf01bd7f085..94517a0a2a04 100644 --- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBean.java +++ b/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBean.java @@ -385,7 +385,7 @@ public void setPackagesToScan(String... packagesToScan) { /** * Specify an asynchronous executor for background bootstrapping, - * e.g. a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}. + * for example, a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}. *

    {@code SessionFactory} initialization will then switch into background * bootstrap mode, with a {@code SessionFactory} proxy immediately returned for * injection purposes instead of waiting for Hibernate's bootstrapping to complete. @@ -416,7 +416,7 @@ public void setHibernateIntegrators(Integrator... hibernateIntegrators) { } /** - * Specify a Hibernate {@link MetadataSources} service to use (e.g. reusing an + * Specify a Hibernate {@link MetadataSources} service to use (for example, reusing an * existing one), potentially populated with a custom Hibernate bootstrap * {@link org.hibernate.service.ServiceRegistry} as well. * @since 4.3 @@ -618,7 +618,7 @@ public void afterSingletonsInstantiated() { * of the SessionFactory instance, creating it via the given Configuration * object that got prepared by this LocalSessionFactoryBean. *

    The default implementation invokes LocalSessionFactoryBuilder's buildSessionFactory. - * A custom implementation could prepare the instance in a specific way (e.g. applying + * A custom implementation could prepare the instance in a specific way (for example, applying * a custom ServiceRegistry) or use a custom SessionFactoryImpl subclass. * @param sfb a LocalSessionFactoryBuilder prepared by this LocalSessionFactoryBean * @return the SessionFactory instance diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBuilder.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBuilder.java index 4ae545255fd1..764e8f97d9a3 100644 --- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBuilder.java +++ b/spring-orm/src/main/java/org/springframework/orm/hibernate5/LocalSessionFactoryBuilder.java @@ -75,7 +75,7 @@ * adding {@link SpringSessionContext} as a default and providing convenient ways * to specify a JDBC {@link DataSource} and an application class loader. * - *

    This is designed for programmatic use, e.g. in {@code @Bean} factory methods; + *

    This is designed for programmatic use, for example, in {@code @Bean} factory methods; * consider using {@link LocalSessionFactoryBean} for XML bean definition files. * Typically combined with {@link HibernateTransactionManager} for declarative * transactions against the {@code SessionFactory} and its JDBC {@code DataSource}. @@ -159,7 +159,7 @@ public LocalSessionFactoryBuilder(@Nullable DataSource dataSource, ResourceLoade * @param dataSource the JDBC DataSource that the resulting Hibernate SessionFactory should be using * (may be {@code null}) * @param resourceLoader the ResourceLoader to load application classes from - * @param metadataSources the Hibernate MetadataSources service to use (e.g. reusing an existing one) + * @param metadataSources the Hibernate MetadataSources service to use (for example, reusing an existing one) * @since 4.3 */ public LocalSessionFactoryBuilder( @@ -392,7 +392,7 @@ private boolean matchesEntityTypeFilter(MetadataReader reader, MetadataReaderFac /** * Build the Hibernate {@code SessionFactory} through background bootstrapping, * using the given executor for a parallel initialization phase - * (e.g. a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}). + * (for example, a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}). *

    {@code SessionFactory} initialization will then switch into background * bootstrap mode, with a {@code SessionFactory} proxy immediately returned for * injection purposes instead of waiting for Hibernate's bootstrapping to complete. diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringBeanContainer.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringBeanContainer.java index 7d05bce072eb..f4c0b4149f74 100644 --- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringBeanContainer.java +++ b/spring-orm/src/main/java/org/springframework/orm/hibernate5/SpringBeanContainer.java @@ -41,7 +41,7 @@ *

    Auto-configured by {@link LocalSessionFactoryBean#setBeanFactory}, * programmatically supported via {@link LocalSessionFactoryBuilder#setBeanContainer}, * and manually configurable through a "hibernate.resource.beans.container" entry - * in JPA properties, e.g.: + * in JPA properties, for example: * *

      * <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
    diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java b/spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java
    index 95698191a2f9..94c88ec65fdf 100644
    --- a/spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java
    +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java
    @@ -80,7 +80,7 @@
      * interface, as autodetected by Spring's
      * {@link org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor},
      * for AOP-based translation of native exceptions to Spring DataAccessExceptions.
    - * Hence, the presence of e.g. LocalEntityManagerFactoryBean automatically enables
    + * Hence, the presence of, for example, LocalEntityManagerFactoryBean automatically enables
      * a PersistenceExceptionTranslationPostProcessor to translate JPA exceptions.
      *
      * @author Juergen Hoeller
    @@ -301,7 +301,7 @@ public JpaVendorAdapter getJpaVendorAdapter() {
     	 * by the exposed {@code EntityManagerFactory}.
     	 * 

    This is an alternative to a {@code JpaVendorAdapter}-level * {@code postProcessEntityManager} implementation, enabling convenient - * customizations for application purposes, e.g. setting Hibernate filters. + * customizations for application purposes, for example, setting Hibernate filters. * @since 5.3 * @see JpaVendorAdapter#postProcessEntityManager * @see JpaTransactionManager#setEntityManagerInitializer @@ -312,7 +312,7 @@ public void setEntityManagerInitializer(Consumer entityManagerIni /** * Specify an asynchronous executor for background bootstrapping, - * e.g. a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}. + * for example, a {@link org.springframework.core.task.SimpleAsyncTaskExecutor}. *

    {@code EntityManagerFactory} initialization will then switch into background * bootstrap mode, with a {@code EntityManagerFactory} proxy immediately returned for * injection purposes instead of waiting for the JPA provider's bootstrapping to complete. diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java b/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java index 791ac10b6922..b9f38e313b44 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java @@ -123,7 +123,7 @@ public static EntityManagerFactory findEntityManagerFactory( /** * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding - * EntityManager bound to the current thread, e.g. when using JpaTransactionManager. + * EntityManager bound to the current thread, for example, when using JpaTransactionManager. *

    Note: Will return {@code null} if no thread-bound EntityManager found! * @param emf the EntityManagerFactory to create the EntityManager with * @return the EntityManager, or {@code null} if none found @@ -139,7 +139,7 @@ public static EntityManager getTransactionalEntityManager(EntityManagerFactory e /** * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding - * EntityManager bound to the current thread, e.g. when using JpaTransactionManager. + * EntityManager bound to the current thread, for example, when using JpaTransactionManager. *

    Note: Will return {@code null} if no thread-bound EntityManager found! * @param emf the EntityManagerFactory to create the EntityManager with * @param properties the properties to be passed into the {@code createEntityManager} @@ -161,7 +161,7 @@ public static EntityManager getTransactionalEntityManager(EntityManagerFactory e /** * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding - * EntityManager bound to the current thread, e.g. when using JpaTransactionManager. + * EntityManager bound to the current thread, for example, when using JpaTransactionManager. *

    Same as {@code getEntityManager}, but throwing the original PersistenceException. * @param emf the EntityManagerFactory to create the EntityManager with * @param properties the properties to be passed into the {@code createEntityManager} @@ -180,7 +180,7 @@ public static EntityManager doGetTransactionalEntityManager(EntityManagerFactory /** * Obtain a JPA EntityManager from the given factory. Is aware of a corresponding - * EntityManager bound to the current thread, e.g. when using JpaTransactionManager. + * EntityManager bound to the current thread, for example, when using JpaTransactionManager. *

    Same as {@code getEntityManager}, but throwing the original PersistenceException. * @param emf the EntityManagerFactory to create the EntityManager with * @param properties the properties to be passed into the {@code createEntityManager} @@ -433,7 +433,7 @@ public static void closeEntityManager(@Nullable EntityManager em) { /** * Callback for resource cleanup at the end of a non-JPA transaction - * (e.g. when participating in a JtaTransactionManager transaction), + * (for example, when participating in a JtaTransactionManager transaction), * fully synchronized with the ongoing transaction. * @see org.springframework.transaction.jta.JtaTransactionManager */ diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/JpaDialect.java b/spring-orm/src/main/java/org/springframework/orm/jpa/JpaDialect.java index 9d519dfbfde7..61eaa9bef2d5 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/JpaDialect.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/JpaDialect.java @@ -87,7 +87,7 @@ Object beginTransaction(EntityManager entityManager, TransactionDefinition defin /** * Prepare a JPA transaction, applying the specified semantics. Called by * EntityManagerFactoryUtils when enlisting an EntityManager in a JTA transaction - * or a locally joined transaction (e.g. after upgrading an unsynchronized + * or a locally joined transaction (for example, after upgrading an unsynchronized * EntityManager to a synchronized one). *

    An implementation can apply the read-only flag as flush mode. In that case, * a transaction data object can be returned that holds the previous flush mode diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/JpaVendorAdapter.java b/spring-orm/src/main/java/org/springframework/orm/jpa/JpaVendorAdapter.java index c7912be20810..d55a6b614b49 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/JpaVendorAdapter.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/JpaVendorAdapter.java @@ -45,7 +45,7 @@ public interface JpaVendorAdapter { /** * Return the name of the persistence provider's root package - * (e.g. "oracle.toplink.essentials"). Will be used for + * (for example, "oracle.toplink.essentials"). Will be used for * excluding provider classes from temporary class overriding. * @since 2.5.2 */ @@ -140,7 +140,7 @@ default void postProcessEntityManagerFactory(EntityManagerFactory emf) { /** * Optional callback for post-processing the native EntityManager * before active use. - *

    This can be used for setting vendor-specific parameters, e.g. + *

    This can be used for setting vendor-specific parameters, for example, * Hibernate filters, on every new EntityManager. * @since 5.3 */ diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.java b/spring-orm/src/main/java/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.java index 63ecac06ad8c..bc66db3acf11 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.java @@ -184,7 +184,7 @@ public void setManagedTypes(PersistenceManagedTypes managedTypes) { * In particular, JPA providers may pick up annotated packages for provider-specific * annotations only when driven by {@code persistence.xml}. As of 4.1, Spring's * scan can detect annotated packages as well if supported by the given - * {@link JpaVendorAdapter} (e.g. for Hibernate). + * {@link JpaVendorAdapter} (for example, for Hibernate). *

    If no explicit {@link #setMappingResources mapping resources} have been * specified in addition to these packages, Spring's setup looks for a default * {@code META-INF/orm.xml} file in the classpath, registering it as a mapping @@ -218,7 +218,7 @@ public void setManagedClassNameFilter(ManagedClassNameFilter managedClassNameFil * Can be used on its own or in combination with entity scanning in the classpath, * in both cases avoiding {@code persistence.xml}. *

    Note that mapping resources must be relative to the classpath root, - * e.g. "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", + * for example, "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", * so that they can be loaded through {@code ClassLoader.getResource}. *

    If no explicit mapping resources have been specified next to * {@link #setPackagesToScan packages to scan}, Spring's setup looks for a default diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java b/spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java index 1bf2bea5aef0..058f5e9184d3 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java @@ -219,7 +219,7 @@ public void setManagedTypes(PersistenceManagedTypes managedTypes) { * In particular, JPA providers may pick up annotated packages for provider-specific * annotations only when driven by {@code persistence.xml}. As of 4.1, Spring's * scan can detect annotated packages as well if supported by the given - * {@link org.springframework.orm.jpa.JpaVendorAdapter} (e.g. for Hibernate). + * {@link org.springframework.orm.jpa.JpaVendorAdapter} (for example, for Hibernate). *

    If no explicit {@link #setMappingResources mapping resources} have been * specified in addition to these packages, this manager looks for a default * {@code META-INF/orm.xml} file in the classpath, registering it as a mapping @@ -251,7 +251,7 @@ public void setManagedClassNameFilter(ManagedClassNameFilter managedClassNameFil * Can be used on its own or in combination with entity scanning in the classpath, * in both cases avoiding {@code persistence.xml}. *

    Note that mapping resources must be relative to the classpath root, - * e.g. "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", + * for example, "META-INF/mappings.xml" or "com/mycompany/repository/mappings.xml", * so that they can be loaded through {@code ClassLoader.getResource}. *

    If no explicit mapping resources have been specified next to * {@link #setPackagesToScan packages to scan}, this manager looks for a default diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/support/PersistenceAnnotationBeanPostProcessor.java b/spring-orm/src/main/java/org/springframework/orm/jpa/support/PersistenceAnnotationBeanPostProcessor.java index a750b7a3976f..f5e17433c649 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/support/PersistenceAnnotationBeanPostProcessor.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/support/PersistenceAnnotationBeanPostProcessor.java @@ -113,7 +113,7 @@ * with the bean name used as fallback unit name if no deployed name found. * Typically, Spring's {@link org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean} * will be used for setting up such EntityManagerFactory beans. Alternatively, - * such beans may also be obtained from JNDI, e.g. using the {@code jee:jndi-lookup} + * such beans may also be obtained from JNDI, for example, using the {@code jee:jndi-lookup} * XML configuration element (with the bean name matching the requested unit name). * In both cases, the post-processor definition will look as simple as this: * diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/AbstractJpaVendorAdapter.java b/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/AbstractJpaVendorAdapter.java index baa3a34b255d..f79bb3f5d858 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/AbstractJpaVendorAdapter.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/AbstractJpaVendorAdapter.java @@ -91,7 +91,7 @@ protected String getDatabasePlatform() { *

    NOTE: Do not set this flag to 'true' while also setting JPA's * {@code jakarta.persistence.schema-generation.database.action} property. * These two schema generation mechanisms - standard JPA versus provider-native - - * are mutually exclusive, e.g. with Hibernate 5. + * are mutually exclusive, for example, with Hibernate 5. * @see org.springframework.orm.jpa.AbstractEntityManagerFactoryBean#setJpaProperties */ public void setGenerateDdl(boolean generateDdl) { diff --git a/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/HibernateJpaVendorAdapter.java b/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/HibernateJpaVendorAdapter.java index 913fcd65214b..6f601c1ce80f 100644 --- a/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/HibernateJpaVendorAdapter.java +++ b/spring-orm/src/main/java/org/springframework/orm/jpa/vendor/HibernateJpaVendorAdapter.java @@ -53,7 +53,7 @@ * EntityManager interface, and adapts {@link AbstractJpaVendorAdapter}'s common * configuration settings. Also supports the detection of annotated packages (through * {@link org.springframework.orm.jpa.persistenceunit.SmartPersistenceUnitInfo#getManagedPackages()}), - * e.g. containing Hibernate {@link org.hibernate.annotations.FilterDef} annotations, + * for example, containing Hibernate {@link org.hibernate.annotations.FilterDef} annotations, * along with Spring-driven entity scanning which requires no {@code persistence.xml} * ({@link org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean#setPackagesToScan}). * @@ -103,7 +103,7 @@ public HibernateJpaVendorAdapter() { * new connection handling mode {@code DELAYED_ACQUISITION_AND_HOLD} in that case * unless a user-specified connection handling mode property indicates otherwise; * switch this flag to {@code false} to avoid that interference. - *

    NOTE: For a persistence unit with transaction type JTA e.g. on WebLogic, + *

    NOTE: For a persistence unit with transaction type JTA, for example, on WebLogic, * the connection release mode will never be altered from its provider default, * i.e. not be forced to {@code DELAYED_ACQUISITION_AND_HOLD} by this flag. * Alternatively, set Hibernate's "hibernate.connection.handling_mode" diff --git a/spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/SingleConnectionFactory.java b/spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/SingleConnectionFactory.java index bcdd395663dc..65e9786f8b1e 100644 --- a/spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/SingleConnectionFactory.java +++ b/spring-r2dbc/src/main/java/org/springframework/r2dbc/connection/SingleConnectionFactory.java @@ -42,7 +42,7 @@ *

    Note that at shutdown, someone should close the underlying * {@code Connection} via the {@code close()} method. Client code will * never call close on the {@code Connection} handle if it is - * SmartConnectionFactory-aware (e.g. uses + * SmartConnectionFactory-aware (for example, uses * {@link ConnectionFactoryUtils#releaseConnection(Connection, ConnectionFactory)}). * *

    If client code will call {@link Connection#close()} in the diff --git a/spring-r2dbc/src/main/java/org/springframework/r2dbc/core/DatabaseClient.java b/spring-r2dbc/src/main/java/org/springframework/r2dbc/core/DatabaseClient.java index 449f4db9e843..2d269d23b7e5 100644 --- a/spring-r2dbc/src/main/java/org/springframework/r2dbc/core/DatabaseClient.java +++ b/spring-r2dbc/src/main/java/org/springframework/r2dbc/core/DatabaseClient.java @@ -71,7 +71,7 @@ public interface DatabaseClient extends ConnectionAccessor { /** * Specify a static {@code sql} statement to run. Contract for specifying an * SQL call along with options leading to the execution. The SQL string can - * contain either native parameter bind markers or named parameters (e.g. + * contain either native parameter bind markers or named parameters (for example, * {@literal :foo, :bar}) when {@link NamedParameterExpander} is enabled. * @param sql the SQL statement * @return a new {@link GenericExecuteSpec} @@ -84,7 +84,7 @@ public interface DatabaseClient extends ConnectionAccessor { * Specify an {@linkplain Supplier SQL supplier} that provides SQL to run. * Contract for specifying an SQL call along with options leading to * the execution. The SQL string can contain either native parameter - * bind markers or named parameters (e.g. {@literal :foo, :bar}) when + * bind markers or named parameters (for example, {@literal :foo, :bar}) when * {@link NamedParameterExpander} is enabled. *

    Accepts {@link PreparedOperation} as SQL and binding {@link Supplier}. *

    {@code DatabaseClient} implementations should defer the resolution of diff --git a/spring-test/src/main/java/org/springframework/mock/http/client/reactive/MockClientHttpRequest.java b/spring-test/src/main/java/org/springframework/mock/http/client/reactive/MockClientHttpRequest.java index 170909f1d862..0f77999f0f78 100644 --- a/spring-test/src/main/java/org/springframework/mock/http/client/reactive/MockClientHttpRequest.java +++ b/spring-test/src/main/java/org/springframework/mock/http/client/reactive/MockClientHttpRequest.java @@ -77,7 +77,7 @@ public MockClientHttpRequest(HttpMethod httpMethod, URI url) { * Configure a custom handler for writing the request body. * *

    The default write handler consumes and caches the request body so it - * may be accessed subsequently, e.g. in test assertions. Use this property + * may be accessed subsequently, for example, in test assertions. Use this property * when the request body is an infinite stream. * @param writeHandler the write handler to use returning {@code Mono} * when the body has been "written" (i.e. consumed). diff --git a/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java b/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java index eb8911a93bd7..381825b0cf44 100644 --- a/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java +++ b/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java @@ -1460,7 +1460,7 @@ public HttpServletMapping getHttpServletMapping() { } /** - * Best effort to detect a Servlet path mapping, e.g. {@code "/foo/*"}, by + * Best effort to detect a Servlet path mapping, for example, {@code "/foo/*"}, by * checking whether the length of requestURI > contextPath + servletPath. * This helps {@link org.springframework.web.util.ServletRequestPathUtils} * to take into account the Servlet path when parsing the requestURI. diff --git a/spring-test/src/main/java/org/springframework/test/context/ContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/ContextLoader.java index 3ed1903632df..154dc769fc5b 100644 --- a/spring-test/src/main/java/org/springframework/test/context/ContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/ContextLoader.java @@ -77,7 +77,7 @@ public interface ContextLoader { * must register a JVM shutdown hook for itself. Unless the * context gets closed early, all context instances will be automatically * closed on JVM shutdown. This allows for freeing external resources held by - * beans within the context, e.g. temporary files. + * beans within the context, for example, temporary files. * @param locations the resource locations to use to load the application context * @return a new application context * @throws Exception if context loading failed diff --git a/spring-test/src/main/java/org/springframework/test/context/TestContextManager.java b/spring-test/src/main/java/org/springframework/test/context/TestContextManager.java index 1da2f79decc2..48a6079f948d 100644 --- a/spring-test/src/main/java/org/springframework/test/context/TestContextManager.java +++ b/spring-test/src/main/java/org/springframework/test/context/TestContextManager.java @@ -176,7 +176,7 @@ public void registerTestExecutionListeners(TestExecutionListener... testExecutio /** * Get the current {@link TestExecutionListener TestExecutionListeners} * registered for this {@code TestContextManager}. - *

    Allows for modifications, e.g. adding a listener to the beginning of the list. + *

    Allows for modifications, for example, adding a listener to the beginning of the list. * However, make sure to keep the list stable while actually executing tests. */ public final List getTestExecutionListeners() { diff --git a/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java b/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java index 3a44d0f129d3..f53079a8b7b3 100644 --- a/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java +++ b/spring-test/src/main/java/org/springframework/test/context/TestPropertySource.java @@ -40,7 +40,7 @@ * operating system's environment or Java system properties as well as property * sources added by the application declaratively via * {@link org.springframework.context.annotation.PropertySource @PropertySource} - * or programmatically (e.g., via an + * or programmatically (for example, via an * {@link org.springframework.context.ApplicationContextInitializer ApplicationContextInitializer} * or some other means). Thus, test property sources can be used to selectively * override properties defined in system and application property sources. @@ -128,7 +128,7 @@ * test class is defined. A path starting with a slash will be treated as an * absolute classpath resource, for example: * {@code "/org/example/test.xml"}. A path which references a - * URL (e.g., a path prefixed with + * URL (for example, a path prefixed with * {@link org.springframework.util.ResourceUtils#CLASSPATH_URL_PREFIX classpath:}, * {@link org.springframework.util.ResourceUtils#FILE_URL_PREFIX file:}, * {@code http:}, etc.) will be loaded using the specified resource protocol. diff --git a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java index d63715d04cb8..7d64249ce654 100644 --- a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java +++ b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java @@ -111,7 +111,7 @@ public interface ContextCache { * {@linkplain org.springframework.context.ConfigurableApplicationContext#close() close} * it if it is an instance of {@code ConfigurableApplicationContext}. *

    Generally speaking, this method should be called to properly evict - * a context from the cache (e.g., due to a custom eviction policy) or if + * a context from the cache (for example, due to a custom eviction policy) or if * the state of a singleton bean has been modified, potentially affecting * future interaction with the context. *

    In addition, the semantics of the supplied {@code HierarchyMode} must diff --git a/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java b/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java index 1838a732447d..e19cb750e8de 100644 --- a/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java +++ b/spring-test/src/main/java/org/springframework/test/context/jdbc/Sql.java @@ -111,7 +111,7 @@ * test class is defined. A path starting with a slash will be treated as an * absolute classpath resource, for example: * {@code "/org/example/schema.sql"}. A path which references a - * URL (e.g., a path prefixed with + * URL (for example, a path prefixed with * {@link org.springframework.util.ResourceUtils#CLASSPATH_URL_PREFIX classpath:}, * {@link org.springframework.util.ResourceUtils#FILE_URL_PREFIX file:}, * {@code http:}, etc.) will be loaded using the specified resource protocol. diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java index 05f9126164ac..4cc99d69a427 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java @@ -49,7 +49,7 @@ * supports both XML configuration files and Groovy scripts simultaneously. * *

    Placing an empty {@code @ContextConfiguration} annotation on a test class signals - * that default resource locations (e.g., XML configuration files or Groovy scripts) + * that default resource locations (for example, XML configuration files or Groovy scripts) * or default * {@linkplain org.springframework.context.annotation.Configuration configuration classes} * should be detected. Furthermore, if a specific {@link ContextLoader} or @@ -57,7 +57,7 @@ * {@code @ContextConfiguration}, a concrete subclass of * {@code AbstractDelegatingSmartContextLoader} will be used as the default loader, * thus providing automatic support for either path-based resource locations - * (e.g., XML configuration files and Groovy scripts) or annotated classes, + * (for example, XML configuration files and Groovy scripts) or annotated classes, * but not both simultaneously. * *

    A test class may optionally declare neither path-based resource locations diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoaderUtils.java b/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoaderUtils.java index c63512a12ab1..a531d0c44786 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoaderUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoaderUtils.java @@ -32,7 +32,7 @@ /** * Utility methods for {@link SmartContextLoader SmartContextLoaders} that deal - * with component classes (e.g., {@link Configuration @Configuration} classes). + * with component classes (for example, {@link Configuration @Configuration} classes). * * @author Sam Brannen * @since 3.2 diff --git a/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java index fef799f259c3..916dbd50d068 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/DependencyInjectionTestExecutionListener.java @@ -47,7 +47,7 @@ public class DependencyInjectionTestExecutionListener extends AbstractTestExecut * dependencies will be injected in * {@link #prepareTestInstance(TestContext) prepareTestInstance()} in any * case. - *

    Clients of a {@link TestContext} (e.g., other + *

    Clients of a {@link TestContext} (for example, other * {@link org.springframework.test.context.TestExecutionListener TestExecutionListeners}) * may therefore choose to set this attribute to signal that dependencies * should be reinjected between execution of individual test diff --git a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java index a37261b71b8f..700f38acd868 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/TestPropertySourceUtils.java @@ -90,7 +90,7 @@ static MergedTestPropertySources buildMergedTestPropertySources(Class testCla TestPropertySourceAttributes previousAttributes = null; // Iterate over all aggregate levels, where each level is represented by - // a list of merged annotations found at that level (e.g., on a test + // a list of merged annotations found at that level (for example, on a test // class in the class hierarchy). for (List> aggregatedAnnotations : findRepeatableAnnotations(testClass, TestPropertySource.class)) { diff --git a/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java index 32921943eeb2..8322a84b605a 100644 --- a/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java +++ b/spring-test/src/main/java/org/springframework/test/context/transaction/TransactionalTestExecutionListener.java @@ -110,7 +110,7 @@ * {@code ApplicationContext} for the test. In case there are multiple * instances of {@code PlatformTransactionManager} within the test's * {@code ApplicationContext}, a qualifier may be declared via - * {@link Transactional @Transactional} (e.g., {@code @Transactional("myTxMgr")} + * {@link Transactional @Transactional} (for example, {@code @Transactional("myTxMgr")} * or {@code @Transactional(transactionManager = "myTxMgr")}, or * {@link org.springframework.transaction.annotation.TransactionManagementConfigurer * TransactionManagementConfigurer} can be implemented by an diff --git a/spring-test/src/main/java/org/springframework/test/context/util/TestContextResourceUtils.java b/spring-test/src/main/java/org/springframework/test/context/util/TestContextResourceUtils.java index bd940007a278..ebc3c7c87fd2 100644 --- a/spring-test/src/main/java/org/springframework/test/context/util/TestContextResourceUtils.java +++ b/spring-test/src/main/java/org/springframework/test/context/util/TestContextResourceUtils.java @@ -77,7 +77,7 @@ public static String[] convertToClasspathResourcePaths(Class clazz, String... *

  • A path starting with a slash will be treated as an absolute path * within the classpath, for example: {@code "/org/example/schema.sql"}. * Such a path will be prepended with the {@code classpath:} prefix. - *
  • A path which is already prefixed with a URL protocol (e.g., + *
  • A path which is already prefixed with a URL protocol (for example, * {@code classpath:}, {@code file:}, {@code http:}, etc.) will not have its * protocol modified. * diff --git a/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java b/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java index 8fbae866496c..52cc39e6b708 100644 --- a/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java +++ b/spring-test/src/main/java/org/springframework/test/context/web/WebAppConfiguration.java @@ -60,7 +60,7 @@ /** * The resource path to the root directory of the web application. - *

    A path that does not include a Spring resource prefix (e.g., {@code classpath:}, + *

    A path that does not include a Spring resource prefix (for example, {@code classpath:}, * {@code file:}, etc.) will be interpreted as a file system resource, and a * path should not end with a slash. *

    Defaults to {@code "src/main/webapp"} as a file system resource. Note diff --git a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java index 026d0527f9f2..046c0d406f22 100644 --- a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java +++ b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java @@ -223,7 +223,7 @@ public T evaluateXpath(byte[] content, @Nullable String encoding, Class t /** * Parse the given XML content to a {@link Document}. * @param xml the content to parse - * @param encoding optional content encoding, if provided as metadata (e.g. in HTTP headers) + * @param encoding optional content encoding, if provided as metadata (for example, in HTTP headers) * @return the parsed document */ protected Document parseXmlByteArray(byte[] xml, @Nullable String encoding) throws Exception { diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java index 3b4700a8beae..881b7c0654a4 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/ExchangeResult.java @@ -80,7 +80,7 @@ public class ExchangeResult { @Nullable private final Object mockServerResult; - /** Ensure single logging, e.g. for expectAll. */ + /** Ensure single logging, for example, for expectAll. */ private boolean diagnosticsLogged; diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/MockServerConfigurer.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/MockServerConfigurer.java index ec6a6e116394..011daf484350 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/MockServerConfigurer.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/MockServerConfigurer.java @@ -25,7 +25,7 @@ * *

    An implementation of this interface can be plugged in via * {@link WebTestClient.MockServerSpec#apply} where instances are likely obtained - * via static methods, e.g.: + * via static methods, for example: * *

      * import static org.example.ExampleSetup.securitySetup;
    diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java
    index a4de02424ec1..49999e352235 100644
    --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java
    +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java
    @@ -94,7 +94,7 @@ public interface WebTestClient {
     	/**
     	 * The name of a request header used to assign a unique id to every request
     	 * performed through the {@code WebTestClient}. This can be useful for
    -	 * storing contextual information at all phases of request processing (e.g.
    +	 * storing contextual information at all phases of request processing (for example,
     	 * from a server-side component) under that id and later to look up
     	 * that information once an {@link ExchangeResult} is available.
     	 */
    @@ -553,7 +553,7 @@ interface UriSpec> {
     
     		/**
     		 * Specify the URI for the request using a URI template and URI variables.
    -		 * 

    If a {@link UriBuilderFactory} was configured for the client (e.g. + *

    If a {@link UriBuilderFactory} was configured for the client (for example, * with a base URI) it will be used to expand the URI template. * @return spec to add headers or perform the exchange */ @@ -561,7 +561,7 @@ interface UriSpec> { /** * Specify the URI for the request using a URI template and URI variables. - *

    If a {@link UriBuilderFactory} was configured for the client (e.g. + *

    If a {@link UriBuilderFactory} was configured for the client (for example, * with a base URI) it will be used to expand the URI template. * @return spec to add headers or perform the exchange */ @@ -875,13 +875,13 @@ interface ResponseSpec { /** * Consume and decode the response body to {@code byte[]} and then apply - * assertions on the raw content (e.g. isEmpty, JSONPath, etc.) + * assertions on the raw content (for example, isEmpty, JSONPath, etc.). */ BodyContentSpec expectBody(); /** * Exit the chained flow in order to consume the response body - * externally, e.g. via {@link reactor.test.StepVerifier}. + * externally, for example, via {@link reactor.test.StepVerifier}. *

    Note that when {@code Void.class} is passed in, the response body * is consumed and released. If no content is expected, then consider * using {@code .expectBody().isEmpty()} instead which asserts that @@ -927,7 +927,7 @@ interface BodySpec> { T value(Matcher matcher); /** - * Transform the extracted the body with a function, e.g. extracting a + * Transform the extracted the body with a function, for example, extracting a * property, and assert the mapped value with a {@link Matcher}. * @since 5.1 */ diff --git a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WiretapConnector.java b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WiretapConnector.java index 35e2eee74a2f..c502d883ade6 100644 --- a/spring-test/src/main/java/org/springframework/test/web/reactive/server/WiretapConnector.java +++ b/spring-test/src/main/java/org/springframework/test/web/reactive/server/WiretapConnector.java @@ -190,7 +190,7 @@ public Mono getContent() { } if (!this.hasContentConsumer) { // Couple of possible cases: - // 1. Mock server never consumed request body (e.g. error before read) + // 1. Mock server never consumed request body (for example, error before read) // 2. FluxExchangeResult: getResponseBodyContent called before getResponseBody //noinspection ConstantConditions (this.publisher != null ? this.publisher : this.publisherNested) diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/assertj/MockMvcTester.java b/spring-test/src/main/java/org/springframework/test/web/servlet/assertj/MockMvcTester.java index 9d2b49b94b71..309ee6c78a77 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/assertj/MockMvcTester.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/assertj/MockMvcTester.java @@ -355,7 +355,7 @@ public MockMvcRequestBuilder method(HttpMethod method) { *

    Use only this method if you need to provide a custom * {@link RequestBuilder}. For regular cases, users should initiate the * configuration of the request using one of the methods available on - * this instance, e.g. {@link #get()} for HTTP GET. + * this instance, for example, {@link #get()} for HTTP GET. *

    Contrary to {@link MockMvc#perform(RequestBuilder)}, this does not * throw an exception if the request fails with an unresolved exception. * Rather, the result provides the exception, if any. Assuming that a diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/client/MockMvcWebTestClient.java b/spring-test/src/main/java/org/springframework/test/web/servlet/client/MockMvcWebTestClient.java index 9a206edc2f0f..cb632fa6e28b 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/client/MockMvcWebTestClient.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/client/MockMvcWebTestClient.java @@ -130,7 +130,7 @@ static WebTestClient.Builder bindTo(MockMvc mockMvc) { * including HTTP status, headers, and body. That is all that is available * when making a live request over HTTP. However when the server is * {@link MockMvc}, many more assertions are possible against the server - * response, e.g. model attributes, flash attributes, etc. + * response, for example, model attributes, flash attributes, etc. * *

    Example: *

    diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java b/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
    index fa73f00795bb..00c0c54ceb21 100644
    --- a/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
    +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
    @@ -195,7 +195,7 @@ public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, URI u
     	}
     
     	/**
    -	 * Alternative factory method that allows for custom HTTP verbs (e.g. WebDAV).
    +	 * Alternative factory method that allows for custom HTTP verbs (for example, WebDAV).
     	 * @param httpMethod the HTTP method
     	 * @param uri the URI
     	 * @since 4.3
    diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/ConfigurableMockMvcBuilder.java b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/ConfigurableMockMvcBuilder.java
    index 4a4db80e079c..40de7774f21d 100644
    --- a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/ConfigurableMockMvcBuilder.java
    +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/ConfigurableMockMvcBuilder.java
    @@ -136,7 +136,7 @@ default  T defaultResponseCharacterEncoding(Charset defaultResponse
     
     	/**
     	 * Add a {@code MockMvcConfigurer} that automates MockMvc setup and
    -	 * configures it for some specific purpose (e.g. security).
    +	 * configures it for some specific purpose (for example, security).
     	 * 

    There is a built-in {@link SharedHttpSessionConfigurer} that can be * used to re-use the HTTP session across requests. 3rd party frameworks * like Spring Security also use this mechanism to provide configuration diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcConfigurer.java b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcConfigurer.java index e3edfe6f1c23..b7707efde915 100644 --- a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcConfigurer.java +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcConfigurer.java @@ -22,12 +22,12 @@ /** * Contract for customizing a {@code ConfigurableMockMvcBuilder} in some - * specific way, e.g. a 3rd party library that wants to provide shortcuts for + * specific way, for example, a 3rd party library that wants to provide shortcuts for * setting up a MockMvc. * *

    An implementation of this interface can be plugged in via * {@link ConfigurableMockMvcBuilder#apply} with instances of this type likely - * created via static methods, e.g.: + * created via static methods, for example: * *

      * import static org.example.ExampleSetup.mySetup;
    diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcFilterDecorator.java b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcFilterDecorator.java
    index f20dfa4058cc..f07720d4abc3 100644
    --- a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcFilterDecorator.java
    +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/MockMvcFilterDecorator.java
    @@ -66,13 +66,13 @@ final class MockMvcFilterDecorator implements Filter {
     
     	private final boolean hasPatterns;
     
    -	/** Patterns that require an exact match, e.g. "/test" */
    +	/** Patterns that require an exact match, for example, "/test". */
     	private final List exactMatches = new ArrayList<>();
     
    -	/** Patterns that require the URL to have a specific prefix, e.g. "/test/*" */
    +	/** Patterns that require the URL to have a specific prefix, for example, "/test/*". */
     	private final List startsWithMatches = new ArrayList<>();
     
    -	/** Patterns that require the request URL to have a specific suffix, e.g. "*.html" */
    +	/** Patterns that require the request URL to have a specific suffix, for example, "*.html". */
     	private final List endsWithMatches = new ArrayList<>();
     
     
    diff --git a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java
    index fde448875512..4c68fffef1cb 100644
    --- a/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java
    +++ b/spring-test/src/main/java/org/springframework/test/web/servlet/setup/StandaloneMockMvcBuilder.java
    @@ -285,7 +285,7 @@ public StandaloneMockMvcBuilder setViewResolvers(ViewResolver...resolvers) {
     	/**
     	 * Sets up a single {@link ViewResolver} that always returns the provided
     	 * view instance. This is a convenient shortcut if you need to use one
    -	 * View instance only -- e.g. rendering generated content (JSON, XML, Atom).
    +	 * View instance only -- for example, rendering generated content (JSON, XML, Atom).
     	 */
     	public StandaloneMockMvcBuilder setSingleView(View view) {
     		this.viewResolvers = Collections.singletonList(new StaticViewResolver(view));
    diff --git a/spring-test/src/test/java/org/springframework/test/context/junit4/spr9051/TransactionalAnnotatedConfigClassesWithoutAtConfigurationTests.java b/spring-test/src/test/java/org/springframework/test/context/junit4/spr9051/TransactionalAnnotatedConfigClassesWithoutAtConfigurationTests.java
    index e13dd93c80a5..7914ac6aff97 100644
    --- a/spring-test/src/test/java/org/springframework/test/context/junit4/spr9051/TransactionalAnnotatedConfigClassesWithoutAtConfigurationTests.java
    +++ b/spring-test/src/test/java/org/springframework/test/context/junit4/spr9051/TransactionalAnnotatedConfigClassesWithoutAtConfigurationTests.java
    @@ -73,9 +73,9 @@ public PlatformTransactionManager transactionManager() {
     
     		/**
     		 * Since this method does not reside in a true {@code @Configuration class},
    -		 * it acts as a factory method when invoked directly (e.g., from
    +		 * it acts as a factory method when invoked directly (for example, from
     		 * {@link #transactionManager()}) and as a singleton bean when retrieved
    -		 * through the application context (e.g., when injected into the test
    +		 * through the application context (for example, when injected into the test
     		 * instance). The result is that this method will be called twice:
     		 *
     		 * 
      diff --git a/spring-tx/src/main/java/org/springframework/dao/DataAccessException.java b/spring-tx/src/main/java/org/springframework/dao/DataAccessException.java index 32479d9c02d4..9664399b13ab 100644 --- a/spring-tx/src/main/java/org/springframework/dao/DataAccessException.java +++ b/spring-tx/src/main/java/org/springframework/dao/DataAccessException.java @@ -27,7 +27,7 @@ * *

      This exception hierarchy aims to let user code find and handle the * kind of error encountered without knowing the details of the particular - * data access API in use (e.g. JDBC). Thus, it is possible to react to an + * data access API in use (for example, JDBC). Thus, it is possible to react to an * optimistic locking failure without knowing that JDBC is being used. * *

      As this class is a runtime exception, there is no need for user code diff --git a/spring-tx/src/main/java/org/springframework/dao/DataIntegrityViolationException.java b/spring-tx/src/main/java/org/springframework/dao/DataIntegrityViolationException.java index 0ec2d95ab9f7..a4044aa64830 100644 --- a/spring-tx/src/main/java/org/springframework/dao/DataIntegrityViolationException.java +++ b/spring-tx/src/main/java/org/springframework/dao/DataIntegrityViolationException.java @@ -25,7 +25,7 @@ * is not purely a relational concept; integrity constraints such * as unique primary keys are required by most database types. * - *

      Serves as a superclass for more specific exceptions, e.g. + *

      Serves as a superclass for more specific exceptions, for example, * {@link DuplicateKeyException}. However, it is generally * recommended to handle {@code DataIntegrityViolationException} * itself instead of relying on specific exception subclasses. diff --git a/spring-tx/src/main/java/org/springframework/dao/DataRetrievalFailureException.java b/spring-tx/src/main/java/org/springframework/dao/DataRetrievalFailureException.java index 6b36a34ab566..67e055adb3d1 100644 --- a/spring-tx/src/main/java/org/springframework/dao/DataRetrievalFailureException.java +++ b/spring-tx/src/main/java/org/springframework/dao/DataRetrievalFailureException.java @@ -19,7 +19,7 @@ import org.springframework.lang.Nullable; /** - * Exception thrown if certain expected data could not be retrieved, e.g. + * Exception thrown if certain expected data could not be retrieved, for example, * when looking up specific data via a known identifier. This exception * will be thrown either by O/R mapping tools or by DAO implementations. * diff --git a/spring-tx/src/main/java/org/springframework/dao/PessimisticLockingFailureException.java b/spring-tx/src/main/java/org/springframework/dao/PessimisticLockingFailureException.java index b0b5547679b2..82749d877856 100644 --- a/spring-tx/src/main/java/org/springframework/dao/PessimisticLockingFailureException.java +++ b/spring-tx/src/main/java/org/springframework/dao/PessimisticLockingFailureException.java @@ -23,7 +23,7 @@ * Thrown by Spring's SQLException translation mechanism * if a corresponding database error is encountered. * - *

      Serves as a superclass for more specific exceptions, e.g. + *

      Serves as a superclass for more specific exceptions, for example, * {@link CannotAcquireLockException}. However, it is generally * recommended to handle {@code PessimisticLockingFailureException} * itself instead of relying on specific exception subclasses. diff --git a/spring-tx/src/main/java/org/springframework/dao/annotation/PersistenceExceptionTranslationPostProcessor.java b/spring-tx/src/main/java/org/springframework/dao/annotation/PersistenceExceptionTranslationPostProcessor.java index 1c2bd4e7f683..6627cc080ffe 100644 --- a/spring-tx/src/main/java/org/springframework/dao/annotation/PersistenceExceptionTranslationPostProcessor.java +++ b/spring-tx/src/main/java/org/springframework/dao/annotation/PersistenceExceptionTranslationPostProcessor.java @@ -38,7 +38,7 @@ * PersistenceExceptionTranslator} interface, which are subsequently asked to translate * candidate exceptions. * - *

      All of Spring's applicable resource factories (e.g. + *

      All of Spring's applicable resource factories (for example, * {@link org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean}) * implement the {@code PersistenceExceptionTranslator} interface out of the box. * As a consequence, all that is usually needed to enable automatic exception diff --git a/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointFactory.java b/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointFactory.java index 1da1e4d629dc..7ac7272c766e 100644 --- a/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointFactory.java +++ b/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointFactory.java @@ -34,7 +34,7 @@ * Generic implementation of the JCA 1.7 * {@link jakarta.resource.spi.endpoint.MessageEndpointFactory} interface, * providing transaction management capabilities for any kind of message - * listener object (e.g. {@link jakarta.jms.MessageListener} objects or + * listener object (for example, {@link jakarta.jms.MessageListener} objects or * {@link jakarta.resource.cci.MessageListener} objects). * *

      Uses AOP proxies for concrete endpoint instances, simply wrapping @@ -60,7 +60,7 @@ public class GenericMessageEndpointFactory extends AbstractMessageEndpointFactor /** * Specify the message listener object that the endpoint should expose - * (e.g. a {@link jakarta.jms.MessageListener} objects or + * (for example, a {@link jakarta.jms.MessageListener} objects or * {@link jakarta.resource.cci.MessageListener} implementation). */ public void setMessageListener(Object messageListener) { diff --git a/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java b/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java index 10e5295db6df..8ae0cbd2741f 100644 --- a/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java +++ b/spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java @@ -87,7 +87,7 @@ *

      For a different target resource, the configuration would simply point to a * different ResourceAdapter and a different ActivationSpec object (which are * both specific to the resource provider), and possibly a different message - * listener (e.g. a CCI {@link jakarta.resource.cci.MessageListener} for a + * listener (for example, a CCI {@link jakarta.resource.cci.MessageListener} for a * resource adapter which is based on the JCA Common Client Interface). * *

      The asynchronous execution strategy can be customized through the @@ -123,7 +123,7 @@ * *

      Alternatively, check out your resource provider's ActivationSpec object, * which should support local transactions through a provider-specific config flag, - * e.g. ActiveMQActivationSpec's "useRAManagedTransaction" bean property. + * for example, ActiveMQActivationSpec's "useRAManagedTransaction" bean property. * *

        * <bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager">
      diff --git a/spring-tx/src/main/java/org/springframework/jca/support/LocalConnectionFactoryBean.java b/spring-tx/src/main/java/org/springframework/jca/support/LocalConnectionFactoryBean.java
      index 3c4d213367ed..f7a0be1fe487 100644
      --- a/spring-tx/src/main/java/org/springframework/jca/support/LocalConnectionFactoryBean.java
      +++ b/spring-tx/src/main/java/org/springframework/jca/support/LocalConnectionFactoryBean.java
      @@ -56,7 +56,7 @@
        * of XA enlistment. You need to specify an XA-capable ConnectionManager in
        * order to make the connector interact with an XA transaction coordinator.
        * Alternatively, simply use the native local transaction facilities of the
      - * exposed API (e.g. CCI local transactions), or use a corresponding
      + * exposed API (for example, CCI local transactions), or use a corresponding
        * implementation of Spring's PlatformTransactionManager SPI to drive local
        * transactions.
        *
      diff --git a/spring-tx/src/main/java/org/springframework/transaction/PlatformTransactionManager.java b/spring-tx/src/main/java/org/springframework/transaction/PlatformTransactionManager.java
      index fb937bf42387..345b5bf27ff0 100644
      --- a/spring-tx/src/main/java/org/springframework/transaction/PlatformTransactionManager.java
      +++ b/spring-tx/src/main/java/org/springframework/transaction/PlatformTransactionManager.java
      @@ -34,7 +34,7 @@
        * 

      A classic implementation of this strategy interface is * {@link org.springframework.transaction.jta.JtaTransactionManager}. However, * in common single-resource scenarios, Spring's specific transaction managers - * for e.g. JDBC, JPA, JMS are preferred choices. + * for example, JDBC, JPA, JMS are preferred choices. * * @author Rod Johnson * @author Juergen Hoeller diff --git a/spring-tx/src/main/java/org/springframework/transaction/TransactionExecution.java b/spring-tx/src/main/java/org/springframework/transaction/TransactionExecution.java index f632c4d85e78..63b3da57fa48 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/TransactionExecution.java +++ b/spring-tx/src/main/java/org/springframework/transaction/TransactionExecution.java @@ -60,7 +60,7 @@ default boolean hasTransaction() { *

      This is primarily here for transaction manager state handling. * Prefer the use of {@link #hasTransaction()} for application purposes * since this is usually semantically appropriate. - *

      The "new" status can be transaction manager specific, e.g. returning + *

      The "new" status can be transaction manager specific, for example, returning * {@code true} for an actual nested transaction but potentially {@code false} * for a savepoint-based nested transaction scope if the savepoint management * is explicitly exposed (such as on {@link TransactionStatus}). A combined diff --git a/spring-tx/src/main/java/org/springframework/transaction/annotation/AnnotationTransactionAttributeSource.java b/spring-tx/src/main/java/org/springframework/transaction/annotation/AnnotationTransactionAttributeSource.java index 493fa0192caa..bc89a105111d 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/annotation/AnnotationTransactionAttributeSource.java +++ b/spring-tx/src/main/java/org/springframework/transaction/annotation/AnnotationTransactionAttributeSource.java @@ -149,7 +149,7 @@ public void setPublicMethodsOnly(boolean publicMethodsOnly) { * but not on checked exceptions. A default rule may override this * while still respecting any custom rules in the transaction attribute. * @param rollbackRule a rollback rule overriding the default behavior, - * e.g. {@link RollbackRuleAttribute#ROLLBACK_ON_ALL_EXCEPTIONS} + * for example, {@link RollbackRuleAttribute#ROLLBACK_ON_ALL_EXCEPTIONS} * @since 6.2 * @see RuleBasedTransactionAttribute#getRollbackRules() * @see EnableTransactionManagement#rollbackOn() diff --git a/spring-tx/src/main/java/org/springframework/transaction/annotation/EnableTransactionManagement.java b/spring-tx/src/main/java/org/springframework/transaction/annotation/EnableTransactionManagement.java index 4a4ddf426a0b..8c83e5c06506 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/annotation/EnableTransactionManagement.java +++ b/spring-tx/src/main/java/org/springframework/transaction/annotation/EnableTransactionManagement.java @@ -172,7 +172,7 @@ * {@code @Transactional}. For example, other beans marked with Spring's * {@code @Async} annotation will be upgraded to subclass proxying at the same * time. This approach has no negative impact in practice unless one is explicitly - * expecting one type of proxy vs another, e.g. in tests. + * expecting one type of proxy vs another, for example, in tests. */ boolean proxyTargetClass() default false; diff --git a/spring-tx/src/main/java/org/springframework/transaction/annotation/Transactional.java b/spring-tx/src/main/java/org/springframework/transaction/annotation/Transactional.java index 4549186f543f..956dfe60ea12 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/annotation/Transactional.java +++ b/spring-tx/src/main/java/org/springframework/transaction/annotation/Transactional.java @@ -108,7 +108,7 @@ *

      Note: When configured with a {@code ReactiveTransactionManager}, all * transaction-demarcated methods are expected to return a reactive pipeline. * Void methods or regular return types need to be associated with a regular - * {@code PlatformTransactionManager}, e.g. through {@link #transactionManager()}. + * {@code PlatformTransactionManager}, for example, through {@link #transactionManager()}. * * @author Colin Sampaleanu * @author Juergen Hoeller @@ -205,7 +205,7 @@ *

      Exclusively designed for use with {@link Propagation#REQUIRED} or * {@link Propagation#REQUIRES_NEW} since it only applies to newly started * transactions. - * @return the timeout in seconds as a String value, e.g. a placeholder + * @return the timeout in seconds as a String value, for example, a placeholder * @since 5.3 * @see org.springframework.transaction.interceptor.TransactionAttribute#getTimeout() */ diff --git a/spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListener.java b/spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListener.java index 579017c95462..0897270da5c7 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListener.java +++ b/spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListener.java @@ -111,7 +111,7 @@ /** * An optional identifier for the listener, defaulting to the fully-qualified - * signature of the declaring method (e.g. "mypackage.MyClass.myMethod()"). + * signature of the declaring method (for example, "mypackage.MyClass.myMethod()"). * @since 5.3 * @see EventListener#id * @see TransactionalApplicationListener#getListenerId() diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/DefaultTransactionAttribute.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/DefaultTransactionAttribute.java index 0eaf43a7308e..c373271c28c1 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/DefaultTransactionAttribute.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/DefaultTransactionAttribute.java @@ -90,7 +90,7 @@ public DefaultTransactionAttribute(int propagationBehavior) { /** * Set a descriptor for this transaction attribute, - * e.g. indicating where the attribute is applying. + * for example, indicating where the attribute is applying. * @since 4.3.4 */ public void setDescriptor(@Nullable String descriptor) { diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/MethodMapTransactionAttributeSource.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/MethodMapTransactionAttributeSource.java index 082c1199d6ad..a4fe2cac71a1 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/MethodMapTransactionAttributeSource.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/MethodMapTransactionAttributeSource.java @@ -74,7 +74,7 @@ public class MethodMapTransactionAttributeSource /** * Set a name/attribute map, consisting of "{@code .}" - * method names (e.g. "com.mycompany.mycode.MyClass.myMethod") and + * method names (for example, "com.mycompany.mycode.MyClass.myMethod") and * {@link TransactionAttribute} instances (or Strings to be converted * to {@code TransactionAttribute} instances). *

      Intended for configuration via setter injection, typically within diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/NameMatchTransactionAttributeSource.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/NameMatchTransactionAttributeSource.java index 4d9ecbd42fc3..7eb89423037a 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/NameMatchTransactionAttributeSource.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/NameMatchTransactionAttributeSource.java @@ -62,7 +62,7 @@ public class NameMatchTransactionAttributeSource /** * Set a name/attribute map, consisting of method names - * (e.g. "myMethod") and {@link TransactionAttribute} instances. + * (for example, "myMethod") and {@link TransactionAttribute} instances. * @see #setProperties * @see TransactionAttribute */ diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAspectSupport.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAspectSupport.java index c644c976f56b..89dd57102573 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAspectSupport.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAspectSupport.java @@ -68,7 +68,7 @@ * *

      Uses the Strategy design pattern. A {@link PlatformTransactionManager} or * {@link ReactiveTransactionManager} implementation will perform the actual transaction - * management, and a {@link TransactionAttributeSource} (e.g. annotation-based) is used + * management, and a {@link TransactionAttributeSource} (for example, annotation-based) is used * for determining transaction definitions for a particular class or method. * *

      A transaction aspect is serializable if its {@code TransactionManager} and @@ -116,7 +116,7 @@ public abstract class TransactionAspectSupport implements BeanFactoryAware, Init /** * Holder to support the {@code currentTransactionStatus()} method, * and to support communication between different cooperating advices - * (e.g. before and after advice) if the aspect involves more than a + * (for example, before and after advice) if the aspect involves more than a * single method (as will be the case for around advice). */ private static final ThreadLocal transactionInfoHolder = @@ -245,7 +245,7 @@ public TransactionManager getTransactionManager() { /** * Set properties with method names as keys and transaction attribute * descriptors (parsed via TransactionAttributeEditor) as values: - * e.g. key = "myMethod", value = "PROPAGATION_REQUIRED,readOnly". + * for example, key = "myMethod", value = "PROPAGATION_REQUIRED,readOnly". *

      Note: Method names are always applied to the target class, * no matter if defined in an interface or the class itself. *

      Internally, a NameMatchTransactionAttributeSource will be diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionProxyFactoryBean.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionProxyFactoryBean.java index 774107b46ff1..723d1eb877f3 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionProxyFactoryBean.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionProxyFactoryBean.java @@ -133,7 +133,7 @@ public void setTransactionManager(PlatformTransactionManager transactionManager) /** * Set properties with method names as keys and transaction attribute * descriptors (parsed via TransactionAttributeEditor) as values: - * e.g. key = "myMethod", value = "PROPAGATION_REQUIRED,readOnly". + * for example, key = "myMethod", value = "PROPAGATION_REQUIRED,readOnly". *

      Note: Method names are always applied to the target class, * no matter if defined in an interface or the class itself. *

      Internally, a NameMatchTransactionAttributeSource will be diff --git a/spring-tx/src/main/java/org/springframework/transaction/jta/JtaTransactionManager.java b/spring-tx/src/main/java/org/springframework/transaction/jta/JtaTransactionManager.java index b24144f6b62c..c937dbcd3bce 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/jta/JtaTransactionManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/jta/JtaTransactionManager.java @@ -62,7 +62,7 @@ * *

      This transaction manager is appropriate for handling distributed transactions, * i.e. transactions that span multiple resources, and for controlling transactions on - * application server resources (e.g. JDBC DataSources available in JNDI) in general. + * application server resources (for example, JDBC DataSources available in JNDI) in general. * For a single JDBC DataSource, DataSourceTransactionManager is perfectly sufficient, * and for accessing a single resource with Hibernate (including transactional cache), * HibernateTransactionManager is appropriate, for example. @@ -92,7 +92,7 @@ * API in addition to the standard JTA UserTransaction handle. As of Spring 2.5, this * JtaTransactionManager autodetects the TransactionSynchronizationRegistry and uses * it for registering Spring-managed synchronizations when participating in an existing - * JTA transaction (e.g. controlled by EJB CMT). If no TransactionSynchronizationRegistry + * JTA transaction (for example, controlled by EJB CMT). If no TransactionSynchronizationRegistry * is available, then such synchronizations will be registered via the (non-EE) JTA * TransactionManager handle. * @@ -420,7 +420,7 @@ public void setAutodetectTransactionSynchronizationRegistry(boolean autodetectTr *

      Default is "false", throwing an exception if a non-default isolation level * is specified for a transaction. Turn this flag on if affected resource adapters * check the thread-bound transaction context and apply the specified isolation - * levels individually (e.g. through an IsolationLevelDataSourceAdapter). + * levels individually (for example, through an IsolationLevelDataSourceAdapter). * @see org.springframework.jdbc.datasource.IsolationLevelDataSourceAdapter * @see org.springframework.jdbc.datasource.lookup.IsolationLevelDataSourceRouter */ diff --git a/spring-tx/src/main/java/org/springframework/transaction/jta/SpringJtaSynchronizationAdapter.java b/spring-tx/src/main/java/org/springframework/transaction/jta/SpringJtaSynchronizationAdapter.java index 4beebb30b339..622339fcdfdc 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/jta/SpringJtaSynchronizationAdapter.java +++ b/spring-tx/src/main/java/org/springframework/transaction/jta/SpringJtaSynchronizationAdapter.java @@ -122,7 +122,7 @@ public void beforeCompletion() { finally { // Process Spring's beforeCompletion early, in order to avoid issues // with strict JTA implementations that issue warnings when doing JDBC - // operations after transaction completion (e.g. Connection.getWarnings). + // operations after transaction completion (for example, Connection.getWarnings). this.beforeCompletionCalled = true; this.springSynchronization.beforeCompletion(); } diff --git a/spring-tx/src/main/java/org/springframework/transaction/reactive/AbstractReactiveTransactionManager.java b/spring-tx/src/main/java/org/springframework/transaction/reactive/AbstractReactiveTransactionManager.java index 6efe444555c2..8a3a5056b6a7 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/reactive/AbstractReactiveTransactionManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/reactive/AbstractReactiveTransactionManager.java @@ -59,7 +59,7 @@ * * *

      Subclasses have to implement specific template methods for specific - * states of a transaction, e.g.: begin, suspend, resume, commit, rollback. + * states of a transaction, for example: begin, suspend, resume, commit, rollback. * The most important of them are abstract and must be provided by a concrete * implementation; for the rest, defaults are provided, so overriding is optional. * @@ -763,7 +763,7 @@ private Mono cleanupAfterCompletion(TransactionSynchronizationManager sync *

      The returned object will usually be specific to the concrete transaction * manager implementation, carrying corresponding transaction state in a * modifiable fashion. This object will be passed into the other template - * methods (e.g. doBegin and doCommit), either directly or as part of a + * methods (for example, doBegin and doCommit), either directly or as part of a * DefaultReactiveTransactionStatus instance. *

      The returned object should contain information about any existing * transaction, that is, a transaction that has already started before the @@ -816,7 +816,7 @@ protected boolean isExistingTransaction(Object transaction) { * @param definition a TransactionDefinition instance, describing propagation * behavior, isolation level, read-only flag, timeout, and transaction name * @throws org.springframework.transaction.NestedTransactionNotSupportedException - * if the underlying transaction does not support nesting (e.g. through savepoints) + * if the underlying transaction does not support nesting (for example, through savepoints) */ protected abstract Mono doBegin(TransactionSynchronizationManager synchronizationManager, Object transaction, TransactionDefinition definition); diff --git a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionCallback.java b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionCallback.java index 63546c24c435..a5974d5f2625 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionCallback.java +++ b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionCallback.java @@ -26,7 +26,7 @@ * *

      Typically used to assemble various calls to transaction-unaware data access * services into a higher-level service method with transaction demarcation. As an - * alternative, consider the use of declarative transaction demarcation (e.g. through + * alternative, consider the use of declarative transaction demarcation (for example, through * Spring's {@link org.springframework.transaction.annotation.Transactional} annotation). * * @author Mark Paluch @@ -42,7 +42,7 @@ public interface TransactionCallback { * Gets called by {@link TransactionalOperator} within a transactional context. * Does not need to care about transactions itself, although it can retrieve and * influence the status of the current transaction via the given status object, - * e.g. setting rollback-only. + * for example, setting rollback-only. * @param status associated transaction status * @return a result publisher * @see TransactionalOperator#transactional diff --git a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronization.java b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronization.java index ac8309f4c8fe..dc1774d916a4 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronization.java +++ b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronization.java @@ -101,7 +101,7 @@ default Mono beforeCompletion() { /** * Invoked after transaction commit. Can perform further operations right * after the main transaction has successfully committed. - *

      Can e.g. commit further operations that are supposed to follow on a successful + *

      Can, for example, commit further operations that are supposed to follow on a successful * commit of the main transaction, like confirmation messages or emails. *

      NOTE: The transaction will have been committed already, but the * transactional resources might still be active and accessible. As a consequence, diff --git a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronizationManager.java b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronizationManager.java index b5a1b11ebad5..1c2fa3a5bf81 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronizationManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionSynchronizationManager.java @@ -39,7 +39,7 @@ * to be removed before a new one can be set for the same key. * Supports a list of transaction synchronizations if synchronization is active. * - *

      Resource management code should check for context-bound resources, e.g. + *

      Resource management code should check for context-bound resources, for example, * database connections, via {@code getResource}. Such code is normally not * supposed to bind resources to units of work, as this is the responsibility * of transaction managers. A further option is to lazily bind on first use if @@ -58,7 +58,7 @@ * doesn't support transaction synchronization. * *

      Synchronization is for example used to always return the same resources within - * a transaction, e.g. a database connection for any given connection factory. + * a transaction, for example, a database connection for any given connection factory. * * @author Mark Paluch * @author Juergen Hoeller diff --git a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionalEventPublisher.java b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionalEventPublisher.java index 443d4607154d..dfb8fed6d186 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionalEventPublisher.java +++ b/spring-tx/src/main/java/org/springframework/transaction/reactive/TransactionalEventPublisher.java @@ -65,7 +65,7 @@ public TransactionalEventPublisher(ApplicationEventPublisher eventPublisher) { * Publish an event created through the given function which maps the transaction * source object (the {@link TransactionContext}) to the event instance. * @param eventCreationFunction a function mapping the source object to the event instance, - * e.g. {@code source -> new PayloadApplicationEvent<>(source, "myPayload")} + * for example, {@code source -> new PayloadApplicationEvent<>(source, "myPayload")} * @return the Reactor {@link Mono} for the transactional event publication */ public Mono publishEvent(Function eventCreationFunction) { diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/AbstractPlatformTransactionManager.java b/spring-tx/src/main/java/org/springframework/transaction/support/AbstractPlatformTransactionManager.java index 8da5bab11855..73b56a20152b 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/AbstractPlatformTransactionManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/AbstractPlatformTransactionManager.java @@ -59,7 +59,7 @@ * * *

      Subclasses have to implement specific template methods for specific - * states of a transaction, e.g.: begin, suspend, resume, commit, rollback. + * states of a transaction, for example: begin, suspend, resume, commit, rollback. * The most important of them are abstract and must be provided by a concrete * implementation; for the rest, defaults are provided, so overriding is optional. * @@ -67,7 +67,7 @@ * that get invoked at transaction completion time. This is mainly used internally * by the data access support classes for JDBC, Hibernate, JPA, etc when running * within a JTA transaction: They register resources that are opened within the - * transaction for closing at transaction completion time, allowing e.g. for reuse + * transaction for closing at transaction completion time, allowing, for example, for reuse * of the same Hibernate Session within the transaction. The same mechanism can * also be leveraged for custom synchronization needs in an application. * @@ -188,7 +188,7 @@ public final int getTransactionSynchronization() { * Specify the default timeout that this transaction manager should apply * if there is no timeout specified at the transaction level, in seconds. *

      Default is the underlying transaction infrastructure's default timeout, - * e.g. typically 30 seconds in case of a JTA provider, indicated by the + * for example, typically 30 seconds in case of a JTA provider, indicated by the * {@code TransactionDefinition.TIMEOUT_DEFAULT} value. * @see org.springframework.transaction.TransactionDefinition#TIMEOUT_DEFAULT */ @@ -228,7 +228,7 @@ public final boolean isNestedTransactionAllowed() { /** * Set whether existing transactions should be validated before participating * in them. - *

      When participating in an existing transaction (e.g. with + *

      When participating in an existing transaction (for example, with * PROPAGATION_REQUIRED or PROPAGATION_SUPPORTS encountering an existing * transaction), this outer transaction's characteristics will apply even * to the inner transaction scope. Validation will detect incompatible @@ -255,7 +255,7 @@ public final boolean isValidateExistingTransaction() { /** * Set whether to globally mark an existing transaction as rollback-only * after a participating transaction failed. - *

      Default is "true": If a participating transaction (e.g. with + *

      Default is "true": If a participating transaction (for example, with * PROPAGATION_REQUIRED or PROPAGATION_SUPPORTS encountering an existing * transaction) fails, the transaction will be globally marked as rollback-only. * The only possible outcome of such a transaction is a rollback: The @@ -1080,7 +1080,7 @@ private void cleanupAfterCompletion(DefaultTransactionStatus status) { *

      The returned object will usually be specific to the concrete transaction * manager implementation, carrying corresponding transaction state in a * modifiable fashion. This object will be passed into the other template - * methods (e.g. doBegin and doCommit), either directly or as part of a + * methods (for example, doBegin and doCommit), either directly or as part of a * DefaultTransactionStatus instance. *

      The returned object should contain information about any existing * transaction, that is, a transaction that has already started before the diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/ResourceHolderSupport.java b/spring-tx/src/main/java/org/springframework/transaction/support/ResourceHolderSupport.java index c58256223c09..c0b2bdaf636f 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/ResourceHolderSupport.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/ResourceHolderSupport.java @@ -71,7 +71,7 @@ public void setRollbackOnly() { /** * Reset the rollback-only status for this resource transaction. *

      Only really intended to be called after custom rollback steps which - * keep the original resource in action, e.g. in case of a savepoint. + * keep the original resource in action, for example, in case of a savepoint. * @since 5.0 * @see org.springframework.transaction.SavepointManager#rollbackToSavepoint */ @@ -120,7 +120,7 @@ public Date getDeadline() { /** * Return the time to live for this object in seconds. - * Rounds up eagerly, e.g. 9.00001 still to 10. + * Rounds up eagerly, for example, 9.00001 still to 10. * @return number of seconds until expiration * @throws TransactionTimedOutException if the deadline has already been reached */ diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/ResourceTransactionManager.java b/spring-tx/src/main/java/org/springframework/transaction/support/ResourceTransactionManager.java index f6ee501bba46..09d8472715ec 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/ResourceTransactionManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/ResourceTransactionManager.java @@ -37,7 +37,7 @@ public interface ResourceTransactionManager extends PlatformTransactionManager { /** * Return the resource factory that this transaction manager operates on, - * e.g. a JDBC DataSource or a JMS ConnectionFactory. + * for example, a JDBC DataSource or a JMS ConnectionFactory. *

      This target resource factory is usually used as resource key for * {@link TransactionSynchronizationManager}'s resource bindings per thread. * @return the target resource factory (never {@code null}) diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallback.java b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallback.java index 926cdaf9289c..70b76cf96fc2 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallback.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallback.java @@ -25,7 +25,7 @@ * *

      Typically used to assemble various calls to transaction-unaware data access * services into a higher-level service method with transaction demarcation. As an - * alternative, consider the use of declarative transaction demarcation (e.g. through + * alternative, consider the use of declarative transaction demarcation (for example, through * Spring's {@link org.springframework.transaction.annotation.Transactional} annotation). * * @author Juergen Hoeller @@ -41,7 +41,7 @@ public interface TransactionCallback { * Gets called by {@link TransactionTemplate#execute} within a transactional context. * Does not need to care about transactions itself, although it can retrieve and * influence the status of the current transaction via the given status object, - * e.g. setting rollback-only. + * for example, setting rollback-only. *

      Allows for returning a result object created within the transaction, i.e. a * domain object or a collection of domain objects. A RuntimeException thrown by the * callback is treated as application exception that enforces a rollback. Any such diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallbackWithoutResult.java b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallbackWithoutResult.java index 84eb4d890088..4552e5796142 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallbackWithoutResult.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionCallbackWithoutResult.java @@ -41,7 +41,7 @@ public final Object doInTransaction(TransactionStatus status) { * Gets called by {@code TransactionTemplate.execute} within a transactional * context. Does not need to care about transactions itself, although it can retrieve * and influence the status of the current transaction via the given status object, - * e.g. setting rollback-only. + * for example, setting rollback-only. *

      A RuntimeException thrown by the callback is treated as application * exception that enforces a rollback. An exception gets propagated to the * caller of the template. diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronization.java b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronization.java index 36f1dd761a66..5d47f89db0bb 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronization.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronization.java @@ -118,7 +118,7 @@ default void savepointRollback(Object savepoint) { /** * Invoked before transaction commit (before "beforeCompletion"). - * Can e.g. flush transactional O/R Mapping sessions to the database. + * Can, for example, flush transactional O/R Mapping sessions to the database. *

      This callback does not mean that the transaction will actually be committed. * A rollback decision can still occur after this method has been called. This callback * is rather meant to perform work that's only relevant if a commit still has a chance @@ -150,7 +150,7 @@ default void beforeCompletion() { /** * Invoked after transaction commit. Can perform further operations right * after the main transaction has successfully committed. - *

      Can e.g. commit further operations that are supposed to follow on a successful + *

      Can, for example, commit further operations that are supposed to follow on a successful * commit of the main transaction, like confirmation messages or emails. *

      NOTE: The transaction will have been committed already, but the * transactional resources might still be active and accessible. As a consequence, diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java index f7fb0d40c0d0..0b310c99e136 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java +++ b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java @@ -37,7 +37,7 @@ * to be removed before a new one can be set for the same key. * Supports a list of transaction synchronizations if synchronization is active. * - *

      Resource management code should check for thread-bound resources, e.g. JDBC + *

      Resource management code should check for thread-bound resources, for example, JDBC * Connections or Hibernate Sessions, via {@code getResource}. Such code is * normally not supposed to bind resources to threads, as this is the responsibility * of transaction managers. A further option is to lazily bind on first use if @@ -58,7 +58,7 @@ * doesn't support transaction synchronization. * *

      Synchronization is for example used to always return the same resources - * within a JTA transaction, e.g. a JDBC Connection or a Hibernate Session for + * within a JTA transaction, for example, a JDBC Connection or a Hibernate Session for * any given DataSource or SessionFactory, respectively. * * @author Juergen Hoeller diff --git a/spring-web/src/main/java/org/springframework/http/ContentDisposition.java b/spring-web/src/main/java/org/springframework/http/ContentDisposition.java index 7697538739d3..03d1e84ee844 100644 --- a/spring-web/src/main/java/org/springframework/http/ContentDisposition.java +++ b/spring-web/src/main/java/org/springframework/http/ContentDisposition.java @@ -698,7 +698,7 @@ public interface Builder { * Set the value of the {@literal filename} parameter. The given * filename will be formatted as quoted-string, as defined in RFC 2616, * section 2.2, and any quote characters within the filename value will - * be escaped with a backslash, e.g. {@code "foo\"bar.txt"} becomes + * be escaped with a backslash, for example, {@code "foo\"bar.txt"} becomes * {@code "foo\\\"bar.txt"}. */ Builder filename(@Nullable String filename); diff --git a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java index 0c428ff240e7..cddc62ba5847 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java +++ b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java @@ -1418,7 +1418,7 @@ public String getUpgrade() { } /** - * Set the request header names (e.g. "Accept-Language") for which the + * Set the request header names (for example, "Accept-Language") for which the * response is subject to content negotiation and variances based on the * value of those request headers. * @param requestHeaders the request header names diff --git a/spring-web/src/main/java/org/springframework/http/HttpMethod.java b/spring-web/src/main/java/org/springframework/http/HttpMethod.java index 12f77ffe4bc6..e10185ecb462 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpMethod.java +++ b/spring-web/src/main/java/org/springframework/http/HttpMethod.java @@ -129,7 +129,7 @@ public static HttpMethod valueOf(String method) { /** - * Return the name of this method, e.g. "GET", "POST". + * Return the name of this method, for example, "GET", "POST". */ public String name() { return this.name; diff --git a/spring-web/src/main/java/org/springframework/http/HttpStatusCode.java b/spring-web/src/main/java/org/springframework/http/HttpStatusCode.java index 3275eb8d9661..20a0c243fc6e 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpStatusCode.java +++ b/spring-web/src/main/java/org/springframework/http/HttpStatusCode.java @@ -79,7 +79,7 @@ public sealed interface HttpStatusCode extends Serializable permits DefaultHttpS /** * Whether this {@code HttpStatusCode} shares the same integer {@link #value() value} as the other status code. *

      Useful for comparisons that take deprecated aliases into account or compare arbitrary implementations - * of {@code HttpStatusCode} (e.g. in place of {@link HttpStatus#equals(Object) HttpStatus enum equality}). + * of {@code HttpStatusCode} (for example, in place of {@link HttpStatus#equals(Object) HttpStatus enum equality}). * @param other the other {@code HttpStatusCode} to compare * @return true if the two {@code HttpStatusCode} objects share the same integer {@code value()}, false otherwise * @since 6.0.5 diff --git a/spring-web/src/main/java/org/springframework/http/MediaType.java b/spring-web/src/main/java/org/springframework/http/MediaType.java index 47639ad4747c..f2fa5b61ed18 100644 --- a/spring-web/src/main/java/org/springframework/http/MediaType.java +++ b/spring-web/src/main/java/org/springframework/http/MediaType.java @@ -286,7 +286,7 @@ public class MediaType extends MimeType implements Serializable { * @deprecated as of 5.3 since it originates from the W3C Activity Streams * specification which has a more specific purpose and has been since * replaced with a different mime type. Use {@link #APPLICATION_NDJSON} as - * a replacement or any other line-delimited JSON format (e.g. JSON Lines, + * a replacement or any other line-delimited JSON format (for example, JSON Lines, * JSON Text Sequences). */ @Deprecated diff --git a/spring-web/src/main/java/org/springframework/http/MediaTypeEditor.java b/spring-web/src/main/java/org/springframework/http/MediaTypeEditor.java index 8a6971909fbb..092448b29a60 100644 --- a/spring-web/src/main/java/org/springframework/http/MediaTypeEditor.java +++ b/spring-web/src/main/java/org/springframework/http/MediaTypeEditor.java @@ -23,7 +23,7 @@ /** * {@link java.beans.PropertyEditor Editor} for {@link MediaType} * descriptors, to automatically convert {@code String} specifications - * (e.g. {@code "text/html"}) to {@code MediaType} properties. + * (for example, {@code "text/html"}) to {@code MediaType} properties. * * @author Juergen Hoeller * @since 3.0 diff --git a/spring-web/src/main/java/org/springframework/http/ProblemDetail.java b/spring-web/src/main/java/org/springframework/http/ProblemDetail.java index 4b38fd55ca98..016160acb518 100644 --- a/spring-web/src/main/java/org/springframework/http/ProblemDetail.java +++ b/spring-web/src/main/java/org/springframework/http/ProblemDetail.java @@ -37,7 +37,7 @@ * *

      For an extended response, an application can also create a subclass with * additional properties. Subclasses can use the protected copy constructor to - * re-create an existing {@code ProblemDetail} instance as the subclass, e.g. + * re-create an existing {@code ProblemDetail} instance as the subclass, for example, * from an {@code @ControllerAdvice} such as * {@link org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler} or * {@link org.springframework.web.reactive.result.method.annotation.ResponseEntityExceptionHandler}. diff --git a/spring-web/src/main/java/org/springframework/http/ReactiveHttpOutputMessage.java b/spring-web/src/main/java/org/springframework/http/ReactiveHttpOutputMessage.java index b15f84c89880..f55ae517df9e 100644 --- a/spring-web/src/main/java/org/springframework/http/ReactiveHttpOutputMessage.java +++ b/spring-web/src/main/java/org/springframework/http/ReactiveHttpOutputMessage.java @@ -46,7 +46,7 @@ public interface ReactiveHttpOutputMessage extends HttpMessage { /** * Register an action to apply just before the HttpOutputMessage is committed. *

      Note: the supplied action must be properly deferred, - * e.g. via {@link Mono#defer} or {@link Mono#fromRunnable}, to ensure it's + * for example, via {@link Mono#defer} or {@link Mono#fromRunnable}, to ensure it's * executed in the right order, relative to other actions. * @param action the action to apply */ diff --git a/spring-web/src/main/java/org/springframework/http/ResponseCookie.java b/spring-web/src/main/java/org/springframework/http/ResponseCookie.java index b65df60254c6..67d8dbea3908 100644 --- a/spring-web/src/main/java/org/springframework/http/ResponseCookie.java +++ b/spring-web/src/main/java/org/springframework/http/ResponseCookie.java @@ -229,7 +229,7 @@ public static ResponseCookieBuilder from(final String name, final String value) /** * Factory method to obtain a builder for a server-defined cookie. Unlike * {@link #from(String, String)} this option assumes input from a remote - * server, which can be handled more leniently, e.g. ignoring an empty domain + * server, which can be handled more leniently, for example, ignoring an empty domain * name with double quotes. * @param name the cookie name * @param value the cookie value diff --git a/spring-web/src/main/java/org/springframework/http/ResponseEntity.java b/spring-web/src/main/java/org/springframework/http/ResponseEntity.java index 2a55dfcbb7a4..a6e16405e88d 100644 --- a/spring-web/src/main/java/org/springframework/http/ResponseEntity.java +++ b/spring-web/src/main/java/org/springframework/http/ResponseEntity.java @@ -458,7 +458,7 @@ public interface HeadersBuilder> { B cacheControl(CacheControl cacheControl); /** - * Configure one or more request header names (e.g. "Accept-Language") to + * Configure one or more request header names (for example, "Accept-Language") to * add to the "Vary" response header to inform clients that the response is * subject to content negotiation and variances based on the value of the * given request headers. The configured request header names are added only diff --git a/spring-web/src/main/java/org/springframework/http/client/MultipartBodyBuilder.java b/spring-web/src/main/java/org/springframework/http/client/MultipartBodyBuilder.java index d9372552c321..46640fed4144 100644 --- a/spring-web/src/main/java/org/springframework/http/client/MultipartBodyBuilder.java +++ b/spring-web/src/main/java/org/springframework/http/client/MultipartBodyBuilder.java @@ -63,7 +63,7 @@ * Resource image = new ClassPathResource("image.jpg"); * builder.part("image", image).header("foo", "bar"); * - * // Add content (e.g. JSON) + * // Add content (for example, JSON) * Account account = ... * builder.part("account", account).header("foo", "bar"); * @@ -104,7 +104,7 @@ public MultipartBodyBuilder() { *

        *
      • String -- form field *
      • {@link org.springframework.core.io.Resource Resource} -- file part - *
      • Object -- content to be encoded (e.g. to JSON) + *
      • Object -- content to be encoded (for example, to JSON). *
      • {@link HttpEntity} -- part content and headers although generally it's * easier to add headers through the returned builder *
      • {@link Part} -- a part from a server request diff --git a/spring-web/src/main/java/org/springframework/http/codec/CodecConfigurer.java b/spring-web/src/main/java/org/springframework/http/codec/CodecConfigurer.java index a5906a49b697..a309838cc880 100644 --- a/spring-web/src/main/java/org/springframework/http/codec/CodecConfigurer.java +++ b/spring-web/src/main/java/org/springframework/http/codec/CodecConfigurer.java @@ -39,9 +39,9 @@ *

        HTTP message readers and writers are divided into 3 categories that are * ordered as follows: *

          - *
        1. Typed readers and writers that support specific types, e.g. byte[], String. - *
        2. Object readers and writers, e.g. JSON, XML. - *
        3. Catch-all readers or writers, e.g. String with any media type. + *
        4. Typed readers and writers that support specific types, for example, byte[], String. + *
        5. Object readers and writers, for example, JSON, XML. + *
        6. Catch-all readers or writers, for example, String with any media type. *
        * *

        Typed and object readers are further subdivided and ordered as follows: @@ -241,7 +241,7 @@ interface DefaultCodecs { * decoding to a single {@code DataBuffer}, * {@link java.nio.ByteBuffer ByteBuffer}, {@code byte[]}, * {@link org.springframework.core.io.Resource Resource}, {@code String}, etc. - * It can also occur when splitting the input stream, e.g. delimited text, + * It can also occur when splitting the input stream, for example, delimited text, * in which case the limit applies to data buffered between delimiters. *

        By default this is not set, in which case individual codec defaults * apply. All codecs are limited to 256K by default. diff --git a/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationBinaryDecoder.java b/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationBinaryDecoder.java index 6d703f96bf7c..b0c05318d00c 100644 --- a/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationBinaryDecoder.java +++ b/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationBinaryDecoder.java @@ -60,7 +60,7 @@ public KotlinSerializationBinaryDecoder(T format, MimeType... supportedMimeTypes * decoding to a single {@code DataBuffer}, * {@link java.nio.ByteBuffer ByteBuffer}, {@code byte[]}, * {@link org.springframework.core.io.Resource Resource}, {@code String}, etc. - * It can also occur when splitting the input stream, e.g. delimited text, + * It can also occur when splitting the input stream, for example, delimited text, * in which case the limit applies to data buffered between delimiters. *

        By default this is set to 256K. * @param byteCount the max number of bytes to buffer, or -1 for unlimited diff --git a/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationStringDecoder.java b/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationStringDecoder.java index 4b71dadf7a56..79f42b43fb4e 100644 --- a/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationStringDecoder.java +++ b/spring-web/src/main/java/org/springframework/http/codec/KotlinSerializationStringDecoder.java @@ -61,7 +61,7 @@ public KotlinSerializationStringDecoder(T format, MimeType... supportedMimeTypes * decoding to a single {@code DataBuffer}, * {@link java.nio.ByteBuffer ByteBuffer}, {@code byte[]}, * {@link org.springframework.core.io.Resource Resource}, {@code String}, etc. - * It can also occur when splitting the input stream, e.g. delimited text, + * It can also occur when splitting the input stream, for example, delimited text, * in which case the limit applies to data buffered between delimiters. *

        By default this is set to 256K. * @param byteCount the max number of bytes to buffer, or -1 for unlimited diff --git a/spring-web/src/main/java/org/springframework/http/codec/multipart/Part.java b/spring-web/src/main/java/org/springframework/http/codec/multipart/Part.java index 89e6db530358..3b36dd974976 100644 --- a/spring-web/src/main/java/org/springframework/http/codec/multipart/Part.java +++ b/spring-web/src/main/java/org/springframework/http/codec/multipart/Part.java @@ -29,7 +29,7 @@ * part is either a {@link FormFieldPart} or a {@link FilePart}. * *

        Multipart requests may also be used outside a browser for data of any - * content type (e.g. JSON, PDF, etc). + * content type (for example, JSON, PDF, etc). * * @author Sebastien Deleuze * @author Rossen Stoyanchev diff --git a/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java index 2b5cba9879e7..34062542faa4 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java +++ b/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java @@ -48,7 +48,7 @@ /** * Implementation of {@link HttpMessageConverter} to read and write 'normal' HTML - * forms and also to write (but not read) multipart data (e.g. file uploads). + * forms and also to write (but not read) multipart data (for example, file uploads). * *

        In other words, this converter can read and write the * {@code "application/x-www-form-urlencoded"} media type as diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJsonHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJsonHttpMessageConverter.java index 4584b42913e7..1f73d60f92c6 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJsonHttpMessageConverter.java +++ b/spring-web/src/main/java/org/springframework/http/converter/json/AbstractJsonHttpMessageConverter.java @@ -36,7 +36,7 @@ import org.springframework.lang.Nullable; /** - * Common base class for plain JSON converters, e.g. Gson and JSON-B. + * Common base class for plain JSON converters, for example, Gson and JSON-B. * *

        Note that the Jackson converters have a dedicated class hierarchy * due to their multi-format support. diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java index e872d7daf4ca..d3306f2eb463 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java +++ b/spring-web/src/main/java/org/springframework/http/converter/json/GsonHttpMessageConverter.java @@ -96,7 +96,7 @@ protected Object readInternal(Type resolvedType, Reader reader) throws Exception protected void writeInternal(Object object, @Nullable Type type, Writer writer) throws Exception { // In Gson, toJson with a type argument will exclusively use that given type, // ignoring the actual type of the object... which might be more specific, - // e.g. a subclass of the specified type which includes additional fields. + // for example, a subclass of the specified type which includes additional fields. // As a consequence, we're only passing in parameterized type declarations // which might contain extra generics that the object instance doesn't retain. if (type instanceof ParameterizedType) { diff --git a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java index 50370530b75e..f075ff49ea56 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java +++ b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java @@ -267,7 +267,7 @@ public Jackson2ObjectMapperBuilder annotationIntrospector(AnnotationIntrospector /** * Alternative to {@link #annotationIntrospector(AnnotationIntrospector)} * that allows combining with rather than replacing the currently set - * introspector, e.g. via + * introspector, for example, via * {@link AnnotationIntrospectorPair#pair(AnnotationIntrospector, AnnotationIntrospector)}. * @param pairingFunction a function to apply to the currently set * introspector (possibly {@code null}); the result of the function becomes diff --git a/spring-web/src/main/java/org/springframework/http/server/ServletServerHttpResponse.java b/spring-web/src/main/java/org/springframework/http/server/ServletServerHttpResponse.java index 1ba11b10f767..f6d3ef6cbdf5 100644 --- a/spring-web/src/main/java/org/springframework/http/server/ServletServerHttpResponse.java +++ b/spring-web/src/main/java/org/springframework/http/server/ServletServerHttpResponse.java @@ -142,7 +142,7 @@ private void writeHeaders() { * *

        The intent is merely to expose what is available through the HttpServletResponse * i.e. the ability to look up specific header values by name. All other - * map-related operations (e.g. iteration, removal, etc) apply only to values + * map-related operations (for example, iteration, removal, etc) apply only to values * added directly through HttpHeaders methods. * * @since 4.0.3 diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ContextPathCompositeHandler.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ContextPathCompositeHandler.java index 42d63aea5258..97302037ebd7 100644 --- a/spring-web/src/main/java/org/springframework/http/server/reactive/ContextPathCompositeHandler.java +++ b/spring-web/src/main/java/org/springframework/http/server/reactive/ContextPathCompositeHandler.java @@ -63,7 +63,7 @@ private static void assertValidContextPath(String contextPath) { @Override public Mono handle(ServerHttpRequest request, ServerHttpResponse response) { - // Remove underlying context path first (e.g. Servlet container) + // Remove underlying context path first (for example, Servlet container) String path = request.getPath().pathWithinApplication().value(); return this.handlerMap.entrySet().stream() .filter(entry -> path.startsWith(entry.getKey())) diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java index 205b77b4867f..093076710b19 100644 --- a/spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java +++ b/spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java @@ -148,7 +148,7 @@ private String getServletPath(ServletConfig config) { throw new IllegalArgumentException("Expected a single Servlet mapping: " + "either the default Servlet mapping (i.e. '/'), " + - "or a path based mapping (e.g. '/*', '/foo/*'). " + + "or a path based mapping (for example, '/*', '/foo/*'). " + "Actual mappings: " + mappings + " for Servlet '" + name + "'"); } @@ -237,7 +237,7 @@ private static void runIfAsyncNotComplete(AsyncContext asyncContext, AtomicBoole } catch (IllegalStateException ex) { // Ignore: AsyncContext recycled and should not be used - // e.g. TIMEOUT_LISTENER (above) may have completed the AsyncContext + // for example, TIMEOUT_LISTENER (above) may have completed the AsyncContext } } diff --git a/spring-web/src/main/java/org/springframework/web/ErrorResponse.java b/spring-web/src/main/java/org/springframework/web/ErrorResponse.java index c3d1f8fed48b..f6bbebeaf6ea 100644 --- a/spring-web/src/main/java/org/springframework/web/ErrorResponse.java +++ b/spring-web/src/main/java/org/springframework/web/ErrorResponse.java @@ -35,7 +35,7 @@ * interface and a convenient base class for other exceptions to use. * *

        {@code ErrorResponse} is supported as a return value from - * {@code @ExceptionHandler} methods that render directly to the response, e.g. + * {@code @ExceptionHandler} methods that render directly to the response, for example, * by being marked {@code @ResponseBody}, or declared in an * {@code @RestController} or {@code RestControllerAdvice} class. * @@ -62,7 +62,7 @@ default HttpHeaders getHeaders() { * {@link ProblemDetail} whose {@link ProblemDetail#getStatus() status} * should match the response status. *

        Note: The returned {@code ProblemDetail} may be - * updated before the response is rendered, e.g. via + * updated before the response is rendered, for example, via * {@link #updateAndGetBody(MessageSource, Locale)}. Therefore, implementing * methods should use an instance field, and should not re-create the * {@code ProblemDetail} on every call, nor use a static variable. @@ -107,7 +107,7 @@ default String getDetailMessageCode() { * Return arguments to use along with a {@link #getDetailMessageCode() * message code} to resolve the problem "detail" for this exception * through a {@link MessageSource}. The arguments are expanded - * into placeholders of the message value, e.g. "Invalid content type {0}". + * into placeholders of the message value, for example, "Invalid content type {0}". */ @Nullable default Object[] getDetailMessageArguments() { @@ -180,7 +180,7 @@ static String getDefaultTitleMessageCode(Class exceptionType) { /** * Build a message code for the "detail" field, for the given exception type. * @param exceptionType the exception type associated with the problem - * @param suffix an optional suffix, e.g. for exceptions that may have multiple + * @param suffix an optional suffix, for example, for exceptions that may have multiple * error message with different arguments * @return {@code "problemDetail."} followed by the fully qualified * {@link Class#getName() class name} and an optional suffix diff --git a/spring-web/src/main/java/org/springframework/web/WebApplicationInitializer.java b/spring-web/src/main/java/org/springframework/web/WebApplicationInitializer.java index 6ee0811cb8ed..d4ad31fc4fb5 100644 --- a/spring-web/src/main/java/org/springframework/web/WebApplicationInitializer.java +++ b/spring-web/src/main/java/org/springframework/web/WebApplicationInitializer.java @@ -87,7 +87,7 @@ *

        Most major Spring Web components have been updated to support this style of * registration. You'll find that {@code DispatcherServlet}, {@code FrameworkServlet}, * {@code ContextLoaderListener} and {@code DelegatingFilterProxy} all now support - * constructor arguments. Even if a component (e.g. non-Spring, other third party) has not + * constructor arguments. Even if a component (for example, non-Spring, other third party) has not * been specifically updated for use within {@code WebApplicationInitializers}, they still * may be used in any case. The {@code ServletContext} API allows for setting init-params, * context-params, etc programmatically. diff --git a/spring-web/src/main/java/org/springframework/web/accept/AbstractMappingContentNegotiationStrategy.java b/spring-web/src/main/java/org/springframework/web/accept/AbstractMappingContentNegotiationStrategy.java index 66aef505e6df..89f01c57b1b3 100644 --- a/spring-web/src/main/java/org/springframework/web/accept/AbstractMappingContentNegotiationStrategy.java +++ b/spring-web/src/main/java/org/springframework/web/accept/AbstractMappingContentNegotiationStrategy.java @@ -35,13 +35,13 @@ * Base class for {@code ContentNegotiationStrategy} implementations with the * steps to resolve a request to media types. * - *

        First a key (e.g. "json", "pdf") must be extracted from the request (e.g. + *

        First a key (for example, "json", "pdf") must be extracted from the request (for example, * file extension, query param). The key must then be resolved to media type(s) * through the base class {@link MappingMediaTypeFileExtensionResolver} which * stores such mappings. * *

        The method {@link #handleNoMatch} allow subclasses to plug in additional - * ways of looking up media types (e.g. through the Java Activation framework, + * ways of looking up media types (for example, through the Java Activation framework, * or {@link jakarta.servlet.ServletContext#getMimeType}). Media types resolved * via base classes are then added to the base class * {@link MappingMediaTypeFileExtensionResolver}, i.e. cached for new lookups. @@ -69,7 +69,7 @@ public AbstractMappingContentNegotiationStrategy(@Nullable MapBy default this is set to {@code false}. */ public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) { diff --git a/spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java b/spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java index a9fcb4d8dc90..4eb9e6ef1de4 100644 --- a/spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java +++ b/spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java @@ -188,7 +188,7 @@ public void setFavorPathExtension(boolean favorPathExtension) { *

        Note: Mappings registered here may be accessed via * {@link ContentNegotiationManager#getMediaTypeMappings()} and may be used * not only in the parameter and path extension strategies. For example, - * with the Spring MVC config, e.g. {@code @EnableWebMvc} or + * with the Spring MVC config, for example, {@code @EnableWebMvc} or * {@code }, the media type mappings are also plugged * in to: *

          @@ -254,7 +254,7 @@ public void setUseJaf(boolean useJaf) { * When {@link #setFavorPathExtension favorPathExtension} or * {@link #setFavorParameter(boolean)} is set, this property determines * whether to use only registered {@code MediaType} mappings or to allow - * dynamic resolution, e.g. via {@link MediaTypeFactory}. + * dynamic resolution, for example, via {@link MediaTypeFactory}. *

          By default this is not set in which case dynamic resolution is on. */ public void setUseRegisteredExtensionsOnly(boolean useRegisteredExtensionsOnly) { diff --git a/spring-web/src/main/java/org/springframework/web/bind/MissingRequestValueException.java b/spring-web/src/main/java/org/springframework/web/bind/MissingRequestValueException.java index 8770b3d64494..bc606373b8f0 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/MissingRequestValueException.java +++ b/spring-web/src/main/java/org/springframework/web/bind/MissingRequestValueException.java @@ -64,7 +64,7 @@ protected MissingRequestValueException(String msg, boolean missingAfterConversio /** - * Whether the request value was present but converted to {@code null}, e.g. via + * Whether the request value was present but converted to {@code null}, for example, via * {@code org.springframework.core.convert.support.IdToEntityConverter}. */ public boolean isMissingAfterConversion() { diff --git a/spring-web/src/main/java/org/springframework/web/bind/ServletRequestParameterPropertyValues.java b/spring-web/src/main/java/org/springframework/web/bind/ServletRequestParameterPropertyValues.java index f127baee8492..e07bc6c73dbb 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/ServletRequestParameterPropertyValues.java +++ b/spring-web/src/main/java/org/springframework/web/bind/ServletRequestParameterPropertyValues.java @@ -71,7 +71,7 @@ public ServletRequestParameterPropertyValues(ServletRequest request, @Nullable S * @param request the HTTP request * @param prefix the prefix for parameters (the full prefix will * consist of this plus the separator) - * @param prefixSeparator separator delimiting prefix (e.g. "spring") + * @param prefixSeparator separator delimiting prefix (for example, "spring") * and the rest of the parameter name ("param1", "param2") */ public ServletRequestParameterPropertyValues( diff --git a/spring-web/src/main/java/org/springframework/web/bind/WebDataBinder.java b/spring-web/src/main/java/org/springframework/web/bind/WebDataBinder.java index ada9ca0d794d..cb907effab7c 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/WebDataBinder.java +++ b/spring-web/src/main/java/org/springframework/web/bind/WebDataBinder.java @@ -66,7 +66,7 @@ public class WebDataBinder extends DataBinder { /** * Default prefix that field marker parameters start with, followed by the field - * name: e.g. "_subscribeToNewsletter" for a field "subscribeToNewsletter". + * name: for example, "_subscribeToNewsletter" for a field "subscribeToNewsletter". *

          Such a marker parameter indicates that the field was visible, that is, * existed in the form that caused the submission. If no corresponding field * value parameter was found, the field will be reset. The value of the field @@ -78,7 +78,7 @@ public class WebDataBinder extends DataBinder { /** * Default prefix that field default parameters start with, followed by the field - * name: e.g. "!subscribeToNewsletter" for a field "subscribeToNewsletter". + * name: for example, "!subscribeToNewsletter" for a field "subscribeToNewsletter". *

          Default parameters differ from field markers in that they provide a default * value instead of an empty value. * @see #setFieldDefaultPrefix @@ -120,7 +120,7 @@ public WebDataBinder(@Nullable Object target, String objectName) { * empty fields, having "prefix + field" as name. Such a marker parameter is * checked by existence: You can send any value for it, for example "visible". * This is particularly useful for HTML checkboxes and select options. - *

          Default is "_", for "_FIELD" parameters (e.g. "_subscribeToNewsletter"). + *

          Default is "_", for "_FIELD" parameters (for example, "_subscribeToNewsletter"). * Set this to null if you want to turn off the empty field check completely. *

          HTML checkboxes only send a value when they're checked, so it is not * possible to detect that a formerly checked box has just been unchecked, @@ -152,7 +152,7 @@ public String getFieldMarkerPrefix() { * Specify a prefix that can be used for parameters that indicate default * value fields, having "prefix + field" as name. The value of the default * field is used when the field is not provided. - *

          Default is "!", for "!FIELD" parameters (e.g. "!subscribeToNewsletter"). + *

          Default is "!", for "!FIELD" parameters (for example, "!subscribeToNewsletter"). * Set this to null if you want to turn off the field defaults completely. *

          HTML checkboxes only send a value when they're checked, so it is not * possible to detect that a formerly checked box has just been unchecked, diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/CrossOrigin.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/CrossOrigin.java index 7ee9ce421bc2..33e4afe2384d 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/CrossOrigin.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/CrossOrigin.java @@ -38,7 +38,7 @@ * {@link CorsConfiguration#applyPermitDefaultValues()}. * *

          The rules for combining global and local configuration are generally - * additive -- e.g. all global and all local origins. For those attributes + * additive -- for example, all global and all local origins. For those attributes * where only a single value can be accepted such as {@code allowCredentials} * and {@code maxAge}, the local overrides the global value. * See {@link CorsConfiguration#combine(CorsConfiguration)} for more details. diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java index 12f0c70b8a3e..8fcd4f337a90 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/ExceptionHandler.java @@ -40,7 +40,7 @@ * cause within a wrapper exception. As of 5.3, any cause level is being * exposed, whereas previously only an immediate cause was considered. *

        • Request and/or response objects (typically from the Servlet API). - * You may choose any specific request/response type, e.g. + * You may choose any specific request/response type, for example, * {@link jakarta.servlet.ServletRequest} / {@link jakarta.servlet.http.HttpServletRequest}. *
        • Session object: typically {@link jakarta.servlet.http.HttpSession}. * An argument of this type will enforce the presence of a corresponding session. diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java index 12ae0c02e005..6f830c1eb131 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/MatrixVariable.java @@ -63,7 +63,7 @@ /** * The name of the URI path variable where the matrix variable is located, - * if necessary for disambiguation (e.g. a matrix variable with the same + * if necessary for disambiguation (for example, a matrix variable with the same * name present in more than one path segment). */ String pathVar() default ValueConstants.DEFAULT_NONE; diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/ModelAttribute.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/ModelAttribute.java index fa3893153850..4019c20dcceb 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/ModelAttribute.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/ModelAttribute.java @@ -82,7 +82,7 @@ *

          The default model attribute name is inferred from the declared * attribute type (i.e. the method parameter type or method return type), * based on the non-qualified class name: - * e.g. "orderAddress" for class "mypackage.OrderAddress", + * for example, "orderAddress" for class "mypackage.OrderAddress", * or "orderAddressList" for "List<mypackage.OrderAddress>". * @since 4.3 */ diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/PathVariable.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/PathVariable.java index cee9fe2485c2..1856378ce911 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/PathVariable.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/PathVariable.java @@ -60,7 +60,7 @@ *

          Defaults to {@code true}, leading to an exception being thrown if the path * variable is missing in the incoming request. Switch this to {@code false} if * you prefer a {@code null} or Java 8 {@code java.util.Optional} in this case. - * e.g. on a {@code ModelAttribute} method which serves for different requests. + * for example, on a {@code ModelAttribute} method which serves for different requests. * @since 4.3.3 */ boolean required() default true; diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java index 0bff16d474fb..d01491b34697 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java @@ -61,7 +61,7 @@ * mapping will be used. This also applies to composed {@code @RequestMapping} * annotations such as {@code @GetMapping}, {@code @PostMapping}, etc. * - *

          NOTE: When using controller interfaces (e.g. for AOP proxying), + *

          NOTE: When using controller interfaces (for example, for AOP proxying), * make sure to consistently put all your mapping annotations — such * as {@code @RequestMapping} and {@code @SessionAttributes} — on * the controller interface rather than on the implementation class. @@ -105,10 +105,10 @@ /** * The path mapping URIs — for example, {@code "/profile"}. - *

          Ant-style path patterns are also supported (e.g. {@code "/profile/**"}). - * At the method level, relative paths (e.g. {@code "edit"}) are supported + *

          Ant-style path patterns are also supported (for example, {@code "/profile/**"}). + * At the method level, relative paths (for example, {@code "edit"}) are supported * within the primary mapping expressed at the type level. - * Path mapping URIs may contain placeholders (e.g. "/${profile_path}"). + * Path mapping URIs may contain placeholders (for example, "/${profile_path}"). *

          Supported at the type level as well as at the method level! * When used at the type level, all method-level mappings inherit * this primary mapping, narrowing it for a specific handler method. @@ -202,7 +202,7 @@ * produces = MediaType.TEXT_PLAIN_VALUE * produces = "text/plain;charset=UTF-8" *

      - *

      If a declared media type contains a parameter (e.g. "charset=UTF-8", + *

      If a declared media type contains a parameter (for example, "charset=UTF-8", * "type=feed", "type=entry") and if a compatible media type from the request * has that parameter too, then the parameter values must match. Otherwise, * if the media type from the request does not contain the parameter, it is diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestPart.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestPart.java index e7c576b73c20..518354623a18 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestPart.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/RequestPart.java @@ -50,7 +50,7 @@ * taking into consideration the 'Content-Type' header of the request part. * {@link RequestParam} is likely to be used with name-value form fields while * {@link RequestPart} is likely to be used with parts containing more complex content - * e.g. JSON, XML). + * for example, JSON, XML). * * @author Rossen Stoyanchev * @author Arjen Poutsma diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttribute.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttribute.java index 7d6775308ee8..f2132a7b7cce 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttribute.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttribute.java @@ -28,7 +28,7 @@ * Annotation to bind a method parameter to a session attribute. * *

      The main motivation is to provide convenient access to existing, permanent - * session attributes (e.g. user authentication object) with an optional/required + * session attributes (for example, user authentication object) with an optional/required * check and a cast to the target method parameter type. * *

      For use cases that require adding or removing session attributes consider diff --git a/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttributes.java b/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttributes.java index 218af83d3c2c..6a422e37c295 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttributes.java +++ b/spring-web/src/main/java/org/springframework/web/bind/annotation/SessionAttributes.java @@ -41,12 +41,12 @@ * to be stored in the session temporarily during the course of a * specific handler's conversation. * - *

      For permanent session attributes, e.g. a user authentication object, + *

      For permanent session attributes, for example, a user authentication object, * use the traditional {@code session.setAttribute} method instead. * Alternatively, consider using the attribute management capabilities of the * generic {@link org.springframework.web.context.request.WebRequest} interface. * - *

      NOTE: When using controller interfaces (e.g. for AOP proxying), + *

      NOTE: When using controller interfaces (for example, for AOP proxying), * make sure to consistently put all your mapping annotations — * such as {@code @RequestMapping} and {@code @SessionAttributes} — on * the controller interface rather than on the implementation class. diff --git a/spring-web/src/main/java/org/springframework/web/bind/support/DefaultDataBinderFactory.java b/spring-web/src/main/java/org/springframework/web/bind/support/DefaultDataBinderFactory.java index 1ca05fd91050..35bbfd51de2b 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/support/DefaultDataBinderFactory.java +++ b/spring-web/src/main/java/org/springframework/web/bind/support/DefaultDataBinderFactory.java @@ -129,7 +129,7 @@ protected WebDataBinder createBinderInstance( /** * Extension point to further initialize the created data binder instance - * (e.g. with {@code @InitBinder} methods) after "global" initialization + * (for example, with {@code @InitBinder} methods) after "global" initialization * via {@link WebBindingInitializer}. * @param dataBinder the data binder instance to customize * @param webRequest the current request diff --git a/spring-web/src/main/java/org/springframework/web/bind/support/SessionStatus.java b/spring-web/src/main/java/org/springframework/web/bind/support/SessionStatus.java index 395be0e5535e..3497e5d3c5fb 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/support/SessionStatus.java +++ b/spring-web/src/main/java/org/springframework/web/bind/support/SessionStatus.java @@ -19,7 +19,7 @@ /** * Simple interface that can be injected into handler methods, allowing them to * signal that their session processing is complete. The handler invoker may - * then follow up with appropriate cleanup, e.g. of session attributes which + * then follow up with appropriate cleanup, for example, of session attributes which * have been implicitly created during this handler's processing (according to * the * {@link org.springframework.web.bind.annotation.SessionAttributes @SessionAttributes} diff --git a/spring-web/src/main/java/org/springframework/web/bind/support/SpringWebConstraintValidatorFactory.java b/spring-web/src/main/java/org/springframework/web/bind/support/SpringWebConstraintValidatorFactory.java index dcbc1a4c7a86..149f92f29161 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/support/SpringWebConstraintValidatorFactory.java +++ b/spring-web/src/main/java/org/springframework/web/bind/support/SpringWebConstraintValidatorFactory.java @@ -30,7 +30,7 @@ *

      In contrast to * {@link org.springframework.validation.beanvalidation.SpringConstraintValidatorFactory}, * this variant is meant for declarative use in a standard {@code validation.xml} file, - * e.g. in combination with JAX-RS or JAX-WS. + * for example, in combination with JAX-RS or JAX-WS. * * @author Juergen Hoeller * @since 4.2.1 diff --git a/spring-web/src/main/java/org/springframework/web/bind/support/WebRequestDataBinder.java b/spring-web/src/main/java/org/springframework/web/bind/support/WebRequestDataBinder.java index 1982222cadb1..2d7d31264f61 100644 --- a/spring-web/src/main/java/org/springframework/web/bind/support/WebRequestDataBinder.java +++ b/spring-web/src/main/java/org/springframework/web/bind/support/WebRequestDataBinder.java @@ -55,7 +55,7 @@ * *

      Can also used for manual data binding in custom web controllers or interceptors * that build on Spring's {@link org.springframework.web.context.request.WebRequest} - * abstraction: e.g. in a {@link org.springframework.web.context.request.WebRequestInterceptor} + * abstraction: for example, in a {@link org.springframework.web.context.request.WebRequestInterceptor} * implementation. Simply instantiate a WebRequestDataBinder for each binding * process, and invoke {@code bind} with the current WebRequest as argument: * diff --git a/spring-web/src/main/java/org/springframework/web/client/RestClient.java b/spring-web/src/main/java/org/springframework/web/client/RestClient.java index c80ac5ae5a03..c0e7ec0b507c 100644 --- a/spring-web/src/main/java/org/springframework/web/client/RestClient.java +++ b/spring-web/src/main/java/org/springframework/web/client/RestClient.java @@ -384,7 +384,7 @@ Builder defaultStatusHandler(Predicate statusPredicate, /** * Configure the {@link ClientHttpRequestFactory} to use. This is useful * for plugging in and/or customizing options of the underlying HTTP - * client library (e.g. SSL). + * client library (for example, SSL). *

      If no request factory is specified, {@code RestClient} uses * {@linkplain org.springframework.http.client.HttpComponentsClientHttpRequestFactory Apache Http Client}, * {@linkplain org.springframework.http.client.JettyClientHttpRequestFactory Jetty Http Client} @@ -464,21 +464,21 @@ interface UriSpec> { * Specify the URI using a fully constructed {@link URI}. *

      If the given URI is absolute, it is used as given. If it is * a relative URI, the {@link UriBuilderFactory} configured for - * the client (e.g. with a base URI) will be used to + * the client (for example, with a base URI) will be used to * {@linkplain URI#resolve(URI) resolve} the given URI against. */ S uri(URI uri); /** * Specify the URI for the request using a URI template and URI variables. - *

      If a {@link UriBuilderFactory} was configured for the client (e.g. + *

      If a {@link UriBuilderFactory} was configured for the client (for example, * with a base URI) it will be used to expand the URI template. */ S uri(String uri, Object... uriVariables); /** * Specify the URI for the request using a URI template and URI variables. - *

      If a {@link UriBuilderFactory} was configured for the client (e.g. + *

      If a {@link UriBuilderFactory} was configured for the client (for example, * with a base URI) it will be used to expand the URI template. */ S uri(String uri, Map uriVariables); diff --git a/spring-web/src/main/java/org/springframework/web/client/RestOperations.java b/spring-web/src/main/java/org/springframework/web/client/RestOperations.java index 440fad582a5e..5429c251963b 100644 --- a/spring-web/src/main/java/org/springframework/web/client/RestOperations.java +++ b/spring-web/src/main/java/org/springframework/web/client/RestOperations.java @@ -374,7 +374,7 @@ ResponseEntity postForEntity(URI url, @Nullable Object request, Class *

      The {@code request} parameter can be a {@link HttpEntity} in order to * add additional HTTP headers to the request. *

      NOTE: The standard JDK HTTP library does not support HTTP PATCH. - * You need to use e.g. the Apache HttpComponents request factory. + * You need to use, for example, the Apache HttpComponents request factory. * @param url the URL * @param request the object to be PATCHed (may be {@code null}) * @param responseType the type of the return value @@ -396,7 +396,7 @@ T patchForObject(String url, @Nullable Object request, Class responseType *

      The {@code request} parameter can be a {@link HttpEntity} in order to * add additional HTTP headers to the request. *

      NOTE: The standard JDK HTTP library does not support HTTP PATCH. - * You need to use e.g. the Apache HttpComponents request factory. + * You need to use, for example, the Apache HttpComponents request factory. * @param url the URL * @param request the object to be PATCHed (may be {@code null}) * @param responseType the type of the return value @@ -417,7 +417,7 @@ T patchForObject(String url, @Nullable Object request, Class responseType *

      The {@code request} parameter can be a {@link HttpEntity} in order to * add additional HTTP headers to the request. *

      NOTE: The standard JDK HTTP library does not support HTTP PATCH. - * You need to use e.g. the Apache HttpComponents request factory. + * You need to use, for example, the Apache HttpComponents request factory. * @param url the URL * @param request the object to be PATCHed (may be {@code null}) * @param responseType the type of the return value diff --git a/spring-web/src/main/java/org/springframework/web/context/ContextLoader.java b/spring-web/src/main/java/org/springframework/web/context/ContextLoader.java index 1f5c6f42de7c..d2f5fd841f00 100644 --- a/spring-web/src/main/java/org/springframework/web/context/ContextLoader.java +++ b/spring-web/src/main/java/org/springframework/web/context/ContextLoader.java @@ -54,9 +54,9 @@ * *

      Processes a {@link #CONFIG_LOCATION_PARAM "contextConfigLocation"} context-param * and passes its value to the context instance, parsing it into potentially multiple - * file paths which can be separated by any number of commas and spaces, e.g. + * file paths which can be separated by any number of commas and spaces, for example, * "WEB-INF/applicationContext1.xml, WEB-INF/applicationContext2.xml". - * Ant-style path patterns are supported as well, e.g. + * Ant-style path patterns are supported as well, for example, * "WEB-INF/*Context.xml,WEB-INF/spring*.xml" or "WEB-INF/**/*Context.xml". * If not explicitly specified, the context implementation is supposed to use a * default location (with XmlWebApplicationContext: "/WEB-INF/applicationContext.xml"). diff --git a/spring-web/src/main/java/org/springframework/web/context/request/AsyncWebRequestInterceptor.java b/spring-web/src/main/java/org/springframework/web/context/request/AsyncWebRequestInterceptor.java index 7582388b12b0..2ac418a7f5a8 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/AsyncWebRequestInterceptor.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/AsyncWebRequestInterceptor.java @@ -22,7 +22,7 @@ * *

      When a handler starts asynchronous request handling, the DispatcherServlet * exits without invoking {@code postHandle} and {@code afterCompletion}, as it - * normally does, since the results of request handling (e.g. ModelAndView) are + * normally does, since the results of request handling (for example, ModelAndView) are * not available in the current thread and handling is not yet complete. * In such scenarios, the {@link #afterConcurrentHandlingStarted(WebRequest)} * method is invoked instead allowing implementations to perform tasks such as diff --git a/spring-web/src/main/java/org/springframework/web/context/request/RequestContextListener.java b/spring-web/src/main/java/org/springframework/web/context/request/RequestContextListener.java index ecca2b235f6a..2ecee077b313 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/RequestContextListener.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/RequestContextListener.java @@ -30,9 +30,9 @@ *

      Alternatively, Spring's {@link org.springframework.web.filter.RequestContextFilter} * and Spring's {@link org.springframework.web.servlet.DispatcherServlet} also expose * the same request context to the current thread. In contrast to this listener, - * advanced options are available there (e.g. "threadContextInheritable"). + * advanced options are available there (for example, "threadContextInheritable"). * - *

      This listener is mainly for use with third-party servlets, e.g. the JSF FacesServlet. + *

      This listener is mainly for use with third-party servlets, for example, the JSF FacesServlet. * Within Spring's own web support, DispatcherServlet's processing is perfectly sufficient. * * @author Juergen Hoeller diff --git a/spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResultProcessingInterceptor.java b/spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResultProcessingInterceptor.java index e37c377fdabf..8c79c180da29 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResultProcessingInterceptor.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResultProcessingInterceptor.java @@ -22,7 +22,7 @@ /** * Intercepts concurrent request handling, where the concurrent result is * obtained by waiting for a {@link DeferredResult} to be set from a thread - * chosen by the application (e.g. in response to some external event). + * chosen by the application (for example, in response to some external event). * *

      A {@code DeferredResultProcessingInterceptor} is invoked before the start * of async processing, after the {@code DeferredResult} is set as well as on diff --git a/spring-web/src/main/java/org/springframework/web/context/request/async/StandardServletAsyncWebRequest.java b/spring-web/src/main/java/org/springframework/web/context/request/async/StandardServletAsyncWebRequest.java index 12009a3c494b..9cad8c359176 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/async/StandardServletAsyncWebRequest.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/async/StandardServletAsyncWebRequest.java @@ -224,7 +224,7 @@ private int tryObtainLock() { return 0; } - // Do not wait indefinitely, stop if we moved on from ASYNC state (e.g. to ERROR), + // Do not wait indefinitely, stop if we moved on from ASYNC state (for example, to ERROR), // helps to avoid ABBA deadlock with onError callback while (this.state == State.ASYNC) { diff --git a/spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java b/spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java index 29ea997a5902..a7438441814c 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java @@ -106,7 +106,7 @@ public final class WebAsyncManager { /** * Configure the {@link AsyncWebRequest} to use. This property may be set * more than once during a single request to accurately reflect the current - * state of the request (e.g. following a forward, request/response + * state of the request (for example, following a forward, request/response * wrapping, etc). However, it should not be set while concurrent handling * is in progress, i.e. while {@link #isConcurrentHandlingStarted()} is * {@code true}. diff --git a/spring-web/src/main/java/org/springframework/web/context/support/AbstractRefreshableWebApplicationContext.java b/spring-web/src/main/java/org/springframework/web/context/support/AbstractRefreshableWebApplicationContext.java index 0c3d92fb7dd9..b679c2185420 100644 --- a/spring-web/src/main/java/org/springframework/web/context/support/AbstractRefreshableWebApplicationContext.java +++ b/spring-web/src/main/java/org/springframework/web/context/support/AbstractRefreshableWebApplicationContext.java @@ -49,7 +49,7 @@ * by the {@link #getConfigLocations} method. * *

      Interprets resource paths as servlet context resources, i.e. as paths beneath - * the web application root. Absolute paths, e.g. for files outside the web app root, + * the web application root. Absolute paths, for example, for files outside the web app root, * can be accessed via "file:" URLs, as implemented by * {@link org.springframework.core.io.DefaultResourceLoader}. * diff --git a/spring-web/src/main/java/org/springframework/web/context/support/AnnotationConfigWebApplicationContext.java b/spring-web/src/main/java/org/springframework/web/context/support/AnnotationConfigWebApplicationContext.java index de5cbf45d8ba..8c673266578e 100644 --- a/spring-web/src/main/java/org/springframework/web/context/support/AnnotationConfigWebApplicationContext.java +++ b/spring-web/src/main/java/org/springframework/web/context/support/AnnotationConfigWebApplicationContext.java @@ -156,7 +156,7 @@ protected ScopeMetadataResolver getScopeMetadataResolver() { *

      Note that {@link #refresh()} must be called in order for the context * to fully process the new classes. * @param componentClasses one or more component classes, - * e.g. {@link org.springframework.context.annotation.Configuration @Configuration} classes + * for example, {@link org.springframework.context.annotation.Configuration @Configuration} classes * @see #scan(String...) * @see #loadBeanDefinitions(DefaultListableBeanFactory) * @see #setConfigLocation(String) diff --git a/spring-web/src/main/java/org/springframework/web/context/support/ServletContextResource.java b/spring-web/src/main/java/org/springframework/web/context/support/ServletContextResource.java index cb8e8ffb8943..6bdaa14a9dfe 100644 --- a/spring-web/src/main/java/org/springframework/web/context/support/ServletContextResource.java +++ b/spring-web/src/main/java/org/springframework/web/context/support/ServletContextResource.java @@ -112,7 +112,7 @@ public boolean exists() { /** * This implementation delegates to {@code ServletContext.getResourceAsStream}, - * which returns {@code null} in case of a non-readable resource (e.g. a directory). + * which returns {@code null} in case of a non-readable resource (for example, a directory). * @see jakarta.servlet.ServletContext#getResourceAsStream(String) */ @Override diff --git a/spring-web/src/main/java/org/springframework/web/context/support/StaticWebApplicationContext.java b/spring-web/src/main/java/org/springframework/web/context/support/StaticWebApplicationContext.java index a03c975d9e15..63b4b5f57ce1 100644 --- a/spring-web/src/main/java/org/springframework/web/context/support/StaticWebApplicationContext.java +++ b/spring-web/src/main/java/org/springframework/web/context/support/StaticWebApplicationContext.java @@ -42,7 +42,7 @@ * despite not actually supporting external configuration files. * *

      Interprets resource paths as servlet context resources, i.e. as paths beneath - * the web application root. Absolute paths, e.g. for files outside the web app root, + * the web application root. Absolute paths, for example, for files outside the web app root, * can be accessed via "file:" URLs, as implemented by * {@link org.springframework.core.io.DefaultResourceLoader}. * diff --git a/spring-web/src/main/java/org/springframework/web/context/support/XmlWebApplicationContext.java b/spring-web/src/main/java/org/springframework/web/context/support/XmlWebApplicationContext.java index 2f396175b21c..a9d6efee1dc2 100644 --- a/spring-web/src/main/java/org/springframework/web/context/support/XmlWebApplicationContext.java +++ b/spring-web/src/main/java/org/springframework/web/context/support/XmlWebApplicationContext.java @@ -97,7 +97,7 @@ protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throw /** * Initialize the bean definition reader used for loading the bean * definitions of this context. Default implementation is empty. - *

      Can be overridden in subclasses, e.g. for turning off XML validation + *

      Can be overridden in subclasses, for example, for turning off XML validation * or using a different XmlBeanDefinitionParser implementation. * @param beanDefinitionReader the bean definition reader used by this context * @see org.springframework.beans.factory.xml.XmlBeanDefinitionReader#setValidationMode diff --git a/spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java b/spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java index 032c0de7ffdb..0ee455a69aed 100644 --- a/spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java +++ b/spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java @@ -125,10 +125,10 @@ public CorsConfiguration(CorsConfiguration other) { * A list of origins for which cross-origin requests are allowed where each * value may be one of the following: *

        - *
      • a specific domain, e.g. {@code "https://domain1.com"} - *
      • comma-delimited list of specific domains, e.g. + *
      • a specific domain, for example, {@code "https://domain1.com"} + *
      • comma-delimited list of specific domains, for example, * {@code "https://a1.com,https://a2.com"}; this is convenient when a value - * is resolved through a property placeholder, e.g. {@code "${origin}"}; + * is resolved through a property placeholder, for example, {@code "${origin}"}; * note that such placeholders must be resolved externally. *
      • the CORS defined special value {@code "*"} for all origins *
      @@ -141,7 +141,7 @@ public CorsConfiguration(CorsConfiguration other) { * As a consequence, those combinations are rejected in favor of using * {@link #setAllowedOriginPatterns allowedOriginPatterns} instead. *

      By default this is not set which means that no origins are allowed. - * However, an instance of this class is often initialized further, e.g. for + * However, an instance of this class is often initialized further, for example, for * {@code @CrossOrigin}, via {@link #applyPermitDefaultValues()}. */ public void setAllowedOrigins(@Nullable List origins) { @@ -198,9 +198,9 @@ else if (this.allowedOrigins == DEFAULT_PERMIT_ALL && CollectionUtils.isEmpty(th * domain1.com on port 8080 or port 8081 *

    1. {@literal https://*.domain1.com:[*]} -- domains ending with * domain1.com on any port, including the default port - *
    2. comma-delimited list of patters, e.g. + *
    3. comma-delimited list of patters, for example, * {@code "https://*.a1.com,https://*.a2.com"}; this is convenient when a - * value is resolved through a property placeholder, e.g. {@code "${origin}"}; + * value is resolved through a property placeholder, for example, {@code "${origin}"}; * note that such placeholders must be resolved externally. * *

      In contrast to {@link #setAllowedOrigins(List) allowedOrigins} which @@ -289,7 +289,7 @@ private static void parseCommaDelimitedOrigin(String rawValue, Consumer } /** - * Set the HTTP methods to allow, e.g. {@code "GET"}, {@code "POST"}, + * Set the HTTP methods to allow, for example, {@code "GET"}, {@code "POST"}, * {@code "PUT"}, etc. The special value {@code "*"} allows all methods. *

      {@code Access-Control-Allow-Methods} response header is set either * to the configured method or to {@code "*"}. Keep in mind however that the @@ -783,7 +783,7 @@ public List checkHeaders(@Nullable List requestHeaders) { /** - * Contains both the user-declared pattern (e.g. "https://*.domain.com") and + * Contains both the user-declared pattern (for example, "https://*.domain.com") and * the regex {@link Pattern} derived from it. */ private static class OriginPattern { diff --git a/spring-web/src/main/java/org/springframework/web/filter/CorsFilter.java b/spring-web/src/main/java/org/springframework/web/filter/CorsFilter.java index 725dfebddbbf..d604ecc59e9d 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/CorsFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/CorsFilter.java @@ -34,7 +34,7 @@ /** * {@link jakarta.servlet.Filter} to handle CORS pre-flight requests and intercept * CORS simple and actual requests with a {@link CorsProcessor}, and to update - * the response, e.g. with CORS response headers, based on the policy matched + * the response, for example, with CORS response headers, based on the policy matched * through the provided {@link CorsConfigurationSource}. * *

      This is an alternative to configuring CORS in the Spring MVC Java config diff --git a/spring-web/src/main/java/org/springframework/web/filter/ForwardedHeaderFilter.java b/spring-web/src/main/java/org/springframework/web/filter/ForwardedHeaderFilter.java index dceabf07146f..d74e69f02595 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/ForwardedHeaderFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/ForwardedHeaderFilter.java @@ -353,7 +353,7 @@ public Object getAttribute(String name) { /** * Responsible for the contextPath, requestURI, and requestURL with forwarded * headers in mind, and also taking into account changes to the path of the - * underlying delegate request (e.g. on a Servlet FORWARD). + * underlying delegate request (for example, on a Servlet FORWARD). */ private static class ForwardedPrefixExtractor { @@ -375,7 +375,7 @@ private static class ForwardedPrefixExtractor { * Constructor with required information. * @param delegate supplier for the current * {@link HttpServletRequestWrapper#getRequest() delegate request} which - * may change during a forward (e.g. Tomcat. + * may change during a forward (for example, Tomcat. * @param baseUrl the host, scheme, and port based on forwarded headers */ public ForwardedPrefixExtractor(Supplier delegate, String baseUrl) { @@ -446,7 +446,7 @@ public StringBuffer getRequestUrl() { } private void recalculatePathsIfNecessary() { - // Path of delegate request changed, e.g. FORWARD on Tomcat + // Path of delegate request changed, for example, FORWARD on Tomcat if (!this.actualRequestUri.equals(this.delegate.get().getRequestURI())) { this.actualRequestUri = this.delegate.get().getRequestURI(); // Keep call order diff --git a/spring-web/src/main/java/org/springframework/web/filter/OncePerRequestFilter.java b/spring-web/src/main/java/org/springframework/web/filter/OncePerRequestFilter.java index 03b997852e9b..c7b673293903 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/OncePerRequestFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/OncePerRequestFilter.java @@ -188,7 +188,7 @@ protected boolean shouldNotFilter(HttpServletRequest request) throws ServletExce /** * The dispatcher type {@code jakarta.servlet.DispatcherType.ASYNC} means a * filter can be invoked in more than one thread over the course of a single - * request. Some filters only need to filter the initial thread (e.g. request + * request. Some filters only need to filter the initial thread (for example, request * wrapping) while others may need to be invoked at least once in each * additional thread for example for setting up thread locals or to perform * final processing at the very end. @@ -232,7 +232,7 @@ protected abstract void doFilterInternal( /** * Typically an ERROR dispatch happens after the REQUEST dispatch completes, * and the filter chain starts anew. On some servers however the ERROR - * dispatch may be nested within the REQUEST dispatch, e.g. as a result of + * dispatch may be nested within the REQUEST dispatch, for example, as a result of * calling {@code sendError} on the response. In that case we are still in * the filter chain, on the same thread, but the request and response have * been switched to the original, unwrapped ones. diff --git a/spring-web/src/main/java/org/springframework/web/filter/RequestContextFilter.java b/spring-web/src/main/java/org/springframework/web/filter/RequestContextFilter.java index 3a57d72e9172..a0a214d2fec4 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/RequestContextFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/RequestContextFilter.java @@ -36,7 +36,7 @@ * and Spring's {@link org.springframework.web.servlet.DispatcherServlet} also expose * the same request context to the current thread. * - *

      This filter is mainly for use with third-party servlets, e.g. the JSF FacesServlet. + *

      This filter is mainly for use with third-party servlets, for example, the JSF FacesServlet. * Within Spring's own web support, DispatcherServlet's processing is perfectly sufficient. * * @author Juergen Hoeller @@ -62,7 +62,7 @@ public class RequestContextFilter extends OncePerRequestFilter { * (that is, ending after their initial task, without reuse of the thread). *

      WARNING: Do not use inheritance for child threads if you are * accessing a thread pool which is configured to potentially add new threads - * on demand (e.g. a JDK {@link java.util.concurrent.ThreadPoolExecutor}), + * on demand (for example, a JDK {@link java.util.concurrent.ThreadPoolExecutor}), * since this will expose the inherited context to such a pooled thread. */ public void setThreadContextInheritable(boolean threadContextInheritable) { diff --git a/spring-web/src/main/java/org/springframework/web/filter/ShallowEtagHeaderFilter.java b/spring-web/src/main/java/org/springframework/web/filter/ShallowEtagHeaderFilter.java index 7f830f9bdb4a..3564cc8629ca 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/ShallowEtagHeaderFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/ShallowEtagHeaderFilter.java @@ -43,7 +43,7 @@ * not sent, but rather a {@code 304 "Not Modified"} status instead. * *

      Since the ETag is based on the response content, the response - * (e.g. a {@link org.springframework.web.servlet.View}) is still rendered. + * (for example, a {@link org.springframework.web.servlet.View}) is still rendered. * As such, this filter only saves bandwidth, not server performance. * *

      State-changing HTTP methods and other HTTP conditional request headers such as diff --git a/spring-web/src/main/java/org/springframework/web/filter/UrlHandlerFilter.java b/spring-web/src/main/java/org/springframework/web/filter/UrlHandlerFilter.java index e6e50eabcad5..9566a4faffc5 100644 --- a/spring-web/src/main/java/org/springframework/web/filter/UrlHandlerFilter.java +++ b/spring-web/src/main/java/org/springframework/web/filter/UrlHandlerFilter.java @@ -118,7 +118,7 @@ protected void doFilterInternal(HttpServletRequest request, HttpServletResponse /** * Create a builder by adding a handler for URL's with a trailing slash. - * @param pathPatterns path patterns to map the handler to, e.g. + * @param pathPatterns path patterns to map the handler to, for example, * "/path/*", "/path/**", * "/path/foo/". * @return a spec to configure the trailing slash handler with @@ -136,7 +136,7 @@ public interface Builder { /** * Add a handler for URL's with a trailing slash. - * @param pathPatterns path patterns to map the handler to, e.g. + * @param pathPatterns path patterns to map the handler to, for example, * "/path/*", "/path/**", * "/path/foo/". * @return a spec to configure the handler with diff --git a/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java b/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java index 20e4207c4626..a3b45aecbdb8 100644 --- a/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java +++ b/spring-web/src/main/java/org/springframework/web/method/ControllerAdviceBean.java @@ -188,7 +188,7 @@ public Class getBeanType() { public Object resolveBean() { if (this.resolvedBean == null) { Object resolvedBean = this.beanFactory.getBean(this.beanName); - // Don't cache non-singletons (e.g., prototypes). + // Don't cache non-singletons (for example, prototypes). if (!this.isSingleton) { return resolvedBean; } diff --git a/spring-web/src/main/java/org/springframework/web/method/HandlerMethod.java b/spring-web/src/main/java/org/springframework/web/method/HandlerMethod.java index 1c1ad19b05c6..41a53a5e3aad 100644 --- a/spring-web/src/main/java/org/springframework/web/method/HandlerMethod.java +++ b/spring-web/src/main/java/org/springframework/web/method/HandlerMethod.java @@ -57,7 +57,7 @@ * method annotations, etc. * *

      The class may be created with a bean instance or with a bean name - * (e.g. lazy-init bean, prototype bean). Use {@link #createWithResolvedBean()} + * (for example, lazy-init bean, prototype bean). Use {@link #createWithResolvedBean()} * to obtain a {@code HandlerMethod} instance with a bean instance resolved * through the associated {@link BeanFactory}. * @@ -372,7 +372,7 @@ protected void assertTargetBean(Method method, Object targetBean, Object[] args) String text = "The mapped handler method class '" + methodDeclaringClass.getName() + "' is not an instance of the actual controller bean class '" + targetBeanClass.getName() + "'. If the controller requires proxying " + - "(e.g. due to @Transactional), please use class-based proxying."; + "(for example, due to @Transactional), please use class-based proxying."; throw new IllegalStateException(formatInvokeError(text, args)); } } diff --git a/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java b/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java index c0366067f4df..427a886c62d4 100644 --- a/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java +++ b/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java @@ -110,7 +110,7 @@ public static HandlerTypePredicate forAnyHandlerType() { } /** - * Match handlers declared under a base package, e.g. "org.example". + * Match handlers declared under a base package, for example, "org.example". * @param packages one or more base package names */ public static HandlerTypePredicate forBasePackage(String... packages) { @@ -163,7 +163,7 @@ public static class Builder { private final List> annotations = new ArrayList<>(); /** - * Match handlers declared under a base package, e.g. "org.example". + * Match handlers declared under a base package, for example, "org.example". * @param packages one or more base package classes */ public Builder basePackage(String... packages) { diff --git a/spring-web/src/main/java/org/springframework/web/method/annotation/ExceptionHandlerMethodResolver.java b/spring-web/src/main/java/org/springframework/web/method/annotation/ExceptionHandlerMethodResolver.java index e20fcacbf846..80d6d70bdc41 100644 --- a/spring-web/src/main/java/org/springframework/web/method/annotation/ExceptionHandlerMethodResolver.java +++ b/spring-web/src/main/java/org/springframework/web/method/annotation/ExceptionHandlerMethodResolver.java @@ -202,7 +202,7 @@ public ExceptionHandlerMappingInfo resolveExceptionMapping(Throwable exception, /** * Find a {@link Method} to handle the given exception type. This can be - * useful if an {@link Exception} instance is not available (e.g. for tools). + * useful if an {@link Exception} instance is not available (for example, for tools). *

      Uses {@link ExceptionDepthComparator} if more than one match is found. * @param exceptionType the exception type * @return a Method to handle the exception, or {@code null} if none found @@ -215,7 +215,7 @@ public Method resolveMethodByExceptionType(Class exceptionT /** * Find a {@link Method} to handle the given exception type and media type. - * This can be useful if an {@link Exception} instance is not available (e.g. for tools). + * This can be useful if an {@link Exception} instance is not available (for example, for tools). * @param exceptionType the exception type * @param mediaType the media type requested by the HTTP client * @return a Method to handle the exception, or {@code null} if none found diff --git a/spring-web/src/main/java/org/springframework/web/method/support/InvocableHandlerMethod.java b/spring-web/src/main/java/org/springframework/web/method/support/InvocableHandlerMethod.java index 6c84737f706d..b1398f9a9b54 100644 --- a/spring-web/src/main/java/org/springframework/web/method/support/InvocableHandlerMethod.java +++ b/spring-web/src/main/java/org/springframework/web/method/support/InvocableHandlerMethod.java @@ -124,7 +124,7 @@ public void setHandlerMethodArgumentResolvers(HandlerMethodArgumentResolverCompo /** * Set the ParameterNameDiscoverer for resolving parameter names when needed - * (e.g. default request attribute name). + * (for example, default request attribute name). *

      Default is a {@link org.springframework.core.DefaultParameterNameDiscoverer}. */ public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) { diff --git a/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java b/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java index bf5ae9f91ef8..7f2db8d3dcdc 100644 --- a/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java +++ b/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java @@ -165,7 +165,7 @@ private boolean useDefaultModel() { * returns either the "default" model (template rendering) or the "redirect" * model (redirect URL preparation). Use of this method may be needed for * advanced cases when access to the "default" model is needed regardless, - * e.g. to save model attributes specified via {@code @SessionAttributes}. + * for example, to save model attributes specified via {@code @SessionAttributes}. * @return the default model (never {@code null}) * @since 4.1.4 */ @@ -184,7 +184,7 @@ public void setRedirectModel(ModelMap redirectModel) { } /** - * Whether the controller has returned a redirect instruction, e.g. a + * Whether the controller has returned a redirect instruction, for example, a * "redirect:" prefixed view name, a RedirectView instance, etc. */ public void setRedirectModelScenario(boolean redirectModelScenario) { @@ -253,7 +253,7 @@ public SessionStatus getSessionStatus() { } /** - * Whether the request has been handled fully within the handler, e.g. + * Whether the request has been handled fully within the handler, for example, * {@code @ResponseBody} method, and therefore view resolution is not * necessary. This flag can also be set when controller methods declare an * argument of type {@code ServletResponse} or {@code OutputStream}). diff --git a/spring-web/src/main/java/org/springframework/web/multipart/MultipartFile.java b/spring-web/src/main/java/org/springframework/web/multipart/MultipartFile.java index 0cfda77c558c..34ad8274c263 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/MultipartFile.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/MultipartFile.java @@ -124,7 +124,7 @@ default Resource getResource() { * in order to work with any storage mechanism. *

      NOTE: Depending on the underlying provider, temporary storage * may be container-dependent, including the base directory for relative - * destinations specified here (e.g. with Servlet multipart handling). + * destinations specified here (for example, with Servlet multipart handling). * For absolute destinations, the target file may get renamed/moved from its * temporary location or newly copied, even if a temporary copy already exists. * @param dest the destination file (typically absolute) diff --git a/spring-web/src/main/java/org/springframework/web/multipart/MultipartHttpServletRequest.java b/spring-web/src/main/java/org/springframework/web/multipart/MultipartHttpServletRequest.java index 40f678469da8..7d2237d85961 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/MultipartHttpServletRequest.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/MultipartHttpServletRequest.java @@ -62,7 +62,7 @@ public interface MultipartHttpServletRequest extends HttpServletRequest, Multipa /** * Return the headers for the specified part of the multipart request. *

      If the underlying implementation supports access to part headers, - * then all headers are returned. Otherwise, e.g. for a file upload, the + * then all headers are returned. Otherwise, for example, for a file upload, the * returned headers may expose a 'Content-Type' if available. */ @Nullable diff --git a/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java b/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java index acb7cfb94445..e9ffe0604e38 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/support/MissingServletRequestPartException.java @@ -28,7 +28,7 @@ * Signals the part of a "multipart/form-data" request, identified by name * could not be found. This may be because the request is not a multipart * request, or a part with that name is not present, or because the application - * is not configured correctly for processing multipart requests, e.g. there + * is not configured correctly for processing multipart requests, for example, there * is no {@link MultipartResolver}. * *

      Note: This exception does not extend from diff --git a/spring-web/src/main/java/org/springframework/web/multipart/support/MultipartFilter.java b/spring-web/src/main/java/org/springframework/web/multipart/support/MultipartFilter.java index bc39ea425901..7e5703bb88b0 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/support/MultipartFilter.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/support/MultipartFilter.java @@ -54,7 +54,7 @@ *

      Note: This filter is an alternative to using DispatcherServlet's * MultipartResolver support, for example for web applications with custom web views * which do not use Spring's web MVC, or for custom filters applied before a Spring MVC - * DispatcherServlet (e.g. {@link org.springframework.web.filter.HiddenHttpMethodFilter}). + * DispatcherServlet (for example, {@link org.springframework.web.filter.HiddenHttpMethodFilter}). * In any case, this filter should not be combined with servlet-specific multipart resolution. * * @author Juergen Hoeller diff --git a/spring-web/src/main/java/org/springframework/web/multipart/support/StandardMultipartHttpServletRequest.java b/spring-web/src/main/java/org/springframework/web/multipart/support/StandardMultipartHttpServletRequest.java index c20330f93e74..554f7aa8445f 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/support/StandardMultipartHttpServletRequest.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/support/StandardMultipartHttpServletRequest.java @@ -148,7 +148,7 @@ public Enumeration getParameterNames() { } // Servlet getParameterNames() not guaranteed to include multipart form items - // (e.g. on WebLogic 12) -> need to merge them here to be on the safe side + // (for example, on WebLogic 12) -> need to merge them here to be on the safe side Set paramNames = new LinkedHashSet<>(); Enumeration paramEnum = super.getParameterNames(); while (paramEnum.hasMoreElements()) { @@ -169,7 +169,7 @@ public Map getParameterMap() { } // Servlet getParameterMap() not guaranteed to include multipart form items - // (e.g. on WebLogic 12) -> need to merge them here to be on the safe side + // (for example, on WebLogic 12) -> need to merge them here to be on the safe side Map paramMap = new LinkedHashMap<>(super.getParameterMap()); for (String paramName : this.multipartParameterNames) { if (!paramMap.containsKey(paramName)) { @@ -269,7 +269,7 @@ public void transferTo(File dest) throws IOException, IllegalStateException { if (dest.isAbsolute() && !dest.exists()) { // Servlet Part.write is not guaranteed to support absolute file paths: // may translate the given path to a relative location within a temp dir - // (e.g. on Jetty whereas Tomcat and Undertow detect absolute paths). + // (for example, on Jetty whereas Tomcat and Undertow detect absolute paths). // At least we offloaded the file from memory storage; it'll get deleted // from the temp dir eventually in any case. And for our user's purposes, // we can manually copy it to the requested location as a fallback. diff --git a/spring-web/src/main/java/org/springframework/web/multipart/support/StandardServletMultipartResolver.java b/spring-web/src/main/java/org/springframework/web/multipart/support/StandardServletMultipartResolver.java index 3e35fb96228a..29c79b7a8132 100644 --- a/spring-web/src/main/java/org/springframework/web/multipart/support/StandardServletMultipartResolver.java +++ b/spring-web/src/main/java/org/springframework/web/multipart/support/StandardServletMultipartResolver.java @@ -88,7 +88,7 @@ public void setResolveLazily(boolean resolveLazily) { * specification, only kicking in for "multipart/form-data" requests. *

      Default is "false", trying to process any request with a "multipart/" * content type as far as the underlying Servlet container supports it - * (which works on e.g. Tomcat but not on Jetty). For consistent portability + * (which works on, for example, Tomcat but not on Jetty). For consistent portability * and in particular for consistent custom handling of non-form multipart * request types outside of Spring's {@link MultipartResolver} mechanism, * switch this flag to "true": Only "multipart/form-data" requests will be diff --git a/spring-web/src/main/java/org/springframework/web/server/MissingRequestValueException.java b/spring-web/src/main/java/org/springframework/web/server/MissingRequestValueException.java index 281676507a71..0cc87bf4cd75 100644 --- a/spring-web/src/main/java/org/springframework/web/server/MissingRequestValueException.java +++ b/spring-web/src/main/java/org/springframework/web/server/MissingRequestValueException.java @@ -46,7 +46,7 @@ public MissingRequestValueException(String name, Class type, String label, Me /** - * Return the name of the missing value, e.g. the name of the missing request + * Return the name of the missing value, for example, the name of the missing request * header, or cookie, etc. */ public String getName() { @@ -61,7 +61,7 @@ public Class getType() { } /** - * Return a label that describes the request value, e.g. "request header", + * Return a label that describes the request value, for example, "request header", * "cookie value", etc. Use this to create a custom message. */ public String getLabel() { diff --git a/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java b/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java index 8e9c039aae71..ace7a1b97fc9 100644 --- a/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java +++ b/spring-web/src/main/java/org/springframework/web/server/ResponseStatusException.java @@ -109,7 +109,7 @@ public String getReason() { } /** - * Return headers to add to the error response, e.g. "Allow", "Accept", etc. + * Return headers to add to the error response, for example, "Allow", "Accept", etc. *

      By default, delegates to {@link #getResponseHeaders()} for backwards * compatibility. */ @@ -120,7 +120,7 @@ public HttpHeaders getHeaders() { /** * Return headers associated with the exception that should be added to the - * error response, e.g. "Allow", "Accept", etc. + * error response, for example, "Allow", "Accept", etc. *

      The default implementation in this class returns empty headers. * @since 5.1.13 * @deprecated as of 6.0 in favor of {@link #getHeaders()} diff --git a/spring-web/src/main/java/org/springframework/web/server/ServerWebInputException.java b/spring-web/src/main/java/org/springframework/web/server/ServerWebInputException.java index 530135b0924a..e0ba0ea2435d 100644 --- a/spring-web/src/main/java/org/springframework/web/server/ServerWebInputException.java +++ b/spring-web/src/main/java/org/springframework/web/server/ServerWebInputException.java @@ -22,7 +22,7 @@ /** * Exception for errors that fit response status 400 (bad request) for use in - * Spring Web applications. The exception provides additional fields (e.g. + * Spring Web applications. The exception provides additional fields (for example, * an optional {@link MethodParameter} if related to the error). * * @author Rossen Stoyanchev diff --git a/spring-web/src/main/java/org/springframework/web/server/handler/ExceptionHandlingWebHandler.java b/spring-web/src/main/java/org/springframework/web/server/handler/ExceptionHandlingWebHandler.java index 4e80dff39935..ab69be912d23 100644 --- a/spring-web/src/main/java/org/springframework/web/server/handler/ExceptionHandlingWebHandler.java +++ b/spring-web/src/main/java/org/springframework/web/server/handler/ExceptionHandlingWebHandler.java @@ -91,7 +91,7 @@ public Mono handle(ServerWebExchange exchange) { /** * WebExceptionHandler to insert a checkpoint with current URL information. * Must be the first in order to ensure we catch the error signal before - * the exception is handled and e.g. turned into an error response. + * the exception is handled and, for example, turned into an error response. * @since 5.2 */ private static class CheckpointInsertingHandler implements WebExceptionHandler { diff --git a/spring-web/src/main/java/org/springframework/web/server/session/InMemoryWebSessionStore.java b/spring-web/src/main/java/org/springframework/web/server/session/InMemoryWebSessionStore.java index 98ecad3ae738..b0243ef603b0 100644 --- a/spring-web/src/main/java/org/springframework/web/server/session/InMemoryWebSessionStore.java +++ b/spring-web/src/main/java/org/springframework/web/server/session/InMemoryWebSessionStore.java @@ -82,7 +82,7 @@ public int getMaxSessions() { * Configure the {@link Clock} to use to set lastAccessTime on every created * session and to calculate if it is expired. *

      This may be useful to align to different timezone or to set the clock - * back in a test, e.g. {@code Clock.offset(clock, Duration.ofMinutes(-31))} + * back in a test, for example, {@code Clock.offset(clock, Duration.ofMinutes(-31))} * in order to simulate session expiration. *

      By default this is {@code Clock.system(ZoneId.of("GMT"))}. * @param clock the clock to use diff --git a/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java b/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java index 15bce4e0f910..2b34bb53ee13 100644 --- a/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java +++ b/spring-web/src/main/java/org/springframework/web/service/annotation/HttpExchange.java @@ -109,7 +109,7 @@ * {@link org.springframework.web.bind.annotation.RequestPart @RequestPart} * Add a request part, which may be a String (form field), * {@link org.springframework.core.io.Resource} (file part), Object (entity to be - * encoded, e.g. as JSON), {@link HttpEntity} (part content and headers), a + * encoded, for example, as JSON), {@link HttpEntity} (part content and headers), a * {@link org.springframework.http.codec.multipart.Part}, or a * {@link org.reactivestreams.Publisher} of any of the above. * ( diff --git a/spring-web/src/main/java/org/springframework/web/service/invoker/AbstractNamedValueArgumentResolver.java b/spring-web/src/main/java/org/springframework/web/service/invoker/AbstractNamedValueArgumentResolver.java index 97288c2b5ea3..88fd07c94eef 100644 --- a/spring-web/src/main/java/org/springframework/web/service/invoker/AbstractNamedValueArgumentResolver.java +++ b/spring-web/src/main/java/org/springframework/web/service/invoker/AbstractNamedValueArgumentResolver.java @@ -246,7 +246,7 @@ protected static class NamedValueInfo { * @param name the name to use, possibly empty if not specified * @param required whether it is marked as required * @param defaultValue fallback value, possibly {@link ValueConstants#DEFAULT_NONE} - * @param label how it should appear in error messages, e.g. "path variable", "request header" + * @param label how it should appear in error messages, for example, "path variable", "request header" * @param multiValued whether this argument resolver supports sending multiple values; * if not, then multiple values are formatted as a String value */ diff --git a/spring-web/src/main/java/org/springframework/web/service/invoker/HttpRequestValues.java b/spring-web/src/main/java/org/springframework/web/service/invoker/HttpRequestValues.java index 87adc5e333fe..7bf09599ae2b 100644 --- a/spring-web/src/main/java/org/springframework/web/service/invoker/HttpRequestValues.java +++ b/spring-web/src/main/java/org/springframework/web/service/invoker/HttpRequestValues.java @@ -360,7 +360,7 @@ public Builder addRequestParameter(String name, String... values) { *

        *
      • String -- form field *
      • {@link org.springframework.core.io.Resource Resource} -- file part - *
      • Object -- content to be encoded (e.g. to JSON) + *
      • Object -- content to be encoded (for example, to JSON) *
      • {@link HttpEntity} -- part content and headers although generally it's * easier to add headers through the returned builder *
      diff --git a/spring-web/src/main/java/org/springframework/web/service/invoker/RequestParamArgumentResolver.java b/spring-web/src/main/java/org/springframework/web/service/invoker/RequestParamArgumentResolver.java index 019be4aa9682..4bcf4aef779e 100644 --- a/spring-web/src/main/java/org/springframework/web/service/invoker/RequestParamArgumentResolver.java +++ b/spring-web/src/main/java/org/springframework/web/service/invoker/RequestParamArgumentResolver.java @@ -64,7 +64,7 @@ public RequestParamArgumentResolver(ConversionService conversionService) { /** - * Whether to format multiple values (e.g. collection, array) as a single + * Whether to format multiple values (for example, collection, array) as a single * String value through the configured {@link ConversionService} unless the * content type is form data, or it is a multipart request. *

      By default, this is {@code false} in which case formatting is not applied, diff --git a/spring-web/src/main/java/org/springframework/web/service/invoker/RequestPartArgumentResolver.java b/spring-web/src/main/java/org/springframework/web/service/invoker/RequestPartArgumentResolver.java index 77180350d693..f4173d6e0666 100644 --- a/spring-web/src/main/java/org/springframework/web/service/invoker/RequestPartArgumentResolver.java +++ b/spring-web/src/main/java/org/springframework/web/service/invoker/RequestPartArgumentResolver.java @@ -40,7 +40,7 @@ *

    4. String -- form field *
    5. {@link org.springframework.core.io.Resource Resource} -- file part *
    6. {@link MultipartFile} -- uploaded file - *
    7. Object -- content to be encoded (e.g. to JSON) + *
    8. Object -- content to be encoded (for example, to JSON) *
    9. {@link HttpEntity} -- part content and headers although generally it's * easier to add headers through the returned builder *
    10. {@link Part} -- a part from a server request diff --git a/spring-web/src/main/java/org/springframework/web/util/ContentCachingRequestWrapper.java b/spring-web/src/main/java/org/springframework/web/util/ContentCachingRequestWrapper.java index 3821051fa7b7..c98ab1b9ac89 100644 --- a/spring-web/src/main/java/org/springframework/web/util/ContentCachingRequestWrapper.java +++ b/spring-web/src/main/java/org/springframework/web/util/ContentCachingRequestWrapper.java @@ -47,7 +47,7 @@ * content is not consumed, then the content is not cached, and cannot be * retrieved via {@link #getContentAsByteArray()}. * - *

      Used e.g. by {@link org.springframework.web.filter.AbstractRequestLoggingFilter}. + *

      Used, for example, by {@link org.springframework.web.filter.AbstractRequestLoggingFilter}. * * @author Juergen Hoeller * @author Brian Clozel diff --git a/spring-web/src/main/java/org/springframework/web/util/ContentCachingResponseWrapper.java b/spring-web/src/main/java/org/springframework/web/util/ContentCachingResponseWrapper.java index 41fc196d6781..6f150b7547d1 100644 --- a/spring-web/src/main/java/org/springframework/web/util/ContentCachingResponseWrapper.java +++ b/spring-web/src/main/java/org/springframework/web/util/ContentCachingResponseWrapper.java @@ -40,7 +40,7 @@ * the {@linkplain #getOutputStream() output stream} and {@linkplain #getWriter() writer}, * and allows this content to be retrieved via a {@linkplain #getContentAsByteArray() byte array}. * - *

      Used e.g. by {@link org.springframework.web.filter.ShallowEtagHeaderFilter}. + *

      Used, for example, by {@link org.springframework.web.filter.ShallowEtagHeaderFilter}. * * @author Juergen Hoeller * @author Sam Brannen diff --git a/spring-web/src/main/java/org/springframework/web/util/HierarchicalUriComponents.java b/spring-web/src/main/java/org/springframework/web/util/HierarchicalUriComponents.java index c97f84e6985a..a36adbf4b868 100644 --- a/spring-web/src/main/java/org/springframework/web/util/HierarchicalUriComponents.java +++ b/spring-web/src/main/java/org/springframework/web/util/HierarchicalUriComponents.java @@ -822,7 +822,7 @@ else if (level > 0) { * Whether the given String is a single URI variable that can be * expanded. It must have '{' and '}' surrounding non-empty text and no * nested placeholders unless it is a variable with regex syntax, - * e.g. {@code "/{year:\d{1,4}}"}. + * for example, {@code "/{year:\d{1,4}}"}. */ private boolean isUriVariable(CharSequence source) { if (source.length() < 2 || source.charAt(0) != '{' || source.charAt(source.length() -1) != '}') { diff --git a/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java b/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java index 07a200dc2011..ca57017a7fdd 100644 --- a/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java +++ b/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java @@ -51,7 +51,7 @@ public abstract class HtmlUtils { * Turn special characters into HTML character references. *

      Handles the complete character set defined in the HTML 4.01 recommendation. *

      Escapes all special characters to their corresponding - * entity reference (e.g. {@code <}). + * entity reference (for example, {@code <}). *

      Reference: * * https://www.w3.org/TR/html4/sgml/entities.html @@ -67,7 +67,7 @@ public static String htmlEscape(String input) { * Turn special characters into HTML character references. *

      Handles the complete character set defined in the HTML 4.01 recommendation. *

      Escapes all special characters to their corresponding - * entity reference (e.g. {@code <}) at least as required by the + * entity reference (for example, {@code <}) at least as required by the * specified encoding. In other words, if a special character does * not have to be escaped for the given encoding, it may not be. *

      Reference: diff --git a/spring-web/src/main/java/org/springframework/web/util/IntrospectorCleanupListener.java b/spring-web/src/main/java/org/springframework/web/util/IntrospectorCleanupListener.java index cdf38031364a..8345c1bbe1df 100644 --- a/spring-web/src/main/java/org/springframework/web/util/IntrospectorCleanupListener.java +++ b/spring-web/src/main/java/org/springframework/web/util/IntrospectorCleanupListener.java @@ -52,7 +52,7 @@ *

      Application classes hardly ever need to use the JavaBeans Introspector * directly, so are normally not the cause of Introspector resource leaks. * Rather, many libraries and frameworks do not clean up the Introspector: - * e.g. Struts and Quartz. + * for example, Struts and Quartz. * *

      Note that a single such Introspector leak will cause the entire web * app class loader to not get garbage collected! This has the consequence that diff --git a/spring-web/src/main/java/org/springframework/web/util/ServletContextPropertyUtils.java b/spring-web/src/main/java/org/springframework/web/util/ServletContextPropertyUtils.java index cdb3dd7e34b3..14a8e2f7b4cb 100644 --- a/spring-web/src/main/java/org/springframework/web/util/ServletContextPropertyUtils.java +++ b/spring-web/src/main/java/org/springframework/web/util/ServletContextPropertyUtils.java @@ -26,7 +26,7 @@ * Helper class for resolving placeholders in texts. Usually applied to file paths. * *

      A text may contain {@code ${...}} placeholders, to be resolved as servlet context - * init parameters or system properties: e.g. {@code ${user.dir}}. Default values can + * init parameters or system properties: for example, {@code ${user.dir}}. Default values can * be supplied using the ":" separator between key and value. * * @author Juergen Hoeller diff --git a/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java b/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java index 6b0b2987e5f6..b468038af99e 100644 --- a/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java +++ b/spring-web/src/main/java/org/springframework/web/util/UriBuilder.java @@ -166,7 +166,7 @@ public interface UriBuilder { * Append the given query parameter. Both the parameter name and values may * contain URI template variables to be expanded later from values. If no * values are given, the resulting URI will contain the query parameter name - * only, e.g. {@code "?foo"} instead of {@code "?foo=bar"}. + * only, for example, {@code "?foo"} instead of {@code "?foo=bar"}. *

      Note: encoding, if applied, will only encode characters * that are illegal in a query parameter name or value such as {@code "="} * or {@code "&"}. All others that are legal as per syntax rules in diff --git a/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java b/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java index 828d15915986..fd011edb6392 100644 --- a/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java +++ b/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java @@ -38,7 +38,7 @@ *

      Note: this class uses {@link UriComponentsBuilder} * internally to expand URI templates, and is merely a shortcut for already * prepared URI templates. For more dynamic preparation and extra flexibility, - * e.g. around URI encoding, consider using {@code UriComponentsBuilder} or the + * for example, around URI encoding, consider using {@code UriComponentsBuilder} or the * higher level {@link DefaultUriBuilderFactory} which adds several encoding * modes on top of {@code UriComponentsBuilder}. See the * reference docs diff --git a/spring-web/src/main/java/org/springframework/web/util/UriUtils.java b/spring-web/src/main/java/org/springframework/web/util/UriUtils.java index c7b8aa409fac..c8faec81c9b3 100644 --- a/spring-web/src/main/java/org/springframework/web/util/UriUtils.java +++ b/spring-web/src/main/java/org/springframework/web/util/UriUtils.java @@ -34,7 +34,7 @@ * *

      There are two types of encode methods: *