From 9540d2c81b93b9062faf79d4df998525f3dedb7c Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 18 Dec 2012 14:45:36 +0100 Subject: [PATCH] Replace with {@code} throughout Javadoc Issue: SPR-10128 --- .../java/org/springframework/aop/Advisor.java | 2 +- .../aop/AfterReturningAdvice.java | 2 +- .../aop/IntroductionAwareMethodMatcher.java | 6 +- .../aop/MethodBeforeAdvice.java | 2 +- .../springframework/aop/MethodMatcher.java | 22 +-- .../org/springframework/aop/Pointcut.java | 4 +- .../aop/ProxyMethodInvocation.java | 16 +- .../springframework/aop/TargetClassAware.java | 2 +- .../org/springframework/aop/TargetSource.java | 12 +- .../springframework/aop/TrueClassFilter.java | 2 +- .../aop/TrueMethodMatcher.java | 2 +- .../org/springframework/aop/TruePointcut.java | 2 +- .../aop/aspectj/AbstractAspectJAdvice.java | 4 +- .../aop/aspectj/AspectInstanceFactory.java | 4 +- .../AspectJAdviceParameterNameDiscoverer.java | 92 ++++----- .../aop/aspectj/AspectJAopUtils.java | 6 +- .../aspectj/AspectJExpressionPointcut.java | 10 +- .../aop/aspectj/AspectJProxyUtils.java | 2 +- .../aspectj/AspectJWeaverMessageHandler.java | 2 +- .../MethodInvocationProceedingJoinPoint.java | 12 +- .../aop/aspectj/RuntimeTestWalker.java | 2 +- .../aspectj/SimpleAspectInstanceFactory.java | 4 +- .../SingletonAspectInstanceFactory.java | 2 +- .../aop/aspectj/TypePatternClassFilter.java | 12 +- ...nnotationAwareAspectJAutoProxyCreator.java | 2 +- .../annotation/AspectJAdvisorFactory.java | 6 +- .../annotation/AspectJProxyFactory.java | 2 +- .../aspectj/annotation/AspectMetadata.java | 4 +- ...ntiationModelAwarePointcutAdvisorImpl.java | 2 +- .../ReflectiveAspectJAdvisorFactory.java | 2 +- ...pleMetadataAwareAspectInstanceFactory.java | 2 +- ...tonMetadataAwareAspectInstanceFactory.java | 2 +- .../AspectJPrecedenceComparator.java | 10 +- .../aop/aspectj/package-info.java | 3 +- ...erceptorDrivenBeanDefinitionDecorator.java | 6 +- .../config/AdvisorComponentDefinition.java | 2 +- .../aop/config/AopConfigUtils.java | 2 +- .../aop/config/AopNamespaceHandler.java | 16 +- .../aop/config/AopNamespaceUtils.java | 6 +- .../AspectJAutoProxyBeanDefinitionParser.java | 2 +- .../config/ConfigBeanDefinitionParser.java | 28 +-- .../ScopedProxyBeanDefinitionDecorator.java | 2 +- .../AbstractAdvisingBeanPostProcessor.java | 2 +- .../aop/framework/Advised.java | 22 +-- .../aop/framework/AdvisedSupport.java | 4 +- .../aop/framework/AopContext.java | 14 +- .../aop/framework/AopProxy.java | 10 +- .../aop/framework/AopProxyUtils.java | 6 +- .../aop/framework/CglibAopProxy.java | 18 +- .../aop/framework/JdkDynamicAopProxy.java | 2 +- .../aop/framework/ProxyConfig.java | 2 +- .../aop/framework/ProxyCreatorSupport.java | 2 +- .../aop/framework/ProxyFactory.java | 10 +- .../aop/framework/ProxyFactoryBean.java | 6 +- .../framework/ReflectiveMethodInvocation.java | 2 +- .../aop/framework/adapter/AdvisorAdapter.java | 2 +- .../adapter/AdvisorAdapterRegistry.java | 2 +- .../adapter/ThrowsAdviceInterceptor.java | 4 +- .../AbstractAdvisorAutoProxyCreator.java | 2 +- .../autoproxy/AbstractAutoProxyCreator.java | 16 +- .../framework/autoproxy/AutoProxyUtils.java | 2 +- .../BeanFactoryAdvisorRetrievalHelper.java | 2 +- .../DefaultAdvisorAutoProxyCreator.java | 4 +- .../autoproxy/ProxyCreationContext.java | 4 +- .../autoproxy/TargetSourceCreator.java | 2 +- ...ctBeanFactoryBasedTargetSourceCreator.java | 8 +- .../AbstractMonitoringInterceptor.java | 6 +- .../interceptor/AbstractTraceInterceptor.java | 64 +++---- .../AsyncExecutionInterceptor.java | 8 +- .../CustomizableTraceInterceptor.java | 146 +++++++------- .../aop/interceptor/DebugInterceptor.java | 6 +- .../interceptor/ExposeBeanNameAdvisors.java | 6 +- .../ExposeInvocationInterceptor.java | 2 +- .../PerformanceMonitorInterceptor.java | 4 +- .../interceptor/SimpleTraceInterceptor.java | 4 +- .../support/AbstractExpressionPointcut.java | 2 +- .../support/AbstractRegexpMethodPointcut.java | 12 +- .../springframework/aop/support/AopUtils.java | 14 +- .../aop/support/ComposablePointcut.java | 12 +- .../DefaultBeanFactoryPointcutAdvisor.java | 2 +- .../support/DefaultIntroductionAdvisor.java | 2 +- .../aop/support/DefaultPointcutAdvisor.java | 6 +- ...erTargetObjectIntroductionInterceptor.java | 2 +- .../DelegatingIntroductionInterceptor.java | 2 +- .../aop/support/JdkRegexpMethodPointcut.java | 20 +- .../aop/support/MethodMatchers.java | 6 +- .../aop/support/NameMatchMethodPointcut.java | 2 +- .../NameMatchMethodPointcutAdvisor.java | 2 +- .../support/RegexpMethodPointcutAdvisor.java | 2 +- .../AnnotationMatchingPointcut.java | 4 +- .../AbstractBeanFactoryBasedTargetSource.java | 6 +- .../AbstractLazyCreationTargetSource.java | 8 +- .../target/AbstractPoolingTargetSource.java | 2 +- .../AbstractPrototypeBasedTargetSource.java | 4 +- .../aop/target/CommonsPoolTargetSource.java | 26 +-- .../aop/target/EmptyTargetSource.java | 16 +- .../aop/target/LazyInitTargetSource.java | 4 +- .../aop/target/ThreadLocalTargetSource.java | 2 +- .../AbstractRefreshableTargetSource.java | 6 +- .../BeanFactoryRefreshableTargetSource.java | 2 +- .../AspectJPrecedenceComparatorTests.java | 23 --- .../aspectj/AbstractBeanConfigurerAspect.aj | 2 +- ...nterfaceDrivenDependencyInjectionAspect.aj | 24 +-- .../aspectj/AnnotationBeanConfigurerAspect.aj | 2 +- ...nterfaceDrivenDependencyInjectionAspect.aj | 2 +- ...otationDrivenStaticEntityMockingControl.aj | 2 +- .../aspectj/AbstractTransactionAspect.aj | 2 +- .../beans/BeanMetadataAttribute.java | 4 +- .../beans/BeanMetadataAttributeAccessor.java | 4 +- .../beans/BeanMetadataElement.java | 4 +- .../org/springframework/beans/BeanUtils.java | 64 +++---- .../springframework/beans/BeanWrapper.java | 4 +- .../beans/BeanWrapperImpl.java | 16 +- .../beans/CachedIntrospectionResults.java | 2 +- .../ConversionNotSupportedException.java | 10 +- .../GenericTypeAwarePropertyDescriptor.java | 2 +- .../org/springframework/beans/Mergeable.java | 4 +- .../beans/MutablePropertyValues.java | 12 +- .../beans/PropertyAccessException.java | 2 +- .../beans/PropertyAccessor.java | 8 +- .../beans/PropertyAccessorUtils.java | 4 +- .../beans/PropertyBatchUpdateException.java | 4 +- .../beans/PropertyEditorRegistrar.java | 10 +- .../beans/PropertyEditorRegistry.java | 14 +- .../beans/PropertyEditorRegistrySupport.java | 20 +- .../beans/PropertyMatches.java | 2 +- .../springframework/beans/PropertyValue.java | 10 +- .../springframework/beans/PropertyValues.java | 6 +- .../springframework/beans/TypeConverter.java | 16 +- .../beans/TypeConverterDelegate.java | 24 +-- .../beans/TypeMismatchException.java | 16 +- .../beans/annotation/AnnotationBeanUtils.java | 6 +- .../beans/factory/BeanClassLoaderAware.java | 10 +- .../beans/factory/BeanCreationException.java | 2 +- .../factory/BeanDefinitionStoreException.java | 6 +- .../beans/factory/BeanFactory.java | 42 ++-- .../beans/factory/BeanFactoryAware.java | 2 +- .../beans/factory/BeanFactoryUtils.java | 10 +- .../beans/factory/FactoryBean.java | 18 +- .../FactoryBeanNotInitializedException.java | 2 +- .../factory/HierarchicalBeanFactory.java | 8 +- .../beans/factory/ListableBeanFactory.java | 46 ++--- .../beans/factory/ObjectFactory.java | 4 +- .../beans/factory/SmartFactoryBean.java | 8 +- .../factory/access/BeanFactoryLocator.java | 24 +-- .../factory/access/BeanFactoryReference.java | 10 +- .../access/SingletonBeanFactoryLocator.java | 24 +-- .../access/el/SpringBeanELResolver.java | 4 +- .../annotation/AnnotatedBeanDefinition.java | 2 +- .../beans/factory/annotation/Autowired.java | 2 +- .../AutowiredAnnotationBeanPostProcessor.java | 10 +- .../factory/annotation/Configurable.java | 2 +- .../RequiredAnnotationBeanPostProcessor.java | 10 +- .../factory/config/AbstractFactoryBean.java | 8 +- .../config/AutowireCapableBeanFactory.java | 18 +- .../beans/factory/config/BeanDefinition.java | 24 +-- .../factory/config/BeanDefinitionHolder.java | 6 +- .../factory/config/BeanPostProcessor.java | 10 +- .../beans/factory/config/BeanReference.java | 2 +- .../config/BeanReferenceFactoryBean.java | 2 +- .../config/ConfigurableBeanFactory.java | 12 +- .../ConfigurableListableBeanFactory.java | 2 +- .../config/ConstructorArgumentValues.java | 38 ++-- .../config/CustomEditorConfigurer.java | 4 +- .../factory/config/DependencyDescriptor.java | 14 +- .../DestructionAwareBeanPostProcessor.java | 2 +- .../InstantiationAwareBeanPostProcessor.java | 12 +- .../beans/factory/config/ListFactoryBean.java | 2 +- .../config/MethodInvokingFactoryBean.java | 2 +- .../ObjectFactoryCreatingFactoryBean.java | 2 +- .../PreferencesPlaceholderConfigurer.java | 4 +- .../config/PropertyOverrideConfigurer.java | 2 +- .../config/PropertyPlaceholderConfigurer.java | 12 +- .../config/ProviderCreatingFactoryBean.java | 4 +- .../config/RuntimeBeanNameReference.java | 2 +- .../factory/config/RuntimeBeanReference.java | 2 +- .../beans/factory/config/Scope.java | 24 +-- .../config/ServiceLocatorFactoryBean.java | 26 +-- .../factory/config/SingletonBeanRegistry.java | 16 +- ...rtInstantiationAwareBeanPostProcessor.java | 6 +- .../factory/config/TypedStringValue.java | 2 +- .../factory/parsing/AliasDefinition.java | 2 +- .../parsing/BeanComponentDefinition.java | 2 +- .../factory/parsing/ComponentDefinition.java | 22 +-- .../parsing/ConstructorArgumentEntry.java | 4 +- .../parsing/FailFastProblemReporter.java | 4 +- .../factory/parsing/ImportDefinition.java | 4 +- .../beans/factory/parsing/Location.java | 6 +- .../factory/parsing/NullSourceExtractor.java | 4 +- .../beans/factory/parsing/ParseState.java | 10 +- .../parsing/PassThroughSourceExtractor.java | 4 +- .../beans/factory/parsing/Problem.java | 8 +- .../factory/parsing/ProblemReporter.java | 6 +- .../beans/factory/parsing/PropertyEntry.java | 2 +- .../factory/parsing/SourceExtractor.java | 6 +- .../AbstractAutowireCapableBeanFactory.java | 42 ++-- .../support/AbstractBeanDefinition.java | 42 ++-- .../support/AbstractBeanDefinitionReader.java | 8 +- .../factory/support/AbstractBeanFactory.java | 34 ++-- .../support/AutowireCandidateQualifier.java | 4 +- .../support/AutowireCandidateResolver.java | 2 +- .../support/BeanDefinitionBuilder.java | 24 +-- .../support/BeanDefinitionDefaults.java | 2 +- .../factory/support/BeanDefinitionReader.java | 34 ++-- .../support/BeanDefinitionReaderUtils.java | 2 +- .../support/BeanDefinitionRegistry.java | 2 +- .../support/BeanDefinitionValueResolver.java | 4 +- ...CglibSubclassingInstantiationStrategy.java | 4 +- .../factory/support/ConstructorResolver.java | 6 +- .../support/DefaultListableBeanFactory.java | 10 +- .../support/DefaultSingletonBeanRegistry.java | 4 +- .../support/DisposableBeanAdapter.java | 2 +- .../support/FactoryBeanRegistrySupport.java | 4 +- .../support/GenericBeanDefinition.java | 6 +- .../support/InstantiationStrategy.java | 8 +- .../beans/factory/support/ManagedList.java | 2 +- .../beans/factory/support/ManagedMap.java | 2 +- .../factory/support/ManagedProperties.java | 2 +- .../beans/factory/support/ManagedSet.java | 2 +- .../beans/factory/support/MethodOverride.java | 2 +- .../factory/support/MethodOverrides.java | 2 +- .../PropertiesBeanDefinitionReader.java | 24 +-- .../factory/support/RootBeanDefinition.java | 2 +- .../SimpleSecurityContextProvider.java | 6 +- .../beans/factory/support/package-info.java | 5 +- .../factory/wiring/BeanConfigurerSupport.java | 6 +- .../beans/factory/wiring/BeanWiringInfo.java | 8 +- .../wiring/BeanWiringInfoResolver.java | 2 +- .../xml/AbstractBeanDefinitionParser.java | 14 +- .../AbstractSimpleBeanDefinitionParser.java | 32 ++-- .../AbstractSingleBeanDefinitionParser.java | 28 +-- .../factory/xml/BeanDefinitionDecorator.java | 8 +- .../xml/BeanDefinitionDocumentReader.java | 2 +- .../xml/BeanDefinitionParserDelegate.java | 16 +- .../DefaultBeanDefinitionDocumentReader.java | 2 +- .../xml/DefaultNamespaceHandlerResolver.java | 14 +- .../factory/xml/DelegatingEntityResolver.java | 2 +- .../xml/DocumentDefaultsDefinition.java | 6 +- .../beans/factory/xml/DocumentLoader.java | 2 +- .../beans/factory/xml/NamespaceHandler.java | 16 +- .../factory/xml/NamespaceHandlerResolver.java | 2 +- .../factory/xml/PluggableSchemaResolver.java | 12 +- .../SimpleConstructorNamespaceHandler.java | 12 +- .../xml/SimplePropertyNamespaceHandler.java | 12 +- .../factory/xml/UtilNamespaceHandler.java | 2 +- .../factory/xml/XmlBeanDefinitionReader.java | 14 +- .../beans/factory/xml/package-info.java | 3 +- .../propertyeditors/CharacterEditor.java | 14 +- .../beans/propertyeditors/CharsetEditor.java | 4 +- .../propertyeditors/ClassArrayEditor.java | 18 +- .../beans/propertyeditors/ClassEditor.java | 8 +- .../beans/propertyeditors/CurrencyEditor.java | 2 +- .../propertyeditors/CustomBooleanEditor.java | 4 +- .../CustomCollectionEditor.java | 6 +- .../propertyeditors/CustomDateEditor.java | 10 +- .../propertyeditors/CustomMapEditor.java | 6 +- .../propertyeditors/CustomNumberEditor.java | 14 +- .../beans/propertyeditors/FileEditor.java | 2 +- .../propertyeditors/InputSourceEditor.java | 6 +- .../propertyeditors/InputStreamEditor.java | 4 +- .../beans/propertyeditors/LocaleEditor.java | 4 +- .../beans/propertyeditors/PatternEditor.java | 6 +- .../propertyeditors/PropertiesEditor.java | 10 +- .../StringArrayPropertyEditor.java | 20 +- .../propertyeditors/StringTrimmerEditor.java | 10 +- .../beans/propertyeditors/TimeZoneEditor.java | 4 +- .../beans/propertyeditors/URIEditor.java | 6 +- .../beans/propertyeditors/URLEditor.java | 2 +- .../beans/propertyeditors/UUIDEditor.java | 2 +- .../ArgumentConvertingMethodInvoker.java | 2 +- .../beans/support/MutableSortDefinition.java | 2 +- .../beans/support/PagedListHolder.java | 8 +- .../support/ResourceEditorRegistrar.java | 2 +- .../DefaultListableBeanFactoryTests.java | 2 +- .../cache/ehcache/EhCacheFactoryBean.java | 2 +- .../cache/jcache/JCacheCache.java | 4 +- .../mail/SimpleMailMessage.java | 14 +- .../javamail/ConfigurableMimeFileTypeMap.java | 36 ++-- .../mail/javamail/InternetAddressEditor.java | 2 +- .../mail/javamail/JavaMailSender.java | 4 +- .../mail/javamail/JavaMailSenderImpl.java | 48 ++--- .../mail/javamail/MimeMessageHelper.java | 64 +++---- .../mail/javamail/MimeMessagePreparator.java | 2 +- .../mail/javamail/SmartMimeMessage.java | 8 +- .../commonj/ScheduledTimerListener.java | 4 +- .../commonj/TimerManagerAccessor.java | 4 +- .../scheduling/quartz/CronTriggerBean.java | 6 +- .../quartz/CronTriggerFactoryBean.java | 10 +- .../quartz/JobDetailAwareTrigger.java | 2 +- .../scheduling/quartz/JobDetailBean.java | 4 +- .../quartz/JobDetailFactoryBean.java | 2 +- .../quartz/LocalTaskExecutorThreadPool.java | 4 +- .../scheduling/quartz/QuartzJobBean.java | 2 +- .../scheduling/quartz/SchedulerAccessor.java | 8 +- .../quartz/SchedulerFactoryBean.java | 6 +- .../scheduling/quartz/SimpleTriggerBean.java | 6 +- .../quartz/SimpleTriggerFactoryBean.java | 10 +- .../quartz/SpringBeanJobFactory.java | 2 +- .../FreeMarkerConfigurationFactory.java | 24 +-- .../ui/jasperreports/JasperReportsUtils.java | 108 +++++------ .../ui/velocity/CommonsLoggingLogSystem.java | 6 +- .../ui/velocity/SpringResourceLoader.java | 6 +- .../ui/velocity/VelocityEngineFactory.java | 10 +- .../java/org/springframework/cache/Cache.java | 4 +- .../cache/concurrent/ConcurrentMapCache.java | 6 +- .../cache/support/SimpleValueWrapper.java | 2 +- .../context/ApplicationContext.java | 12 +- .../context/ApplicationContextAware.java | 2 +- .../context/ApplicationContextException.java | 4 +- .../context/ApplicationEvent.java | 2 +- .../context/ApplicationListener.java | 2 +- .../ConfigurableApplicationContext.java | 4 +- .../context/HierarchicalMessageSource.java | 4 +- .../springframework/context/Lifecycle.java | 2 +- .../context/MessageSource.java | 10 +- .../context/MessageSourceResolvable.java | 2 +- .../context/ResourceLoaderAware.java | 10 +- .../access/ContextBeanFactoryReference.java | 4 +- .../access/ContextJndiBeanFactoryLocator.java | 6 +- .../ContextSingletonBeanFactoryLocator.java | 4 +- .../AnnotationBeanNameGenerator.java | 8 +- .../annotation/AnnotationConfigUtils.java | 2 +- .../AnnotationScopeMetadataResolver.java | 4 +- .../context/annotation/Bean.java | 2 +- .../ClassPathBeanDefinitionScanner.java | 4 +- .../CommonAnnotationBeanPostProcessor.java | 40 ++-- .../annotation/ScopeMetadataResolver.java | 8 +- .../config/ContextNamespaceHandler.java | 2 +- .../event/ApplicationContextEvent.java | 8 +- .../context/event/ContextClosedEvent.java | 6 +- .../context/event/ContextRefreshedEvent.java | 6 +- .../context/event/ContextStartedEvent.java | 6 +- .../context/event/ContextStoppedEvent.java | 6 +- .../event/EventPublicationInterceptor.java | 12 +- .../SimpleApplicationEventMulticaster.java | 2 +- .../context/expression/MapAccessor.java | 2 +- .../context/i18n/LocaleContextHolder.java | 14 +- .../context/i18n/SimpleLocaleContext.java | 4 +- .../support/AbstractApplicationContext.java | 28 +-- .../support/AbstractMessageSource.java | 18 +- ...ctRefreshableConfigApplicationContext.java | 6 +- .../AbstractXmlApplicationContext.java | 6 +- .../support/ApplicationObjectSupport.java | 4 +- .../support/ContextTypeMatchClassLoader.java | 2 +- .../DefaultMessageSourceResolvable.java | 2 +- .../support/GenericApplicationContext.java | 4 +- .../support/GenericXmlApplicationContext.java | 2 +- .../support/MessageSourceAccessor.java | 8 +- .../support/MessageSourceResourceBundle.java | 6 +- .../context/support/MessageSourceSupport.java | 8 +- ...ReloadableResourceBundleMessageSource.java | 8 +- .../support/ResourceBundleMessageSource.java | 22 +-- .../context/support/SimpleThreadScope.java | 4 +- .../weaving/DefaultContextLoadTimeWeaver.java | 6 +- .../context/weaving/LoadTimeWeaverAware.java | 4 +- .../weaving/LoadTimeWeaverAwareProcessor.java | 16 +- .../AbstractRemoteSlsbInvokerInterceptor.java | 6 +- .../AbstractSlsbInvokerInterceptor.java | 2 +- .../ejb/config/JeeNamespaceHandler.java | 2 +- .../JndiLookupBeanDefinitionParser.java | 2 +- ...lStatelessSessionBeanDefinitionParser.java | 2 +- ...eStatelessSessionBeanDefinitionParser.java | 2 +- .../SpringBeanAutowiringInterceptor.java | 18 +- .../ejb/interceptor/package-info.java | 3 +- .../ejb/support/AbstractEnterpriseBean.java | 24 +-- .../support/AbstractJmsMessageDrivenBean.java | 4 +- .../support/AbstractMessageDrivenBean.java | 16 +- .../support/AbstractStatefulSessionBean.java | 32 ++-- .../support/AbstractStatelessSessionBean.java | 16 +- .../ejb/support/package-info.java | 7 +- .../format/AnnotationFormatterFactory.java | 12 +- .../format/FormatterRegistry.java | 14 +- .../format/annotation/DateTimeFormat.java | 12 +- .../format/annotation/NumberFormat.java | 4 +- .../format/datetime/joda/JodaTimeContext.java | 4 +- .../datetime/joda/JodaTimeContextHolder.java | 6 +- .../format/datetime/package-info.java | 2 +- .../number/AbstractNumberFormatter.java | 2 +- .../format/number/package-info.java | 2 +- ...ormattingConversionServiceFactoryBean.java | 2 +- .../InstrumentationLoadTimeWeaver.java | 4 +- .../classloading/LoadTimeWeaver.java | 22 +-- .../ReflectiveLoadTimeWeaver.java | 8 +- .../SimpleInstrumentableClassLoader.java | 16 +- .../classloading/SimpleLoadTimeWeaver.java | 16 +- .../glassfish/GlassFishLoadTimeWeaver.java | 10 +- .../jboss/JBossLoadTimeWeaver.java | 4 +- .../jboss/JBossMCTranslatorAdapter.java | 2 +- .../oc4j/OC4JClassPreprocessorAdapter.java | 2 +- .../classloading/oc4j/OC4JLoadTimeWeaver.java | 2 +- .../WebLogicClassPreProcessorAdapter.java | 2 +- .../weblogic/WebLogicLoadTimeWeaver.java | 4 +- .../WebSphereClassPreDefinePlugin.java | 2 +- .../websphere/WebSphereLoadTimeWeaver.java | 4 +- .../jmx/MBeanServerNotFoundException.java | 6 +- .../jmx/access/ConnectorDelegate.java | 10 +- .../access/InvalidInvocationException.java | 2 +- .../access/InvocationFailureException.java | 4 +- .../jmx/access/MBeanClientInterceptor.java | 46 ++--- .../access/MBeanConnectFailureException.java | 2 +- .../access/MBeanInfoRetrievalException.java | 4 +- .../jmx/access/MBeanProxyFactoryBean.java | 4 +- .../access/NotificationListenerRegistrar.java | 12 +- .../jmx/export/MBeanExportException.java | 4 +- .../jmx/export/MBeanExporter.java | 142 +++++++------- .../jmx/export/MBeanExporterListener.java | 4 +- .../UnableToRegisterMBeanException.java | 4 +- .../AnnotationJmxAttributeSource.java | 2 +- .../annotation/ManagedOperationParameter.java | 4 +- .../ManagedOperationParameters.java | 2 +- .../export/annotation/ManagedResource.java | 2 +- .../assembler/AbstractMBeanInfoAssembler.java | 30 +-- .../AbstractReflectiveMBeanInfoAssembler.java | 98 +++++----- .../AutodetectCapableMBeanInfoAssembler.java | 8 +- .../InterfaceBasedMBeanInfoAssembler.java | 58 +++--- .../export/assembler/MBeanInfoAssembler.java | 2 +- .../assembler/MetadataMBeanInfoAssembler.java | 48 ++--- .../MethodExclusionMBeanInfoAssembler.java | 18 +- .../MethodNameBasedMBeanInfoAssembler.java | 16 +- .../SimpleReflectiveMBeanInfoAssembler.java | 10 +- .../metadata/InvalidMetadataException.java | 4 +- .../export/metadata/JmxAttributeSource.java | 44 ++--- .../jmx/export/metadata/ManagedResource.java | 2 +- .../export/naming/IdentityNamingStrategy.java | 6 +- .../jmx/export/naming/KeyNamingStrategy.java | 34 ++-- .../export/naming/MetadataNamingStrategy.java | 18 +- .../export/naming/ObjectNamingStrategy.java | 14 +- .../jmx/export/naming/SelfNaming.java | 4 +- .../ModelMBeanNotificationPublisher.java | 10 +- .../notification/NotificationPublisher.java | 6 +- .../support/ConnectorServerFactoryBean.java | 48 ++--- .../springframework/jmx/support/JmxUtils.java | 42 ++-- .../jmx/support/MBeanRegistrationSupport.java | 12 +- .../MBeanServerConnectionFactoryBean.java | 30 +-- .../jmx/support/MBeanServerFactoryBean.java | 56 +++--- .../support/NotificationListenerHolder.java | 14 +- .../jmx/support/ObjectNameManager.java | 32 ++-- .../WebSphereMBeanServerFactoryBean.java | 4 +- .../jmx/support/package-info.java | 5 +- .../springframework/jndi/JndiCallback.java | 2 +- .../jndi/JndiLocatorDelegate.java | 6 +- .../jndi/JndiObjectTargetSource.java | 6 +- .../springframework/jndi/JndiTemplate.java | 14 +- .../jndi/support/SimpleJndiBeanFactory.java | 2 +- .../rmi/CodebaseAwareObjectInputStream.java | 4 +- .../rmi/JndiRmiClientInterceptor.java | 2 +- .../remoting/rmi/JndiRmiProxyFactoryBean.java | 2 +- .../remoting/rmi/JndiRmiServiceExporter.java | 4 +- .../RemoteInvocationSerializingExporter.java | 4 +- .../remoting/rmi/RmiBasedExporter.java | 2 +- .../remoting/rmi/RmiClientInterceptor.java | 10 +- .../rmi/RmiClientInterceptorUtils.java | 4 +- .../remoting/rmi/RmiInvocationHandler.java | 2 +- .../remoting/rmi/RmiProxyFactoryBean.java | 4 +- .../remoting/rmi/RmiRegistryFactoryBean.java | 12 +- .../remoting/rmi/RmiServiceExporter.java | 24 +-- .../remoting/soap/SoapFaultException.java | 2 +- .../remoting/support/RemoteAccessor.java | 2 +- .../remoting/support/RemoteExporter.java | 2 +- .../remoting/support/RemoteInvocation.java | 4 +- .../RemoteInvocationBasedAccessor.java | 2 +- .../support/RemoteInvocationResult.java | 4 +- .../support/RemoteInvocationUtils.java | 6 +- .../remoting/support/RemotingSupport.java | 4 +- .../scheduling/SchedulingAwareRunnable.java | 2 +- .../scheduling/SchedulingTaskExecutor.java | 12 +- .../scheduling/TaskScheduler.java | 6 +- .../springframework/scheduling/Trigger.java | 2 +- .../scheduling/TriggerContext.java | 6 +- .../annotation/AsyncAnnotationAdvisor.java | 8 +- .../AsyncAnnotationBeanPostProcessor.java | 4 +- .../scheduling/annotation/AsyncResult.java | 4 +- .../scheduling/annotation/EnableAsync.java | 2 +- .../ConcurrentTaskExecutor.java | 2 +- .../ThreadPoolTaskExecutor.java | 10 +- .../concurrent/ConcurrentTaskExecutor.java | 4 +- .../concurrent/ConcurrentTaskScheduler.java | 2 +- .../ExecutorConfigurationSupport.java | 8 +- .../concurrent/ForkJoinPoolFactoryBean.java | 8 +- .../concurrent/ScheduledExecutorTask.java | 8 +- .../ThreadPoolExecutorFactoryBean.java | 4 +- .../concurrent/ThreadPoolTaskExecutor.java | 6 +- .../concurrent/ThreadPoolTaskScheduler.java | 2 +- .../scheduling/concurrent/package-info.java | 7 +- .../config/TaskNamespaceHandler.java | 2 +- .../scheduling/support/PeriodicTrigger.java | 2 +- .../scheduling/timer/DelegatingTimerTask.java | 6 +- .../MethodInvokingTimerTaskFactoryBean.java | 4 +- .../scheduling/timer/ScheduledTimerTask.java | 8 +- .../scheduling/timer/TimerFactoryBean.java | 6 +- .../scheduling/timer/TimerTaskExecutor.java | 6 +- .../scripting/ScriptCompilationException.java | 2 +- .../scripting/ScriptFactory.java | 18 +- .../scripting/ScriptSource.java | 4 +- .../scripting/bsh/BshScriptFactory.java | 4 +- .../scripting/bsh/BshScriptUtils.java | 12 +- .../config/LangNamespaceHandler.java | 2 +- .../config/ScriptBeanDefinitionParser.java | 16 +- .../groovy/GroovyObjectCustomizer.java | 2 +- .../scripting/groovy/GroovyScriptFactory.java | 4 +- .../scripting/jruby/JRubyScriptUtils.java | 10 +- .../RefreshableScriptTargetSource.java | 2 +- .../support/ScriptFactoryPostProcessor.java | 10 +- .../scripting/support/StaticScriptSource.java | 2 +- .../springframework/ui/ExtendedModelMap.java | 2 +- .../java/org/springframework/ui/Model.java | 22 +-- .../java/org/springframework/ui/ModelMap.java | 26 +-- .../ui/context/HierarchicalThemeSource.java | 4 +- .../org/springframework/ui/context/Theme.java | 4 +- .../ui/context/ThemeSource.java | 2 +- .../ui/context/package-info.java | 13 +- .../support/ResourceBundleThemeSource.java | 2 +- .../support/UiApplicationContextUtils.java | 2 +- .../validation/AbstractBindingResult.java | 4 +- .../AbstractPropertyBindingResult.java | 2 +- .../validation/BeanPropertyBindingResult.java | 6 +- .../validation/BindingErrorProcessor.java | 26 +-- .../validation/BindingResult.java | 12 +- .../validation/BindingResultUtils.java | 4 +- .../validation/DataBinder.java | 10 +- .../DefaultBindingErrorProcessor.java | 4 +- .../DefaultMessageCodesResolver.java | 2 +- .../springframework/validation/Errors.java | 56 +++--- .../validation/FieldError.java | 2 +- .../validation/MessageCodesResolver.java | 2 +- .../validation/ObjectError.java | 2 +- .../validation/ValidationUtils.java | 58 +++--- .../springframework/validation/Validator.java | 26 +-- .../validation/annotation/package-info.java | 2 +- .../LocalValidatorFactoryBean.java | 4 +- .../MethodValidationInterceptor.java | 2 +- .../SpringValidatorAdapter.java | 2 +- .../aop/framework/AbstractAopProxyTests.java | 2 +- .../jmx/AbstractMBeanServerTests.java | 6 +- .../mock/jndi/ExpectedLookupTemplate.java | 2 +- .../mock/jndi/SimpleNamingContext.java | 4 +- .../mock/jndi/SimpleNamingContextBuilder.java | 14 +- .../core/AttributeAccessor.java | 16 +- .../core/BridgeMethodResolver.java | 10 +- .../core/CollectionFactory.java | 8 +- .../core/ConfigurableObjectInputStream.java | 4 +- .../org/springframework/core/Constants.java | 38 ++-- .../org/springframework/core/Conventions.java | 38 ++-- .../org/springframework/core/ErrorCoded.java | 2 +- .../core/GenericCollectionTypeResolver.java | 62 +++--- .../core/GenericTypeResolver.java | 12 +- .../core/InfrastructureProxy.java | 2 +- .../org/springframework/core/JdkVersion.java | 10 +- ...lVariableTableParameterNameDiscoverer.java | 2 +- .../springframework/core/MethodParameter.java | 20 +- .../core/NestedCheckedException.java | 16 +- .../core/NestedIOException.java | 4 +- .../core/NestedRuntimeException.java | 16 +- .../springframework/core/OrderComparator.java | 6 +- .../org/springframework/core/Ordered.java | 2 +- .../core/OverridingClassLoader.java | 10 +- .../core/ParameterNameDiscoverer.java | 8 +- .../PrioritizedParameterNameDiscoverer.java | 6 +- .../core/SimpleAliasRegistry.java | 2 +- .../core/SmartClassLoader.java | 2 +- .../springframework/core/SpringVersion.java | 4 +- .../AnnotationAwareOrderComparator.java | 2 +- .../core/annotation/AnnotationUtils.java | 62 +++--- .../core/annotation/Order.java | 2 +- .../core/convert/Property.java | 8 +- .../core/convert/TypeDescriptor.java | 42 ++-- .../FallbackObjectToStringConverter.java | 2 +- .../support/GenericConversionService.java | 4 +- .../convert/support/IdToEntityConverter.java | 2 +- .../support/ObjectToObjectConverter.java | 2 +- .../enums/AbstractGenericLabeledEnum.java | 2 +- .../core/enums/LabeledEnum.java | 10 +- .../core/enums/LabeledEnumResolver.java | 10 +- .../core/enums/LetterCodedLabeledEnum.java | 4 +- .../core/enums/ShortCodedLabeledEnum.java | 4 +- .../core/enums/StaticLabeledEnum.java | 2 +- .../core/enums/StaticLabeledEnumResolver.java | 4 +- .../core/enums/StringCodedLabeledEnum.java | 4 +- .../core/env/AbstractEnvironment.java | 2 +- .../springframework/core/env/Environment.java | 2 +- .../core/io/AbstractResource.java | 8 +- .../core/io/ByteArrayResource.java | 2 +- .../core/io/ClassPathResource.java | 10 +- .../core/io/ClassRelativeResourceLoader.java | 4 +- .../core/io/DefaultResourceLoader.java | 4 +- .../core/io/DescriptiveResource.java | 2 +- .../core/io/FileSystemResource.java | 2 +- .../core/io/InputStreamResource.java | 6 +- .../core/io/InputStreamSource.java | 6 +- .../org/springframework/core/io/Resource.java | 14 +- .../core/io/ResourceEditor.java | 20 +- .../core/io/ResourceLoader.java | 2 +- .../springframework/core/io/UrlResource.java | 4 +- .../org/springframework/core/io/VfsUtils.java | 4 +- .../core/io/WritableResource.java | 4 +- .../core/io/support/EncodedResource.java | 6 +- .../io/support/LocalizedResourceHelper.java | 4 +- .../PathMatchingResourcePatternResolver.java | 68 +++---- .../io/support/PropertiesLoaderSupport.java | 2 +- .../io/support/PropertiesLoaderUtils.java | 4 +- .../support/ResourceArrayPropertyEditor.java | 10 +- .../core/io/support/ResourcePatternUtils.java | 4 +- .../support/SerializationFailedException.java | 4 +- .../core/style/DefaultToStringStyler.java | 4 +- .../core/style/DefaultValueStyler.java | 2 +- .../core/style/StylerUtils.java | 2 +- .../core/style/ToStringCreator.java | 4 +- .../core/style/ToStringStyler.java | 6 +- .../core/task/AsyncTaskExecutor.java | 10 +- .../core/task/SimpleAsyncTaskExecutor.java | 6 +- .../core/task/SyncTaskExecutor.java | 6 +- .../core/task/TaskExecutor.java | 4 +- .../core/task/TaskRejectedException.java | 6 +- .../core/task/TaskTimeoutException.java | 6 +- .../task/support/ExecutorServiceAdapter.java | 12 +- .../task/support/TaskExecutorAdapter.java | 4 +- .../core/type/AnnotationMetadata.java | 8 +- .../core/type/ClassMetadata.java | 6 +- .../core/type/MethodMetadata.java | 2 +- .../core/type/StandardClassMetadata.java | 2 +- .../core/type/StandardMethodMetadata.java | 2 +- .../classreading/MetadataReaderFactory.java | 4 +- .../classreading/SimpleMetadataReader.java | 2 +- .../type/filter/AnnotationTypeFilter.java | 4 +- .../springframework/util/AntPathMatcher.java | 50 ++--- .../java/org/springframework/util/Assert.java | 80 ++++---- .../util/AutoPopulatingList.java | 14 +- .../util/CachingMapDecorator.java | 8 +- .../org/springframework/util/ClassUtils.java | 118 ++++++------ .../springframework/util/CollectionUtils.java | 46 ++--- .../util/CommonsLogWriter.java | 2 +- .../util/ConcurrencyThrottleSupport.java | 4 +- .../util/CustomizableThreadCreator.java | 4 +- .../util/DefaultPropertiesPersister.java | 12 +- .../springframework/util/FileSystemUtils.java | 14 +- .../util/LinkedCaseInsensitiveMap.java | 2 +- .../springframework/util/Log4jConfigurer.java | 2 +- .../springframework/util/MethodInvoker.java | 10 +- .../springframework/util/MultiValueMap.java | 2 +- .../org/springframework/util/NumberUtils.java | 24 +-- .../org/springframework/util/ObjectUtils.java | 146 +++++++------- .../org/springframework/util/PathMatcher.java | 30 +-- .../util/PropertiesPersister.java | 6 +- .../util/PropertyPlaceholderHelper.java | 18 +- .../springframework/util/ReflectionUtils.java | 50 ++--- .../springframework/util/ResourceUtils.java | 24 +-- .../org/springframework/util/StopWatch.java | 4 +- .../org/springframework/util/StringUtils.java | 156 +++++++-------- .../util/SystemPropertyUtils.java | 4 +- .../util/comparator/BooleanComparator.java | 4 +- .../util/comparator/NullSafeComparator.java | 10 +- .../util/comparator/package-info.java | 3 +- .../util/xml/AbstractStaxContentHandler.java | 8 +- .../util/xml/AbstractStaxXMLReader.java | 22 +-- .../util/xml/AbstractXMLReader.java | 14 +- .../util/xml/AbstractXMLStreamReader.java | 2 +- .../util/xml/DomContentHandler.java | 4 +- .../springframework/util/xml/DomUtils.java | 30 +-- .../util/xml/SimpleNamespaceContext.java | 6 +- .../util/xml/SimpleSaxErrorHandler.java | 2 +- .../xml/SimpleTransformErrorListener.java | 2 +- .../util/xml/StaxEventContentHandler.java | 14 +- .../util/xml/StaxEventXMLReader.java | 12 +- .../springframework/util/xml/StaxResult.java | 44 ++--- .../springframework/util/xml/StaxSource.java | 44 ++--- .../util/xml/StaxStreamContentHandler.java | 6 +- .../util/xml/StaxStreamXMLReader.java | 12 +- .../springframework/util/xml/StaxUtils.java | 10 +- .../util/xml/TransformerUtils.java | 6 +- .../factory/annotation/TestAutowired.java | 2 +- ...hMatchingResourcePatternResolverTests.java | 2 +- .../util/ResourceUtilsTests.java | 2 +- .../xml/AbstractStaxXMLReaderTestCase.java | 2 +- .../expression/BeanResolver.java | 2 +- .../expression/ConstructorResolver.java | 2 +- .../expression/MethodResolver.java | 2 +- .../expression/TypedValue.java | 2 +- .../common/CompositeStringExpression.java | 2 +- .../spel/ast/OperatorInstanceof.java | 2 +- .../TomcatInstrumentableClassLoader.java | 20 +- .../InstrumentationSavingAgent.java | 4 +- .../jdbc/BadSqlGrammarException.java | 2 +- .../jdbc/InvalidResultSetAccessException.java | 2 +- .../jdbc/core/BeanPropertyRowMapper.java | 10 +- .../jdbc/core/CallableStatementCallback.java | 6 +- .../core/CallableStatementCreatorFactory.java | 4 +- .../jdbc/core/ColumnMapRowMapper.java | 4 +- .../jdbc/core/ConnectionCallback.java | 8 +- ...rruptibleBatchPreparedStatementSetter.java | 14 +- .../jdbc/core/JdbcOperations.java | 100 +++++----- .../jdbc/core/JdbcTemplate.java | 10 +- .../jdbc/core/ParameterMapper.java | 2 +- .../jdbc/core/PreparedStatementCallback.java | 10 +- .../core/PreparedStatementCreatorFactory.java | 12 +- .../jdbc/core/ResultSetExtractor.java | 2 +- .../core/ResultSetSupportingSqlParameter.java | 2 +- .../jdbc/core/RowCallbackHandler.java | 2 +- .../jdbc/core/RowCountCallbackHandler.java | 2 +- .../springframework/jdbc/core/RowMapper.java | 4 +- .../core/RowMapperResultSetExtractor.java | 2 +- .../jdbc/core/SingleColumnRowMapper.java | 28 +-- .../jdbc/core/SqlInOutParameter.java | 4 +- .../jdbc/core/SqlParameter.java | 24 +-- .../jdbc/core/SqlParameterValue.java | 8 +- .../jdbc/core/SqlProvider.java | 2 +- .../jdbc/core/SqlReturnResultSet.java | 2 +- .../jdbc/core/SqlReturnType.java | 4 +- .../jdbc/core/SqlReturnUpdateCount.java | 6 +- .../core/SqlRowSetResultSetExtractor.java | 8 +- .../jdbc/core/SqlTypeValue.java | 6 +- .../jdbc/core/StatementCallback.java | 10 +- .../jdbc/core/StatementCreatorUtils.java | 8 +- .../AbstractSqlParameterSource.java | 4 +- .../namedparam/MapSqlParameterSource.java | 8 +- .../NamedParameterJdbcOperations.java | 20 +- .../NamedParameterJdbcTemplate.java | 2 +- .../core/namedparam/NamedParameterUtils.java | 4 +- .../core/namedparam/SqlParameterSource.java | 6 +- .../namedparam/SqlParameterSourceUtils.java | 2 +- .../jdbc/core/namedparam/package-info.java | 3 +- .../jdbc/core/simple/AbstractJdbcCall.java | 8 +- .../jdbc/core/simple/AbstractJdbcInsert.java | 2 +- .../ParameterizedBeanPropertyRowMapper.java | 4 +- .../ParameterizedSingleColumnRowMapper.java | 6 +- .../jdbc/core/simple/SimpleJdbcCall.java | 4 +- .../core/simple/SimpleJdbcCallOperations.java | 6 +- .../jdbc/core/simple/SimpleJdbcInsert.java | 4 +- .../core/simple/SimpleJdbcOperations.java | 68 +++---- .../jdbc/core/simple/package-info.java | 9 +- ...rruptibleBatchPreparedStatementSetter.java | 4 +- ...tLobCreatingPreparedStatementCallback.java | 2 +- ...bstractLobStreamingResultSetExtractor.java | 6 +- .../core/support/AbstractSqlTypeValue.java | 4 +- .../support/JdbcBeanDefinitionReader.java | 2 +- .../jdbc/core/support/JdbcDaoSupport.java | 2 +- .../jdbc/core/support/package-info.java | 3 +- .../jdbc/datasource/AbstractDataSource.java | 2 +- .../AbstractDriverBasedDataSource.java | 4 +- .../jdbc/datasource/ConnectionHolder.java | 6 +- .../jdbc/datasource/ConnectionProxy.java | 2 +- .../DataSourceTransactionManager.java | 2 +- .../jdbc/datasource/DataSourceUtils.java | 10 +- .../datasource/DriverManagerDataSource.java | 4 +- .../IsolationLevelDataSourceAdapter.java | 6 +- .../datasource/SimpleDriverDataSource.java | 2 +- .../SingleConnectionDataSource.java | 12 +- .../jdbc/datasource/SmartDataSource.java | 4 +- .../TransactionAwareDataSourceProxy.java | 6 +- .../UserCredentialsDataSourceAdapter.java | 14 +- .../WebSphereDataSourceAdapter.java | 12 +- .../embedded/EmbeddedDatabaseBuilder.java | 4 +- .../embedded/EmbeddedDatabaseFactory.java | 2 +- .../lookup/AbstractRoutingDataSource.java | 4 +- .../lookup/BeanFactoryDataSourceLookup.java | 4 +- .../datasource/lookup/DataSourceLookup.java | 4 +- .../lookup/MapDataSourceLookup.java | 4 +- .../jdbc/object/BatchSqlUpdate.java | 24 +-- .../object/MappingSqlQueryWithParameters.java | 6 +- .../jdbc/object/RdbmsOperation.java | 26 +-- .../springframework/jdbc/object/SqlCall.java | 6 +- .../jdbc/object/SqlFunction.java | 14 +- .../jdbc/object/SqlOperation.java | 6 +- .../springframework/jdbc/object/SqlQuery.java | 30 +-- .../jdbc/object/SqlUpdate.java | 12 +- .../jdbc/object/StoredProcedure.java | 12 +- .../jdbc/object/UpdatableSqlQuery.java | 6 +- .../jdbc/object/package-info.java | 5 +- ...bstractFallbackSQLExceptionTranslator.java | 18 +- ...CustomSQLExceptionTranslatorRegistrar.java | 2 +- .../CustomSQLExceptionTranslatorRegistry.java | 2 +- .../jdbc/support/JdbcAccessor.java | 2 +- .../jdbc/support/JdbcUtils.java | 18 +- .../jdbc/support/KeyHolder.java | 2 +- .../SQLErrorCodeSQLExceptionTranslator.java | 6 +- .../jdbc/support/SQLErrorCodes.java | 2 +- .../jdbc/support/SQLErrorCodesFactory.java | 22 +-- .../SQLExceptionSubclassTranslator.java | 2 +- .../jdbc/support/SQLExceptionTranslator.java | 10 +- .../jdbc/support/SqlValue.java | 2 +- .../AbstractDataFieldMaxValueIncrementer.java | 2 +- .../AbstractSequenceMaxValueIncrementer.java | 2 +- .../incrementer/DerbyMaxValueIncrementer.java | 4 +- .../SqlServerMaxValueIncrementer.java | 4 +- .../SybaseAnywhereMaxValueIncrementer.java | 6 +- .../SybaseMaxValueIncrementer.java | 6 +- .../jdbc/support/lob/DefaultLobHandler.java | 24 +-- .../lob/JtaLobCreatorSynchronization.java | 4 +- .../jdbc/support/lob/LobCreator.java | 30 +-- .../jdbc/support/lob/LobCreatorUtils.java | 2 +- .../jdbc/support/lob/LobHandler.java | 64 +++---- .../jdbc/support/lob/OracleLobHandler.java | 32 ++-- .../lob/SpringLobCreatorSynchronization.java | 4 +- .../nativejdbc/C3P0NativeJdbcExtractor.java | 6 +- .../CommonsDbcpNativeJdbcExtractor.java | 6 +- .../nativejdbc/JBossNativeJdbcExtractor.java | 12 +- .../nativejdbc/Jdbc4NativeJdbcExtractor.java | 12 +- .../nativejdbc/NativeJdbcExtractor.java | 16 +- .../NativeJdbcExtractorAdapter.java | 20 +- .../OracleJdbc4NativeJdbcExtractor.java | 10 +- .../nativejdbc/SimpleNativeJdbcExtractor.java | 6 +- .../WebLogicNativeJdbcExtractor.java | 10 +- .../WebSphereNativeJdbcExtractor.java | 10 +- .../rowset/ResultSetWrappingSqlRowSet.java | 14 +- .../ResultSetWrappingSqlRowSetMetaData.java | 4 +- .../jdbc/support/rowset/SqlRowSet.java | 14 +- .../support/rowset/SqlRowSetMetaData.java | 4 +- .../jdbc/support/xml/Jdbc4SqlXmlHandler.java | 2 +- .../jdbc/support/xml/SqlXmlHandler.java | 54 +++--- .../xml/SqlXmlObjectMappingHandler.java | 8 +- .../support/xml/XmlBinaryStreamProvider.java | 6 +- .../xml/XmlCharacterStreamProvider.java | 6 +- .../jdbc/support/xml/XmlResultProvider.java | 8 +- .../org/springframework/jms/JmsException.java | 4 +- .../config/JcaListenerContainerParser.java | 2 +- .../config/JmsListenerContainerParser.java | 2 +- .../connection/CachingConnectionFactory.java | 6 +- .../connection/ConnectionFactoryUtils.java | 30 +-- .../DelegatingConnectionFactory.java | 2 +- .../jms/connection/JmsResourceHolder.java | 4 +- .../jms/connection/JmsTransactionManager.java | 4 +- .../connection/JmsTransactionManager102.java | 4 +- .../jms/connection/SessionProxy.java | 2 +- .../connection/SingleConnectionFactory.java | 12 +- .../SingleConnectionFactory102.java | 4 +- .../connection/SmartConnectionFactory.java | 2 +- ...ransactionAwareConnectionFactoryProxy.java | 2 +- ...erCredentialsConnectionFactoryAdapter.java | 22 +-- .../jms/core/BrowserCallback.java | 6 +- .../jms/core/JmsOperations.java | 46 ++--- .../springframework/jms/core/JmsTemplate.java | 32 ++-- .../jms/core/JmsTemplate102.java | 2 +- .../jms/core/MessageCreator.java | 12 +- .../jms/core/ProducerCallback.java | 6 +- .../jms/core/SessionCallback.java | 4 +- .../jms/core/support/package-info.java | 3 +- .../AbstractJmsListeningContainer.java | 8 +- .../AbstractMessageListenerContainer.java | 14 +- ...stractPollingMessageListenerContainer.java | 10 +- .../DefaultMessageListenerContainer.java | 14 +- .../DefaultMessageListenerContainer102.java | 2 +- .../listener/SessionAwareMessageListener.java | 4 +- .../SimpleMessageListenerContainer.java | 4 +- .../SimpleMessageListenerContainer102.java | 2 +- .../adapter/MessageListenerAdapter.java | 56 +++--- .../DefaultJmsActivationSpecFactory.java | 2 +- .../endpoint/JmsMessageEndpointFactory.java | 2 +- .../StandardJmsActivationSpecFactory.java | 4 +- .../remoting/JmsInvokerClientInterceptor.java | 4 +- .../remoting/JmsInvokerProxyFactoryBean.java | 4 +- .../remoting/JmsInvokerServiceExporter.java | 4 +- .../jms/support/JmsAccessor.java | 8 +- .../springframework/jms/support/JmsUtils.java | 30 +-- .../MarshallingMessageConverter.java | 8 +- .../converter/SimpleMessageConverter.java | 2 +- .../converter/SimpleMessageConverter102.java | 4 +- .../BeanFactoryDestinationResolver.java | 4 +- .../destination/DestinationResolver.java | 4 +- .../DynamicDestinationResolver.java | 2 +- .../destination/JmsDestinationAccessor.java | 2 +- .../destination/JndiDestinationResolver.java | 4 +- .../hibernate4/HibernateSystemException.java | 2 +- .../HibernateTransactionManager.java | 14 +- .../hibernate4/LocalSessionFactoryBean.java | 6 +- .../LocalSessionFactoryBuilder.java | 6 +- .../orm/hibernate4/SessionFactoryUtils.java | 8 +- .../SpringFlushSynchronization.java | 2 +- .../hibernate4/SpringJtaSessionContext.java | 2 +- .../orm/hibernate4/package-info.java | 3 +- .../support/OpenSessionInViewFilter.java | 12 +- .../support/OpenSessionInViewInterceptor.java | 24 +-- .../orm/hibernate4/support/package-info.java | 2 +- .../web/DelegatingServletInputStream.java | 4 +- .../web/DelegatingServletOutputStream.java | 4 +- .../mock/web/HeaderValueHolder.java | 2 +- .../mock/web/MockHttpServletRequest.java | 22 +-- .../mock/web/MockHttpServletResponse.java | 10 +- .../AbstractSessionFactoryBean.java | 16 +- .../orm/hibernate3/HibernateAccessor.java | 12 +- .../orm/hibernate3/HibernateCallback.java | 12 +- .../orm/hibernate3/HibernateInterceptor.java | 10 +- .../orm/hibernate3/HibernateOperations.java | 76 ++++---- .../hibernate3/HibernateSystemException.java | 2 +- .../orm/hibernate3/HibernateTemplate.java | 46 ++--- .../HibernateTransactionManager.java | 22 +-- .../LocalDataSourceConnectionProvider.java | 2 +- .../LocalJtaDataSourceConnectionProvider.java | 2 +- .../hibernate3/LocalSessionFactoryBean.java | 20 +- .../orm/hibernate3/SessionFactoryUtils.java | 54 +++--- ...tionAwareDataSourceConnectionProvider.java | 2 +- .../AnnotationSessionFactoryBean.java | 6 +- .../orm/hibernate3/package-info.java | 3 +- .../hibernate3/support/AbstractLobType.java | 2 +- .../hibernate3/support/BlobByteArrayType.java | 2 +- .../support/BlobSerializableType.java | 2 +- .../hibernate3/support/BlobStringType.java | 12 +- .../hibernate3/support/ClobStringType.java | 2 +- .../support/HibernateDaoSupport.java | 4 +- .../IdTransferringMergeEventListener.java | 8 +- .../support/OpenSessionInViewFilter.java | 14 +- .../support/OpenSessionInViewInterceptor.java | 38 ++-- .../orm/hibernate3/support/package-info.java | 3 +- .../orm/ibatis/SqlMapClientCallback.java | 10 +- .../orm/ibatis/SqlMapClientFactoryBean.java | 8 +- .../orm/ibatis/SqlMapClientTemplate.java | 6 +- .../orm/ibatis/support/package-info.java | 3 +- .../orm/jdo/DefaultJdoDialect.java | 28 +-- .../springframework/orm/jdo/JdoAccessor.java | 2 +- .../springframework/orm/jdo/JdoCallback.java | 8 +- .../springframework/orm/jdo/JdoDialect.java | 16 +- .../orm/jdo/JdoInterceptor.java | 10 +- .../orm/jdo/JdoOperations.java | 26 +-- .../orm/jdo/JdoSystemException.java | 2 +- .../springframework/orm/jdo/JdoTemplate.java | 18 +- .../orm/jdo/JdoTransactionManager.java | 6 +- .../LocalPersistenceManagerFactoryBean.java | 12 +- .../jdo/PersistenceManagerFactoryUtils.java | 26 +-- ...onAwarePersistenceManagerFactoryProxy.java | 10 +- .../orm/jdo/support/JdoDaoSupport.java | 4 +- .../OpenPersistenceManagerInViewFilter.java | 4 +- .../SpringPersistenceManagerProxyBean.java | 6 +- .../orm/jdo/support/package-info.java | 3 +- .../jpa/AbstractEntityManagerFactoryBean.java | 12 +- .../orm/jpa/DefaultJpaDialect.java | 10 +- .../orm/jpa/EntityManagerFactoryAccessor.java | 6 +- .../orm/jpa/EntityManagerFactoryInfo.java | 24 +-- .../orm/jpa/EntityManagerFactoryUtils.java | 28 +-- .../orm/jpa/EntityManagerProxy.java | 2 +- .../orm/jpa/ExtendedEntityManagerCreator.java | 30 +-- .../springframework/orm/jpa/JpaAccessor.java | 4 +- .../springframework/orm/jpa/JpaCallback.java | 20 +- .../springframework/orm/jpa/JpaDialect.java | 16 +- .../orm/jpa/JpaInterceptor.java | 12 +- .../orm/jpa/JpaOperations.java | 10 +- .../orm/jpa/JpaSystemException.java | 2 +- .../springframework/orm/jpa/JpaTemplate.java | 8 +- .../orm/jpa/JpaTransactionManager.java | 6 +- .../orm/jpa/JpaVendorAdapter.java | 4 +- ...ocalContainerEntityManagerFactoryBean.java | 40 ++-- .../jpa/LocalEntityManagerFactoryBean.java | 4 +- .../orm/jpa/SharedEntityManagerCreator.java | 4 +- .../ClassFileTransformerAdapter.java | 2 +- .../DefaultPersistenceUnitManager.java | 62 +++--- .../PersistenceUnitManager.java | 4 +- .../PersistenceUnitPostProcessor.java | 2 +- .../PersistenceUnitReader.java | 14 +- .../orm/jpa/support/JpaDaoSupport.java | 4 +- .../OpenEntityManagerInViewFilter.java | 6 +- ...ersistenceAnnotationBeanPostProcessor.java | 40 ++-- .../jpa/support/SharedEntityManagerBean.java | 2 +- .../orm/jpa/support/package-info.java | 3 +- .../jpa/vendor/AbstractJpaVendorAdapter.java | 2 +- .../orm/jpa/vendor/Database.java | 2 +- .../vendor/EclipseLinkJpaVendorAdapter.java | 2 +- .../HibernateJpaSessionFactoryBean.java | 2 +- .../jpa/vendor/HibernateJpaVendorAdapter.java | 2 +- .../orm/jpa/vendor/OpenJpaDialect.java | 12 +- .../orm/jpa/vendor/OpenJpaVendorAdapter.java | 2 +- .../jpa/vendor/TopLinkJpaVendorAdapter.java | 2 +- .../mock/jndi/ExpectedLookupTemplate.java | 2 +- .../mock/jndi/SimpleNamingContext.java | 4 +- .../mock/jndi/SimpleNamingContextBuilder.java | 14 +- ...DependencyInjectionSpringContextTests.java | 8 +- .../AbstractSingleSpringContextTests.java | 16 +- .../test/AbstractSpringContextTests.java | 10 +- ...sactionalDataSourceSpringContextTests.java | 2 +- ...stractTransactionalSpringContextTests.java | 6 +- ...ractAnnotationAwareTransactionalTests.java | 10 +- .../test/annotation/DirtiesContext.java | 4 +- .../test/annotation/IfProfileValue.java | 6 +- .../test/annotation/ProfileValueSource.java | 4 +- .../test/annotation/ProfileValueUtils.java | 22 +-- .../test/annotation/Rollback.java | 2 +- .../test/jdbc/JdbcTestUtils.java | 6 +- .../test/jpa/AbstractJpaTests.java | 4 +- .../OrmXmlOverridingShadowingClassLoader.java | 4 +- .../oxm/GenericMarshaller.java | 4 +- .../oxm/GenericUnmarshaller.java | 4 +- .../org/springframework/oxm/Marshaller.java | 10 +- .../oxm/MarshallingException.java | 4 +- .../oxm/MarshallingFailureException.java | 4 +- .../oxm/UncategorizedMappingException.java | 2 +- .../org/springframework/oxm/Unmarshaller.java | 4 +- .../oxm/UnmarshallingFailureException.java | 4 +- .../oxm/ValidationFailureException.java | 4 +- .../oxm/XmlMappingException.java | 4 +- .../oxm/castor/CastorMappingException.java | 2 +- .../oxm/castor/CastorMarshaller.java | 36 ++-- .../CastorMarshallerBeanDefinitionParser.java | 2 +- .../Jaxb2MarshallerBeanDefinitionParser.java | 2 +- .../JibxMarshallerBeanDefinitionParser.java | 4 +- .../oxm/config/OxmNamespaceHandler.java | 2 +- ...mlBeansMarshallerBeanDefinitionParser.java | 2 +- .../oxm/jaxb/Jaxb2Marshaller.java | 42 ++-- .../oxm/jibx/JibxMarshaller.java | 24 +-- .../oxm/mime/MimeContainer.java | 6 +- .../oxm/support/AbstractMarshaller.java | 168 ++++++++-------- .../oxm/support/MarshallingSource.java | 18 +- .../oxm/support/SaxResourceUtils.java | 6 +- .../oxm/xmlbeans/XmlBeansMarshaller.java | 20 +- .../oxm/xmlbeans/XmlOptionsFactoryBean.java | 8 +- .../oxm/xstream/XStreamMarshaller.java | 30 +-- .../oxm/xstream/XStreamUtils.java | 8 +- .../tiles/ComponentControllerSupport.java | 10 +- .../web/servlet/view/tiles/TilesView.java | 2 +- .../struts/ActionServletAwareProcessor.java | 2 +- .../web/struts/ContextLoaderPlugIn.java | 4 +- .../web/struts/DelegatingActionProxy.java | 60 +++--- .../web/struts/DelegatingActionUtils.java | 8 +- .../struts/DelegatingRequestProcessor.java | 74 +++---- .../DelegatingTilesRequestProcessor.java | 2 +- .../web/struts/SpringBindingActionForm.java | 8 +- .../mock/http/client/package-info.java | 4 +- .../mock/http/package-info.java | 4 +- .../mock/jndi/ExpectedLookupTemplate.java | 2 +- .../mock/jndi/SimpleNamingContext.java | 4 +- .../mock/jndi/SimpleNamingContextBuilder.java | 14 +- .../web/DelegatingServletInputStream.java | 4 +- .../web/DelegatingServletOutputStream.java | 4 +- .../mock/web/HeaderValueHolder.java | 2 +- .../mock/web/MockHttpServletRequest.java | 18 +- .../mock/web/MockHttpServletResponse.java | 10 +- .../mock/web/MockPageContext.java | 4 +- ...DependencyInjectionSpringContextTests.java | 8 +- .../AbstractSingleSpringContextTests.java | 16 +- .../test/AbstractSpringContextTests.java | 10 +- ...sactionalDataSourceSpringContextTests.java | 2 +- ...stractTransactionalSpringContextTests.java | 6 +- .../springframework/test/AssertThrows.java | 34 ++-- ...ractAnnotationAwareTransactionalTests.java | 10 +- .../test/annotation/DirtiesContext.java | 14 +- .../test/annotation/IfProfileValue.java | 14 +- .../test/annotation/ProfileValueSource.java | 4 +- .../test/annotation/ProfileValueUtils.java | 28 +-- .../test/annotation/Rollback.java | 2 +- .../test/context/ActiveProfiles.java | 4 +- .../test/context/ContextCache.java | 20 +- .../test/context/ContextConfiguration.java | 10 +- .../test/context/ContextLoader.java | 10 +- .../test/context/ContextLoaderUtils.java | 22 +-- .../context/MergedContextConfiguration.java | 18 +- .../test/context/SmartContextLoader.java | 18 +- .../test/context/TestContext.java | 30 +-- .../test/context/TestContextManager.java | 40 ++-- .../test/context/TestExecutionListener.java | 14 +- .../test/context/TestExecutionListeners.java | 26 +-- .../AbstractJUnit38SpringContextTests.java | 8 +- ...ransactionalJUnit38SpringContextTests.java | 4 +- ...TransactionalJUnit4SpringContextTests.java | 2 +- .../junit4/SpringJUnit4ClassRunner.java | 60 +++--- .../RunAfterTestClassCallbacks.java | 10 +- .../RunAfterTestMethodCallbacks.java | 12 +- .../RunBeforeTestClassCallbacks.java | 8 +- .../RunBeforeTestMethodCallbacks.java | 10 +- .../statements/SpringFailOnTimeout.java | 10 +- .../junit4/statements/SpringRepeat.java | 6 +- .../junit4/statements/package-info.java | 3 +- .../support/AbstractContextLoader.java | 32 ++-- .../AbstractDelegatingSmartContextLoader.java | 4 +- .../support/AbstractGenericContextLoader.java | 28 +-- .../AnnotationConfigContextLoader.java | 28 +-- .../AnnotationConfigContextLoaderUtils.java | 12 +- ...endencyInjectionTestExecutionListener.java | 4 +- .../DirtiesContextTestExecutionListener.java | 10 +- .../GenericPropertiesContextLoader.java | 2 +- .../support/GenericXmlContextLoader.java | 2 +- .../AbstractTestNGSpringContextTests.java | 2 +- ...TransactionalTestNGSpringContextTests.java | 2 +- .../context/transaction/AfterTransaction.java | 6 +- .../transaction/BeforeTransaction.java | 6 +- .../TransactionalTestExecutionListener.java | 20 +- .../web/AbstractGenericWebContextLoader.java | 4 +- .../web/AnnotationConfigWebContextLoader.java | 18 +- .../web/GenericXmlWebContextLoader.java | 2 +- .../web/WebMergedContextConfiguration.java | 12 +- .../test/jdbc/JdbcTestUtils.java | 2 +- .../test/jdbc/SimpleJdbcTestUtils.java | 6 +- .../test/jpa/AbstractAspectjJpaTests.java | 8 +- .../test/jpa/AbstractJpaTests.java | 4 +- .../OrmXmlOverridingShadowingClassLoader.java | 4 +- .../test/web/AbstractModelAndViewTests.java | 40 ++-- .../test/web/ModelAndViewAssert.java | 40 ++-- .../mock/web/MockPageContextTests.java | 2 +- ...dingPropertiesAndInheritedLoaderTests.java | 2 +- ...ithPropertiesExtendingPropertiesTests.java | 2 +- ...ssLevelTransactionalSpringRunnerTests.java | 2 +- ...rceSpringJUnit4ClassRunnerAppCtxTests.java | 2 +- ...ckFalseTransactionalSpringRunnerTests.java | 2 +- ...ackTrueTransactionalSpringRunnerTests.java | 2 +- ...odLevelTransactionalSpringRunnerTests.java | 4 +- ...cesSpringJUnit4ClassRunnerAppCtxTests.java | 6 +- ...sedSpringJUnit4ClassRunnerAppCtxTests.java | 4 +- .../SpringJUnit4ClassRunnerAppCtxTests.java | 4 +- ...figSpringJUnit4ClassRunnerAppCtxTests.java | 2 +- .../annotation/PojoAndStringConfig.java | 2 +- ...ustomizedGenericXmlContextLoaderTests.java | 2 +- ...mlContextLoaderResourceLocationsTests.java | 4 +- .../transaction/TransactionTestUtils.java | 18 +- ...ChainedPersistenceExceptionTranslator.java | 2 +- .../dao/support/DaoSupport.java | 2 +- .../dao/support/DataAccessUtils.java | 22 +-- ...stenceExceptionTranslationInterceptor.java | 2 +- .../PersistenceExceptionTranslator.java | 2 +- .../cci/InvalidResultSetAccessException.java | 2 +- .../connection/ConnectionFactoryUtils.java | 12 +- ...onnectionSpecConnectionFactoryAdapter.java | 14 +- .../connection/NotSupportedRecordFactory.java | 2 +- .../connection/SingleConnectionFactory.java | 4 +- ...ransactionAwareConnectionFactoryProxy.java | 10 +- .../jca/cci/core/CciTemplate.java | 10 +- .../jca/cci/core/ConnectionCallback.java | 8 +- .../jca/cci/core/InteractionCallback.java | 8 +- .../jca/cci/core/RecordCreator.java | 8 +- .../jca/cci/core/RecordExtractor.java | 2 +- .../jca/cci/core/support/CciDaoSupport.java | 2 +- .../jca/cci/core/support/package-info.java | 3 +- .../cci/object/MappingRecordOperation.java | 20 +- .../jca/cci/object/SimpleRecordOperation.java | 4 +- .../jca/cci/object/package-info.java | 5 +- .../springframework/jca/cci/package-info.java | 3 +- .../jca/context/BootstrapContextAware.java | 4 +- .../context/SpringContextResourceAdapter.java | 6 +- .../AbstractMessageEndpointFactory.java | 18 +- .../GenericMessageEndpointFactory.java | 2 +- .../jca/support/SimpleBootstrapContext.java | 8 +- .../jca/work/WorkManagerTaskExecutor.java | 10 +- .../PlatformTransactionManager.java | 6 +- .../transaction/SavepointManager.java | 4 +- .../transaction/TransactionDefinition.java | 44 ++--- .../TransactionSystemException.java | 4 +- .../AnnotationTransactionAttributeSource.java | 10 +- .../transaction/annotation/Isolation.java | 6 +- .../transaction/annotation/Propagation.java | 4 +- .../TransactionAnnotationParser.java | 4 +- .../transaction/annotation/Transactional.java | 4 +- .../AnnotationDrivenBeanDefinitionParser.java | 2 +- .../config/TxNamespaceHandler.java | 6 +- ...actFallbackTransactionAttributeSource.java | 18 +- .../DefaultTransactionAttribute.java | 2 +- .../MethodMapTransactionAttributeSource.java | 4 +- .../interceptor/NoRollbackRuleAttribute.java | 10 +- .../interceptor/RollbackRuleAttribute.java | 20 +- .../RuleBasedTransactionAttribute.java | 8 +- .../interceptor/TransactionAspectSupport.java | 32 ++-- .../interceptor/TransactionAttribute.java | 4 +- .../TransactionAttributeEditor.java | 4 +- .../TransactionAttributeSource.java | 6 +- .../TransactionAttributeSourceEditor.java | 6 +- .../TransactionAttributeSourcePointcut.java | 2 +- .../interceptor/TransactionInterceptor.java | 2 +- .../JtaAfterCompletionSynchronization.java | 4 +- .../jta/JtaTransactionManager.java | 38 ++-- .../jta/OC4JJtaTransactionManager.java | 6 +- .../jta/SpringJtaSynchronizationAdapter.java | 14 +- .../transaction/jta/TransactionFactory.java | 6 +- .../jta/WebLogicJtaTransactionManager.java | 6 +- .../jta/WebSphereUowTransactionManager.java | 12 +- .../AbstractPlatformTransactionManager.java | 100 +++++----- .../support/AbstractTransactionStatus.java | 4 +- ...kPreferringPlatformTransactionManager.java | 8 +- .../support/DefaultTransactionDefinition.java | 20 +- .../ResourceHolderSynchronization.java | 16 +- .../support/ResourceTransactionManager.java | 2 +- .../support/SimpleTransactionStatus.java | 2 +- .../support/TransactionCallback.java | 4 +- .../TransactionCallbackWithoutResult.java | 2 +- .../support/TransactionOperations.java | 2 +- .../support/TransactionSynchronization.java | 10 +- .../TransactionSynchronizationManager.java | 26 +-- .../TransactionSynchronizationUtils.java | 20 +- .../support/TransactionTemplate.java | 2 +- .../mock/jndi/ExpectedLookupTemplate.java | 2 +- .../mock/jndi/SimpleNamingContext.java | 4 +- .../mock/jndi/SimpleNamingContextBuilder.java | 14 +- ...TransactionAttributeSourceEditorTests.java | 2 +- .../org/springframework/http/MediaType.java | 34 ++-- .../springframework/http/MediaTypeEditor.java | 4 +- .../http/client/ClientHttpRequest.java | 2 +- .../http/client/ClientHttpResponse.java | 4 +- .../CommonsClientHttpRequestFactory.java | 8 +- .../http/client/package-info.java | 5 +- .../AbstractHttpMessageConverter.java | 4 +- .../ByteArrayHttpMessageConverter.java | 2 +- .../converter/StringHttpMessageConverter.java | 2 +- .../MappingJackson2HttpMessageConverter.java | 2 +- .../MappingJacksonHttpMessageConverter.java | 2 +- .../xml/MarshallingHttpMessageConverter.java | 2 +- .../springframework/http/package-info.java | 3 +- .../http/server/package-info.java | 5 +- .../caucho/HessianClientInterceptor.java | 2 +- .../remoting/caucho/HessianExporter.java | 2 +- .../AbstractHttpInvokerRequestExecutor.java | 20 +- .../HttpInvokerClientConfiguration.java | 2 +- .../jaxrpc/JaxRpcPortClientInterceptor.java | 12 +- .../jaxrpc/JaxRpcPortProxyFactoryBean.java | 2 +- .../jaxrpc/JaxRpcServicePostProcessor.java | 4 +- .../jaxrpc/JaxRpcSoapFaultException.java | 2 +- .../jaxrpc/LocalJaxRpcServiceFactory.java | 4 +- .../jaxrpc/LocalJaxRpcServiceFactoryBean.java | 2 +- .../jaxrpc/ServletEndpointSupport.java | 2 +- .../jaxws/JaxWsPortClientInterceptor.java | 2 +- .../web/HttpRequestHandler.java | 6 +- .../web/bind/EscapedErrors.java | 2 +- .../web/bind/ServletRequestDataBinder.java | 8 +- .../web/bind/ServletRequestUtils.java | 24 +-- ...sfiedServletRequestParameterException.java | 4 +- .../web/bind/WebDataBinder.java | 10 +- .../web/bind/annotation/CookieValue.java | 6 +- .../web/bind/annotation/ExceptionHandler.java | 8 +- .../web/bind/annotation/InitBinder.java | 2 +- .../web/bind/annotation/MatrixVariable.java | 8 +- .../web/bind/annotation/RequestBody.java | 6 +- .../web/bind/annotation/RequestHeader.java | 8 +- .../web/bind/annotation/RequestMapping.java | 32 ++-- .../web/bind/annotation/RequestParam.java | 8 +- .../web/bind/annotation/RequestPart.java | 6 +- .../bind/annotation/SessionAttributes.java | 4 +- .../web/bind/annotation/ValueConstants.java | 2 +- .../support/HandlerMethodResolver.java | 4 +- .../ConfigurableWebBindingInitializer.java | 10 +- .../bind/support/SessionAttributeStore.java | 4 +- .../web/bind/support/SimpleSessionStatus.java | 2 +- .../web/bind/support/WebArgumentResolver.java | 2 +- .../bind/support/WebRequestDataBinder.java | 6 +- .../client/DefaultResponseErrorHandler.java | 2 +- .../client/HttpMessageConverterExtractor.java | 2 +- .../web/client/ResponseErrorHandler.java | 4 +- .../web/client/RestOperations.java | 36 ++-- .../web/client/RestTemplate.java | 4 +- .../web/client/support/package-info.java | 3 +- .../ConfigurableWebApplicationContext.java | 2 +- .../web/context/ContextLoader.java | 14 +- .../web/context/ContextLoaderListener.java | 2 +- .../web/context/ServletConfigAware.java | 4 +- .../web/context/ServletContextAware.java | 4 +- .../web/context/WebApplicationContext.java | 4 +- .../request/FacesRequestAttributes.java | 2 +- ...g4jNestedDiagnosticContextInterceptor.java | 2 +- .../web/context/request/NativeWebRequest.java | 4 +- .../context/request/RequestAttributes.java | 8 +- .../context/request/RequestContextHolder.java | 8 +- .../request/RequestContextListener.java | 4 +- .../web/context/request/RequestScope.java | 6 +- .../request/ServletRequestAttributes.java | 2 +- .../web/context/request/SessionScope.java | 10 +- .../web/context/request/WebRequest.java | 8 +- .../request/WebRequestInterceptor.java | 4 +- ...tractRefreshableWebApplicationContext.java | 2 +- .../support/GenericWebApplicationContext.java | 4 +- .../support/HttpRequestHandlerServlet.java | 2 +- .../ServletContextParameterFactoryBean.java | 2 +- ...tContextPropertyPlaceholderConfigurer.java | 8 +- .../support/ServletContextResource.java | 14 +- ...ServletContextResourcePatternResolver.java | 4 +- .../context/support/ServletContextScope.java | 2 +- .../support/SpringBeanAutowiringSupport.java | 10 +- .../support/WebApplicationContextUtils.java | 6 +- .../support/WebApplicationObjectSupport.java | 8 +- .../web/context/support/package-info.java | 3 +- .../filter/AbstractRequestLoggingFilter.java | 36 ++-- .../web/filter/GenericFilterBean.java | 22 +-- .../web/filter/HiddenHttpMethodFilter.java | 8 +- .../web/filter/OncePerRequestFilter.java | 8 +- .../web/filter/RequestContextFilter.java | 2 +- .../web/filter/ShallowEtagHeaderFilter.java | 6 +- .../web/jsf/DecoratingNavigationHandler.java | 26 +-- .../jsf/DelegatingNavigationHandlerProxy.java | 12 +- .../DelegatingPhaseListenerMulticaster.java | 14 +- .../web/jsf/DelegatingVariableResolver.java | 14 +- .../web/jsf/FacesContextUtils.java | 8 +- ...WebApplicationContextVariableResolver.java | 8 +- .../web/jsf/el/SpringBeanFacesELResolver.java | 10 +- .../WebApplicationContextFacesELResolver.java | 8 +- .../web/method/package-info.java | 3 +- .../method/support/ModelAndViewContainer.java | 2 +- .../web/multipart/MultipartFile.java | 6 +- .../web/multipart/MultipartRequest.java | 4 +- .../web/multipart/MultipartResolver.java | 16 +- .../commons/CommonsFileUploadSupport.java | 6 +- .../commons/CommonsMultipartFile.java | 2 +- .../commons/CommonsMultipartResolver.java | 4 +- .../multipart/support/MultipartFilter.java | 10 +- .../StandardServletMultipartResolver.java | 2 +- .../web/util/ExpressionEvaluationUtils.java | 16 +- .../util/HtmlCharacterEntityReferences.java | 2 +- .../springframework/web/util/HtmlUtils.java | 2 +- .../web/util/HttpSessionMutexListener.java | 4 +- .../web/util/IntrospectorCleanupListener.java | 4 +- .../web/util/Log4jConfigListener.java | 4 +- .../web/util/Log4jWebConfigurer.java | 8 +- .../web/util/NestedServletException.java | 4 +- .../springframework/web/util/TagUtils.java | 34 ++-- .../springframework/web/util/UriTemplate.java | 38 ++-- .../springframework/web/util/UriUtils.java | 4 +- .../web/util/UrlPathHelper.java | 14 +- .../web/util/WebAppRootListener.java | 4 +- .../springframework/web/util/WebUtils.java | 78 ++++---- .../test/DelegatingServletInputStream.java | 4 +- .../test/DelegatingServletOutputStream.java | 4 +- .../mock/web/test/HeaderValueHolder.java | 2 +- .../mock/web/test/MockHttpServletRequest.java | 16 +- .../web/test/MockHttpServletResponse.java | 10 +- .../mock/web/test/MockPageContext.java | 4 +- .../web/jsf/MockFacesContext.java | 2 +- .../web/portlet/DispatcherPortlet.java | 20 +- .../web/portlet/FrameworkPortlet.java | 14 +- .../web/portlet/GenericPortletBean.java | 8 +- .../web/portlet/HandlerAdapter.java | 20 +- .../web/portlet/HandlerExceptionResolver.java | 4 +- .../web/portlet/HandlerExecutionChain.java | 4 +- .../web/portlet/HandlerInterceptor.java | 98 +++++----- .../web/portlet/HandlerMapping.java | 6 +- .../web/portlet/ModelAndView.java | 34 ++-- .../bind/PortletRequestDataBinder.java | 8 +- .../web/portlet/bind/PortletRequestUtils.java | 24 +-- .../bind/annotation/ActionMapping.java | 2 +- ...ConfigurablePortletApplicationContext.java | 2 +- .../PortletApplicationContextUtils.java | 2 +- .../context/PortletContextResource.java | 14 +- ...PortletContextResourcePatternResolver.java | 8 +- .../portlet/context/PortletContextScope.java | 2 +- .../context/PortletRequestAttributes.java | 2 +- .../portlet/context/PortletWebRequest.java | 4 +- .../AbstractHandlerExceptionResolver.java | 2 +- .../handler/AbstractHandlerMapping.java | 24 +-- .../AbstractMapBasedHandlerMapping.java | 4 +- .../handler/HandlerInterceptorAdapter.java | 2 +- .../handler/ParameterHandlerMapping.java | 2 +- .../handler/ParameterMappingInterceptor.java | 12 +- .../handler/PortletModeHandlerMapping.java | 2 +- .../PortletModeParameterHandlerMapping.java | 2 +- .../SimpleMappingExceptionResolver.java | 8 +- .../handler/SimplePortletHandlerAdapter.java | 2 +- .../handler/SimplePortletPostProcessor.java | 6 +- .../WebRequestHandlerInterceptorAdapter.java | 6 +- .../CommonsPortletMultipartResolver.java | 4 +- .../multipart/PortletMultipartResolver.java | 14 +- .../mvc/AbstractCommandController.java | 4 +- .../web/portlet/mvc/AbstractController.java | 16 +- .../portlet/mvc/AbstractFormController.java | 84 ++++---- .../mvc/AbstractWizardFormController.java | 52 ++--- .../portlet/mvc/BaseCommandController.java | 50 ++--- .../web/portlet/mvc/Controller.java | 4 +- .../mvc/ParameterizableViewController.java | 2 +- .../mvc/PortletWrappingController.java | 4 +- .../portlet/mvc/ResourceAwareController.java | 2 +- .../web/portlet/mvc/SimpleFormController.java | 88 ++++----- .../AnnotationMethodHandlerAdapter.java | 12 +- ...otationMethodHandlerExceptionResolver.java | 2 +- .../DefaultAnnotationHandlerMapping.java | 6 +- .../web/portlet/mvc/package-info.java | 7 +- .../web/portlet/util/PortletUtils.java | 28 +-- .../web/DelegatingServletOutputStream.java | 4 +- .../mock/web/HeaderValueHolder.java | 2 +- .../mock/web/MockHttpServletResponse.java | 10 +- .../servlet/view/tiles3/TilesConfigurer.java | 2 +- .../web/servlet/DispatcherServlet.java | 24 +-- .../web/servlet/FrameworkServlet.java | 28 +-- .../web/servlet/HandlerAdapter.java | 14 +- .../web/servlet/HandlerExceptionResolver.java | 4 +- .../web/servlet/HandlerExecutionChain.java | 6 +- .../web/servlet/HandlerInterceptor.java | 10 +- .../web/servlet/HandlerMapping.java | 8 +- .../web/servlet/HttpServletBean.java | 10 +- .../web/servlet/LocaleResolver.java | 10 +- .../web/servlet/ModelAndView.java | 34 ++-- .../servlet/RequestToViewNameTranslator.java | 2 +- .../web/servlet/ResourceServlet.java | 12 +- .../org/springframework/web/servlet/View.java | 4 +- .../web/servlet/ViewRendererServlet.java | 2 +- .../web/servlet/ViewResolver.java | 6 +- .../AbstractDetectingUrlHandlerMapping.java | 2 +- .../AbstractHandlerExceptionResolver.java | 8 +- .../handler/AbstractHandlerMapping.java | 26 +-- ...bstractHandlerMethodExceptionResolver.java | 4 +- .../handler/AbstractUrlHandlerMapping.java | 10 +- .../ConversionServiceExposingInterceptor.java | 2 +- .../handler/HandlerInterceptorAdapter.java | 2 +- .../SimpleMappingExceptionResolver.java | 14 +- .../handler/SimpleServletHandlerAdapter.java | 2 +- .../handler/SimpleServletPostProcessor.java | 6 +- .../handler/SimpleUrlHandlerMapping.java | 8 +- .../i18n/AcceptHeaderLocaleResolver.java | 2 +- .../servlet/i18n/CookieLocaleResolver.java | 2 +- .../web/servlet/i18n/FixedLocaleResolver.java | 2 +- .../servlet/i18n/SessionLocaleResolver.java | 6 +- .../mvc/AbstractCommandController.java | 4 +- .../web/servlet/mvc/AbstractController.java | 16 +- .../servlet/mvc/AbstractFormController.java | 48 ++--- .../mvc/AbstractUrlViewController.java | 8 +- .../mvc/AbstractWizardFormController.java | 34 ++-- .../servlet/mvc/BaseCommandController.java | 26 +-- .../mvc/CancellableFormController.java | 40 ++-- .../web/servlet/mvc/Controller.java | 16 +- .../web/servlet/mvc/LastModified.java | 6 +- .../mvc/ParameterizableViewController.java | 2 +- .../mvc/ServletForwardingController.java | 6 +- .../mvc/ServletWrappingController.java | 4 +- .../web/servlet/mvc/SimpleFormController.java | 36 ++-- .../mvc/UrlFilenameViewController.java | 18 +- .../servlet/mvc/WebContentInterceptor.java | 2 +- .../AnnotationMethodHandlerAdapter.java | 16 +- ...otationMethodHandlerExceptionResolver.java | 2 +- .../DefaultAnnotationHandlerMapping.java | 2 +- .../ResponseStatusExceptionResolver.java | 4 +- .../method/AbstractHandlerMethodAdapter.java | 2 +- .../ExtendedServletRequestDataBinder.java | 4 +- .../RequestMappingHandlerAdapter.java | 10 +- .../web/servlet/mvc/method/package-info.java | 3 +- .../AbstractUrlMethodNameResolver.java | 6 +- .../InternalPathMethodNameResolver.java | 2 +- .../mvc/multiaction/MethodNameResolver.java | 2 +- .../multiaction/MultiActionController.java | 38 ++-- .../ParameterMethodNameResolver.java | 6 +- .../PropertiesMethodNameResolver.java | 6 +- .../web/servlet/mvc/package-info.java | 7 +- .../AbstractControllerUrlHandlerMapping.java | 2 +- .../AnnotationControllerTypePredicate.java | 2 +- .../ControllerBeanNameHandlerMapping.java | 2 +- .../ControllerClassNameHandlerMapping.java | 20 +- .../DefaultHandlerExceptionResolver.java | 4 +- .../resource/ResourceHttpRequestHandler.java | 8 +- .../web/servlet/support/BindStatus.java | 20 +- .../support/JspAwareRequestContext.java | 8 +- .../web/servlet/support/JstlUtils.java | 4 +- .../web/servlet/support/RequestContext.java | 58 +++--- .../servlet/support/RequestContextUtils.java | 6 +- .../servlet/support/WebContentGenerator.java | 8 +- .../web/servlet/tags/BindTag.java | 6 +- .../web/servlet/tags/EditorAwareTag.java | 2 +- .../servlet/tags/HtmlEscapingAwareTag.java | 4 +- .../web/servlet/tags/MessageTag.java | 2 +- .../web/servlet/tags/ParamAware.java | 4 +- .../servlet/tags/RequestContextAwareTag.java | 4 +- .../web/servlet/tags/TransformTag.java | 2 +- .../web/servlet/tags/UrlTag.java | 4 +- .../tags/form/AbstractCheckedElementTag.java | 22 +-- .../form/AbstractDataBoundFormElementTag.java | 18 +- .../servlet/tags/form/AbstractFormTag.java | 14 +- .../tags/form/AbstractHtmlElementBodyTag.java | 2 +- .../tags/form/AbstractHtmlElementTag.java | 64 +++---- .../form/AbstractHtmlInputElementTag.java | 36 ++-- .../form/AbstractMultiCheckedElementTag.java | 46 ++--- .../form/AbstractSingleCheckedElementTag.java | 18 +- .../web/servlet/tags/form/ButtonTag.java | 24 +-- .../web/servlet/tags/form/CheckboxTag.java | 12 +- .../web/servlet/tags/form/CheckboxesTag.java | 4 +- .../web/servlet/tags/form/ErrorsTag.java | 32 ++-- .../web/servlet/tags/form/FormTag.java | 56 +++--- .../web/servlet/tags/form/HiddenInputTag.java | 10 +- .../web/servlet/tags/form/InputTag.java | 36 ++-- .../web/servlet/tags/form/LabelTag.java | 30 +-- .../web/servlet/tags/form/OptionTag.java | 40 ++-- .../web/servlet/tags/form/OptionWriter.java | 62 +++--- .../web/servlet/tags/form/OptionsTag.java | 40 ++-- .../servlet/tags/form/PasswordInputTag.java | 12 +- .../web/servlet/tags/form/RadioButtonTag.java | 4 +- .../servlet/tags/form/RadioButtonsTag.java | 4 +- .../web/servlet/tags/form/SelectTag.java | 64 +++---- .../tags/form/SelectedValueComparator.java | 20 +- .../web/servlet/tags/form/TagIdGenerator.java | 8 +- .../web/servlet/tags/form/TagWriter.java | 2 +- .../web/servlet/tags/form/TextareaTag.java | 14 +- .../web/servlet/tags/form/ValueFormatter.java | 6 +- .../web/servlet/tags/form/package-info.java | 3 +- .../web/servlet/tags/package-info.java | 3 +- .../servlet/theme/CookieThemeResolver.java | 2 +- .../web/servlet/theme/FixedThemeResolver.java | 2 +- .../servlet/theme/SessionThemeResolver.java | 4 +- .../web/servlet/theme/package-info.java | 13 +- .../view/AbstractCachingViewResolver.java | 6 +- .../servlet/view/AbstractUrlBasedView.java | 6 +- .../web/servlet/view/AbstractView.java | 16 +- .../view/ContentNegotiatingViewResolver.java | 4 +- .../DefaultRequestToViewNameTranslator.java | 4 +- .../servlet/view/InternalResourceView.java | 16 +- .../view/InternalResourceViewResolver.java | 4 +- .../web/servlet/view/JstlView.java | 8 +- .../web/servlet/view/RedirectView.java | 16 +- .../view/ResourceBundleViewResolver.java | 36 ++-- .../servlet/view/UrlBasedViewResolver.java | 22 +-- .../view/document/AbstractPdfView.java | 16 +- .../view/freemarker/FreeMarkerView.java | 6 +- ...AbstractJasperReportsSingleFormatView.java | 16 +- .../AbstractJasperReportsView.java | 180 +++++++++--------- .../ConfigurableJasperReportsView.java | 8 +- .../jasperreports/JasperReportsCsvView.java | 2 +- .../jasperreports/JasperReportsHtmlView.java | 2 +- .../JasperReportsMultiFormatView.java | 46 ++--- .../jasperreports/JasperReportsPdfView.java | 2 +- .../JasperReportsViewResolver.java | 10 +- .../jasperreports/JasperReportsXlsView.java | 2 +- .../servlet/view/tiles2/TilesConfigurer.java | 2 +- .../view/velocity/VelocityConfigurer.java | 4 +- .../view/velocity/VelocityLayoutView.java | 12 +- .../velocity/VelocityLayoutViewResolver.java | 4 +- .../servlet/view/velocity/VelocityView.java | 26 +-- .../view/velocity/VelocityViewResolver.java | 4 +- .../web/servlet/view/xml/MarshallingView.java | 6 +- .../servlet/view/xslt/AbstractXsltView.java | 38 ++-- .../web/servlet/view/xslt/XsltView.java | 16 +- .../servlet/view/xslt/XsltViewResolver.java | 4 +- .../web/servlet/tags/form/SelectTagTests.java | 8 +- .../web/servlet/tags/form/TestTypes.java | 2 +- 1503 files changed, 8001 insertions(+), 8060 deletions(-) diff --git a/spring-aop/src/main/java/org/springframework/aop/Advisor.java b/spring-aop/src/main/java/org/springframework/aop/Advisor.java index ff4e1745d8..8fe320c032 100644 --- a/spring-aop/src/main/java/org/springframework/aop/Advisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/Advisor.java @@ -50,7 +50,7 @@ public interface Advisor { * (for example, creating a mixin) or shared with all instances of * the advised class obtained from the same Spring bean factory. *

Note that this method is not currently used by the framework. - * Typical Advisor implementations always return true. + * Typical Advisor implementations always return {@code true}. * Use singleton/prototype bean definitions or appropriate programmatic * proxy creation to ensure that Advisors have the correct lifecycle model. * @return whether this advice is associated with a particular target instance diff --git a/spring-aop/src/main/java/org/springframework/aop/AfterReturningAdvice.java b/spring-aop/src/main/java/org/springframework/aop/AfterReturningAdvice.java index ac4b9ba227..f79397741e 100644 --- a/spring-aop/src/main/java/org/springframework/aop/AfterReturningAdvice.java +++ b/spring-aop/src/main/java/org/springframework/aop/AfterReturningAdvice.java @@ -33,7 +33,7 @@ public interface AfterReturningAdvice extends AfterAdvice { * @param returnValue the value returned by the method, if any * @param method method being invoked * @param args arguments to the method - * @param target target of the method invocation. May be null. + * @param target target of the method invocation. May be {@code null}. * @throws Throwable if this object wishes to abort the call. * Any exception thrown will be returned to the caller if it's * allowed by the method signature. Otherwise the exception diff --git a/spring-aop/src/main/java/org/springframework/aop/IntroductionAwareMethodMatcher.java b/spring-aop/src/main/java/org/springframework/aop/IntroductionAwareMethodMatcher.java index 1363960890..0ab9dd6b9b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/IntroductionAwareMethodMatcher.java +++ b/spring-aop/src/main/java/org/springframework/aop/IntroductionAwareMethodMatcher.java @@ -33,10 +33,10 @@ public interface IntroductionAwareMethodMatcher extends MethodMatcher { * instead of the 2-arg {@link #matches(java.lang.reflect.Method, Class)} method * if the caller supports the extended IntroductionAwareMethodMatcher interface. * @param method the candidate method - * @param targetClass the target class (may be null, in which case + * @param targetClass the target class (may be {@code null}, in which case * the candidate class must be taken to be the method's declaring class) - * @param hasIntroductions true if the object on whose behalf we are - * asking is the subject on one or more introductions; false otherwise + * @param hasIntroductions {@code true} if the object on whose behalf we are + * asking is the subject on one or more introductions; {@code false} otherwise * @return whether or not this method matches statically */ boolean matches(Method method, Class targetClass, boolean hasIntroductions); diff --git a/spring-aop/src/main/java/org/springframework/aop/MethodBeforeAdvice.java b/spring-aop/src/main/java/org/springframework/aop/MethodBeforeAdvice.java index 63ee9c9dff..cf3c87d2d1 100644 --- a/spring-aop/src/main/java/org/springframework/aop/MethodBeforeAdvice.java +++ b/spring-aop/src/main/java/org/springframework/aop/MethodBeforeAdvice.java @@ -33,7 +33,7 @@ public interface MethodBeforeAdvice extends BeforeAdvice { * Callback before a given method is invoked. * @param method method being invoked * @param args arguments to the method - * @param target target of the method invocation. May be null. + * @param target target of the method invocation. May be {@code null}. * @throws Throwable if this object wishes to abort the call. * Any exception thrown will be returned to the caller if it's * allowed by the method signature. Otherwise the exception diff --git a/spring-aop/src/main/java/org/springframework/aop/MethodMatcher.java b/spring-aop/src/main/java/org/springframework/aop/MethodMatcher.java index 40ebad2777..af2fb26fc1 100644 --- a/spring-aop/src/main/java/org/springframework/aop/MethodMatcher.java +++ b/spring-aop/src/main/java/org/springframework/aop/MethodMatcher.java @@ -26,15 +26,15 @@ import java.lang.reflect.Method; * also makes arguments for a particular call available, and any effects of running * previous advice applying to the joinpoint. * - *

If an implementation returns false from its {@link #isRuntime()} + *

If an implementation returns {@code false} from its {@link #isRuntime()} * method, evaluation can be performed statically, and the result will be the same * for all invocations of this method, whatever their arguments. This means that - * if the {@link #isRuntime()} method returns false, the 3-arg + * if the {@link #isRuntime()} method returns {@code false}, the 3-arg * {@link #matches(java.lang.reflect.Method, Class, Object[])} method will never be invoked. * - *

If an implementation returns true from its 2-arg + *

If an implementation returns {@code true} from its 2-arg * {@link #matches(java.lang.reflect.Method, Class)} method and its {@link #isRuntime()} method - * returns true, the 3-arg {@link #matches(java.lang.reflect.Method, Class, Object[])} + * returns {@code true}, the 3-arg {@link #matches(java.lang.reflect.Method, Class, Object[])} * method will be invoked immediately before each potential execution of the related advice, * to decide whether the advice should run. All previous advice, such as earlier interceptors * in an interceptor chain, will have run, so any state changes they have produced in @@ -49,11 +49,11 @@ public interface MethodMatcher { /** * Perform static checking whether the given method matches. If this - * returns false or if the {@link #isRuntime()} method - * returns false, no runtime check (i.e. no. + * returns {@code false} or if the {@link #isRuntime()} method + * returns {@code false}, no runtime check (i.e. no. * {@link #matches(java.lang.reflect.Method, Class, Object[])} call) will be made. * @param method the candidate method - * @param targetClass the target class (may be null, in which case + * @param targetClass the target class (may be {@code null}, in which case * the candidate class must be taken to be the method's declaring class) * @return whether or not this method matches statically */ @@ -62,7 +62,7 @@ public interface MethodMatcher { /** * Is this MethodMatcher dynamic, that is, must a final call be made on the * {@link #matches(java.lang.reflect.Method, Class, Object[])} method at - * runtime even if the 2-arg matches method returns true? + * runtime even if the 2-arg matches method returns {@code true}? *

Can be invoked when an AOP proxy is created, and need not be invoked * again before each method invocation, * @return whether or not a runtime match via the 3-arg @@ -75,12 +75,12 @@ public interface MethodMatcher { * Check whether there a runtime (dynamic) match for this method, * which must have matched statically. *

This method is invoked only if the 2-arg matches method returns - * true for the given method and target class, and if the - * {@link #isRuntime()} method returns true. Invoked + * {@code true} for the given method and target class, and if the + * {@link #isRuntime()} method returns {@code true}. Invoked * immediately before potential running of the advice, after any * advice earlier in the advice chain has run. * @param method the candidate method - * @param targetClass the target class (may be null, in which case + * @param targetClass the target class (may be {@code null}, in which case * the candidate class must be taken to be the method's declaring class) * @param args arguments to the method * @return whether there's a runtime match 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 cebbfa023c..05addda78b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/Pointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/Pointcut.java @@ -34,13 +34,13 @@ public interface Pointcut { /** * Return the ClassFilter for this pointcut. - * @return the ClassFilter (never null) + * @return the ClassFilter (never {@code null}) */ ClassFilter getClassFilter(); /** * Return the MethodMatcher for this pointcut. - * @return the MethodMatcher (never null) + * @return the MethodMatcher (never {@code null}) */ MethodMatcher getMethodMatcher(); diff --git a/spring-aop/src/main/java/org/springframework/aop/ProxyMethodInvocation.java b/spring-aop/src/main/java/org/springframework/aop/ProxyMethodInvocation.java index 00015a5d9e..e49c697f3c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/ProxyMethodInvocation.java +++ b/spring-aop/src/main/java/org/springframework/aop/ProxyMethodInvocation.java @@ -40,22 +40,22 @@ public interface ProxyMethodInvocation extends MethodInvocation { Object getProxy(); /** - * Create a clone of this object. If cloning is done before proceed() - * is invoked on this object, proceed() can be invoked once per clone + * Create a clone of this object. If cloning is done before {@code proceed()} + * is invoked on this object, {@code proceed()} can be invoked once per clone * to invoke the joinpoint (and the rest of the advice chain) more than once. * @return an invocable clone of this invocation. - * proceed() can be called once per clone. + * {@code proceed()} can be called once per clone. */ MethodInvocation invocableClone(); /** - * Create a clone of this object. If cloning is done before proceed() - * is invoked on this object, proceed() can be invoked once per clone + * Create a clone of this object. If cloning is done before {@code proceed()} + * is invoked on this object, {@code proceed()} can be invoked once per clone * to invoke the joinpoint (and the rest of the advice chain) more than once. * @param arguments the arguments that the cloned invocation is supposed to use, * overriding the original arguments * @return an invocable clone of this invocation. - * proceed() can be called once per clone. + * {@code proceed()} can be called once per clone. */ MethodInvocation invocableClone(Object[] arguments); @@ -71,14 +71,14 @@ public interface ProxyMethodInvocation extends MethodInvocation { *

Such attributes are not used within the AOP framework itself. They are * just kept as part of the invocation object, for use in special interceptors. * @param key the name of the attribute - * @param value the value of the attribute, or null to reset it + * @param value the value of the attribute, or {@code null} to reset it */ void setUserAttribute(String key, Object value); /** * Return the value of the specified user attribute. * @param key the name of the attribute - * @return the value of the attribute, or null if not set + * @return the value of the attribute, or {@code null} if not set * @see #setUserAttribute */ Object getUserAttribute(String key); diff --git a/spring-aop/src/main/java/org/springframework/aop/TargetClassAware.java b/spring-aop/src/main/java/org/springframework/aop/TargetClassAware.java index 5334ae26ff..53f308b332 100644 --- a/spring-aop/src/main/java/org/springframework/aop/TargetClassAware.java +++ b/spring-aop/src/main/java/org/springframework/aop/TargetClassAware.java @@ -32,7 +32,7 @@ public interface TargetClassAware { /** * Return the target class behind the implementing object * (typically a proxy configuration or an actual proxy). - * @return the target Class, or null if not known + * @return the target Class, or {@code null} if not known */ Class getTargetClass(); diff --git a/spring-aop/src/main/java/org/springframework/aop/TargetSource.java b/spring-aop/src/main/java/org/springframework/aop/TargetSource.java index f5be5fdb9b..bd3185952f 100644 --- a/spring-aop/src/main/java/org/springframework/aop/TargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/TargetSource.java @@ -17,16 +17,16 @@ package org.springframework.aop; /** - * A TargetSource is used to obtain the current "target" of + * A {@code TargetSource} is used to obtain the current "target" of * an AOP invocation, which will be invoked via reflection if no around * advice chooses to end the interceptor chain itself. * - *

If a TargetSource is "static", it will always return + *

If a {@code TargetSource} is "static", it will always return * the same target, allowing optimizations in the AOP framework. Dynamic * target sources can support pooling, hot swapping, etc. * *

Application developers don't usually need to work with - * TargetSources directly: this is an AOP framework interface. + * {@code TargetSources} directly: this is an AOP framework interface. * * @author Rod Johnson */ @@ -34,8 +34,8 @@ public interface TargetSource extends TargetClassAware { /** * Return the type of targets returned by this {@link TargetSource}. - *

Can return null, although certain usages of a - * TargetSource might just work with a predetermined + *

Can return {@code null}, although certain usages of a + * {@code TargetSource} might just work with a predetermined * target class. * @return the type of targets returned by this {@link TargetSource} */ @@ -46,7 +46,7 @@ public interface TargetSource extends TargetClassAware { *

In that case, there will be no need to invoke * {@link #releaseTarget(Object)}, and the AOP framework can cache * the return value of {@link #getTarget()}. - * @return true if the target is immutable + * @return {@code true} if the target is immutable * @see #getTarget */ boolean isStatic(); diff --git a/spring-aop/src/main/java/org/springframework/aop/TrueClassFilter.java b/spring-aop/src/main/java/org/springframework/aop/TrueClassFilter.java index 4cf96a3fca..b510df206f 100644 --- a/spring-aop/src/main/java/org/springframework/aop/TrueClassFilter.java +++ b/spring-aop/src/main/java/org/springframework/aop/TrueClassFilter.java @@ -40,7 +40,7 @@ class TrueClassFilter implements ClassFilter, Serializable { /** * Required to support serialization. Replaces with canonical * instance on deserialization, protecting Singleton pattern. - * Alternative to overriding equals(). + * Alternative to overriding {@code equals()}. */ private Object readResolve() { return INSTANCE; diff --git a/spring-aop/src/main/java/org/springframework/aop/TrueMethodMatcher.java b/spring-aop/src/main/java/org/springframework/aop/TrueMethodMatcher.java index 53e50f3c83..d6d67efc72 100644 --- a/spring-aop/src/main/java/org/springframework/aop/TrueMethodMatcher.java +++ b/spring-aop/src/main/java/org/springframework/aop/TrueMethodMatcher.java @@ -50,7 +50,7 @@ class TrueMethodMatcher implements MethodMatcher, Serializable { /** * Required to support serialization. Replaces with canonical * instance on deserialization, protecting Singleton pattern. - * Alternative to overriding equals(). + * Alternative to overriding {@code equals()}. */ private Object readResolve() { return INSTANCE; diff --git a/spring-aop/src/main/java/org/springframework/aop/TruePointcut.java b/spring-aop/src/main/java/org/springframework/aop/TruePointcut.java index 87365aa1ef..c286cb1809 100644 --- a/spring-aop/src/main/java/org/springframework/aop/TruePointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/TruePointcut.java @@ -44,7 +44,7 @@ class TruePointcut implements Pointcut, Serializable { /** * Required to support serialization. Replaces with canonical * instance on deserialization, protecting Singleton pattern. - * Alternative to overriding equals(). + * Alternative to overriding {@code equals()}. */ private Object readResolve() { return INSTANCE; diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AbstractAspectJAdvice.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AbstractAspectJAdvice.java index 734f4befb6..515358c3e3 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AbstractAspectJAdvice.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AbstractAspectJAdvice.java @@ -347,8 +347,8 @@ public abstract class AbstractAspectJAdvice implements Advice, AspectJPrecedence * on subsequent advice invocations can be as fast as possible. *

If the first argument is of type JoinPoint or ProceedingJoinPoint then we * pass a JoinPoint in that position (ProceedingJoinPoint for around advice). - *

If the first argument is of type JoinPoint.StaticPart - * then we pass a JoinPoint.StaticPart in that position. + *

If the first argument is of type {@code JoinPoint.StaticPart} + * then we pass a {@code JoinPoint.StaticPart} in that position. *

Remaining arguments have to be bound by pointcut evaluation at * a given join point. We will get back a map from argument name to * value. We need to calculate which advice parameter needs to be bound diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectInstanceFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectInstanceFactory.java index 0794a3fe1b..3c16911977 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectInstanceFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectInstanceFactory.java @@ -34,13 +34,13 @@ public interface AspectInstanceFactory extends Ordered { /** * Create an instance of this factory's aspect. - * @return the aspect instance (never null) + * @return the aspect instance (never {@code null}) */ Object getAspectInstance(); /** * Expose the aspect class loader that this factory uses. - * @return the aspect class loader (never null) + * @return the aspect class loader (never {@code null}) */ ClassLoader getAspectClassLoader(); diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAdviceParameterNameDiscoverer.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAdviceParameterNameDiscoverer.java index 7a9dba9612..66a04dc022 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAdviceParameterNameDiscoverer.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAdviceParameterNameDiscoverer.java @@ -36,82 +36,82 @@ import org.springframework.util.StringUtils; /** * {@link ParameterNameDiscoverer} implementation that tries to deduce parameter names * for an advice method from the pointcut expression, returning, and throwing clauses. - * If an unambiguous interpretation is not available, it returns null. + * If an unambiguous interpretation is not available, it returns {@code null}. * *

This class interprets arguments in the following way: *

    *
  1. If the first parameter of the method is of type {@link JoinPoint} * or {@link ProceedingJoinPoint}, it is assumed to be for passing - * thisJoinPoint to the advice, and the parameter name will - * be assigned the value "thisJoinPoint".
  2. + * {@code thisJoinPoint} to the advice, and the parameter name will + * be assigned the value {@code "thisJoinPoint"}. *
  3. If the first parameter of the method is of type - * JoinPoint.StaticPart, it is assumed to be for passing - * "thisJoinPointStaticPart" to the advice, and the parameter name - * will be assigned the value "thisJoinPointStaticPart".
  4. + * {@code JoinPoint.StaticPart}, it is assumed to be for passing + * {@code "thisJoinPointStaticPart"} to the advice, and the parameter name + * will be assigned the value {@code "thisJoinPointStaticPart"}. *
  5. If a {@link #setThrowingName(String) throwingName} has been set, and - * there are no unbound arguments of type Throwable+, then an + * there are no unbound arguments of type {@code Throwable+}, then an * {@link IllegalArgumentException} is raised. If there is more than one - * unbound argument of type Throwable+, then an + * unbound argument of type {@code Throwable+}, then an * {@link AmbiguousBindingException} is raised. If there is exactly one - * unbound argument of type Throwable+, then the corresponding + * unbound argument of type {@code Throwable+}, then the corresponding * parameter name is assigned the value <throwingName>.
  6. *
  7. If there remain unbound arguments, then the pointcut expression is - * examined. Let a be the number of annotation-based pointcut + * examined. Let {@code a} be the number of annotation-based pointcut * expressions (@annotation, @this, @target, @args, * @within, @withincode) that are used in binding form. Usage in * binding form has itself to be deduced: if the expression inside the * pointcut is a single string literal that meets Java variable name - * conventions it is assumed to be a variable name. If a is - * zero we proceed to the next stage. If a > 1 then an - * AmbiguousBindingException is raised. If a == 1, - * and there are no unbound arguments of type Annotation+, - * then an IllegalArgumentException is raised. if there is + * conventions it is assumed to be a variable name. If {@code a} is + * zero we proceed to the next stage. If {@code a} > 1 then an + * {@code AmbiguousBindingException} is raised. If {@code a} == 1, + * and there are no unbound arguments of type {@code Annotation+}, + * then an {@code IllegalArgumentException} is raised. if there is * exactly one such argument, then the corresponding parameter name is * assigned the value from the pointcut expression.
  8. *
  9. If a returningName has been set, and there are no unbound arguments - * then an IllegalArgumentException is raised. If there is + * then an {@code IllegalArgumentException} is raised. If there is * more than one unbound argument then an - * AmbiguousBindingException is raised. If there is exactly + * {@code AmbiguousBindingException} is raised. If there is exactly * one unbound argument then the corresponding parameter name is assigned * the value <returningName>.
  10. *
  11. If there remain unbound arguments, then the pointcut expression is - * examined once more for this, target, and - * args pointcut expressions used in the binding form (binding + * examined once more for {@code this}, {@code target}, and + * {@code args} pointcut expressions used in the binding form (binding * forms are deduced as described for the annotation based pointcuts). If * there remains more than one unbound argument of a primitive type (which - * can only be bound in args) then an - * AmbiguousBindingException is raised. If there is exactly - * one argument of a primitive type, then if exactly one args + * can only be bound in {@code args}) then an + * {@code AmbiguousBindingException} is raised. If there is exactly + * one argument of a primitive type, then if exactly one {@code args} * bound variable was found, we assign the corresponding parameter name - * the variable name. If there were no args bound variables - * found an IllegalStateException is raised. If there are - * multiple args bound variables, an - * AmbiguousBindingException is raised. At this point, if + * the variable name. If there were no {@code args} bound variables + * found an {@code IllegalStateException} is raised. If there are + * multiple {@code args} bound variables, an + * {@code AmbiguousBindingException} is raised. At this point, if * there remains more than one unbound argument we raise an - * AmbiguousBindingException. If there are no unbound arguments + * {@code AmbiguousBindingException}. If there are no unbound arguments * remaining, we are done. If there is exactly one unbound argument * remaining, and only one candidate variable name unbound from - * this, target, or args, it is + * {@code this}, {@code target}, or {@code args}, it is * assigned as the corresponding parameter name. If there are multiple - * possibilities, an AmbiguousBindingException is raised.
  12. + * possibilities, an {@code AmbiguousBindingException} is raised. *
* - *

The behavior on raising an IllegalArgumentException or - * AmbiguousBindingException is configurable to allow this discoverer + *

The behavior on raising an {@code IllegalArgumentException} or + * {@code AmbiguousBindingException} is configurable to allow this discoverer * to be used as part of a chain-of-responsibility. By default the condition will - * be logged and the getParameterNames(..) method will simply return - * null. If the {@link #setRaiseExceptions(boolean) raiseExceptions} - * property is set to true, the conditions will be thrown as - * IllegalArgumentException and AmbiguousBindingException, + * be logged and the {@code getParameterNames(..)} method will simply return + * {@code null}. If the {@link #setRaiseExceptions(boolean) raiseExceptions} + * property is set to {@code true}, the conditions will be thrown as + * {@code IllegalArgumentException} and {@code AmbiguousBindingException}, * respectively. * *

Was that perfectly clear? ;) * *

Short version: If an unambiguous binding can be deduced, then it is. - * If the advice requirements cannot possibly be satisfied, then null + * If the advice requirements cannot possibly be satisfied, then {@code null} * is returned. By setting the {@link #setRaiseExceptions(boolean) raiseExceptions} - * property to true, descriptive exceptions will be thrown instead of - * returning null in the case that the parameter names cannot be discovered. + * property to {@code true}, descriptive exceptions will be thrown instead of + * returning {@code null} in the case that the parameter names cannot be discovered. * * @author Adrian Colyer * @since 2.0 @@ -191,14 +191,14 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov /** * Indicate whether {@link IllegalArgumentException} and {@link AmbiguousBindingException} * must be thrown as appropriate in the case of failing to deduce advice parameter names. - * @param raiseExceptions true if exceptions are to be thrown + * @param raiseExceptions {@code true} if exceptions are to be thrown */ public void setRaiseExceptions(boolean raiseExceptions) { this.raiseExceptions = raiseExceptions; } /** - * If afterReturning advice binds the return value, the + * If {@code afterReturning} advice binds the return value, the * returning variable name must be specified. * @param returningName the name of the returning variable */ @@ -207,7 +207,7 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov } /** - * If afterThrowing advice binds the thrown value, the + * If {@code afterThrowing} advice binds the thrown value, the * throwing variable name must be specified. * @param throwingName the name of the throwing variable */ @@ -305,9 +305,9 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov /** * An advice method can never be a constructor in Spring. - * @return null + * @return {@code null} * @throws UnsupportedOperationException if - * {@link #setRaiseExceptions(boolean) raiseExceptions} has been set to true + * {@link #setRaiseExceptions(boolean) raiseExceptions} has been set to {@code true} */ public String[] getParameterNames(Constructor ctor) { if (this.raiseExceptions) { @@ -493,7 +493,7 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov } /** - * Given an args pointcut body (could be args or at_args), + * Given an args pointcut body (could be {@code args} or {@code at_args}), * add any candidate variable names to the given list. */ private void maybeExtractVariableNamesFromArgs(String argsSpec, List varNames) { @@ -726,7 +726,7 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov } /* - * Return true if the given argument type is a subclass + * Return {@code true} if the given argument type is a subclass * of the given supertype. */ private boolean isSubtypeOf(Class supertype, int argumentNumber) { @@ -755,7 +755,7 @@ public class AspectJAdviceParameterNameDiscoverer implements ParameterNameDiscov /* * Find the argument index with the given type, and bind the given - * varName in that position. + * {@code varName} in that position. */ private void findAndBind(Class argumentType, String varName) { for (int i = 0; i < this.argumentTypes.length; i++) { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAopUtils.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAopUtils.java index d8fe47d3e6..16308507e1 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAopUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJAopUtils.java @@ -32,7 +32,7 @@ import org.springframework.aop.BeforeAdvice; public abstract class AspectJAopUtils { /** - * Return true if the advisor is a form of before advice. + * Return {@code true} if the advisor is a form of before advice. */ public static boolean isBeforeAdvice(Advisor anAdvisor) { AspectJPrecedenceInformation precedenceInfo = getAspectJPrecedenceInformationFor(anAdvisor); @@ -43,7 +43,7 @@ public abstract class AspectJAopUtils { } /** - * Return true if the advisor is a form of after advice. + * Return {@code true} if the advisor is a form of after advice. */ public static boolean isAfterAdvice(Advisor anAdvisor) { AspectJPrecedenceInformation precedenceInfo = getAspectJPrecedenceInformationFor(anAdvisor); @@ -56,7 +56,7 @@ public abstract class AspectJAopUtils { /** * Return the AspectJPrecedenceInformation provided by this advisor or its advice. * If neither the advisor nor the advice have precedence information, this method - * will return null. + * will return {@code null}. */ public static AspectJPrecedenceInformation getAspectJPrecedenceInformationFor(Advisor anAdvisor) { if (anAdvisor instanceof AspectJPrecedenceInformation) { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJExpressionPointcut.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJExpressionPointcut.java index f3334ea569..470ed686f3 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJExpressionPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJExpressionPointcut.java @@ -223,9 +223,9 @@ public class AspectJExpressionPointcut extends AbstractExpressionPointcut /** * If a pointcut expression has been specified in XML, the user cannot - * write and as "&&" (though && will work). - * We also allow and between two pointcut sub-expressions. - *

This method converts back to && for the AspectJ pointcut parser. + * write {@code and} as "&&" (though && will work). + * We also allow {@code and} between two pointcut sub-expressions. + *

This method converts back to {@code &&} for the AspectJ pointcut parser. */ private String replaceBooleanOperators(String pcExpr) { String result = StringUtils.replace(pcExpr, " and ", " && "); @@ -494,10 +494,10 @@ public class AspectJExpressionPointcut extends AbstractExpressionPointcut /** - * Handler for the Spring-specific bean() pointcut designator + * Handler for the Spring-specific {@code bean()} pointcut designator * extension to AspectJ. *

This handler must be added to each pointcut object that needs to - * handle the bean() PCD. Matching context is obtained + * handle the {@code bean()} PCD. Matching context is obtained * automatically by examining a thread local variable and therefore a matching * context need not be set on the pointcut. */ diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJProxyUtils.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJProxyUtils.java index 8b39665a05..8d80da138c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJProxyUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJProxyUtils.java @@ -37,7 +37,7 @@ public abstract class AspectJProxyUtils { * and make available the current AspectJ JoinPoint. The call will have no effect if there are no * AspectJ advisors in the advisor chain. * @param advisors Advisors available - * @return true if any special {@link Advisor Advisors} were added, otherwise false. + * @return {@code true} if any special {@link Advisor Advisors} were added, otherwise {@code false}. */ public static boolean makeAdvisorChainAspectJCapableIfNecessary(List advisors) { // Don't add advisors to an empty list; may indicate that proxying is just not required diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJWeaverMessageHandler.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJWeaverMessageHandler.java index 5732ae1451..c8329e413a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJWeaverMessageHandler.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/AspectJWeaverMessageHandler.java @@ -33,7 +33,7 @@ import org.aspectj.bridge.IMessageHandler; *

-XmessageHandlerClass:org.springframework.aop.aspectj.AspectJWeaverMessageHandler * *

to the weaver; for example, specifying the following in a - * "META-INF/aop.xml file: + * "{@code META-INF/aop.xml} file: * *

<weaver options="..."/> * diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/MethodInvocationProceedingJoinPoint.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/MethodInvocationProceedingJoinPoint.java index b718359ff9..a2e8a6a64c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/MethodInvocationProceedingJoinPoint.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/MethodInvocationProceedingJoinPoint.java @@ -34,11 +34,11 @@ import org.springframework.util.Assert; * Implementation of AspectJ ProceedingJoinPoint interface * wrapping an AOP Alliance MethodInvocation. * - *

Note: the getThis() method returns the current Spring AOP proxy. - * The getTarget() method returns the current Spring AOP target (which may be - * null if there is no target), and is a plain POJO without any advice. + *

Note: the {@code getThis()} method returns the current Spring AOP proxy. + * The {@code getTarget()} method returns the current Spring AOP target (which may be + * {@code null} if there is no target), and is a plain POJO without any advice. * If you want to call the object and have the advice take effect, use - * getThis(). A common example is casting the object to an + * {@code getThis()}. A common example is casting the object to an * introduced interface in the implementation of an introduction. * *

Of course there is no such distinction between target and proxy in AspectJ. @@ -92,14 +92,14 @@ public class MethodInvocationProceedingJoinPoint implements ProceedingJoinPoint, } /** - * Returns the Spring AOP proxy. Cannot be null. + * Returns the Spring AOP proxy. Cannot be {@code null}. */ public Object getThis() { return this.methodInvocation.getProxy(); } /** - * Returns the Spring AOP target. May be null if there is no target. + * Returns the Spring AOP target. May be {@code null} if there is no target. */ public Object getTarget() { return this.methodInvocation.getThis(); diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/RuntimeTestWalker.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/RuntimeTestWalker.java index 208c65cb82..4cc0b44f74 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/RuntimeTestWalker.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/RuntimeTestWalker.java @@ -44,7 +44,7 @@ import org.springframework.util.ReflectionUtils; *

It relies on implementation specific knowledge in AspectJ to break * encapsulation and do something AspectJ was not designed to do: query * the types of runtime tests that will be performed. The code here should - * migrate to ShadowMatch.getVariablesInvolvedInRuntimeTest() + * migrate to {@code ShadowMatch.getVariablesInvolvedInRuntimeTest()} * or some similar operation. * *

See . diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/SimpleAspectInstanceFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/SimpleAspectInstanceFactory.java index 8c0f70fe98..3316e76582 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/SimpleAspectInstanceFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/SimpleAspectInstanceFactory.java @@ -42,7 +42,7 @@ public class SimpleAspectInstanceFactory implements AspectInstanceFactory { } /** - * Return the specified aspect class (never null). + * Return the specified aspect class (never {@code null}). */ public final Class getAspectClass() { return this.aspectClass; @@ -81,7 +81,7 @@ public class SimpleAspectInstanceFactory implements AspectInstanceFactory { * Determine a fallback order for the case that the aspect instance * does not express an instance-specific order through implementing * the {@link org.springframework.core.Ordered} interface. - *

The default implementation simply returns Ordered.LOWEST_PRECEDENCE. + *

The default implementation simply returns {@code Ordered.LOWEST_PRECEDENCE}. * @param aspectClass the aspect class */ protected int getOrderForAspectClass(Class aspectClass) { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/SingletonAspectInstanceFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/SingletonAspectInstanceFactory.java index c50b359452..58173805d7 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/SingletonAspectInstanceFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/SingletonAspectInstanceFactory.java @@ -71,7 +71,7 @@ public class SingletonAspectInstanceFactory implements AspectInstanceFactory { * Determine a fallback order for the case that the aspect instance * does not express an instance-specific order through implementing * the {@link org.springframework.core.Ordered} interface. - *

The default implementation simply returns Ordered.LOWEST_PRECEDENCE. + *

The default implementation simply returns {@code Ordered.LOWEST_PRECEDENCE}. * @param aspectClass the aspect class */ protected int getOrderForAspectClass(Class aspectClass) { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/TypePatternClassFilter.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/TypePatternClassFilter.java index e6fa6f0dd7..1ae00d2421 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/TypePatternClassFilter.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/TypePatternClassFilter.java @@ -50,7 +50,7 @@ public class TypePatternClassFilter implements ClassFilter { * Create a fully configured {@link TypePatternClassFilter} using the * given type pattern. * @param typePattern the type pattern that AspectJ weaver should parse - * @throws IllegalArgumentException if the supplied typePattern is null + * @throws IllegalArgumentException if the supplied {@code typePattern} is {@code null} * or is recognized as invalid */ public TypePatternClassFilter(String typePattern) { @@ -68,11 +68,11 @@ public class TypePatternClassFilter implements ClassFilter { * * org.springframework.beans.ITestBean+ * - * This will match the ITestBean interface and any class + * This will match the {@code ITestBean} interface and any class * that implements it. *

These conventions are established by AspectJ, not Spring AOP. * @param typePattern the type pattern that AspectJ weaver should parse - * @throws IllegalArgumentException if the supplied typePattern is null + * @throws IllegalArgumentException if the supplied {@code typePattern} is {@code null} * or is recognized as invalid */ public void setTypePattern(String typePattern) { @@ -102,9 +102,9 @@ public class TypePatternClassFilter implements ClassFilter { /** * If a type pattern has been specified in XML, the user cannot - * write and as "&&" (though && will work). - * We also allow and between two sub-expressions. - *

This method converts back to && for the AspectJ pointcut parser. + * write {@code and} as "&&" (though && will work). + * We also allow {@code and} between two sub-expressions. + *

This method converts back to {@code &&} for the AspectJ pointcut parser. */ private String replaceBooleanOperators(String pcExpr) { pcExpr = StringUtils.replace(pcExpr," and "," && "); 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 d19a5d7c67..a871be26d3 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 @@ public class AnnotationAwareAspectJAutoProxyCreator extends AspectJAwareAdvisorA /** * Check whether the given aspect bean is eligible for auto-proxying. *

If no <aop:include> elements were used then "includePatterns" will be - * null and all beans are included. If "includePatterns" is non-null, + * {@code null} and all beans are included. If "includePatterns" is non-null, * then one of the patterns must match. */ protected boolean isEligibleAspectBean(String beanName) { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJAdvisorFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJAdvisorFactory.java index d6141af1ab..a85a138ca2 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJAdvisorFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJAdvisorFactory.java @@ -40,7 +40,7 @@ public interface AspectJAdvisorFactory { /** * Determine whether or not the given class is an aspect, as reported * by AspectJ's {@link org.aspectj.lang.reflect.AjTypeSystem}. - *

Will simply return false if the supposed aspect is + *

Will simply return {@code false} if the supposed aspect is * invalid (such as an extension of a concrete aspect class). * Will return true for some aspects that Spring AOP cannot process, * such as those with unsupported instantiation models. @@ -75,7 +75,7 @@ public interface AspectJAdvisorFactory { * @param aif the aspect instance factory * @param declarationOrderInAspect the declaration order within the aspect * @param aspectName the name of the aspect - * @return null if the method is not an AspectJ advice method + * @return {@code null} if the method is not an AspectJ advice method * or if it is a pointcut that will be used by other advice but will not * create a Spring advice in its own right */ @@ -89,7 +89,7 @@ public interface AspectJAdvisorFactory { * @param aif the aspect instance factory * @param declarationOrderInAspect the declaration order within the aspect * @param aspectName the name of the aspect - * @return null if the method is not an AspectJ advice method + * @return {@code null} if the method is not an AspectJ advice method * or if it is a pointcut that will be used by other advice but will not * create a Spring advice in its own right * @see org.springframework.aop.aspectj.AspectJAroundAdvice diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java index cbe06d3c27..f7a264eb37 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java @@ -72,7 +72,7 @@ public class AspectJProxyFactory extends ProxyCreatorSupport { } /** - * Create a new AspectJProxyFactory. + * Create a new {@code AspectJProxyFactory}. * No target, only interfaces. Must add interceptors. */ public AspectJProxyFactory(Class[] interfaces) { 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 9125cbee2a..3aefe815c9 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 @@ -109,7 +109,7 @@ public class AspectMetadata { } /** - * Extract contents from String of form pertarget(contents). + * Extract contents from String of form {@code pertarget(contents)}. */ private String findPerClause(Class aspectClass) { // TODO when AspectJ provides this, we can remove this hack. Hence we don't @@ -144,7 +144,7 @@ public class AspectMetadata { /** * Return a Spring pointcut expression for a singleton aspect. - * (e.g. Pointcut.TRUE if it's a singleton). + * (e.g. {@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/aspectj/annotation/InstantiationModelAwarePointcutAdvisorImpl.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/InstantiationModelAwarePointcutAdvisorImpl.java index 071468141c..bf1856b6a4 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/InstantiationModelAwarePointcutAdvisorImpl.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/InstantiationModelAwarePointcutAdvisorImpl.java @@ -103,7 +103,7 @@ class InstantiationModelAwarePointcutAdvisorImpl /** * This is only of interest for Spring AOP: AspectJ instantiation semantics - * are much richer. In AspectJ terminology, all a return of true + * are much richer. In AspectJ terminology, all a return of {@code true} * means here is that the aspect is not a SINGLETON. */ public boolean isPerInstance() { diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java index 35ade227ce..f8d684bc3b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/ReflectiveAspectJAdvisorFactory.java @@ -144,7 +144,7 @@ public class ReflectiveAspectJAdvisorFactory extends AbstractAspectJAdvisorFacto * for the given introduction field. *

Resulting Advisors will need to be evaluated for targets. * @param introductionField the field to introspect - * @return null if not an Advisor + * @return {@code null} if not an Advisor */ private Advisor getDeclareParentsAdvisor(Field introductionField) { DeclareParents declareParents = introductionField.getAnnotation(DeclareParents.class); diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SimpleMetadataAwareAspectInstanceFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SimpleMetadataAwareAspectInstanceFactory.java index 33d19a8811..5bea20f88f 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SimpleMetadataAwareAspectInstanceFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SimpleMetadataAwareAspectInstanceFactory.java @@ -53,7 +53,7 @@ public class SimpleMetadataAwareAspectInstanceFactory extends SimpleAspectInstan * Determine a fallback order for the case that the aspect instance * does not express an instance-specific order through implementing * the {@link org.springframework.core.Ordered} interface. - *

The default implementation simply returns Ordered.LOWEST_PRECEDENCE. + *

The default implementation simply returns {@code Ordered.LOWEST_PRECEDENCE}. * @param aspectClass the aspect class */ @Override diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SingletonMetadataAwareAspectInstanceFactory.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SingletonMetadataAwareAspectInstanceFactory.java index aa279de07c..8478f7390d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SingletonMetadataAwareAspectInstanceFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/SingletonMetadataAwareAspectInstanceFactory.java @@ -54,7 +54,7 @@ public class SingletonMetadataAwareAspectInstanceFactory extends SingletonAspect /** * Check whether the aspect class carries an * {@link org.springframework.core.annotation.Order} annotation, - * falling back to Ordered.LOWEST_PRECEDENCE. + * falling back to {@code Ordered.LOWEST_PRECEDENCE}. * @see org.springframework.core.annotation.Order */ @Override diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparator.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparator.java index 8d21b47b5e..d05e67b5da 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparator.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparator.java @@ -27,15 +27,15 @@ import org.springframework.util.Assert; /** * Orders AspectJ advice/advisors by precedence (not invocation order). * - *

Given two pieces of advice, a and b: + *

Given two pieces of advice, {@code a} and {@code b}: *

diff --git a/spring-aop/src/main/java/org/springframework/aop/aspectj/package-info.java b/spring-aop/src/main/java/org/springframework/aop/aspectj/package-info.java index 6dc2fdb0c0..99d336b05a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/aspectj/package-info.java +++ b/spring-aop/src/main/java/org/springframework/aop/aspectj/package-info.java @@ -1,4 +1,3 @@ - /** * * AspectJ integration package. Includes Spring AOP advice implementations for AspectJ 5 @@ -6,7 +5,7 @@ * implementation that allows use of the AspectJ pointcut expression language with the Spring AOP * runtime framework. * - *

Note that use of this package does not require the use of the ajc compiler + *

Note that use of this package does not require the use of the {@code ajc} compiler * or AspectJ load-time weaver. It is intended to enable the use of a valuable subset of AspectJ * functionality, with consistent semantics, with the proxy-based Spring AOP framework. * diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AbstractInterceptorDrivenBeanDefinitionDecorator.java b/spring-aop/src/main/java/org/springframework/aop/config/AbstractInterceptorDrivenBeanDefinitionDecorator.java index 173148c5ca..e8decbf469 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/AbstractInterceptorDrivenBeanDefinitionDecorator.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/AbstractInterceptorDrivenBeanDefinitionDecorator.java @@ -40,7 +40,7 @@ import org.springframework.util.StringUtils; * to the resulting bean. * *

This base class controls the creation of the {@link ProxyFactoryBean} bean definition - * and wraps the original as an inner-bean definition for the target property + * and wraps the original as an inner-bean definition for the {@code target} property * of {@link ProxyFactoryBean}. * *

Chaining is correctly handled, ensuring that only one {@link ProxyFactoryBean} definition @@ -48,7 +48,7 @@ import org.springframework.util.StringUtils; * already created the {@link org.springframework.aop.framework.ProxyFactoryBean} then the * interceptor is simply added to the existing definition. * - *

Subclasses have only to create the BeanDefinition to the interceptor that + *

Subclasses have only to create the {@code BeanDefinition} to the interceptor that * they wish to add. * * @author Rob Harrop @@ -118,7 +118,7 @@ public abstract class AbstractInterceptorDrivenBeanDefinitionDecorator implement } /** - * Subclasses should implement this method to return the BeanDefinition + * Subclasses should implement this method to return the {@code BeanDefinition} * for the interceptor they wish to apply to the bean being decorated. */ protected abstract BeanDefinition createInterceptorDefinition(Node node); diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AdvisorComponentDefinition.java b/spring-aop/src/main/java/org/springframework/aop/config/AdvisorComponentDefinition.java index 36eda24329..b28e6d3e03 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/AdvisorComponentDefinition.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/AdvisorComponentDefinition.java @@ -25,7 +25,7 @@ import org.springframework.util.Assert; /** * {@link org.springframework.beans.factory.parsing.ComponentDefinition} * that bridges the gap between the advisor bean definition configured - * by the <aop:advisor> tag and the component definition + * by the {@code <aop:advisor>} tag and the component definition * infrastructure. * * @author Rob Harrop diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AopConfigUtils.java b/spring-aop/src/main/java/org/springframework/aop/config/AopConfigUtils.java index d3f28a464f..6d97412f9d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/AopConfigUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/AopConfigUtils.java @@ -34,7 +34,7 @@ import org.springframework.util.Assert; *

Only a single auto-proxy creator can be registered yet multiple concrete * implementations are available. Therefore this class wraps a simple escalation * protocol, allowing classes to request a particular auto-proxy creator and know - * that class, or a subclass thereof, will eventually be resident + * that class, {@code or a subclass thereof}, will eventually be resident * in the application context. * * @author Rob Harrop diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceHandler.java b/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceHandler.java index 9f0dc56d03..b250bf747e 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceHandler.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceHandler.java @@ -21,21 +21,21 @@ import org.springframework.beans.factory.xml.BeanDefinitionParser; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** - * NamespaceHandler for the aop namespace. + * {@code NamespaceHandler} for the {@code aop} namespace. * *

Provides a {@link org.springframework.beans.factory.xml.BeanDefinitionParser} for the - * <aop:config> tag. A config tag can include nested - * pointcut, advisor and aspect tags. + * {@code <aop:config>} tag. A {@code config} tag can include nested + * {@code pointcut}, {@code advisor} and {@code aspect} tags. * - *

The pointcut tag allows for creation of named + *

The {@code pointcut} tag allows for creation of named * {@link AspectJExpressionPointcut} beans using a simple syntax: *

  * <aop:pointcut id="getNameCalls" expression="execution(* *..ITestBean.getName(..))"/>
  * 
* - *

Using the advisor tag you can configure an {@link org.springframework.aop.Advisor} + *

Using the {@code advisor} tag you can configure an {@link org.springframework.aop.Advisor} * and have it applied to all relevant beans in you {@link org.springframework.beans.factory.BeanFactory} - * automatically. The advisor tag supports both in-line and referenced + * automatically. The {@code advisor} tag supports both in-line and referenced * {@link org.springframework.aop.Pointcut Pointcuts}: * *

@@ -56,8 +56,8 @@ public class AopNamespaceHandler extends NamespaceHandlerSupport {
 
 	/**
 	 * Register the {@link BeanDefinitionParser BeanDefinitionParsers} for the
-	 * 'config', 'spring-configured', 'aspectj-autoproxy'
-	 * and 'scoped-proxy' tags.
+	 * '{@code config}', '{@code spring-configured}', '{@code aspectj-autoproxy}'
+	 * and '{@code scoped-proxy}' tags.
 	 */
 	public void init() {
 		// In 2.0 XSD as well as in 2.1 XSD.
diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceUtils.java b/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceUtils.java
index ae9888dca4..9d19ec544b 100644
--- a/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceUtils.java
+++ b/spring-aop/src/main/java/org/springframework/aop/config/AopNamespaceUtils.java
@@ -25,7 +25,7 @@ import org.springframework.beans.factory.xml.ParserContext;
 
 /**
  * Utility class for handling registration of auto-proxy creators used internally
- * by the 'aop' namespace tags.
+ * by the '{@code aop}' namespace tags.
  *
  * 

Only a single auto-proxy creator can be registered and multiple tags may wish * to register different concrete implementations. As such this class delegates to @@ -42,12 +42,12 @@ import org.springframework.beans.factory.xml.ParserContext; public abstract class AopNamespaceUtils { /** - * The proxy-target-class attribute as found on AOP-related XML tags. + * The {@code proxy-target-class} attribute as found on AOP-related XML tags. */ public static final String PROXY_TARGET_CLASS_ATTRIBUTE = "proxy-target-class"; /** - * The expose-proxy attribute as found on AOP-related XML tags. + * The {@code expose-proxy} attribute as found on AOP-related XML tags. */ private static final String EXPOSE_PROXY_ATTRIBUTE = "expose-proxy"; diff --git a/spring-aop/src/main/java/org/springframework/aop/config/AspectJAutoProxyBeanDefinitionParser.java b/spring-aop/src/main/java/org/springframework/aop/config/AspectJAutoProxyBeanDefinitionParser.java index 0aca37520b..d9e5b43615 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/AspectJAutoProxyBeanDefinitionParser.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/AspectJAutoProxyBeanDefinitionParser.java @@ -27,7 +27,7 @@ import org.springframework.beans.factory.xml.BeanDefinitionParser; import org.springframework.beans.factory.xml.ParserContext; /** - * {@link BeanDefinitionParser} for the aspectj-autoproxy tag, + * {@link BeanDefinitionParser} for the {@code aspectj-autoproxy} tag, * enabling the automatic application of @AspectJ-style aspects found in * the {@link org.springframework.beans.factory.BeanFactory}. * diff --git a/spring-aop/src/main/java/org/springframework/aop/config/ConfigBeanDefinitionParser.java b/spring-aop/src/main/java/org/springframework/aop/config/ConfigBeanDefinitionParser.java index 8613647b15..f97d8230eb 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/ConfigBeanDefinitionParser.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/ConfigBeanDefinitionParser.java @@ -49,7 +49,7 @@ import org.springframework.util.StringUtils; import org.springframework.util.xml.DomUtils; /** - * {@link BeanDefinitionParser} for the <aop:config> tag. + * {@link BeanDefinitionParser} for the {@code <aop:config>} tag. * * @author Rob Harrop * @author Juergen Hoeller @@ -122,8 +122,8 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { /** * Configures the auto proxy creator needed to support the {@link BeanDefinition BeanDefinitions} - * created by the '<aop:config/>' tag. Will force class proxying if the - * 'proxy-target-class' attribute is set to 'true'. + * created by the '{@code <aop:config/>}' tag. Will force class proxying if the + * '{@code proxy-target-class}' attribute is set to '{@code true}'. * @see AopNamespaceUtils */ private void configureAutoProxyCreator(ParserContext parserContext, Element element) { @@ -131,7 +131,7 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Parses the supplied <advisor> element and registers the resulting + * Parses the supplied {@code <advisor>} element and registers the resulting * {@link org.springframework.aop.Advisor} and any resulting {@link org.springframework.aop.Pointcut} * with the supplied {@link BeanDefinitionRegistry}. */ @@ -168,7 +168,7 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { /** * Create a {@link RootBeanDefinition} for the advisor described in the supplied. Does not - * parse any associated 'pointcut' or 'pointcut-ref' attributes. + * parse any associated '{@code pointcut}' or '{@code pointcut-ref}' attributes. */ private AbstractBeanDefinition createAdvisorBeanDefinition(Element advisorElement, ParserContext parserContext) { RootBeanDefinition advisorDefinition = new RootBeanDefinition(DefaultBeanFactoryPointcutAdvisor.class); @@ -257,9 +257,9 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Return true if the supplied node describes an advice type. May be one of: - * 'before', 'after', 'after-returning', - * 'after-throwing' or 'around'. + * Return {@code true} if the supplied node describes an advice type. May be one of: + * '{@code before}', '{@code after}', '{@code after-returning}', + * '{@code after-throwing}' or '{@code around}'. */ private boolean isAdviceNode(Node aNode, ParserContext parserContext) { if (!(aNode instanceof Element)) { @@ -273,7 +273,7 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Parse a 'declare-parents' element and register the appropriate + * Parse a '{@code declare-parents}' element and register the appropriate * DeclareParentsAdvisor with the BeanDefinitionRegistry encapsulated in the * supplied ParserContext. */ @@ -304,8 +304,8 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Parses one of 'before', 'after', 'after-returning', - * 'after-throwing' or 'around' and registers the resulting + * Parses one of '{@code before}', '{@code after}', '{@code after-returning}', + * '{@code after-throwing}' or '{@code around}' and registers the resulting * BeanDefinition with the supplied BeanDefinitionRegistry. * @return the generated advice RootBeanDefinition */ @@ -427,7 +427,7 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Parses the supplied <pointcut> and registers the resulting + * Parses the supplied {@code <pointcut>} and registers the resulting * Pointcut with the BeanDefinitionRegistry. */ private AbstractBeanDefinition parsePointcut(Element pointcutElement, ParserContext parserContext) { @@ -460,8 +460,8 @@ class ConfigBeanDefinitionParser implements BeanDefinitionParser { } /** - * Parses the pointcut or pointcut-ref attributes of the supplied - * {@link Element} and add a pointcut property as appropriate. Generates a + * Parses the {@code pointcut} or {@code pointcut-ref} attributes of the supplied + * {@link Element} and add a {@code pointcut} property as appropriate. Generates a * {@link org.springframework.beans.factory.config.BeanDefinition} for the pointcut if necessary * and returns its bean name, otherwise returns the bean name of the referred pointcut. */ diff --git a/spring-aop/src/main/java/org/springframework/aop/config/ScopedProxyBeanDefinitionDecorator.java b/spring-aop/src/main/java/org/springframework/aop/config/ScopedProxyBeanDefinitionDecorator.java index bbba335bb6..797b5f6698 100644 --- a/spring-aop/src/main/java/org/springframework/aop/config/ScopedProxyBeanDefinitionDecorator.java +++ b/spring-aop/src/main/java/org/springframework/aop/config/ScopedProxyBeanDefinitionDecorator.java @@ -27,7 +27,7 @@ import org.springframework.beans.factory.xml.ParserContext; /** * {@link BeanDefinitionDecorator} responsible for parsing the - * <aop:scoped-proxy/> tag. + * {@code <aop:scoped-proxy/>} tag. * * @author Rob Harrop * @author Juergen Hoeller 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 cf22fddded..a78e33daf2 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 @@ -93,7 +93,7 @@ public abstract class AbstractAdvisingBeanPostProcessor extends ProxyConfig /** * Check whether the given bean is eligible for advising with this * post-processor's {@link Advisor}. - *

Implements caching of canApply results per bean name. + *

Implements caching of {@code canApply} results per bean name. * @param bean the bean instance * @param beanName the name of the bean * @see AopUtils#canApply(Advisor, Class) diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/Advised.java b/spring-aop/src/main/java/org/springframework/aop/framework/Advised.java index c166ddc04d..ffc317ce37 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/Advised.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/Advised.java @@ -77,7 +77,7 @@ public interface Advised extends TargetClassAware { * Set whether the proxy should be exposed by the AOP framework as a * ThreadLocal for retrieval via the AopContext class. This is useful * if an advised object needs to call another advised method on itself. - * (If it uses this, the invocation will not be advised). + * (If it uses {@code this}, the invocation will not be advised). *

Default is "false", for optimal performance. */ void setExposeProxy(boolean exposeProxy); @@ -85,7 +85,7 @@ public interface Advised extends TargetClassAware { /** * Return whether the factory should expose the proxy as a ThreadLocal. * This can be necessary if a target object needs to invoke a method on itself - * benefitting from advice. (If it invokes a method on this no advice + * benefitting from advice. (If it invokes a method on {@code this} no advice * will apply.) Getting the proxy is analogous to an EJB calling getEJBObject(). * @see AopContext */ @@ -110,7 +110,7 @@ public interface Advised extends TargetClassAware { /** * Return the advisors applying to this proxy. - * @return a list of Advisors applying to this proxy (never null) + * @return a list of Advisors applying to this proxy (never {@code null}) */ Advisor[] getAdvisors(); @@ -135,7 +135,7 @@ public interface Advised extends TargetClassAware { /** * Remove the given advisor. * @param advisor the advisor to remove - * @return true if the advisor was removed; false + * @return {@code true} if the advisor was removed; {@code false} * if the advisor was not found and hence could not be removed */ boolean removeAdvisor(Advisor advisor); @@ -165,7 +165,7 @@ public interface Advised extends TargetClassAware { * @param a the advisor to replace * @param b the advisor to replace it with * @return whether it was replaced. If the advisor wasn't found in the - * list of advisors, this method returns false and does nothing. + * list of advisors, this method returns {@code false} and does nothing. * @throws AopConfigException in case of invalid advice */ boolean replaceAdvisor(Advisor a, Advisor b) throws AopConfigException; @@ -174,9 +174,9 @@ public interface Advised extends TargetClassAware { /** * Add the given AOP Alliance advice to the tail of the advice (interceptor) chain. *

This will be wrapped in a DefaultPointcutAdvisor with a pointcut that always - * applies, and returned from the getAdvisors() method in this wrapped form. + * applies, and returned from the {@code getAdvisors()} method in this wrapped form. *

Note that the given advice will apply to all invocations on the proxy, - * even to the toString() method! Use appropriate advice implementations + * even to the {@code toString()} method! Use appropriate advice implementations * or specify appropriate pointcuts to apply to a narrower set of methods. * @param advice advice to add to the tail of the chain * @throws AopConfigException in case of invalid advice @@ -191,7 +191,7 @@ public interface Advised extends TargetClassAware { * with a pointcut that always applies, and returned from the {@link #getAdvisors()} * method in this wrapped form. *

Note: The given advice will apply to all invocations on the proxy, - * even to the toString() method! Use appropriate advice implementations + * even to the {@code toString()} method! Use appropriate advice implementations * or specify appropriate pointcuts to apply to a narrower set of methods. * @param pos index from 0 (head) * @param advice advice to add at the specified position in the advice chain @@ -202,8 +202,8 @@ public interface Advised extends TargetClassAware { /** * Remove the Advisor containing the given advice. * @param advice the advice to remove - * @return true of the advice was found and removed; - * false if there was no such advice + * @return {@code true} of the advice was found and removed; + * {@code false} if there was no such advice */ boolean removeAdvice(Advice advice); @@ -219,7 +219,7 @@ public interface Advised extends TargetClassAware { /** - * As toString() will normally be delegated to the target, + * As {@code toString()} will normally be delegated to the target, * this returns the equivalent for the AOP proxy. * @return a string description of the proxy configuration */ diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AdvisedSupport.java b/spring-aop/src/main/java/org/springframework/aop/framework/AdvisedSupport.java index ebb59896ec..63d8711269 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AdvisedSupport.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AdvisedSupport.java @@ -184,7 +184,7 @@ public class AdvisedSupport extends ProxyConfig implements Advised { } /** - * Return the advisor chain factory to use (never null). + * Return the advisor chain factory to use (never {@code null}). */ public AdvisorChainFactory getAdvisorChainFactory() { return this.advisorChainFactory; @@ -221,7 +221,7 @@ public class AdvisedSupport extends ProxyConfig implements Advised { * Remove a proxied interface. *

Does nothing if the given interface isn't proxied. * @param intf the interface to remove from the proxy - * @return true if the interface was removed; false + * @return {@code true} if the interface was removed; {@code false} * if the interface was not found and hence could not be removed */ public boolean removeInterface(Class intf) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AopContext.java b/spring-aop/src/main/java/org/springframework/aop/framework/AopContext.java index 299ebfa31a..ca61dcc557 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AopContext.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AopContext.java @@ -21,9 +21,9 @@ import org.springframework.core.NamedThreadLocal; /** * Class containing static methods used to obtain information about the current AOP invocation. * - *

The currentProxy() method is usable if the AOP framework is configured to + *

The {@code currentProxy()} method is usable if the AOP framework is configured to * expose the current proxy (not the default). It returns the AOP proxy in use. Target objects - * or advice can use this to make advised calls, in the same way as getEJBObject() + * or advice can use this to make advised calls, in the same way as {@code getEJBObject()} * can be used in EJBs. They can also use it to find advice configuration. * *

Spring's AOP framework does not expose proxies by default, as there is a performance cost @@ -42,7 +42,7 @@ public abstract class AopContext { /** * ThreadLocal holder for AOP proxy associated with this thread. - * Will contain null unless the "exposeProxy" property on + * Will contain {@code null} unless the "exposeProxy" property on * the controlling proxy configuration has been set to "true". * @see ProxyConfig#setExposeProxy */ @@ -53,7 +53,7 @@ public abstract class AopContext { * Try to return the current AOP proxy. This method is usable only if the * calling method has been invoked via AOP, and the AOP framework has been set * to expose proxies. Otherwise, this method will throw an IllegalStateException. - * @return Object the current AOP proxy (never returns null) + * @return Object the current AOP proxy (never returns {@code null}) * @throws IllegalStateException if the proxy cannot be found, because the * method was invoked outside an AOP invocation context, or because the * AOP framework has not been configured to expose the proxy @@ -68,10 +68,10 @@ public abstract class AopContext { } /** - * Make the given proxy available via the currentProxy() method. + * Make the given proxy available via the {@code currentProxy()} method. *

Note that the caller should be careful to keep the old value as appropriate. - * @param proxy the proxy to expose (or null to reset it) - * @return the old proxy, which may be null if none was bound + * @param proxy the proxy to expose (or {@code null} to reset it) + * @return the old proxy, which may be {@code null} if none was bound * @see #currentProxy() */ static Object setCurrentProxy(Object proxy) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AopProxy.java b/spring-aop/src/main/java/org/springframework/aop/framework/AopProxy.java index 2fe5af6c35..c002e43a51 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AopProxy.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AopProxy.java @@ -33,20 +33,20 @@ public interface AopProxy { * Create a new proxy object. *

Uses the AopProxy's default class loader (if necessary for proxy creation): * usually, the thread context class loader. - * @return the new proxy object (never null) - * @see java.lang.Thread#getContextClassLoader() + * @return the new proxy object (never {@code null}) + * @see Thread#getContextClassLoader() */ Object getProxy(); /** * Create a new proxy object. *

Uses the given class loader (if necessary for proxy creation). - * null will simply be passed down and thus lead to the low-level + * {@code null} will simply be passed down and thus lead to the low-level * proxy facility's default, which is usually different from the default chosen * by the AopProxy implementation's {@link #getProxy()} method. * @param classLoader the class loader to create the proxy with - * (or null for the low-level proxy facility's default) - * @return the new proxy object (never null) + * (or {@code null} for the low-level proxy facility's default) + * @return the new proxy object (never {@code null}) */ Object getProxy(ClassLoader classLoader); diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/AopProxyUtils.java b/spring-aop/src/main/java/org/springframework/aop/framework/AopProxyUtils.java index 28e48adb4f..a602cefe37 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/AopProxyUtils.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/AopProxyUtils.java @@ -44,9 +44,9 @@ public abstract class AopProxyUtils { * as long as possible without side effects, that is, just for singleton targets. * @param candidate the instance to check (might be an AOP proxy) * @return the target class (or the plain class of the given object as fallback; - * never null) + * never {@code null}) * @see org.springframework.aop.TargetClassAware#getTargetClass() - * @see org.springframework.aop.framework.Advised#getTargetSource() + * @see Advised#getTargetSource() */ public static Class ultimateTargetClass(Object candidate) { Assert.notNull(candidate, "Candidate object must not be null"); @@ -112,7 +112,7 @@ public abstract class AopProxyUtils { * i.e. all non-Advised interfaces that the proxy implements. * @param proxy the proxy to analyze (usually a JDK dynamic proxy) * @return all user-specified interfaces that the proxy implements, - * in the original order (never null or empty) + * in the original order (never {@code null} or empty) * @see Advised */ public static Class[] proxiedUserInterfaces(Object proxy) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/CglibAopProxy.java b/spring-aop/src/main/java/org/springframework/aop/framework/CglibAopProxy.java index bbf7015e0a..5801458ff0 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/CglibAopProxy.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/CglibAopProxy.java @@ -234,7 +234,7 @@ final class CglibAopProxy implements AopProxy, Serializable { } /** - * Checks to see whether the supplied Class has already been validated and + * Checks to see whether the supplied {@code Class} has already been validated and * validates it if not. */ private void validateClassIfNecessary(Class proxySuperClass) { @@ -249,7 +249,7 @@ final class CglibAopProxy implements AopProxy, Serializable { } /** - * Checks for final methods on the Class and writes warnings to the log + * Checks for final methods on the {@code Class} and writes warnings to the log * for each one found. */ private void doValidateClass(Class proxySuperClass) { @@ -376,7 +376,7 @@ final class CglibAopProxy implements AopProxy, Serializable { * Method interceptor used for static targets with no advice chain. The call * is passed directly back to the target. Used when the proxy needs to be * exposed and it can't be determined that the method won't return - * this. + * {@code this}. */ private static class StaticUnadvisedInterceptor implements MethodInterceptor, Serializable { @@ -509,7 +509,7 @@ final class CglibAopProxy implements AopProxy, Serializable { /** - * Dispatcher for the equals method. + * Dispatcher for the {@code equals} method. * Ensures that the method call is always handled by this class. */ private static class EqualsInterceptor implements MethodInterceptor, Serializable { @@ -541,7 +541,7 @@ final class CglibAopProxy implements AopProxy, Serializable { /** - * Dispatcher for the hashCode method. + * Dispatcher for the {@code hashCode} method. * Ensures that the method call is always handled by this class. */ private static class HashCodeInterceptor implements MethodInterceptor, Serializable { @@ -609,7 +609,7 @@ final class CglibAopProxy implements AopProxy, Serializable { oldProxy = AopContext.setCurrentProxy(proxy); setProxyContext = true; } - // May be null. Get as late as possible to minimize the time we + // May be null Get as late as possible to minimize the time we // "own" the target, in case it comes from a pool. target = getTarget(); if (target != null) { @@ -745,11 +745,11 @@ final class CglibAopProxy implements AopProxy, Serializable { * invoke the advice chain. Otherwise a DyanmicAdvisedInterceptor is * used. *

For non-advised methods:
- *
Where it can be determined that the method will not return this - * or when ProxyFactory.getExposeProxy() returns false, + *
Where it can be determined that the method will not return {@code this} + * or when {@code ProxyFactory.getExposeProxy()} returns {@code false}, * then a Dispatcher is used. For static targets, the StaticDispatcher is used; * and for dynamic targets, a DynamicUnadvisedInterceptor is used. - * If it possible for the method to return this then a + * If it possible for the method to return {@code this} then a * StaticUnadvisedInterceptor is used for static targets - the * DynamicUnadvisedInterceptor already considers this.
* diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/JdkDynamicAopProxy.java b/spring-aop/src/main/java/org/springframework/aop/framework/JdkDynamicAopProxy.java index 24c0610c08..7e10c4c228 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/JdkDynamicAopProxy.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/JdkDynamicAopProxy.java @@ -143,7 +143,7 @@ final class JdkDynamicAopProxy implements AopProxy, InvocationHandler, Serializa /** - * Implementation of InvocationHandler.invoke. + * Implementation of {@code InvocationHandler.invoke}. *

Callers will see exactly the exception thrown by the target, * unless a hook method throws an exception. */ diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyConfig.java b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyConfig.java index e012777285..e8decfcf94 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyConfig.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyConfig.java @@ -112,7 +112,7 @@ public class ProxyConfig implements Serializable { * Set whether the proxy should be exposed by the AOP framework as a * ThreadLocal for retrieval via the AopContext class. This is useful * if an advised object needs to call another advised method on itself. - * (If it uses this, the invocation will not be advised). + * (If it uses {@code this}, the invocation will not be advised). *

Default is "false", in order to avoid unnecessary extra interception. * This means that no guarantees are provided that AopContext access will * work consistently within any method of the advised object. diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyCreatorSupport.java b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyCreatorSupport.java index c5eeb924ec..c34bb113ab 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyCreatorSupport.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyCreatorSupport.java @@ -95,7 +95,7 @@ public class ProxyCreatorSupport extends AdvisedSupport { /** * Subclasses should call this to get a new AOP proxy. They should not - * create an AOP proxy with this as an argument. + * create an AOP proxy with {@code this} as an argument. */ protected final synchronized AopProxy createAopProxy() { if (!this.active) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactory.java b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactory.java index 989160bf65..acc4b69054 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactory.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactory.java @@ -74,7 +74,7 @@ public class ProxyFactory extends ProxyCreatorSupport { } /** - * Create a ProxyFactory for the specified TargetSource, + * Create a ProxyFactory for the specified {@code TargetSource}, * making the proxy implement the specified interface. * @param proxyInterface the interface that the proxy should implement * @param targetSource the TargetSource that the proxy should invoke @@ -103,7 +103,7 @@ public class ProxyFactory extends ProxyCreatorSupport { * or removed interfaces. Can add and remove interceptors. *

Uses the given class loader (if necessary for proxy creation). * @param classLoader the class loader to create the proxy with - * (or null for the low-level proxy facility's default) + * (or {@code null} for the low-level proxy facility's default) * @return the proxy object */ public Object getProxy(ClassLoader classLoader) { @@ -127,7 +127,7 @@ public class ProxyFactory extends ProxyCreatorSupport { } /** - * Create a proxy for the specified TargetSource, + * Create a proxy for the specified {@code TargetSource}, * implementing the specified interface. * @param proxyInterface the interface that the proxy should implement * @param targetSource the TargetSource that the proxy should invoke @@ -140,8 +140,8 @@ public class ProxyFactory extends ProxyCreatorSupport { } /** - * Create a proxy for the specified TargetSource that extends - * the target class of the TargetSource. + * Create a proxy for the specified {@code TargetSource} that extends + * the target class of the {@code TargetSource}. * @param targetSource the TargetSource that the proxy should invoke * @return the proxy object */ diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java index a9b039f35f..6cd0d15155 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java @@ -233,7 +233,7 @@ public class ProxyFactoryBean extends ProxyCreatorSupport * Return a proxy. Invoked when clients obtain beans from this factory bean. * Create an instance of the AOP proxy to be returned by this factory. * The instance will be cached for a singleton, and create on each call to - * getObject() for a proxy. + * {@code getObject()} for a proxy. * @return a fresh AOP proxy reflecting the current state of this factory */ public Object getObject() throws BeansException { @@ -351,7 +351,7 @@ public class ProxyFactoryBean extends ProxyCreatorSupport /** * Return the proxy object to expose. - *

The default implementation uses a getProxy call with + *

The default implementation uses a {@code getProxy} call with * the factory's bean class loader. Can be overridden to specify a * custom class loader. * @param aopProxy the prepared AopProxy instance to get the proxy from @@ -392,7 +392,7 @@ public class ProxyFactoryBean extends ProxyCreatorSupport * which concludes the interceptorNames list, is an Advisor or Advice, * or may be a target. * @param beanName bean name to check - * @return true if it's an Advisor or Advice + * @return {@code true} if it's an Advisor or Advice */ private boolean isNamedBeanAnAdvisorOrAdvice(String beanName) { Class namedBeanClass = this.beanFactory.getType(beanName); 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 10578d9960..5062a916c5 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 @@ -253,7 +253,7 @@ public class ReflectiveMethodInvocation implements ProxyMethodInvocation, Clonea * This method provides an invocation-bound alternative to a ThreadLocal. *

This map is initialized lazily and is not used in the AOP framework itself. * @return any user attributes associated with this invocation - * (never null) + * (never {@code null}) */ public Map getUserAttributes() { if (this.userAttributes == null) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapter.java b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapter.java index 5acc518359..b1f5a6396d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapter.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapter.java @@ -38,7 +38,7 @@ public interface AdvisorAdapter { /** * Does this adapter understand this advice object? Is it valid to - * invoke the getInterceptors method with an Advisor that + * invoke the {@code getInterceptors} method with an Advisor that * contains this advice as an argument? * @param advice an Advice such as a BeforeAdvice * @return whether this adapter understands the given advice object diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapterRegistry.java b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapterRegistry.java index f0b38d0d67..1c69281c70 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapterRegistry.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/AdvisorAdapterRegistry.java @@ -38,7 +38,7 @@ public interface AdvisorAdapterRegistry { * {@link org.springframework.aop.AfterReturningAdvice}, * {@link org.springframework.aop.ThrowsAdvice}. * @param advice object that should be an advice - * @return an Advisor wrapping the given advice. Never returns null. + * @return an Advisor wrapping the given advice. Never returns {@code null}. * If the advice parameter is an Advisor, return it. * @throws UnknownAdviceTypeException if no registered advisor adapter * can wrap the supposed advice diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/ThrowsAdviceInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/ThrowsAdviceInterceptor.java index 81023c1251..32f3d2d44d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/adapter/ThrowsAdviceInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/adapter/ThrowsAdviceInterceptor.java @@ -32,10 +32,10 @@ import org.springframework.util.Assert; /** * Interceptor to wrap an after-throwing advice. * - *

The signatures on handler methods on the ThrowsAdvice + *

The signatures on handler methods on the {@code ThrowsAdvice} * implementation method argument must be of the form:
* - * void afterThrowing([Method, args, target], ThrowableSubclass); + * {@code void afterThrowing([Method, args, target], ThrowableSubclass);} * *

Only the last argument is required. * diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAdvisorAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAdvisorAutoProxyCreator.java index 8bca7ccd9d..dba5d066d5 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAdvisorAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAdvisorAutoProxyCreator.java @@ -76,7 +76,7 @@ public abstract class AbstractAdvisorAutoProxyCreator extends AbstractAutoProxyC * Find all eligible Advisors for auto-proxying this class. * @param beanClass the clazz to find advisors for * @param beanName the name of the currently proxied bean - * @return the empty List, not null, + * @return the empty List, not {@code null}, * if there are no pointcuts or interceptors * @see #findCandidateAdvisors * @see #sortAdvisors 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 4e4f638008..bcef35918f 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 @@ -147,7 +147,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig /** * Set the ordering which will apply to this class's implementation * of Ordered, used when applying multiple BeanPostProcessors. - *

Default value is Integer.MAX_VALUE, meaning that it's non-ordered. + *

Default value is {@code Integer.MAX_VALUE}, meaning that it's non-ordered. * @param order ordering value */ public final void setOrder(int order) { @@ -243,7 +243,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig /** * Return the owning BeanFactory. - * May be null, as this object doesn't need to belong to a bean factory. + * May be {@code null}, as this object doesn't need to belong to a bean factory. */ protected BeanFactory getBeanFactory() { return this.beanFactory; @@ -390,10 +390,10 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig } /** - * Subclasses should override this method to return true if the + * 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 if it will lead to - * a circular reference. This implementation returns false. + * a circular reference. This implementation returns {@code false}. * @param beanClass the class of the bean * @param beanName the name of the bean * @return whether to skip the given bean @@ -404,7 +404,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig /** * Create a target source for bean instances. Uses any TargetSourceCreators if set. - * Returns null if no custom TargetSource should be used. + * Returns {@code null} if no custom TargetSource should be used. *

This implementation uses the "customTargetSourceCreators" property. * Subclasses can override this method to use a different mechanism. * @param beanClass the class of the bean to create a TargetSource for @@ -497,7 +497,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig * Return whether the Advisors returned by the subclass are pre-filtered * to match the bean's target class already, allowing the ClassFilter check * to be skipped when building advisors chains for AOP invocations. - *

Default is false. Subclasses may override this if they + *

Default is {@code false}. Subclasses may override this if they * will always return pre-filtered Advisors. * @return whether the Advisors are pre-filtered * @see #getAdvicesAndAdvisorsForBean @@ -581,10 +581,10 @@ public abstract class AbstractAutoProxyCreator extends ProxyConfig * @param beanName the name of the bean * @param customTargetSource the TargetSource returned by the * {@link #getCustomTargetSource} method: may be ignored. - * Will be null if no custom target source is in use. + * Will be {@code null} if no custom target source is in use. * @return an array of additional interceptors for the particular bean; * or an empty array if no additional interceptors but just the common ones; - * or null if no proxy at all, not even with the common interceptors. + * or {@code null} if no proxy at all, not even with the common interceptors. * See constants DO_NOT_PROXY and PROXY_WITHOUT_ADDITIONAL_INTERCEPTORS. * @throws BeansException in case of errors * @see #DO_NOT_PROXY 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 dbc184c2a3..b48ae0905e 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 @@ -33,7 +33,7 @@ public abstract class AutoProxyUtils { /** * Bean definition attribute that may indicate whether a given bean is supposed * to be proxied with its target class (in case of it getting proxied in the first - * place). The value is Boolean.TRUE or Boolean.FALSE. + * place). The value is {@code Boolean.TRUE} or {@code Boolean.FALSE}. *

Proxy factories can set this attribute if they built a target class proxy * for a specific bean, and want to enforce that that bean can always be cast * to its target class (even if AOP advices get applied through auto-proxying). diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanFactoryAdvisorRetrievalHelper.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanFactoryAdvisorRetrievalHelper.java index 4000181369..ab056cd688 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanFactoryAdvisorRetrievalHelper.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/BeanFactoryAdvisorRetrievalHelper.java @@ -107,7 +107,7 @@ public class BeanFactoryAdvisorRetrievalHelper { /** * Determine whether the aspect bean with the given name is eligible. - *

The default implementation always returns true. + *

The default implementation always returns {@code true}. * @param beanName the name of the aspect bean * @return whether the bean is eligible */ diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/DefaultAdvisorAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/DefaultAdvisorAutoProxyCreator.java index cfc4e09cf9..741cd1ae1a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/DefaultAdvisorAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/DefaultAdvisorAutoProxyCreator.java @@ -24,10 +24,10 @@ import org.springframework.beans.factory.BeanNameAware; * no special code to handle any particular aspects, such as pooling aspects. * *

It's possible to filter out advisors - for example, to use multiple post processors - * of this type in the same factory - by setting the usePrefix property + * of this type in the same factory - by setting the {@code usePrefix} property * to true, in which case only advisors beginning with the DefaultAdvisorAutoProxyCreator's * bean name followed by a dot (like "aapc.") will be used. This default prefix can be - * changed from the bean name by setting the advisorBeanNamePrefix property. + * changed from the bean name by setting the {@code advisorBeanNamePrefix} property. * The separator (.) will also be used in this case. * * @author Rod Johnson diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/ProxyCreationContext.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/ProxyCreationContext.java index 244b1eadd5..0adb7d7e2a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/ProxyCreationContext.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/ProxyCreationContext.java @@ -35,7 +35,7 @@ public class ProxyCreationContext { /** * Return the name of the currently proxied bean instance. - * @return the name of the bean, or null if none available + * @return the name of the bean, or {@code null} if none available */ public static String getCurrentProxiedBeanName() { return currentProxiedBeanName.get(); @@ -43,7 +43,7 @@ public class ProxyCreationContext { /** * Set the name of the currently proxied bean instance. - * @param beanName the name of the bean, or null to reset it + * @param beanName the name of the bean, or {@code null} to reset it */ static void setCurrentProxiedBeanName(String beanName) { if (beanName != null) { diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/TargetSourceCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/TargetSourceCreator.java index 735a65b852..5acae865f4 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/TargetSourceCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/TargetSourceCreator.java @@ -35,7 +35,7 @@ public interface TargetSourceCreator { * Create a special TargetSource for the given bean, if any. * @param beanClass the class of the bean to create a TargetSource for * @param beanName the name of the bean - * @return a special TargetSource or null if this TargetSourceCreator isn't + * @return a special TargetSource or {@code null} if this TargetSourceCreator isn't * interested in the particular bean */ TargetSource getTargetSource(Class beanClass, String beanName); diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/target/AbstractBeanFactoryBasedTargetSourceCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/target/AbstractBeanFactoryBasedTargetSourceCreator.java index a7bf4b490c..510b6d8da1 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/target/AbstractBeanFactoryBasedTargetSourceCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/target/AbstractBeanFactoryBasedTargetSourceCreator.java @@ -184,14 +184,14 @@ public abstract class AbstractBeanFactoryBasedTargetSourceCreator /** * Subclasses must implement this method to return a new AbstractPrototypeBasedTargetSource - * if they wish to create a custom TargetSource for this bean, or null if they are + * if they wish to create a custom TargetSource for this bean, or {@code null} if they are * not interested it in, in which case no special target source will be created. - * Subclasses should not call setTargetBeanName or setBeanFactory + * Subclasses should not call {@code setTargetBeanName} or {@code setBeanFactory} * on the AbstractPrototypeBasedTargetSource: This class' implementation of - * getTargetSource() will do that. + * {@code getTargetSource()} will do that. * @param beanClass the class of the bean to create a TargetSource for * @param beanName the name of the bean - * @return the AbstractPrototypeBasedTargetSource, or null if we don't match this + * @return the AbstractPrototypeBasedTargetSource, or {@code null} if we don't match this */ protected abstract AbstractBeanFactoryBasedTargetSource createBeanFactoryBasedTargetSource( Class beanClass, String beanName); diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractMonitoringInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractMonitoringInterceptor.java index 8eb36f0964..2f5bf13495 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractMonitoringInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractMonitoringInterceptor.java @@ -22,10 +22,10 @@ import org.aopalliance.intercept.MethodInvocation; /** * Base class for monitoring interceptors, such as performance monitors. - * Provides prefix and suffix properties + * Provides {@code prefix} and {@code suffix} properties * that help to classify/group performance monitoring results. * - *

Subclasses should call the createInvocationTraceName(MethodInvocation) + *

Subclasses should call the {@code createInvocationTraceName(MethodInvocation)} * method to create a name for the given trace that includes information about the * method invocation under trace along with the prefix and suffix added as appropriate. * @@ -87,7 +87,7 @@ public abstract class AbstractMonitoringInterceptor extends AbstractTraceInterce /** - * Create a String name for the given MethodInvocation + * Create a {@code String} name for the given {@code MethodInvocation} * that can be used for trace/logging purposes. This name is made up of the * configured prefix, followed by the fully-qualified name of the method being * invoked, followed by the configured suffix. diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractTraceInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractTraceInterceptor.java index 2c367c20c0..0defe95a51 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractTraceInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/AbstractTraceInterceptor.java @@ -26,16 +26,16 @@ import org.apache.commons.logging.LogFactory; import org.springframework.aop.support.AopUtils; /** - * Base MethodInterceptor implementation for tracing. + * Base {@code MethodInterceptor} implementation for tracing. * *

By default, log messages are written to the log for the interceptor class, - * not the class which is being intercepted. Setting the useDynamicLogger - * bean property to true causes all log messages to be written to - * the Log for the target class being intercepted. + * not the class which is being intercepted. Setting the {@code useDynamicLogger} + * bean property to {@code true} causes all log messages to be written to + * the {@code Log} for the target class being intercepted. * - *

Subclasses must implement the invokeUnderTrace method, which + *

Subclasses must implement the {@code invokeUnderTrace} method, which * is invoked by this class ONLY when a particular invocation SHOULD be traced. - * Subclasses should write to the Log instance provided. + * Subclasses should write to the {@code Log} instance provided. * * @author Rob Harrop * @author Juergen Hoeller @@ -46,8 +46,8 @@ import org.springframework.aop.support.AopUtils; public abstract class AbstractTraceInterceptor implements MethodInterceptor, Serializable { /** - * The default Log instance used to write trace messages. - * This instance is mapped to the implementing Class. + * The default {@code Log} instance used to write trace messages. + * This instance is mapped to the implementing {@code Class}. */ protected transient Log defaultLogger = LogFactory.getLog(getClass()); @@ -61,9 +61,9 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser /** * Set whether to use a dynamic logger or a static logger. * Default is a static logger for this trace interceptor. - *

Used to determine which Log instance should be used to write + *

Used to determine which {@code Log} instance should be used to write * log messages for a particular method invocation: a dynamic one for the - * Class getting called, or a static one for the Class + * {@code Class} getting called, or a static one for the {@code Class} * of the trace interceptor. *

NOTE: Specify either this property or "loggerName", not both. * @see #getLoggerForInvocation(org.aopalliance.intercept.MethodInvocation) @@ -99,9 +99,9 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser /** - * Determines whether or not logging is enabled for the particular MethodInvocation. + * Determines whether or not logging is enabled for the particular {@code MethodInvocation}. * If not, the method invocation proceeds as normal, otherwise the method invocation is passed - * to the invokeUnderTrace method for handling. + * to the {@code invokeUnderTrace} method for handling. * @see #invokeUnderTrace(org.aopalliance.intercept.MethodInvocation, org.apache.commons.logging.Log) */ public Object invoke(MethodInvocation invocation) throws Throwable { @@ -115,13 +115,13 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser } /** - * Return the appropriate Log instance to use for the given - * MethodInvocation. If the useDynamicLogger flag - * is set, the Log instance will be for the target class of the - * MethodInvocation, otherwise the Log will be the + * Return the appropriate {@code Log} instance to use for the given + * {@code MethodInvocation}. If the {@code useDynamicLogger} flag + * is set, the {@code Log} instance will be for the target class of the + * {@code MethodInvocation}, otherwise the {@code Log} will be the * default static logger. - * @param invocation the MethodInvocation being traced - * @return the Log instance to use + * @param invocation the {@code MethodInvocation} being traced + * @return the {@code Log} instance to use * @see #setUseDynamicLogger */ protected Log getLoggerForInvocation(MethodInvocation invocation) { @@ -146,12 +146,12 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser /** * Determine whether the interceptor should kick in, that is, - * whether the invokeUnderTrace method should be called. - *

Default behavior is to check whether the given Log + * whether the {@code invokeUnderTrace} method should be called. + *

Default behavior is to check whether the given {@code Log} * instance is enabled. Subclasses can override this to apply the * interceptor in other cases as well. - * @param invocation the MethodInvocation being traced - * @param logger the Log instance to check + * @param invocation the {@code MethodInvocation} being traced + * @param logger the {@code Log} instance to check * @see #invokeUnderTrace * @see #isLogEnabled */ @@ -161,9 +161,9 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser /** * Determine whether the given {@link Log} instance is enabled. - *

Default is true when the "trace" level is enabled. + *

Default is {@code true} when the "trace" level is enabled. * Subclasses can override this to change the level under which 'tracing' occurs. - * @param logger the Log instance to check + * @param logger the {@code Log} instance to check */ protected boolean isLogEnabled(Log logger) { return logger.isTraceEnabled(); @@ -172,16 +172,16 @@ public abstract class AbstractTraceInterceptor implements MethodInterceptor, Ser /** * Subclasses must override this method to perform any tracing around the - * supplied MethodInvocation. Subclasses are responsible for - * ensuring that the MethodInvocation actually executes by - * calling MethodInvocation.proceed(). - *

By default, the passed-in Log instance will have log level + * supplied {@code MethodInvocation}. Subclasses are responsible for + * ensuring that the {@code MethodInvocation} actually executes by + * calling {@code MethodInvocation.proceed()}. + *

By default, the passed-in {@code Log} instance will have log level * "trace" enabled. Subclasses do not have to check for this again, unless - * they overwrite the isInterceptorEnabled method to modify + * they overwrite the {@code isInterceptorEnabled} method to modify * the default behavior. - * @param logger the Log to write trace messages to - * @return the result of the call to MethodInvocation.proceed() - * @throws Throwable if the call to MethodInvocation.proceed() + * @param logger the {@code Log} to write trace messages to + * @return the result of the call to {@code MethodInvocation.proceed()} + * @throws Throwable if the call to {@code MethodInvocation.proceed()} * encountered any errors * @see #isInterceptorEnabled * @see #isLogEnabled 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 8b2c788ef3..792639b1c6 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 @@ -30,19 +30,19 @@ import org.springframework.core.task.AsyncTaskExecutor; import org.springframework.util.ReflectionUtils; /** - * AOP Alliance MethodInterceptor that processes method invocations + * AOP Alliance {@code MethodInterceptor} that processes method invocations * asynchronously, using a given {@link org.springframework.core.task.AsyncTaskExecutor}. * Typically used with the {@link org.springframework.scheduling.annotation.Async} annotation. * *

In terms of target method signatures, any parameter types are supported. - * However, the return type is constrained to either void or - * java.util.concurrent.Future. In the latter case, the Future handle + * However, the return type is constrained to either {@code void} or + * {@code java.util.concurrent.Future}. In the latter case, the Future handle * returned from the proxy will be an actual asynchronous Future that can be used * to track the result of the asynchronous method execution. However, since the * target method needs to implement the same signature, it will have to return * a temporary Future handle that just passes the return value through * (like Spring's {@link org.springframework.scheduling.annotation.AsyncResult} - * or EJB 3.1's javax.ejb.AsyncResult). + * or EJB 3.1's {@code javax.ejb.AsyncResult}). * *

As of Spring 3.1.2 the {@code AnnotationAsyncExecutionInterceptor} subclass is * preferred for use due to its support for executor qualification in conjunction with diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/CustomizableTraceInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/CustomizableTraceInterceptor.java index db00bcbbf6..63e7c8d5b1 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/CustomizableTraceInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/CustomizableTraceInterceptor.java @@ -30,7 +30,7 @@ import org.springframework.util.StopWatch; import org.springframework.util.StringUtils; /** - * MethodInterceptor implementation that allows for highly customizable + * {@code MethodInterceptor} implementation that allows for highly customizable * method-level tracing, using placeholders. * *

Trace messages are written on method entry, and if the method invocation succeeds @@ -40,19 +40,19 @@ import org.springframework.util.StringUtils; * messages. The placeholders available are: * *

    - *
  • $[methodName] - replaced with the name of the method being invoked
  • - *
  • $[targetClassName] - replaced with the name of the class that is + *
  • {@code $[methodName]} - replaced with the name of the method being invoked
  • + *
  • {@code $[targetClassName]} - replaced with the name of the class that is * the target of the invocation
  • - *
  • $[targetClassShortName] - replaced with the short name of the class + *
  • {@code $[targetClassShortName]} - replaced with the short name of the class * that is the target of the invocation
  • - *
  • $[returnValue] - replaced with the value returned by the invocation
  • - *
  • $[argumentTypes] - replaced with a comma-separated list of the + *
  • {@code $[returnValue]} - replaced with the value returned by the invocation
  • + *
  • {@code $[argumentTypes]} - replaced with a comma-separated list of the * short class names of the method arguments
  • - *
  • $[arguments] - replaced with a comma-separated list of the - * String representation of the method arguments
  • - *
  • $[exception] - replaced with the String representation - * of any Throwable raised during the invocation
  • - *
  • $[invocationTime] - replaced with the time, in milliseconds, + *
  • {@code $[arguments]} - replaced with a comma-separated list of the + * {@code String} representation of the method arguments
  • + *
  • {@code $[exception]} - replaced with the {@code String} representation + * of any {@code Throwable} raised during the invocation
  • + *
  • {@code $[invocationTime]} - replaced with the time, in milliseconds, * taken by the method invocation
  • *
* @@ -70,56 +70,56 @@ import org.springframework.util.StringUtils; public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { /** - * The $[methodName] placeholder. + * The {@code $[methodName]} placeholder. * Replaced with the name of the method being invoked. */ public static final String PLACEHOLDER_METHOD_NAME = "$[methodName]"; /** - * The $[targetClassName] placeholder. - * Replaced with the fully-qualifed name of the Class + * The {@code $[targetClassName]} placeholder. + * Replaced with the fully-qualifed name of the {@code Class} * of the method invocation target. */ public static final String PLACEHOLDER_TARGET_CLASS_NAME = "$[targetClassName]"; /** - * The $[targetClassShortName] placeholder. - * Replaced with the short name of the Class of the + * The {@code $[targetClassShortName]} placeholder. + * Replaced with the short name of the {@code Class} of the * method invocation target. */ public static final String PLACEHOLDER_TARGET_CLASS_SHORT_NAME = "$[targetClassShortName]"; /** - * The $[returnValue] placeholder. - * Replaced with the String representation of the value + * The {@code $[returnValue]} placeholder. + * Replaced with the {@code String} representation of the value * returned by the method invocation. */ public static final String PLACEHOLDER_RETURN_VALUE = "$[returnValue]"; /** - * The $[argumentTypes] placeholder. + * The {@code $[argumentTypes]} placeholder. * Replaced with a comma-separated list of the argument types for the * method invocation. Argument types are written as short class names. */ public static final String PLACEHOLDER_ARGUMENT_TYPES = "$[argumentTypes]"; /** - * The $[arguments] placeholder. + * The {@code $[arguments]} placeholder. * Replaced with a comma separated list of the argument values for the - * method invocation. Relies on the toString() method of + * method invocation. Relies on the {@code toString()} method of * each argument type. */ public static final String PLACEHOLDER_ARGUMENTS = "$[arguments]"; /** - * The $[exception] placeholder. - * Replaced with the String representation of any - * Throwable raised during method invocation. + * The {@code $[exception]} placeholder. + * Replaced with the {@code String} representation of any + * {@code Throwable} raised during method invocation. */ public static final String PLACEHOLDER_EXCEPTION = "$[exception]"; /** - * The $[invocationTime] placeholder. + * The {@code $[invocationTime]} placeholder. * Replaced with the time taken by the invocation (in milliseconds). */ public static final String PLACEHOLDER_INVOCATION_TIME = "$[invocationTime]"; @@ -143,12 +143,12 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { "Exception thrown in method '" + PLACEHOLDER_METHOD_NAME + "' of class [" + PLACEHOLDER_TARGET_CLASS_NAME + "]"; /** - * The Pattern used to match placeholders. + * The {@code Pattern} used to match placeholders. */ private static final Pattern PATTERN = Pattern.compile("\\$\\[\\p{Alpha}+\\]"); /** - * The Set of allowed placeholders. + * The {@code Set} of allowed placeholders. */ private static final Set ALLOWED_PLACEHOLDERS = new Constants(CustomizableTraceInterceptor.class).getValues("PLACEHOLDER_"); @@ -174,10 +174,10 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { * Set the template used for method entry log messages. * This template can contain any of the following placeholders: *
    - *
  • $[targetClassName]
  • - *
  • $[targetClassShortName]
  • - *
  • $[argumentTypes]
  • - *
  • $[arguments]
  • + *
  • {@code $[targetClassName]}
  • + *
  • {@code $[targetClassShortName]}
  • + *
  • {@code $[argumentTypes]}
  • + *
  • {@code $[arguments]}
  • *
*/ public void setEnterMessage(String enterMessage) throws IllegalArgumentException { @@ -196,12 +196,12 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { * Set the template used for method exit log messages. * This template can contain any of the following placeholders: *
    - *
  • $[targetClassName]
  • - *
  • $[targetClassShortName]
  • - *
  • $[argumentTypes]
  • - *
  • $[arguments]
  • - *
  • $[returnValue]
  • - *
  • $[invocationTime]
  • + *
  • {@code $[targetClassName]}
  • + *
  • {@code $[targetClassShortName]}
  • + *
  • {@code $[argumentTypes]}
  • + *
  • {@code $[arguments]}
  • + *
  • {@code $[returnValue]}
  • + *
  • {@code $[invocationTime]}
  • *
*/ public void setExitMessage(String exitMessage) { @@ -216,11 +216,11 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { * Set the template used for method exception log messages. * This template can contain any of the following placeholders: *
    - *
  • $[targetClassName]
  • - *
  • $[targetClassShortName]
  • - *
  • $[argumentTypes]
  • - *
  • $[arguments]
  • - *
  • $[exception]
  • + *
  • {@code $[targetClassName]}
  • + *
  • {@code $[targetClassShortName]}
  • + *
  • {@code $[argumentTypes]}
  • + *
  • {@code $[arguments]}
  • + *
  • {@code $[exception]}
  • *
*/ public void setExceptionMessage(String exceptionMessage) { @@ -235,10 +235,10 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { /** - * Writes a log message before the invocation based on the value of enterMessage. + * Writes a log message before the invocation based on the value of {@code enterMessage}. * If the invocation succeeds, then a log message is written on exit based on the value - * exitMessage. If an exception occurs during invocation, then a message is - * written based on the value of exceptionMessage. + * {@code exitMessage}. If an exception occurs during invocation, then a message is + * written based on the value of {@code exceptionMessage}. * @see #setEnterMessage * @see #setExitMessage * @see #setExceptionMessage @@ -277,7 +277,7 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { } /** - * Writes the supplied message to the supplied Log instance. + * Writes the supplied message to the supplied {@code Log} instance. * @see #writeToLog(org.apache.commons.logging.Log, String, Throwable) */ protected void writeToLog(Log logger, String message) { @@ -286,8 +286,8 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { /** * Writes the supplied message and {@link Throwable} to the - * supplied Log instance. By default messages are written - * at TRACE level. Sub-classes can override this method + * supplied {@code Log} instance. By default messages are written + * at {@code TRACE} level. Sub-classes can override this method * to control which level the message is written at. */ protected void writeToLog(Log logger, String message, Throwable ex) { @@ -303,16 +303,16 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { * Replace the placeholders in the given message with the supplied values, * or values derived from those supplied. * @param message the message template containing the placeholders to be replaced - * @param methodInvocation the MethodInvocation being logged. - * Used to derive values for all placeholders except $[exception] - * and $[returnValue]. + * @param methodInvocation the {@code MethodInvocation} being logged. + * Used to derive values for all placeholders except {@code $[exception]} + * and {@code $[returnValue]}. * @param returnValue any value returned by the invocation. - * Used to replace the $[returnValue] placeholder. May be null. - * @param throwable any Throwable raised during the invocation. - * The value of Throwable.toString() is replaced for the - * $[exception] placeholder. May be null. + * Used to replace the {@code $[returnValue]} placeholder. May be {@code null}. + * @param throwable any {@code Throwable} raised during the invocation. + * The value of {@code Throwable.toString()} is replaced for the + * {@code $[exception]} placeholder. May be {@code null}. * @param invocationTime the value to write in place of the - * $[invocationTime] placeholder + * {@code $[invocationTime]} placeholder * @return the formatted output to write to the log */ protected String replacePlaceholders(String message, MethodInvocation methodInvocation, @@ -360,12 +360,12 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { } /** - * Adds the String representation of the method return value - * to the supplied StringBuffer. Correctly handles - * null and void results. - * @param methodInvocation the MethodInvocation that returned the value - * @param matcher the Matcher containing the matched placeholder - * @param output the StringBuffer to write output to + * Adds the {@code String} representation of the method return value + * to the supplied {@code StringBuffer}. Correctly handles + * {@code null} and {@code void} results. + * @param methodInvocation the {@code MethodInvocation} that returned the value + * @param matcher the {@code Matcher} containing the matched placeholder + * @param output the {@code StringBuffer} to write output to * @param returnValue the value returned by the method invocation. */ private void appendReturnValue( @@ -383,14 +383,14 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { } /** - * Adds a comma-separated list of the short Class names of the + * Adds a comma-separated list of the short {@code Class} names of the * method argument types to the output. For example, if a method has signature - * put(java.lang.String, java.lang.Object) then the value returned - * will be String, Object. - * @param methodInvocation the MethodInvocation being logged. - * Arguments will be retrieved from the corresponding Method. - * @param matcher the Matcher containing the state of the output - * @param output the StringBuffer containing the output + * {@code put(java.lang.String, java.lang.Object)} then the value returned + * will be {@code String, Object}. + * @param methodInvocation the {@code MethodInvocation} being logged. + * Arguments will be retrieved from the corresponding {@code Method}. + * @param matcher the {@code Matcher} containing the state of the output + * @param output the {@code StringBuffer} containing the output */ private void appendArgumentTypes(MethodInvocation methodInvocation, Matcher matcher, StringBuffer output) { Class[] argumentTypes = methodInvocation.getMethod().getParameterTypes(); @@ -402,9 +402,9 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { } /** - * Checks to see if the supplied String has any placeholders + * Checks to see if the supplied {@code String} has any placeholders * that are not specified as constants on this class and throws an - * IllegalArgumentException if so. + * {@code IllegalArgumentException} if so. */ private void checkForInvalidPlaceholders(String message) throws IllegalArgumentException { Matcher matcher = PATTERN.matcher(message); @@ -417,8 +417,8 @@ public class CustomizableTraceInterceptor extends AbstractTraceInterceptor { } /** - * Replaces $ in inner class names with \$. - *

This code is equivalent to JDK 1.5's quoteReplacement + * Replaces {@code $} in inner class names with {@code \$}. + *

This code is equivalent to JDK 1.5's {@code quoteReplacement} * method in the Matcher class itself. We're keeping our own version * here for JDK 1.4 compliance reasons only. */ diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/DebugInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/DebugInterceptor.java index 665238f35b..e027d9a13b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/DebugInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/DebugInterceptor.java @@ -19,13 +19,13 @@ package org.springframework.aop.interceptor; import org.aopalliance.intercept.MethodInvocation; /** - * AOP Alliance MethodInterceptor that can be introduced in a chain + * AOP Alliance {@code MethodInterceptor} that can be introduced in a chain * to display verbose information about intercepted invocations to the logger. * *

Logs full invocation details on method entry and method exit, * including invocation arguments and invocation count. This is only - * intended for debugging purposes; use SimpleTraceInterceptor - * or CustomizableTraceInterceptor for pure tracing purposes. + * intended for debugging purposes; use {@code SimpleTraceInterceptor} + * or {@code CustomizableTraceInterceptor} for pure tracing purposes. * * @author Rod Johnson * @author Juergen Hoeller diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeBeanNameAdvisors.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeBeanNameAdvisors.java index 5fbb6ad8e8..42750137ac 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeBeanNameAdvisors.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/ExposeBeanNameAdvisors.java @@ -29,7 +29,7 @@ import org.springframework.beans.factory.NamedBean; /** * Convenient methods for creating advisors that may be used when autoproxying beans * created with the Spring IoC container, binding the bean name to the current - * invocation. May support a bean() pointcut designator with AspectJ. + * invocation. May support a {@code bean()} pointcut designator with AspectJ. * *

Typically used in Spring auto-proxying, where the bean name is known * at proxy creation time. @@ -52,7 +52,7 @@ public abstract class ExposeBeanNameAdvisors { * Find the bean name for the current invocation. Assumes that an ExposeBeanNameAdvisor * has been included in the interceptor chain, and that the invocation is exposed * with ExposeInvocationInterceptor. - * @return the bean name (never null) + * @return the bean name (never {@code null}) * @throws IllegalStateException if the bean name has not been exposed */ public static String getBeanName() throws IllegalStateException { @@ -63,7 +63,7 @@ public abstract class ExposeBeanNameAdvisors { * Find the bean name for the given invocation. Assumes that an ExposeBeanNameAdvisor * has been included in the interceptor chain. * @param mi MethodInvocation that should contain the bean name as an attribute - * @return the bean name (never null) + * @return the bean name (never {@code null}) * @throws IllegalStateException if the bean name has not been exposed */ public static String getBeanName(MethodInvocation mi) throws IllegalStateException { 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 86ac202756..51de80ec0f 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 @@ -101,7 +101,7 @@ public class ExposeInvocationInterceptor implements MethodInterceptor, Ordered, /** * Required to support serialization. Replaces with canonical instance * on deserialization, protecting Singleton pattern. - *

Alternative to overriding the equals method. + *

Alternative to overriding the {@code equals} method. */ private Object readResolve() { return INSTANCE; diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/PerformanceMonitorInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/PerformanceMonitorInterceptor.java index f22f54a77b..7db0a7ed3d 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/PerformanceMonitorInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/PerformanceMonitorInterceptor.java @@ -22,10 +22,10 @@ import org.apache.commons.logging.Log; import org.springframework.util.StopWatch; /** - * Simple AOP Alliance MethodInterceptor for performance monitoring. + * Simple AOP Alliance {@code MethodInterceptor} for performance monitoring. * This interceptor has no effect on the intercepted method call. * - *

Uses a StopWatch for the actual performance measuring. + *

Uses a {@code StopWatch} for the actual performance measuring. * * @author Rod Johnson * @author Dmitriy Kopylenko diff --git a/spring-aop/src/main/java/org/springframework/aop/interceptor/SimpleTraceInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/interceptor/SimpleTraceInterceptor.java index 34d0185561..6a7fb5c171 100644 --- a/spring-aop/src/main/java/org/springframework/aop/interceptor/SimpleTraceInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/interceptor/SimpleTraceInterceptor.java @@ -20,11 +20,11 @@ import org.aopalliance.intercept.MethodInvocation; import org.apache.commons.logging.Log; /** - * Simple AOP Alliance MethodInterceptor that can be introduced + * Simple AOP Alliance {@code MethodInterceptor} that can be introduced * in a chain to display verbose trace information about intercepted method * invocations, with method entry and method exit info. * - *

Consider using CustomizableTraceInterceptor for more + *

Consider using {@code CustomizableTraceInterceptor} for more * advanced needs. * * @author Dmitriy Kopylenko diff --git a/spring-aop/src/main/java/org/springframework/aop/support/AbstractExpressionPointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/AbstractExpressionPointcut.java index 743d4559fd..db654b56a0 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/AbstractExpressionPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/AbstractExpressionPointcut.java @@ -46,7 +46,7 @@ public abstract class AbstractExpressionPointcut implements ExpressionPointcut, * Return location information about the pointcut expression * if available. This is useful in debugging. * @return location information as a human-readable String, - * or null if none is available + * or {@code null} if none is available */ public String getLocation() { return this.location; 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 ac64a99226..3967691556 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 @@ -34,8 +34,8 @@ import org.springframework.util.StringUtils; * * *

Note: the regular expressions must be a match. For example, - * .*get.* will match com.mycom.Foo.getBar(). - * get.* will not. + * {@code .*get.*} will match com.mycom.Foo.getBar(). + * {@code get.*} will not. * *

This base class is serializable. Subclasses should declare all fields transient * - the initPatternRepresentation method in this class will be invoked again on the @@ -172,17 +172,17 @@ public abstract class AbstractRegexpMethodPointcut extends StaticMethodMatcherPo /** * Does the pattern at the given index match this string? - * @param pattern String pattern to match + * @param pattern {@code String} pattern to match * @param patternIndex index of pattern from 0 - * @return true if there is a match, else false. + * @return {@code true} if there is a match, else {@code false}. */ protected abstract boolean matches(String pattern, int patternIndex); /** * Does the exclusion pattern at the given index match this string? - * @param pattern String pattern to match. + * @param pattern {@code String} pattern to match. * @param patternIndex index of pattern starting from 0. - * @return true if there is a match, else false. + * @return {@code true} if there is a match, else {@code false}. */ protected abstract boolean matchesExclusion(String pattern, int patternIndex); 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 86234323a2..fdd985191e 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 @@ -109,7 +109,7 @@ public abstract class AopUtils { *

Returns the target class for an AOP proxy and the plain class else. * @param candidate the instance to check (might be an AOP proxy) * @return the target class (or the plain class of the given object as fallback; - * never null) + * never {@code null}) * @see org.springframework.aop.TargetClassAware#getTargetClass() * @see org.springframework.aop.framework.AopProxyUtils#ultimateTargetClass(Object) */ @@ -161,17 +161,17 @@ public abstract class AopUtils { /** * 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 IFoo.bar() and the target class - * may be DefaultFoo. In this case, the method may be - * DefaultFoo.bar(). This enables attributes on that method to be found. + * is one. E.g. 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}, * this method resolves Java 5 bridge methods in order to retrieve attributes * from the original method definition. * @param method the method to be invoked, which may come from an interface * @param targetClass the target class for the current invocation. - * May be null or may not even implement the method. + * May be {@code null} or may not even implement the method. * @return the specific target method, or the original method if the - * targetClass doesn't implement it or is null + * {@code targetClass} doesn't implement it or is {@code null} * @see org.springframework.util.ClassUtils#getMostSpecificMethod */ public static Method getMostSpecificMethod(Method method, Class targetClass) { @@ -268,7 +268,7 @@ public abstract class AopUtils { } /** - * Determine the sublist of the candidateAdvisors list + * Determine the sublist of the {@code candidateAdvisors} list * that is applicable to the given class. * @param candidateAdvisors the Advisors to evaluate * @param clazz the target class diff --git a/spring-aop/src/main/java/org/springframework/aop/support/ComposablePointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/ComposablePointcut.java index b92e535f63..1ec8a01229 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/ComposablePointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/ComposablePointcut.java @@ -28,9 +28,9 @@ import org.springframework.util.ObjectUtils; * Convenient class for building up pointcuts. All methods return * ComposablePointcut, so we can use a concise idiom like: * - * + * {@code * Pointcut pc = new ComposablePointcut().union(classFilter).intersection(methodMatcher).intersection(pointcut); - * + * } * * @author Rod Johnson * @author Juergen Hoeller @@ -49,8 +49,8 @@ public class ComposablePointcut implements Pointcut, Serializable { /** - * Create a default ComposablePointcut, with ClassFilter.TRUE - * and MethodMatcher.TRUE. + * Create a default ComposablePointcut, with {@code ClassFilter.TRUE} + * and {@code MethodMatcher.TRUE}. */ public ComposablePointcut() { this.classFilter = ClassFilter.TRUE; @@ -69,7 +69,7 @@ public class ComposablePointcut implements Pointcut, Serializable { /** * Create a ComposablePointcut for the given ClassFilter, - * with MethodMatcher.TRUE. + * with {@code MethodMatcher.TRUE}. * @param classFilter the ClassFilter to use */ public ComposablePointcut(ClassFilter classFilter) { @@ -80,7 +80,7 @@ public class ComposablePointcut implements Pointcut, Serializable { /** * Create a ComposablePointcut for the given MethodMatcher, - * with ClassFilter.TRUE. + * with {@code ClassFilter.TRUE}. * @param methodMatcher the MethodMatcher to use */ public ComposablePointcut(MethodMatcher methodMatcher) { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/DefaultBeanFactoryPointcutAdvisor.java b/spring-aop/src/main/java/org/springframework/aop/support/DefaultBeanFactoryPointcutAdvisor.java index 0de1c9fd08..9059a86669 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/DefaultBeanFactoryPointcutAdvisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/DefaultBeanFactoryPointcutAdvisor.java @@ -39,7 +39,7 @@ public class DefaultBeanFactoryPointcutAdvisor extends AbstractBeanFactoryPointc /** * Specify the pointcut targeting the advice. - *

Default is Pointcut.TRUE. + *

Default is {@code Pointcut.TRUE}. * @see #setAdviceBeanName */ public void setPointcut(Pointcut pointcut) { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/DefaultIntroductionAdvisor.java b/spring-aop/src/main/java/org/springframework/aop/support/DefaultIntroductionAdvisor.java index 8d5eac8966..36c81c130b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/DefaultIntroductionAdvisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/DefaultIntroductionAdvisor.java @@ -62,7 +62,7 @@ public class DefaultIntroductionAdvisor implements IntroductionAdvisor, ClassFil * Create a DefaultIntroductionAdvisor for the given advice. * @param advice the Advice to apply * @param introductionInfo the IntroductionInfo that describes - * the interface to introduce (may be null) + * the interface to introduce (may be {@code null}) */ public DefaultIntroductionAdvisor(Advice advice, IntroductionInfo introductionInfo) { Assert.notNull(advice, "Advice must not be null"); diff --git a/spring-aop/src/main/java/org/springframework/aop/support/DefaultPointcutAdvisor.java b/spring-aop/src/main/java/org/springframework/aop/support/DefaultPointcutAdvisor.java index 2e97d6de12..7cb9ffb44e 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/DefaultPointcutAdvisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/DefaultPointcutAdvisor.java @@ -42,14 +42,14 @@ public class DefaultPointcutAdvisor extends AbstractGenericPointcutAdvisor imple /** * Create an empty DefaultPointcutAdvisor. *

Advice must be set before use using setter methods. - * Pointcut will normally be set also, but defaults to Pointcut.TRUE. + * Pointcut will normally be set also, but defaults to {@code Pointcut.TRUE}. */ public DefaultPointcutAdvisor() { } /** * Create a DefaultPointcutAdvisor that matches all methods. - *

Pointcut.TRUE will be used as Pointcut. + *

{@code Pointcut.TRUE} will be used as Pointcut. * @param advice the Advice to use */ public DefaultPointcutAdvisor(Advice advice) { @@ -69,7 +69,7 @@ public class DefaultPointcutAdvisor extends AbstractGenericPointcutAdvisor imple /** * Specify the pointcut targeting the advice. - *

Default is Pointcut.TRUE. + *

Default is {@code Pointcut.TRUE}. * @see #setAdvice */ public void setPointcut(Pointcut pointcut) { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/DelegatePerTargetObjectIntroductionInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/support/DelegatePerTargetObjectIntroductionInterceptor.java index 8cac8329e3..7e0747ab86 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/DelegatePerTargetObjectIntroductionInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/DelegatePerTargetObjectIntroductionInterceptor.java @@ -34,7 +34,7 @@ import org.springframework.aop.ProxyMethodInvocation; * object will have its own delegate (whereas DelegatingIntroductionInterceptor * shares the same delegate, and hence the same state across all targets). * - *

The suppressInterface method can be used to suppress interfaces + *

The {@code suppressInterface} method can be used to suppress interfaces * implemented by the delegate class but which should not be introduced to the * owning AOP proxy. * diff --git a/spring-aop/src/main/java/org/springframework/aop/support/DelegatingIntroductionInterceptor.java b/spring-aop/src/main/java/org/springframework/aop/support/DelegatingIntroductionInterceptor.java index 340e66639d..738c336643 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/DelegatingIntroductionInterceptor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/DelegatingIntroductionInterceptor.java @@ -36,7 +36,7 @@ import org.springframework.util.Assert; * All interfaces except IntroductionInterceptor are picked up from * the subclass or delegate by default. * - *

The suppressInterface method can be used to suppress interfaces + *

The {@code suppressInterface} method can be used to suppress interfaces * implemented by the delegate but which should not be introduced to the owning * AOP proxy. * diff --git a/spring-aop/src/main/java/org/springframework/aop/support/JdkRegexpMethodPointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/JdkRegexpMethodPointcut.java index 61595ff86a..af1b41c711 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/JdkRegexpMethodPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/JdkRegexpMethodPointcut.java @@ -21,7 +21,7 @@ import java.util.regex.Pattern; import java.util.regex.PatternSyntaxException; /** - * Regular expression pointcut based on the java.util.regex package. + * Regular expression pointcut based on the {@code java.util.regex} package. * Supports the following JavaBean properties: *

    *
  • pattern: regular expression for the fully-qualified method names to match @@ -30,8 +30,8 @@ import java.util.regex.PatternSyntaxException; *
* *

Note: the regular expressions must be a match. For example, - * .*get.* will match com.mycom.Foo.getBar(). - * get.* will not. + * {@code .*get.*} will match com.mycom.Foo.getBar(). + * {@code get.*} will not. * * @author Dmitriy Kopylenko * @author Rob Harrop @@ -51,7 +51,7 @@ public class JdkRegexpMethodPointcut extends AbstractRegexpMethodPointcut { /** - * Initialize {@link Pattern Patterns} from the supplied String[]. + * Initialize {@link Pattern Patterns} from the supplied {@code String[]}. */ @Override protected void initPatternRepresentation(String[] patterns) throws PatternSyntaxException { @@ -59,7 +59,7 @@ public class JdkRegexpMethodPointcut extends AbstractRegexpMethodPointcut { } /** - * Initialize exclusion {@link Pattern Patterns} from the supplied String[]. + * Initialize exclusion {@link Pattern Patterns} from the supplied {@code String[]}. */ @Override protected void initExcludedPatternRepresentation(String[] excludedPatterns) throws PatternSyntaxException { @@ -67,8 +67,8 @@ public class JdkRegexpMethodPointcut extends AbstractRegexpMethodPointcut { } /** - * Returns true if the {@link Pattern} at index patternIndex - * matches the supplied candidate String. + * Returns {@code true} if the {@link Pattern} at index {@code patternIndex} + * matches the supplied candidate {@code String}. */ @Override protected boolean matches(String pattern, int patternIndex) { @@ -77,8 +77,8 @@ public class JdkRegexpMethodPointcut extends AbstractRegexpMethodPointcut { } /** - * Returns true if the exclusion {@link Pattern} at index patternIndex - * matches the supplied candidate String. + * Returns {@code true} if the exclusion {@link Pattern} at index {@code patternIndex} + * matches the supplied candidate {@code String}. */ @Override protected boolean matchesExclusion(String candidate, int patternIndex) { @@ -88,7 +88,7 @@ public class JdkRegexpMethodPointcut extends AbstractRegexpMethodPointcut { /** - * Compiles the supplied String[] into an array of + * Compiles the supplied {@code String[]} into an array of * {@link Pattern} objects and returns that array. */ private Pattern[] compilePatterns(String[] source) throws PatternSyntaxException { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/MethodMatchers.java b/spring-aop/src/main/java/org/springframework/aop/support/MethodMatchers.java index b4d4fd6f47..54c612d4cb 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/MethodMatchers.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/MethodMatchers.java @@ -82,10 +82,10 @@ public abstract class MethodMatchers { * (if applicable). * @param mm the MethodMatcher to apply (may be an IntroductionAwareMethodMatcher) * @param method the candidate method - * @param targetClass the target class (may be null, in which case + * @param targetClass the target class (may be {@code null}, in which case * the candidate class must be taken to be the method's declaring class) - * @param hasIntroductions true if the object on whose behalf we are - * asking is the subject on one or more introductions; false otherwise + * @param hasIntroductions {@code true} if the object on whose behalf we are + * asking is the subject on one or more introductions; {@code false} otherwise * @return whether or not this method matches statically */ public static boolean matches(MethodMatcher mm, Method method, Class targetClass, boolean hasIntroductions) { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcut.java index 44a03380ff..0cb2e94d5c 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcut.java @@ -42,7 +42,7 @@ public class NameMatchMethodPointcut extends StaticMethodMatcherPointcut impleme /** * Convenience method when we have only a single method name to match. - * Use either this method or setMappedNames, not both. + * Use either this method or {@code setMappedNames}, not both. * @see #setMappedNames */ public void setMappedName(String mappedName) { diff --git a/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcutAdvisor.java b/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcutAdvisor.java index 4cd21ec070..46e4f9b876 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcutAdvisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/NameMatchMethodPointcutAdvisor.java @@ -53,7 +53,7 @@ public class NameMatchMethodPointcutAdvisor extends AbstractGenericPointcutAdvis /** * Convenience method when we have only a single method name to match. - * Use either this method or setMappedNames, not both. + * Use either this method or {@code setMappedNames}, not both. * @see #setMappedNames * @see NameMatchMethodPointcut#setMappedName */ diff --git a/spring-aop/src/main/java/org/springframework/aop/support/RegexpMethodPointcutAdvisor.java b/spring-aop/src/main/java/org/springframework/aop/support/RegexpMethodPointcutAdvisor.java index a610e37f71..74a71b6937 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/RegexpMethodPointcutAdvisor.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/RegexpMethodPointcutAdvisor.java @@ -128,7 +128,7 @@ public class RegexpMethodPointcutAdvisor extends AbstractGenericPointcutAdvisor /** * Create the actual pointcut: By default, a {@link JdkRegexpMethodPointcut} * will be used. - * @return the Pointcut instance (never null) + * @return the Pointcut instance (never {@code null}) */ protected AbstractRegexpMethodPointcut createPointcut() { return new JdkRegexpMethodPointcut(); diff --git a/spring-aop/src/main/java/org/springframework/aop/support/annotation/AnnotationMatchingPointcut.java b/spring-aop/src/main/java/org/springframework/aop/support/annotation/AnnotationMatchingPointcut.java index 01181525e8..9bafe1bd49 100644 --- a/spring-aop/src/main/java/org/springframework/aop/support/annotation/AnnotationMatchingPointcut.java +++ b/spring-aop/src/main/java/org/springframework/aop/support/annotation/AnnotationMatchingPointcut.java @@ -64,9 +64,9 @@ public class AnnotationMatchingPointcut implements Pointcut { /** * Create a new AnnotationMatchingPointcut for the given annotation type. * @param classAnnotationType the annotation type to look for at the class level - * (can be null) + * (can be {@code null}) * @param methodAnnotationType the annotation type to look for at the method level - * (can be null) + * (can be {@code null}) */ public AnnotationMatchingPointcut( Class classAnnotationType, Class methodAnnotationType) { diff --git a/spring-aop/src/main/java/org/springframework/aop/target/AbstractBeanFactoryBasedTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/AbstractBeanFactoryBasedTargetSource.java index 2980b0bf42..8a2d9a6a27 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/AbstractBeanFactoryBasedTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/AbstractBeanFactoryBasedTargetSource.java @@ -94,8 +94,8 @@ public abstract class AbstractBeanFactoryBasedTargetSource /** * Specify the target class explicitly, to avoid any kind of access to the * target bean (for example, to avoid initialization of a FactoryBean instance). - *

Default is to detect the type automatically, through a getType - * call on the BeanFactory (or even a full getBean call as fallback). + *

Default is to detect the type automatically, through a {@code getType} + * call on the BeanFactory (or even a full {@code getBean} call as fallback). */ public void setTargetClass(Class targetClass) { this.targetClass = targetClass; @@ -103,7 +103,7 @@ public abstract class AbstractBeanFactoryBasedTargetSource /** * Set the owning BeanFactory. We need to save a reference so that we can - * use the getBean method on every invocation. + * use the {@code getBean} method on every invocation. */ public void setBeanFactory(BeanFactory beanFactory) { if (this.targetBeanName == null) { diff --git a/spring-aop/src/main/java/org/springframework/aop/target/AbstractLazyCreationTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/AbstractLazyCreationTargetSource.java index 3119e847f1..86259b7abe 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/AbstractLazyCreationTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/AbstractLazyCreationTargetSource.java @@ -26,7 +26,7 @@ import org.springframework.aop.TargetSource; * lazily create a user-managed object. * *

Creation of the lazy target object is controlled by the user by implementing - * the {@link #createObject()} method. This TargetSource will invoke + * the {@link #createObject()} method. This {@code TargetSource} will invoke * this method the first time the proxy is accessed. * *

Useful when you need to pass a reference to some dependency to an object @@ -57,11 +57,11 @@ public abstract class AbstractLazyCreationTargetSource implements TargetSource { } /** - * This default implementation returns null if the - * target is null (it is hasn't yet been initialized), + * This default implementation returns {@code null} if the + * target is {@code null} (it is hasn't yet been initialized), * or the target class if the target has already been initialized. *

Subclasses may wish to override this method in order to provide - * a meaningful value when the target is still null. + * a meaningful value when the target is still {@code null}. * @see #isInitialized() */ public synchronized Class getTargetClass() { diff --git a/spring-aop/src/main/java/org/springframework/aop/target/AbstractPoolingTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/AbstractPoolingTargetSource.java index 3c73521e74..ccb8b56637 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/AbstractPoolingTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/AbstractPoolingTargetSource.java @@ -102,7 +102,7 @@ public abstract class AbstractPoolingTargetSource extends AbstractPrototypeBased /** * Return the given object to the pool. * @param target object that must have been acquired from the pool - * via a call to getTarget() + * via a call to {@code getTarget()} * @throws Exception to allow pooling APIs to throw exception * @see #getTarget */ diff --git a/spring-aop/src/main/java/org/springframework/aop/target/AbstractPrototypeBasedTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/AbstractPrototypeBasedTargetSource.java index f2677afbc2..4880d5119b 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/AbstractPrototypeBasedTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/AbstractPrototypeBasedTargetSource.java @@ -33,7 +33,7 @@ import org.springframework.beans.factory.config.ConfigurableBeanFactory; * new-instance-per-invocation strategy. * *

Such TargetSources must run in a {@link BeanFactory}, as it needs to - * call the getBean method to create a new prototype instance. + * call the {@code getBean} method to create a new prototype instance. * Therefore, this base class extends {@link AbstractBeanFactoryBasedTargetSource}. * * @author Rod Johnson @@ -102,7 +102,7 @@ public abstract class AbstractPrototypeBasedTargetSource extends AbstractBeanFac /** * Replaces this object with a SingletonTargetSource on serialization. * Protected as otherwise it won't be invoked for subclasses. - * (The writeReplace() method must be visible to the class + * (The {@code writeReplace()} method must be visible to the class * being serialized.) *

With this implementation of this method, there is no need to mark * non-serializable fields in this class or subclasses as transient. diff --git a/spring-aop/src/main/java/org/springframework/aop/target/CommonsPoolTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/CommonsPoolTargetSource.java index ba3e32d1f4..24920b3987 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/CommonsPoolTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/CommonsPoolTargetSource.java @@ -27,19 +27,19 @@ import org.springframework.core.Constants; * TargetSource implementation that holds objects in a configurable * Jakarta Commons Pool. * - *

By default, an instance of GenericObjectPool is created. - * Subclasses may change the type of ObjectPool used by - * overriding the createObjectPool() method. + *

By default, an instance of {@code GenericObjectPool} is created. + * Subclasses may change the type of {@code ObjectPool} used by + * overriding the {@code createObjectPool()} method. * *

Provides many configuration properties mirroring those of the Commons Pool - * GenericObjectPool class; these properties are passed to the - * GenericObjectPool during construction. If creating a subclass of this - * class to change the ObjectPool implementation type, pass in the values + * {@code GenericObjectPool} class; these properties are passed to the + * {@code GenericObjectPool} during construction. If creating a subclass of this + * class to change the {@code ObjectPool} implementation type, pass in the values * of configuration properties that are relevant to your chosen implementation. * - *

The testOnBorrow, testOnReturn and testWhileIdle + *

The {@code testOnBorrow}, {@code testOnReturn} and {@code testWhileIdle} * properties are explictly not mirrored because the implementation of - * PoolableObjectFactory used by this class does not implement + * {@code PoolableObjectFactory} used by this class does not implement * meaningful validation. All exposed Commons Pool properties use the corresponding * Commons Pool defaults: for example, * @@ -74,7 +74,7 @@ public class CommonsPoolTargetSource extends AbstractPoolingTargetSource private byte whenExhaustedAction = GenericObjectPool.DEFAULT_WHEN_EXHAUSTED_ACTION; /** - * The Jakarta Commons ObjectPool used to pool target objects + * The Jakarta Commons {@code ObjectPool} used to pool target objects */ private ObjectPool pool; @@ -217,7 +217,7 @@ public class CommonsPoolTargetSource extends AbstractPoolingTargetSource * Subclasses can override this if they want to return a specific Commons pool. * They should apply any configuration properties to the pool here. *

Default is a GenericObjectPool instance with the given pool size. - * @return an empty Commons ObjectPool. + * @return an empty Commons {@code ObjectPool}. * @see org.apache.commons.pool.impl.GenericObjectPool * @see #setMaxSize */ @@ -235,7 +235,7 @@ public class CommonsPoolTargetSource extends AbstractPoolingTargetSource /** - * Borrow an object from the ObjectPool. + * Borrow an object from the {@code ObjectPool}. */ @Override public Object getTarget() throws Exception { @@ -243,7 +243,7 @@ public class CommonsPoolTargetSource extends AbstractPoolingTargetSource } /** - * Returns the specified object to the underlying ObjectPool. + * Returns the specified object to the underlying {@code ObjectPool}. */ @Override public void releaseTarget(Object target) throws Exception { @@ -260,7 +260,7 @@ public class CommonsPoolTargetSource extends AbstractPoolingTargetSource /** - * Closes the underlying ObjectPool when destroying this object. + * Closes the underlying {@code ObjectPool} when destroying this object. */ public void destroy() throws Exception { logger.debug("Closing Commons ObjectPool"); diff --git a/spring-aop/src/main/java/org/springframework/aop/target/EmptyTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/EmptyTargetSource.java index d67b03f0f3..f6358585e2 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/EmptyTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/EmptyTargetSource.java @@ -22,7 +22,7 @@ import org.springframework.aop.TargetSource; import org.springframework.util.ObjectUtils; /** - * Canonical TargetSource when there is no target + * Canonical {@code TargetSource} when there is no target * (or just the target class known), and behavior is supplied * by interfaces and advisors only. * @@ -47,7 +47,7 @@ public class EmptyTargetSource implements TargetSource, Serializable { /** * Return an EmptyTargetSource for the given target Class. - * @param targetClass the target Class (may be null) + * @param targetClass the target Class (may be {@code null}) * @see #getTargetClass() */ public static EmptyTargetSource forClass(Class targetClass) { @@ -56,7 +56,7 @@ public class EmptyTargetSource implements TargetSource, Serializable { /** * Return an EmptyTargetSource for the given target Class. - * @param targetClass the target Class (may be null) + * @param targetClass the target Class (may be {@code null}) * @param isStatic whether the TargetSource should be marked as static * @see #getTargetClass() */ @@ -76,9 +76,9 @@ public class EmptyTargetSource implements TargetSource, Serializable { /** * Create a new instance of the {@link EmptyTargetSource} class. - *

This constructor is private to enforce the + *

This constructor is {@code private} to enforce the * Singleton pattern / factory method pattern. - * @param targetClass the target class to expose (may be null) + * @param targetClass the target class to expose (may be {@code null}) * @param isStatic whether the TargetSource is marked as static */ private EmptyTargetSource(Class targetClass, boolean isStatic) { @@ -87,21 +87,21 @@ public class EmptyTargetSource implements TargetSource, Serializable { } /** - * Always returns the specified target Class, or null if none. + * Always returns the specified target Class, or {@code null} if none. */ public Class getTargetClass() { return this.targetClass; } /** - * Always returns true. + * Always returns {@code true}. */ public boolean isStatic() { return this.isStatic; } /** - * Always returns null. + * Always returns {@code null}. */ public Object getTarget() { return null; diff --git a/spring-aop/src/main/java/org/springframework/aop/target/LazyInitTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/LazyInitTargetSource.java index 2786e16fba..a87f92092a 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/LazyInitTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/LazyInitTargetSource.java @@ -26,9 +26,9 @@ import org.springframework.beans.BeansException; * the actual target object should not be initialized until first use. * When the target bean is defined in an * {@link org.springframework.context.ApplicationContext} (or a - * BeanFactory that is eagerly pre-instantiating singleton beans) + * {@code BeanFactory} that is eagerly pre-instantiating singleton beans) * it must be marked as "lazy-init" too, else it will be instantiated by said - * ApplicationContext (or BeanFactory) on startup. + * {@code ApplicationContext} (or {@code BeanFactory}) on startup. *

For example: * *

diff --git a/spring-aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java
index dd39eecbcb..ca20b2ceea 100644
--- a/spring-aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java
+++ b/spring-aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java
@@ -37,7 +37,7 @@ import org.springframework.core.NamedThreadLocal;
  * for example, if one caller makes repeated calls on the AOP proxy.
  *
  * 

Cleanup of thread-bound objects is performed on BeanFactory destruction, - * calling their DisposableBean.destroy() method if available. + * calling their {@code DisposableBean.destroy()} method if available. * Be aware that many thread-bound objects can be around until the application * actually shuts down. * diff --git a/spring-aop/src/main/java/org/springframework/aop/target/dynamic/AbstractRefreshableTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/dynamic/AbstractRefreshableTargetSource.java index befbcf3939..865e4fa699 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/dynamic/AbstractRefreshableTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/dynamic/AbstractRefreshableTargetSource.java @@ -56,7 +56,7 @@ public abstract class AbstractRefreshableTargetSource implements TargetSource, R * Set the delay between refresh checks, in milliseconds. * Default is -1, indicating no refresh checks at all. *

Note that an actual refresh will only happen when - * {@link #requiresRefresh()} returns true. + * {@link #requiresRefresh()} returns {@code true}. */ public void setRefreshCheckDelay(long refreshCheckDelay) { this.refreshCheckDelay = refreshCheckDelay; @@ -131,7 +131,7 @@ public abstract class AbstractRefreshableTargetSource implements TargetSource, R /** * Determine whether a refresh is required. * Invoked for each refresh check, after the refresh check delay has elapsed. - *

The default implementation always returns true, triggering + *

The default implementation always returns {@code true}, triggering * a refresh every time the delay has elapsed. To be overridden by subclasses * with an appropriate check of the underlying target resource. * @return whether a refresh is required @@ -143,7 +143,7 @@ public abstract class AbstractRefreshableTargetSource implements TargetSource, R /** * Obtain a fresh target object. *

Only invoked if a refresh check has found that a refresh is required - * (that is, {@link #requiresRefresh()} has returned true). + * (that is, {@link #requiresRefresh()} has returned {@code true}). * @return the fresh target object */ protected abstract Object freshTarget(); diff --git a/spring-aop/src/main/java/org/springframework/aop/target/dynamic/BeanFactoryRefreshableTargetSource.java b/spring-aop/src/main/java/org/springframework/aop/target/dynamic/BeanFactoryRefreshableTargetSource.java index ac39d756c7..76c17e3337 100644 --- a/spring-aop/src/main/java/org/springframework/aop/target/dynamic/BeanFactoryRefreshableTargetSource.java +++ b/spring-aop/src/main/java/org/springframework/aop/target/dynamic/BeanFactoryRefreshableTargetSource.java @@ -22,7 +22,7 @@ import org.springframework.util.Assert; /** * Refreshable TargetSource that fetches fresh target beans from a BeanFactory. * - *

Can be subclassed to override requiresRefresh() to suppress + *

Can be subclassed to override {@code requiresRefresh()} to suppress * unnecessary refreshes. By default, a refresh will be performed every time * the "refreshCheckDelay" has elapsed. * diff --git a/spring-aop/src/test/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparatorTests.java b/spring-aop/src/test/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparatorTests.java index 8af3a40d8a..de10e14b42 100644 --- a/spring-aop/src/test/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparatorTests.java +++ b/spring-aop/src/test/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparatorTests.java @@ -41,29 +41,6 @@ import org.springframework.aop.support.DefaultPointcutAdvisor; */ public final class AspectJPrecedenceComparatorTests { - /* - * Specification for the comparator (as defined in the - * AspectJPrecedenceComparator class) - * - *

- * Orders AspectJ advice/advisors by invocation order. - *

- *

- * Given two pieces of advice, a and b: - *

- *
    - *
  • if a and b are defined in different - * aspects, then the advice in the aspect with the lowest order - * value has the highest precedence
  • - *
  • if a and b are defined in the same - * aspect, then if one of a or b is a form of - * after advice, then the advice declared last in the aspect has the - * highest precedence. If neither a nor b is a - * form of after advice, then the advice declared first in the aspect has - * the highest precedence.
  • - *
- */ - private static final int HIGH_PRECEDENCE_ADVISOR_ORDER = 100; private static final int LOW_PRECEDENCE_ADVISOR_ORDER = 200; private static final int EARLY_ADVICE_DECLARATION_ORDER = 5; diff --git a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractBeanConfigurerAspect.aj b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractBeanConfigurerAspect.aj index 2061f62321..5abf0e2989 100644 --- a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractBeanConfigurerAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractBeanConfigurerAspect.aj @@ -25,7 +25,7 @@ import org.springframework.beans.factory.wiring.BeanConfigurerSupport; * pointcut in subaspects. * *

Subaspects may also need a metadata resolution strategy, in the - * BeanWiringInfoResolver interface. The default implementation + * {@code BeanWiringInfoResolver} interface. The default implementation * looks for a bean with the same name as the FQN. This is the default name * of a bean in a Spring container if the id value is not supplied explicitly. * diff --git a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractInterfaceDrivenDependencyInjectionAspect.aj b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractInterfaceDrivenDependencyInjectionAspect.aj index fee434c3e3..0a7303eca8 100644 --- a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractInterfaceDrivenDependencyInjectionAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractInterfaceDrivenDependencyInjectionAspect.aj @@ -29,8 +29,8 @@ import java.io.Serializable; *

* There are two cases that needs to be handled: *

    - *
  1. Normal object creation via the 'new' operator: this is - * taken care of by advising initialization() join points.
  2. + *
  3. Normal object creation via the '{@code new}' operator: this is + * taken care of by advising {@code initialization()} join points.
  4. *
  5. Object creation through deserialization: since no constructor is * invoked during deserialization, the aspect needs to advise a method that a * deserialization mechanism is going to invoke. Ideally, we should not @@ -41,21 +41,21 @@ import java.io.Serializable; * introduced implementation). There are a few choices for the chosen method: *
      *
    • readObject(ObjectOutputStream): Java requires that the method must be - * private

      . Since aspects cannot introduce a private member, + * {@code private}. Since aspects cannot introduce a private member, * while preserving its name, this option is ruled out.
    • - *
    • readResolve(): Java doesn't pose any restriction on an access specifier. + *
    • readResolve(): Java doesn't pose any restriction on an access specifier. * Problem solved! There is one (minor) limitation of this approach in * that if a user class already has this method, that method must be - * public. However, this shouldn't be a big burden, since + * {@code public}. However, this shouldn't be a big burden, since * use cases that need classes to implement readResolve() (custom enums, * for example) are unlikely to be marked as @Configurable, and - * in any case asking to make that method public should not + * in any case asking to make that method {@code public} should not * pose any undue burden.
    • *
    * The minor collaboration needed by user classes (i.e., that the - * implementation of readResolve(), if any, must be - * public) can be lifted as well if we were to use an - * experimental feature in AspectJ - the hasmethod() PCD.
  6. + * implementation of {@code readResolve()}, if any, must be + * {@code public}) can be lifted as well if we were to use an + * experimental feature in AspectJ - the {@code hasmethod()} PCD. *
*

@@ -103,17 +103,17 @@ public abstract aspect AbstractInterfaceDrivenDependencyInjectionAspect extends ConfigurableObject+ && Serializable+ implements ConfigurableDeserializationSupport; /** - * A marker interface to which the readResolve() is introduced. + * A marker interface to which the {@code readResolve()} is introduced. */ static interface ConfigurableDeserializationSupport extends Serializable { } /** - * Introduce the readResolve() method so that we can advise its + * Introduce the {@code readResolve()} method so that we can advise its * execution to configure the object. * *

Note if a method with the same signature already exists in a - * Serializable class of ConfigurableObject type, + * {@code Serializable} class of ConfigurableObject type, * that implementation will take precedence (a good thing, since we are * merely interested in an opportunity to detect deserialization.) */ diff --git a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AnnotationBeanConfigurerAspect.aj b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AnnotationBeanConfigurerAspect.aj index 20b151ed31..06e32f4bfb 100644 --- a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AnnotationBeanConfigurerAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AnnotationBeanConfigurerAspect.aj @@ -32,7 +32,7 @@ import org.springframework.beans.factory.wiring.BeanConfigurerSupport; * annotation to identify which classes need autowiring. * *

The bean name to look up will be taken from the - * @Configurable annotation if specified, otherwise the + * {@code @Configurable} annotation if specified, otherwise the * default bean name to look up will be the FQN of the class being configured. * * @author Rod Johnson diff --git a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/GenericInterfaceDrivenDependencyInjectionAspect.aj b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/GenericInterfaceDrivenDependencyInjectionAspect.aj index bee02ac9be..d91b05d117 100644 --- a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/GenericInterfaceDrivenDependencyInjectionAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/GenericInterfaceDrivenDependencyInjectionAspect.aj @@ -22,7 +22,7 @@ package org.springframework.beans.factory.aspectj; * the use of the @Configurable annotation. * * The subaspect of this aspect doesn't need to include any AOP constructs. - * For example, here is a subaspect that configures the PricingStrategyClient objects. + * For example, here is a subaspect that configures the {@code PricingStrategyClient} objects. *

  * aspect PricingStrategyDependencyInjectionAspect
  *        extends GenericInterfaceDrivenDependencyInjectionAspect {
diff --git a/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj b/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj
index f6c9b7b0a9..56bf082939 100644
--- a/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj
+++ b/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj
@@ -18,7 +18,7 @@ package org.springframework.mock.staticmock;
 
 /**
  * Annotation-based aspect to use in test build to enable mocking static methods
- * on JPA-annotated @Entity classes, as used by Roo for finders.
+ * on JPA-annotated {@code @Entity} classes, as used by Roo for finders.
  *
  * 

Mocking will occur in the call stack of any method in a class (typically a test class) * that is annotated with the @MockStaticEntityMethods annotation. diff --git a/spring-aspects/src/main/java/org/springframework/transaction/aspectj/AbstractTransactionAspect.aj b/spring-aspects/src/main/java/org/springframework/transaction/aspectj/AbstractTransactionAspect.aj index 27a09bb462..3daa476116 100644 --- a/spring-aspects/src/main/java/org/springframework/transaction/aspectj/AbstractTransactionAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/transaction/aspectj/AbstractTransactionAspect.aj @@ -25,7 +25,7 @@ import org.springframework.transaction.interceptor.TransactionAttributeSource; /** * Abstract superaspect for AspectJ transaction aspects. Concrete - * subaspects will implement the transactionalMethodExecution() + * subaspects will implement the {@code transactionalMethodExecution()} * pointcut using a strategy such as Java 5 annotations. * *

Suitable for use inside or outside the Spring IoC container. diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttribute.java b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttribute.java index 8af75c662a..6890b9e706 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttribute.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttribute.java @@ -37,7 +37,7 @@ public class BeanMetadataAttribute implements BeanMetadataElement { /** * Create a new AttributeValue instance. - * @param name the name of the attribute (never null) + * @param name the name of the attribute (never {@code null}) * @param value the value of the attribute (possibly before type conversion) */ public BeanMetadataAttribute(String name, Object value) { @@ -62,7 +62,7 @@ public class BeanMetadataAttribute implements BeanMetadataElement { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttributeAccessor.java b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttributeAccessor.java index 39c28b5747..d059f8e2fa 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttributeAccessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataAttributeAccessor.java @@ -32,7 +32,7 @@ public class BeanMetadataAttributeAccessor extends AttributeAccessorSupport impl /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { @@ -56,7 +56,7 @@ public class BeanMetadataAttributeAccessor extends AttributeAccessorSupport impl * Look up the given BeanMetadataAttribute in this accessor's set of attributes. * @param name the name of the attribute * @return the corresponding BeanMetadataAttribute object, - * or null if no such attribute defined + * or {@code null} if no such attribute defined */ public BeanMetadataAttribute getMetadataAttribute(String name) { return (BeanMetadataAttribute) super.getAttribute(name); diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataElement.java b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataElement.java index 5d39c7f4fd..70b3667bee 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanMetadataElement.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanMetadataElement.java @@ -26,8 +26,8 @@ package org.springframework.beans; public interface BeanMetadataElement { /** - * Return the configuration source Object for this metadata element - * (may be null). + * Return the configuration source {@code Object} for this metadata element + * (may be {@code null}). */ Object getSource(); 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 8c82e9ed51..0a605478c1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java @@ -169,14 +169,14 @@ public abstract class BeanUtils { * Find a method with the given method name and the given parameter types, * declared on the given class or one of its superclasses. Prefers public methods, * but will return a protected, package access, or private method too. - *

Checks Class.getMethod first, falling back to - * findDeclaredMethod. This allows to find public methods + *

Checks {@code Class.getMethod} first, falling back to + * {@code findDeclaredMethod}. This allows to find public methods * without issues even in environments with restricted Java security settings. * @param clazz the class to check * @param methodName the name of the method to find * @param paramTypes the parameter types of the method to find - * @return the Method object, or null if not found - * @see java.lang.Class#getMethod + * @return the Method object, or {@code null} if not found + * @see Class#getMethod * @see #findDeclaredMethod */ public static Method findMethod(Class clazz, String methodName, Class... paramTypes) { @@ -192,12 +192,12 @@ public abstract class BeanUtils { * Find a method with the given method name and the given parameter types, * declared on the given class or one of its superclasses. Will return a public, * protected, package access, or private method. - *

Checks Class.getDeclaredMethod, cascading upwards to all superclasses. + *

Checks {@code Class.getDeclaredMethod}, cascading upwards to all superclasses. * @param clazz the class to check * @param methodName the name of the method to find * @param paramTypes the parameter types of the method to find - * @return the Method object, or null if not found - * @see java.lang.Class#getDeclaredMethod + * @return the Method object, or {@code null} if not found + * @see Class#getDeclaredMethod */ public static Method findDeclaredMethod(Class clazz, String methodName, Class[] paramTypes) { try { @@ -215,15 +215,15 @@ public abstract class BeanUtils { * Find a method with the given method name and minimal parameters (best case: none), * declared on the given class or one of its superclasses. Prefers public methods, * but will return a protected, package access, or private method too. - *

Checks Class.getMethods first, falling back to - * findDeclaredMethodWithMinimalParameters. This allows for finding public + *

Checks {@code Class.getMethods} first, falling back to + * {@code findDeclaredMethodWithMinimalParameters}. This allows for finding public * methods without issues even in environments with restricted Java security settings. * @param clazz the class to check * @param methodName the name of the method to find - * @return the Method object, or null if not found + * @return the Method object, or {@code null} if not found * @throws IllegalArgumentException if methods of the given name were found but * could not be resolved to a unique method with minimal parameters - * @see java.lang.Class#getMethods + * @see Class#getMethods * @see #findDeclaredMethodWithMinimalParameters */ public static Method findMethodWithMinimalParameters(Class clazz, String methodName) @@ -240,13 +240,13 @@ public abstract class BeanUtils { * Find a method with the given method name and minimal parameters (best case: none), * declared on the given class or one of its superclasses. Will return a public, * protected, package access, or private method. - *

Checks Class.getDeclaredMethods, cascading upwards to all superclasses. + *

Checks {@code Class.getDeclaredMethods}, cascading upwards to all superclasses. * @param clazz the class to check * @param methodName the name of the method to find - * @return the Method object, or null if not found + * @return the Method object, or {@code null} if not found * @throws IllegalArgumentException if methods of the given name were found but * could not be resolved to a unique method with minimal parameters - * @see java.lang.Class#getDeclaredMethods + * @see Class#getDeclaredMethods */ public static Method findDeclaredMethodWithMinimalParameters(Class clazz, String methodName) throws IllegalArgumentException { @@ -263,7 +263,7 @@ public abstract class BeanUtils { * in the given list of methods. * @param methods the methods to check * @param methodName the name of the method to find - * @return the Method object, or null if not found + * @return the Method object, or {@code null} if not found * @throws IllegalArgumentException if methods of the given name were found but * could not be resolved to a unique method with minimal parameters */ @@ -297,17 +297,17 @@ public abstract class BeanUtils { } /** - * Parse a method signature in the form methodName[([arg_list])], - * where arg_list is an optional, comma-separated list of fully-qualified - * type names, and attempts to resolve that signature against the supplied Class. - *

When not supplying an argument list (methodName) the method whose name + * Parse a method signature in the form {@code methodName[([arg_list])]}, + * where {@code arg_list} is an optional, comma-separated list of fully-qualified + * type names, and attempts to resolve that signature against the supplied {@code Class}. + *

When not supplying an argument list ({@code methodName}) the method whose name * matches and has the least number of parameters will be returned. When supplying an * argument type list, only the method whose name and argument types match will be returned. - *

Note then that methodName and methodName() are not - * resolved in the same way. The signature methodName means the method called - * methodName with the least number of arguments, whereas methodName() - * means the method called methodName with exactly 0 arguments. - *

If no method can be found, then null is returned. + *

Note then that {@code methodName} and {@code methodName()} are not + * resolved in the same way. The signature {@code methodName} means the method called + * {@code methodName} with the least number of arguments, whereas {@code methodName()} + * means the method called {@code methodName} with exactly 0 arguments. + *

If no method can be found, then {@code null} is returned. * @param signature the method signature as String representation * @param clazz the class to resolve the method signature against * @return the resolved Method @@ -353,9 +353,9 @@ public abstract class BeanUtils { /** - * Retrieve the JavaBeans PropertyDescriptors of a given class. + * Retrieve the JavaBeans {@code PropertyDescriptor}s of a given class. * @param clazz the Class to retrieve the PropertyDescriptors for - * @return an array of PropertyDescriptors for the given class + * @return an array of {@code PropertyDescriptors} for the given class * @throws BeansException if PropertyDescriptor look fails */ public static PropertyDescriptor[] getPropertyDescriptors(Class clazz) throws BeansException { @@ -364,10 +364,10 @@ public abstract class BeanUtils { } /** - * Retrieve the JavaBeans PropertyDescriptors for the given property. + * Retrieve the JavaBeans {@code PropertyDescriptors} for the given property. * @param clazz the Class to retrieve the PropertyDescriptor for * @param propertyName the name of the property - * @return the corresponding PropertyDescriptor, or null if none + * @return the corresponding PropertyDescriptor, or {@code null} if none * @throws BeansException if PropertyDescriptor lookup fails */ public static PropertyDescriptor getPropertyDescriptor(Class clazz, String propertyName) @@ -378,11 +378,11 @@ public abstract class BeanUtils { } /** - * Find a JavaBeans PropertyDescriptor for the given method, + * Find a JavaBeans {@code PropertyDescriptor} for the given method, * with the method either being the read method or the write method for * that bean property. * @param method the method to find a corresponding PropertyDescriptor for - * @return the corresponding PropertyDescriptor, or null if none + * @return the corresponding PropertyDescriptor, or {@code null} if none * @throws BeansException if PropertyDescriptor lookup fails */ public static PropertyDescriptor findPropertyForMethod(Method method) throws BeansException { @@ -403,7 +403,7 @@ public abstract class BeanUtils { * {@link java.beans.PropertyEditorManager} but isolated from the latter's * registered default editors for primitive types. * @param targetType the type to find an editor for - * @return the corresponding editor, or null if none found + * @return the corresponding editor, or {@code null} if none found */ public static PropertyEditor findEditorByConvention(Class targetType) { if (targetType == null || targetType.isArray() || unknownEditorTypes.containsKey(targetType)) { @@ -453,7 +453,7 @@ public abstract class BeanUtils { * given classes/interfaces, if possible. * @param propertyName the name of the bean property * @param beanClasses the classes to check against - * @return the property type, or Object.class as fallback + * @return the property type, or {@code Object.class} as fallback */ public static Class findPropertyType(String propertyName, Class[] beanClasses) { if (beanClasses != null) { diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java b/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java index aea348d6fd..070fdbf8de 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java @@ -50,14 +50,14 @@ public interface BeanWrapper extends ConfigurablePropertyAccessor { /** * Return the bean instance wrapped by this object, if any. - * @return the bean instance, or null if none set + * @return the bean instance, or {@code null} if none set */ Object getWrappedInstance(); /** * Return the type of the wrapped JavaBean object. * @return the type of the wrapped bean instance, - * or null if no wrapped object has been set + * or {@code null} if no wrapped object has been set */ Class getWrappedClass(); diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanWrapperImpl.java b/spring-beans/src/main/java/org/springframework/beans/BeanWrapperImpl.java index 1754c8745d..85d7fb0093 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanWrapperImpl.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanWrapperImpl.java @@ -55,18 +55,18 @@ import org.springframework.util.StringUtils; * for all typical use cases. Caches introspection results for efficiency. * *

Note: Auto-registers default property editors from the - * org.springframework.beans.propertyeditors package, which apply + * {@code org.springframework.beans.propertyeditors} package, which apply * in addition to the JDK's standard PropertyEditors. Applications can call * the {@link #registerCustomEditor(Class, java.beans.PropertyEditor)} method * to register an editor for a particular instance (i.e. they are not shared * across the application). See the base class * {@link PropertyEditorRegistrySupport} for details. * - *

BeanWrapperImpl will convert collection and array values + *

{@code BeanWrapperImpl} will convert collection and array values * to the corresponding target collections or arrays, if necessary. Custom * property editors that deal with collections or arrays can either be - * written via PropertyEditor's setValue, or against a - * comma-delimited String via setAsText, as String arrays are + * written via PropertyEditor's {@code setValue}, or against a + * comma-delimited String via {@code setAsText}, as String arrays are * converted in such a format if the array itself is not assignable. * *

NOTE: As of Spring 2.5, this is - for almost all purposes - an @@ -179,7 +179,7 @@ public class BeanWrapperImpl extends AbstractPropertyAccessor implements BeanWra * registering a nested path that the object is in. * @param object object wrapped by this BeanWrapper * @param nestedPath the nested path of the object - * @param superBw the containing BeanWrapper (must not be null) + * @param superBw the containing BeanWrapper (must not be {@code null}) */ private BeanWrapperImpl(Object object, String nestedPath, BeanWrapperImpl superBw) { setWrappedInstance(object, nestedPath, superBw.getWrappedInstance()); @@ -341,10 +341,10 @@ public class BeanWrapperImpl extends AbstractPropertyAccessor implements BeanWra /** * Internal version of {@link #getPropertyDescriptor}: - * Returns null if not found rather than throwing an exception. + * Returns {@code null} if not found rather than throwing an exception. * @param propertyName the property to obtain the descriptor for * @return the property descriptor for the specified property, - * or null if not found + * or {@code null} if not found * @throws BeansException in case of introspection failure */ protected PropertyDescriptor getPropertyDescriptorInternal(String propertyName) throws BeansException { @@ -474,7 +474,7 @@ public class BeanWrapperImpl extends AbstractPropertyAccessor implements BeanWra /** * Convert the given value for the specified property to the latter's type. *

This method is only intended for optimizations in a BeanFactory. - * Use the convertIfNecessary methods for programmatic conversion. + * Use the {@code convertIfNecessary} methods for programmatic conversion. * @param value the value to convert * @param propertyName the target property * (note that nested or indexed properties are not supported here) 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 2e9dde90b8..47ff208dd4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java +++ b/spring-beans/src/main/java/org/springframework/beans/CachedIntrospectionResults.java @@ -87,7 +87,7 @@ public class CachedIntrospectionResults { * 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. - *

Any acceptClassLoader call at application startup should + *

Any {@code acceptClassLoader} call at application startup should * be paired with a {@link #clearClassLoader} call at application shutdown. * @param classLoader the ClassLoader to accept */ diff --git a/spring-beans/src/main/java/org/springframework/beans/ConversionNotSupportedException.java b/spring-beans/src/main/java/org/springframework/beans/ConversionNotSupportedException.java index afd6a0fc09..7ea4ed901a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/ConversionNotSupportedException.java +++ b/spring-beans/src/main/java/org/springframework/beans/ConversionNotSupportedException.java @@ -30,8 +30,8 @@ public class ConversionNotSupportedException extends TypeMismatchException { /** * Create a new ConversionNotSupportedException. * @param propertyChangeEvent the PropertyChangeEvent that resulted in the problem - * @param requiredType the required target type (or null if not known) - * @param cause the root cause (may be null) + * @param requiredType the required target type (or {@code null} if not known) + * @param cause the root cause (may be {@code null}) */ public ConversionNotSupportedException(PropertyChangeEvent propertyChangeEvent, Class requiredType, Throwable cause) { super(propertyChangeEvent, requiredType, cause); @@ -39,9 +39,9 @@ public class ConversionNotSupportedException extends TypeMismatchException { /** * Create a new ConversionNotSupportedException. - * @param value the offending value that couldn't be converted (may be null) - * @param requiredType the required target type (or null if not known) - * @param cause the root cause (may be null) + * @param value the offending value that couldn't be converted (may be {@code null}) + * @param requiredType the required target type (or {@code null} if not known) + * @param cause the root cause (may be {@code null}) */ public ConversionNotSupportedException(Object value, Class requiredType, Throwable cause) { super(value, requiredType, cause); diff --git a/spring-beans/src/main/java/org/springframework/beans/GenericTypeAwarePropertyDescriptor.java b/spring-beans/src/main/java/org/springframework/beans/GenericTypeAwarePropertyDescriptor.java index e9675f52e4..20260432a2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/GenericTypeAwarePropertyDescriptor.java +++ b/spring-beans/src/main/java/org/springframework/beans/GenericTypeAwarePropertyDescriptor.java @@ -32,7 +32,7 @@ import org.springframework.util.StringUtils; /** * Extension of the standard JavaBeans PropertyDescriptor class, - * overriding getPropertyType() such that a generically + * overriding {@code getPropertyType()} such that a generically * declared type will be resolved against the containing bean class. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/Mergeable.java b/spring-beans/src/main/java/org/springframework/beans/Mergeable.java index 97f742c442..dc142e0f99 100644 --- a/spring-beans/src/main/java/org/springframework/beans/Mergeable.java +++ b/spring-beans/src/main/java/org/springframework/beans/Mergeable.java @@ -40,9 +40,9 @@ public interface Mergeable { * the callee's value set must override those of the supplied object. * @param parent the object to merge with * @return the result of the merge operation - * @throws IllegalArgumentException if the supplied parent is null + * @throws IllegalArgumentException if the supplied parent is {@code null} * @exception IllegalStateException if merging is not enabled for this instance - * (i.e. mergeEnabled equals false). + * (i.e. {@code mergeEnabled} equals {@code false}). */ Object merge(Object parent); diff --git a/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java b/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java index 470a705dd5..94ba9a1af6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java +++ b/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java @@ -46,7 +46,7 @@ public class MutablePropertyValues implements PropertyValues, Serializable { /** * Creates a new empty MutablePropertyValues object. - *

Property values can be added with the add method. + *

Property values can be added with the {@code add} method. * @see #add(String, Object) */ public MutablePropertyValues() { @@ -176,7 +176,7 @@ public class MutablePropertyValues implements PropertyValues, Serializable { } /** - * Overloaded version of addPropertyValue that takes + * Overloaded version of {@code addPropertyValue} that takes * a property name and a property value. *

Note: As of Spring 3.0, we recommend using the more concise * and chaining-capable variant {@link #add}. @@ -234,7 +234,7 @@ public class MutablePropertyValues implements PropertyValues, Serializable { } /** - * Overloaded version of removePropertyValue that takes a property name. + * Overloaded version of {@code removePropertyValue} that takes a property name. * @param propertyName name of the property * @see #removePropertyValue(PropertyValue) */ @@ -291,7 +291,7 @@ public class MutablePropertyValues implements PropertyValues, Serializable { * Register the specified property as "processed" in the sense * of some processor calling the corresponding setter method * outside of the PropertyValue(s) mechanism. - *

This will lead to true being returned from + *

This will lead to {@code true} being returned from * a {@link #contains} call for the specified property. * @param propertyName the name of the property. */ @@ -311,8 +311,8 @@ public class MutablePropertyValues implements PropertyValues, Serializable { } /** - * Return whether this holder contains converted values only (true), - * or whether the values still need to be converted (false). + * Return whether this holder contains converted values only ({@code true}), + * or whether the values still need to be converted ({@code false}). */ public boolean isConverted() { return this.converted; diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessException.java b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessException.java index cb17396c8c..004310ac8d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessException.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessException.java @@ -55,7 +55,7 @@ public abstract class PropertyAccessException extends BeansException implements /** * Return the PropertyChangeEvent that resulted in the problem. - *

May be null; only available if an actual bean property + *

May be {@code null}; only available if an actual bean property * was affected. */ public PropertyChangeEvent getPropertyChangeEvent() { diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessor.java b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessor.java index 280f1d90eb..80168252ac 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessor.java @@ -57,7 +57,7 @@ public interface PropertyAccessor { /** * Determine whether the specified property is readable. - *

Returns false if the property doesn't exist. + *

Returns {@code false} if the property doesn't exist. * @param propertyName the property to check * (may be a nested path and/or an indexed/mapped property) * @return whether the property is readable @@ -66,7 +66,7 @@ public interface PropertyAccessor { /** * Determine whether the specified property is writable. - *

Returns false if the property doesn't exist. + *

Returns {@code false} if the property doesn't exist. * @param propertyName the property to check * (may be a nested path and/or an indexed/mapped property) * @return whether the property is writable @@ -80,7 +80,7 @@ public interface PropertyAccessor { * @param propertyName the property to check * (may be a nested path and/or an indexed/mapped property) * @return the property type for the particular property, - * or null if not determinable + * or {@code null} if not determinable * @throws InvalidPropertyException if there is no such property or * if the property isn't readable * @throws PropertyAccessException if the property was valid but the @@ -94,7 +94,7 @@ public interface PropertyAccessor { * @param propertyName the property to check * (may be a nested path and/or an indexed/mapped property) * @return the property type for the particular property, - * or null if not determinable + * or {@code null} if not determinable * @throws InvalidPropertyException if there is no such property or * if the property isn't readable */ diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessorUtils.java b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessorUtils.java index 53d1377282..9fa559a8e9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyAccessorUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyAccessorUtils.java @@ -132,8 +132,8 @@ public abstract class PropertyAccessorUtils { /** * Determine the canonical name for the given property path. * Removes surrounding quotes from map keys:
- * map['key'] -> map[key]
- * map["key"] -> map[key] + * {@code map['key']} -> {@code map[key]}
+ * {@code map["key"]} -> {@code map[key]} * @param propertyName the bean property path * @return the canonical representation of the property path */ diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyBatchUpdateException.java b/spring-beans/src/main/java/org/springframework/beans/PropertyBatchUpdateException.java index d7a574cc43..378315bea7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyBatchUpdateException.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyBatchUpdateException.java @@ -61,14 +61,14 @@ public class PropertyBatchUpdateException extends BeansException { /** * Return an array of the propertyAccessExceptions stored in this object. - *

Will return the empty array (not null) if there were no errors. + *

Will return the empty array (not {@code null}) if there were no errors. */ public final PropertyAccessException[] getPropertyAccessExceptions() { return this.propertyAccessExceptions; } /** - * Return the exception for this field, or null if there isn't any. + * Return the exception for this field, or {@code null} if there isn't any. */ public PropertyAccessException getPropertyAccessException(String propertyName) { for (PropertyAccessException pae : this.propertyAccessExceptions) { diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java index 56dddc4de5..c14de75ed1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java @@ -34,14 +34,14 @@ public interface PropertyEditorRegistrar { /** * Register custom {@link java.beans.PropertyEditor PropertyEditors} with - * the given PropertyEditorRegistry. + * the given {@code PropertyEditorRegistry}. *

The passed-in registry will usually be a {@link BeanWrapper} or a * {@link org.springframework.validation.DataBinder DataBinder}. *

It is expected that implementations will create brand new - * PropertyEditors instances for each invocation of this - * method (since PropertyEditors are not threadsafe). - * @param registry the PropertyEditorRegistry to register the - * custom PropertyEditors with + * {@code PropertyEditors} instances for each invocation of this + * method (since {@code PropertyEditors} are not threadsafe). + * @param registry the {@code PropertyEditorRegistry} to register the + * custom {@code PropertyEditors} with */ void registerCustomEditors(PropertyEditorRegistry registry); diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistry.java b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistry.java index a14d3c0e92..9eb3af78af 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistry.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistry.java @@ -47,7 +47,7 @@ public interface PropertyEditorRegistry { *

If the property path denotes an array or Collection property, * the editor will get applied either to the array/Collection itself * (the {@link PropertyEditor} has to create an array or Collection value) or - * to each element (the PropertyEditor has to create the element type), + * to each element (the {@code PropertyEditor} has to create the element type), * depending on the specified required type. *

Note: Only one single registered custom editor per property path * is supported. In the case of a Collection/array, do not register an editor @@ -55,24 +55,24 @@ public interface PropertyEditorRegistry { *

For example, if you wanted to register an editor for "items[n].quantity" * (for all values n), you would use "items.quantity" as the value of the * 'propertyPath' argument to this method. - * @param requiredType the type of the property. This may be null + * @param requiredType the type of the property. This may be {@code null} * if a property is given but should be specified in any case, in particular in * case of a Collection - making clear whether the editor is supposed to apply * to the entire Collection itself or to each of its entries. So as a general rule: - * Do not specify null here in case of a Collection/array! + * Do not specify {@code null} here in case of a Collection/array! * @param propertyPath the path of the property (name or nested path), or - * null if registering an editor for all properties of the given type + * {@code null} if registering an editor for all properties of the given type * @param propertyEditor editor to register */ void registerCustomEditor(Class requiredType, String propertyPath, PropertyEditor propertyEditor); /** * Find a custom property editor for the given type and property. - * @param requiredType the type of the property (can be null if a property + * @param requiredType the type of the property (can be {@code null} if a property * is given but should be specified in any case for consistency checking) * @param propertyPath the path of the property (name or nested path), or - * null if looking for an editor for all properties of the given type - * @return the registered editor, or null if none + * {@code null} if looking for an editor for all properties of the given type + * @return the registered editor, or {@code null} if none */ PropertyEditor findCustomEditor(Class requiredType, String propertyPath); diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrySupport.java b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrySupport.java index 2b547c0edf..6b3aa68b6d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrySupport.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrySupport.java @@ -163,7 +163,7 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { * Retrieve the default editor for the given property type, if any. *

Lazily registers the default editors, if they are active. * @param requiredType type of the property - * @return the default editor, or null if none found + * @return the default editor, or {@code null} if none found * @see #registerDefaultEditors */ public PropertyEditor getDefaultEditor(Class requiredType) { @@ -349,9 +349,9 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { * Determine whether this registry contains a custom editor * for the specified array/collection element. * @param elementType the target type of the element - * (can be null if not known) + * (can be {@code null} if not known) * @param propertyPath the property path (typically of the array/collection; - * can be null if not known) + * can be {@code null} if not known) * @return whether a matching custom editor has been found */ public boolean hasCustomEditorForElement(Class elementType, String propertyPath) { @@ -372,11 +372,11 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { * Determine the property type for the given property path. *

Called by {@link #findCustomEditor} if no required type has been specified, * to be able to find a type-specific editor even if just given a property path. - *

The default implementation always returns null. - * BeanWrapperImpl overrides this with the standard getPropertyType + *

The default implementation always returns {@code null}. + * BeanWrapperImpl overrides this with the standard {@code getPropertyType} * method as defined by the BeanWrapper interface. * @param propertyPath the property path to determine the type for - * @return the type of the property, or null if not determinable + * @return the type of the property, or {@code null} if not determinable * @see BeanWrapper#getPropertyType(String) */ protected Class getPropertyType(String propertyPath) { @@ -387,7 +387,7 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { * Get custom editor that has been registered for the given property. * @param propertyName the property path to look for * @param requiredType the type to look for - * @return the custom editor, or null if none specific for this property + * @return the custom editor, or {@code null} if none specific for this property */ private PropertyEditor getCustomEditor(String propertyName, Class requiredType) { CustomEditorHolder holder = this.customEditorsForPath.get(propertyName); @@ -397,9 +397,9 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { /** * Get custom editor for the given type. If no direct match found, * try custom editor for superclass (which will in any case be able - * to render a value as String via getAsText). + * to render a value as String via {@code getAsText}). * @param requiredType the type to look for - * @return the custom editor, or null if none found for this type + * @return the custom editor, or {@code null} if none found for this type * @see java.beans.PropertyEditor#getAsText() */ private PropertyEditor getCustomEditor(Class requiredType) { @@ -436,7 +436,7 @@ public class PropertyEditorRegistrySupport implements PropertyEditorRegistry { * Guess the property type of the specified property from the registered * custom editors (provided that they were registered for a specific type). * @param propertyName the name of the property - * @return the property type, or null if not determinable + * @return the property type, or {@code null} if not determinable */ protected Class guessPropertyTypeFromEditors(String propertyName) { if (this.customEditorsForPath != null) { diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyMatches.java b/spring-beans/src/main/java/org/springframework/beans/PropertyMatches.java index 0c68290650..9584b49107 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyMatches.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyMatches.java @@ -122,7 +122,7 @@ final class PropertyMatches { /** * Generate possible property alternatives for the given property and - * class. Internally uses the getStringDistance method, which + * class. Internally uses the {@code getStringDistance} method, which * in turn uses the Levenshtein algorithm to determine the distance between * two Strings. * @param propertyDescriptors the JavaBeans property descriptors to search diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyValue.java b/spring-beans/src/main/java/org/springframework/beans/PropertyValue.java index abc9c66662..426476b89b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyValue.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyValue.java @@ -65,7 +65,7 @@ public class PropertyValue extends BeanMetadataAttributeAccessor implements Seri /** * Create a new PropertyValue instance. - * @param name the name of the property (never null) + * @param name the name of the property (never {@code null}) * @param value the value of the property (possibly before type conversion) */ public PropertyValue(String name, Object value) { @@ -75,7 +75,7 @@ public class PropertyValue extends BeanMetadataAttributeAccessor implements Seri /** * Copy constructor. - * @param original the PropertyValue to copy (never null) + * @param original the PropertyValue to copy (never {@code null}) */ public PropertyValue(PropertyValue original) { Assert.notNull(original, "Original must not be null"); @@ -94,7 +94,7 @@ public class PropertyValue extends BeanMetadataAttributeAccessor implements Seri /** * Constructor that exposes a new value for an original value holder. * The original holder will be exposed as source of the new holder. - * @param original the PropertyValue to link to (never null) + * @param original the PropertyValue to link to (never {@code null}) * @param newValue the new value to apply */ public PropertyValue(PropertyValue original, Object newValue) { @@ -149,8 +149,8 @@ public class PropertyValue extends BeanMetadataAttributeAccessor implements Seri } /** - * Return whether this holder contains a converted value already (true), - * or whether the value still needs to be converted (false). + * Return whether this holder contains a converted value already ({@code true}), + * or whether the value still needs to be converted ({@code false}). */ public synchronized boolean isConverted() { return this.converted; diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyValues.java b/spring-beans/src/main/java/org/springframework/beans/PropertyValues.java index ad9dbba66e..6ecb77e16d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyValues.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyValues.java @@ -35,17 +35,17 @@ public interface PropertyValues { /** * Return the property value with the given name, if any. * @param propertyName the name to search for - * @return the property value, or null + * @return the property value, or {@code null} */ PropertyValue getPropertyValue(String propertyName); /** * Return the changes since the previous PropertyValues. - * Subclasses should also override equals. + * Subclasses should also override {@code equals}. * @param old old property values * @return PropertyValues updated or new properties. * Return empty PropertyValues if there are no changes. - * @see java.lang.Object#equals + * @see Object#equals */ PropertyValues changesSince(PropertyValues old); diff --git a/spring-beans/src/main/java/org/springframework/beans/TypeConverter.java b/spring-beans/src/main/java/org/springframework/beans/TypeConverter.java index 383f8e0d1e..2efc1edf73 100644 --- a/spring-beans/src/main/java/org/springframework/beans/TypeConverter.java +++ b/spring-beans/src/main/java/org/springframework/beans/TypeConverter.java @@ -33,11 +33,11 @@ public interface TypeConverter { /** * Convert the value to the required type (if necessary from a String). - *

Conversions from String to any type will typically use the setAsText + *

Conversions from String to any type will typically use the {@code setAsText} * method of the PropertyEditor class, or a Spring Converter in a ConversionService. * @param value the value to convert * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @return the new value, possibly the result of type conversion * @throws TypeMismatchException if type conversion failed * @see java.beans.PropertyEditor#setAsText(String) @@ -49,13 +49,13 @@ public interface TypeConverter { /** * Convert the value to the required type (if necessary from a String). - *

Conversions from String to any type will typically use the setAsText + *

Conversions from String to any type will typically use the {@code setAsText} * method of the PropertyEditor class, or a Spring Converter in a ConversionService. * @param value the value to convert * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param methodParam the method parameter that is the target of the conversion - * (for analysis of generic types; may be null) + * (for analysis of generic types; may be {@code null}) * @return the new value, possibly the result of type conversion * @throws TypeMismatchException if type conversion failed * @see java.beans.PropertyEditor#setAsText(String) @@ -68,13 +68,13 @@ public interface TypeConverter { /** * Convert the value to the required type (if necessary from a String). - *

Conversions from String to any type will typically use the setAsText + *

Conversions from String to any type will typically use the {@code setAsText} * method of the PropertyEditor class, or a Spring Converter in a ConversionService. * @param value the value to convert * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param field the reflective field that is the target of the conversion - * (for analysis of generic types; may be null) + * (for analysis of generic types; may be {@code null}) * @return the new value, possibly the result of type conversion * @throws TypeMismatchException if type conversion failed * @see java.beans.PropertyEditor#setAsText(String) diff --git a/spring-beans/src/main/java/org/springframework/beans/TypeConverterDelegate.java b/spring-beans/src/main/java/org/springframework/beans/TypeConverterDelegate.java index 9b47e79443..24bc57e9e3 100644 --- a/spring-beans/src/main/java/org/springframework/beans/TypeConverterDelegate.java +++ b/spring-beans/src/main/java/org/springframework/beans/TypeConverterDelegate.java @@ -81,9 +81,9 @@ class TypeConverterDelegate { * Convert the value to the specified required type. * @param newValue the proposed new value * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param methodParam the method parameter that is the target of the conversion - * (may be null) + * (may be {@code null}) * @return the new value, possibly the result of type conversion * @throws IllegalArgumentException if type conversion failed */ @@ -98,9 +98,9 @@ class TypeConverterDelegate { * Convert the value to the specified required type. * @param newValue the proposed new value * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param field the reflective field that is the target of the conversion - * (may be null) + * (may be {@code null}) * @return the new value, possibly the result of type conversion * @throws IllegalArgumentException if type conversion failed */ @@ -114,10 +114,10 @@ class TypeConverterDelegate { /** * Convert the value to the required type for the specified property. * @param propertyName name of the property - * @param oldValue the previous value, if available (may be null) + * @param oldValue the previous value, if available (may be {@code null}) * @param newValue the proposed new value * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @return the new value, possibly the result of type conversion * @throws IllegalArgumentException if type conversion failed */ @@ -132,10 +132,10 @@ class TypeConverterDelegate { * Convert the value to the required type (if necessary from a String), * for the specified property. * @param propertyName name of the property - * @param oldValue the previous value, if available (may be null) + * @param oldValue the previous value, if available (may be {@code null}) * @param newValue the proposed new value * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param typeDescriptor the descriptor for the target property or field * @return the new value, possibly the result of type conversion * @throws IllegalArgumentException if type conversion failed @@ -326,7 +326,7 @@ class TypeConverterDelegate { /** * Find a default editor for the given type. * @param requiredType the type to find an editor for - * @return the corresponding editor, or null if none + * @return the corresponding editor, or {@code null} if none */ private PropertyEditor findDefaultEditor(Class requiredType) { PropertyEditor editor = null; @@ -344,10 +344,10 @@ class TypeConverterDelegate { /** * Convert the value to the required type (if necessary from a String), * using the given property editor. - * @param oldValue the previous value, if available (may be null) + * @param oldValue the previous value, if available (may be {@code null}) * @param newValue the proposed new value * @param requiredType the type we must convert to - * (or null if not known, for example in case of a collection element) + * (or {@code null} if not known, for example in case of a collection element) * @param editor the PropertyEditor to use * @return the new value, possibly the result of type conversion * @throws IllegalArgumentException if type conversion failed @@ -434,7 +434,7 @@ class TypeConverterDelegate { /** * Convert the given text value using the given property editor. - * @param oldValue the previous value, if available (may be null) + * @param oldValue the previous value, if available (may be {@code null}) * @param newTextValue the proposed text value * @param editor the PropertyEditor to use * @return the converted value diff --git a/spring-beans/src/main/java/org/springframework/beans/TypeMismatchException.java b/spring-beans/src/main/java/org/springframework/beans/TypeMismatchException.java index f2d05a31f0..0e1930bbb2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/TypeMismatchException.java +++ b/spring-beans/src/main/java/org/springframework/beans/TypeMismatchException.java @@ -51,8 +51,8 @@ public class TypeMismatchException extends PropertyAccessException { /** * Create a new TypeMismatchException. * @param propertyChangeEvent the PropertyChangeEvent that resulted in the problem - * @param requiredType the required target type (or null if not known) - * @param cause the root cause (may be null) + * @param requiredType the required target type (or {@code null} if not known) + * @param cause the root cause (may be {@code null}) */ public TypeMismatchException(PropertyChangeEvent propertyChangeEvent, Class requiredType, Throwable cause) { super(propertyChangeEvent, @@ -69,8 +69,8 @@ public class TypeMismatchException extends PropertyAccessException { /** * Create a new TypeMismatchException without PropertyChangeEvent. - * @param value the offending value that couldn't be converted (may be null) - * @param requiredType the required target type (or null if not known) + * @param value the offending value that couldn't be converted (may be {@code null}) + * @param requiredType the required target type (or {@code null} if not known) */ public TypeMismatchException(Object value, Class requiredType) { this(value, requiredType, null); @@ -78,9 +78,9 @@ public class TypeMismatchException extends PropertyAccessException { /** * Create a new TypeMismatchException without PropertyChangeEvent. - * @param value the offending value that couldn't be converted (may be null) - * @param requiredType the required target type (or null if not known) - * @param cause the root cause (may be null) + * @param value the offending value that couldn't be converted (may be {@code null}) + * @param requiredType the required target type (or {@code null} if not known) + * @param cause the root cause (may be {@code null}) */ public TypeMismatchException(Object value, Class requiredType, Throwable cause) { super("Failed to convert value of type '" + ClassUtils.getDescriptiveType(value) + "'" + @@ -92,7 +92,7 @@ public class TypeMismatchException extends PropertyAccessException { /** - * Return the offending value (may be null) + * Return the offending value (may be {@code null}) */ @Override public Object getValue() { diff --git a/spring-beans/src/main/java/org/springframework/beans/annotation/AnnotationBeanUtils.java b/spring-beans/src/main/java/org/springframework/beans/annotation/AnnotationBeanUtils.java index db3c74965b..f6e1b737ff 100644 --- a/spring-beans/src/main/java/org/springframework/beans/annotation/AnnotationBeanUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/annotation/AnnotationBeanUtils.java @@ -38,7 +38,7 @@ public abstract class AnnotationBeanUtils { /** * Copy the properties of the supplied {@link Annotation} to the supplied target bean. - * Any properties defined in excludedProperties will not be copied. + * Any properties defined in {@code excludedProperties} will not be copied. * @param ann the annotation to copy from * @param bean the bean instance to copy to * @param excludedProperties the names of excluded properties, if any @@ -50,11 +50,11 @@ public abstract class AnnotationBeanUtils { /** * Copy the properties of the supplied {@link Annotation} to the supplied target bean. - * Any properties defined in excludedProperties will not be copied. + * Any properties defined in {@code excludedProperties} will not be copied. *

A specified value resolver may resolve placeholders in property values, for example. * @param ann the annotation to copy from * @param bean the bean instance to copy to - * @param valueResolver a resolve to post-process String property values (may be null) + * @param valueResolver a resolve to post-process String property values (may be {@code null}) * @param excludedProperties the names of excluded properties, if any * @see org.springframework.beans.BeanWrapper */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanClassLoaderAware.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanClassLoaderAware.java index 5ec4832163..b27aa6f432 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanClassLoaderAware.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanClassLoaderAware.java @@ -42,12 +42,12 @@ public interface BeanClassLoaderAware extends Aware { * a bean instance. *

Invoked after the population of normal bean properties but * before an initialization callback such as - * {@link org.springframework.beans.factory.InitializingBean InitializingBean's} - * {@link org.springframework.beans.factory.InitializingBean#afterPropertiesSet()} + * {@link InitializingBean InitializingBean's} + * {@link InitializingBean#afterPropertiesSet()} * method or a custom init-method. - * @param classLoader the owning class loader; may be null in - * which case a default ClassLoader must be used, for example - * the ClassLoader obtained via + * @param classLoader the owning class loader; may be {@code null} in + * which case a default {@code ClassLoader} must be used, for example + * the {@code ClassLoader} obtained via * {@link org.springframework.util.ClassUtils#getDefaultClassLoader()} */ void setBeanClassLoader(ClassLoader classLoader); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanCreationException.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanCreationException.java index 486f9248e7..15235f2106 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanCreationException.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanCreationException.java @@ -135,7 +135,7 @@ public class BeanCreationException extends FatalBeanException { /** * Return the related causes, if any. - * @return the array of related causes, or null if none + * @return the array of related causes, or {@code null} if none */ public Throwable[] getRelatedCauses() { if (this.relatedCauses == null) { 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 be86fbd860..9536dec6df 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 @@ -44,7 +44,7 @@ public class BeanDefinitionStoreException extends FatalBeanException { /** * Create a new BeanDefinitionStoreException. * @param msg the detail message (used as exception message as-is) - * @param cause the root cause (may be null) + * @param cause the root cause (may be {@code null}) */ public BeanDefinitionStoreException(String msg, Throwable cause) { super(msg, cause); @@ -64,7 +64,7 @@ public class BeanDefinitionStoreException extends FatalBeanException { * Create a new BeanDefinitionStoreException. * @param resourceDescription description of the resource that the bean definition came from * @param msg the detail message (used as exception message as-is) - * @param cause the root cause (may be null) + * @param cause the root cause (may be {@code null}) */ public BeanDefinitionStoreException(String resourceDescription, String msg, Throwable cause) { super(msg, cause); @@ -88,7 +88,7 @@ public class BeanDefinitionStoreException extends FatalBeanException { * @param beanName the name of the bean requested * @param msg the detail message (appended to an introductory message that indicates * the resource and the name of the bean) - * @param cause the root cause (may be null) + * @param cause the root cause (may be {@code null}) */ public BeanDefinitionStoreException(String resourceDescription, String beanName, String msg, Throwable cause) { super("Invalid bean definition with name '" + beanName + "' defined in " + resourceDescription + ": " + msg, cause); 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 58bba15a4f..0debc41c7d 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 @@ -48,7 +48,7 @@ import org.springframework.beans.BeansException; * implemented using this BeanFactory interface and its subinterfaces. * *

Normally a BeanFactory will load bean definitions stored in a configuration - * source (such as an XML document), and use the org.springframework.beans + * source (such as an XML document), and use the {@code org.springframework.beans} * package to configure the beans. However, an implementation could simply return * Java objects it creates as necessary directly in Java code. There are no * constraints on how the definitions could be stored: LDAP, RDBMS, XML, @@ -63,26 +63,26 @@ import org.springframework.beans.BeansException; * *

Bean factory implementations should support the standard bean lifecycle interfaces * as far as possible. The full set of initialization methods and their standard order is:
- * 1. BeanNameAware's setBeanName
- * 2. BeanClassLoaderAware's setBeanClassLoader
- * 3. BeanFactoryAware's setBeanFactory
- * 4. ResourceLoaderAware's setResourceLoader + * 1. BeanNameAware's {@code setBeanName}
+ * 2. BeanClassLoaderAware's {@code setBeanClassLoader}
+ * 3. BeanFactoryAware's {@code setBeanFactory}
+ * 4. ResourceLoaderAware's {@code setResourceLoader} * (only applicable when running in an application context)
- * 5. ApplicationEventPublisherAware's setApplicationEventPublisher + * 5. ApplicationEventPublisherAware's {@code setApplicationEventPublisher} * (only applicable when running in an application context)
- * 6. MessageSourceAware's setMessageSource + * 6. MessageSourceAware's {@code setMessageSource} * (only applicable when running in an application context)
- * 7. ApplicationContextAware's setApplicationContext + * 7. ApplicationContextAware's {@code setApplicationContext} * (only applicable when running in an application context)
- * 8. ServletContextAware's setServletContext + * 8. ServletContextAware's {@code setServletContext} * (only applicable when running in a web application context)
- * 9. postProcessBeforeInitialization methods of BeanPostProcessors
- * 10. InitializingBean's afterPropertiesSet
+ * 9. {@code postProcessBeforeInitialization} methods of BeanPostProcessors
+ * 10. InitializingBean's {@code afterPropertiesSet}
* 11. a custom init-method definition
- * 12. postProcessAfterInitialization methods of BeanPostProcessors + * 12. {@code postProcessAfterInitialization} methods of BeanPostProcessors * *

On shutdown of a bean factory, the following lifecycle methods apply:
- * 1. DisposableBean's destroy
+ * 1. DisposableBean's {@code destroy}
* 2. a custom destroy-method definition * * @author Rod Johnson @@ -109,7 +109,7 @@ public interface BeanFactory { /** * Used to dereference a {@link FactoryBean} instance and distinguish it from * beans created by the FactoryBean. For example, if the bean named - * myJndiObject is a FactoryBean, getting &myJndiObject + * {@code myJndiObject} is a FactoryBean, getting {@code &myJndiObject} * will return the factory, not the instance returned by the factory. */ String FACTORY_BEAN_PREFIX = "&"; @@ -139,8 +139,8 @@ public interface BeanFactory { * Will ask the parent factory if the bean cannot be found in this factory instance. * @param name the name of the bean to retrieve * @param requiredType type the bean must match. Can be an interface or superclass - * of the actual class, or null for any match. For example, if the value - * is Object.class, this method will succeed whatever the class of the + * of the actual class, or {@code null} for any match. For example, if the value + * is {@code Object.class}, this method will succeed whatever the class of the * returned instance. * @return an instance of the bean * @throws NoSuchBeanDefinitionException if there's no such bean definition @@ -200,7 +200,7 @@ public interface BeanFactory { /** * Is this bean a shared singleton? That is, will {@link #getBean} always * return the same instance? - *

Note: This method returning false does not clearly indicate + *

Note: This method returning {@code false} does not clearly indicate * independent instances. It indicates non-singleton instances, which may correspond * to a scoped bean as well. Use the {@link #isPrototype} operation to explicitly * check for independent instances. @@ -217,7 +217,7 @@ public interface BeanFactory { /** * Is this bean a prototype? That is, will {@link #getBean} always return * independent instances? - *

Note: This method returning false does not clearly indicate + *

Note: This method returning {@code false} does not clearly indicate * a singleton object. It indicates non-independent instances, which may correspond * to a scoped bean as well. Use the {@link #isSingleton} operation to explicitly * check for a shared singleton instance. @@ -240,8 +240,8 @@ public interface BeanFactory { * Will ask the parent factory if the bean cannot be found in this factory instance. * @param name the name of the bean to query * @param targetType the type to match against - * @return true if the bean type matches, - * false if it doesn't match or cannot be determined yet + * @return {@code true} if the bean type matches, + * {@code false} if it doesn't match or cannot be determined yet * @throws NoSuchBeanDefinitionException if there is no bean with the given name * @since 2.0.1 * @see #getBean @@ -257,7 +257,7 @@ public interface BeanFactory { *

Translates aliases back to the corresponding canonical bean name. * Will ask the parent factory if the bean cannot be found in this factory instance. * @param name the name of the bean to query - * @return the type of the bean, or null if not determinable + * @return the type of the bean, or {@code null} if not determinable * @throws NoSuchBeanDefinitionException if there is no bean with the given name * @since 1.1.2 * @see #getBean diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryAware.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryAware.java index f9ea34c86b..1a7df36df2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryAware.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryAware.java @@ -45,7 +45,7 @@ public interface BeanFactoryAware extends Aware { *

Invoked after the population of normal bean properties * but before an initialization callback such as * {@link InitializingBean#afterPropertiesSet()} or a custom init-method. - * @param beanFactory owning BeanFactory (never null). + * @param beanFactory owning BeanFactory (never {@code null}). * The bean can immediately call methods on the factory. * @throws BeansException in case of initialization errors * @see BeanInitializationException diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryUtils.java b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryUtils.java index a2888182ba..2a4f577a1c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/BeanFactoryUtils.java @@ -133,7 +133,7 @@ public abstract class BeanFactoryUtils { *

Does consider objects created by FactoryBeans, which means that FactoryBeans * will get initialized. If the object created by the FactoryBean doesn't match, * the raw FactoryBean itself will be matched against the type. - *

This version of beanNamesForTypeIncludingAncestors automatically + *

This version of {@code beanNamesForTypeIncludingAncestors} automatically * includes prototypes and FactoryBeans. * @param lbf the bean factory * @param type the type that beans must match @@ -300,7 +300,7 @@ public abstract class BeanFactoryUtils { *

Does consider objects created by FactoryBeans, which means that FactoryBeans * will get initialized. If the object created by the FactoryBean doesn't match, * the raw FactoryBean itself will be matched against the type. - *

This version of beanOfTypeIncludingAncestors automatically includes + *

This version of {@code beanOfTypeIncludingAncestors} automatically includes * prototypes and FactoryBeans. *

Note: Beans of the same name will take precedence at the 'lowest' factory level, * i.e. such beans will be returned from the lowest factory that they are being found in, @@ -310,7 +310,7 @@ public abstract class BeanFactoryUtils { * @param lbf the bean factory * @param type type of bean to match * @return the matching bean instance - * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException + * @throws NoSuchBeanDefinitionException * if 0 or more than 1 beans of the given type were found * @throws BeansException if the bean could not be created */ @@ -375,12 +375,12 @@ public abstract class BeanFactoryUtils { *

Does consider objects created by FactoryBeans, which means that FactoryBeans * will get initialized. If the object created by the FactoryBean doesn't match, * the raw FactoryBean itself will be matched against the type. - *

This version of beanOfType automatically includes + *

This version of {@code beanOfType} automatically includes * prototypes and FactoryBeans. * @param lbf the bean factory * @param type type of bean to match * @return the matching bean instance - * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException + * @throws NoSuchBeanDefinitionException * if 0 or more than 1 beans of the given type were found * @throws BeansException if the bean could not be created */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java index 5f30376f11..d16bd68551 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java @@ -60,12 +60,12 @@ public interface FactoryBean { *

If this FactoryBean is not fully initialized yet at the time of * the call (for example because it is involved in a circular reference), * throw a corresponding {@link FactoryBeanNotInitializedException}. - *

As of Spring 2.0, FactoryBeans are allowed to return null + *

As of Spring 2.0, FactoryBeans are allowed to return {@code null} * objects. The factory will consider this as normal value to be used; it * will not throw a FactoryBeanNotInitializedException in this case anymore. * FactoryBean implementations are encouraged to throw * FactoryBeanNotInitializedException themselves now, as appropriate. - * @return an instance of the bean (can be null) + * @return an instance of the bean (can be {@code null}) * @throws Exception in case of creation errors * @see FactoryBeanNotInitializedException */ @@ -73,7 +73,7 @@ public interface FactoryBean { /** * Return the type of object that this FactoryBean creates, - * or null if not known in advance. + * or {@code null} if not known in advance. *

This allows one to check for specific types of beans without * instantiating objects, for example on autowiring. *

In the case of implementations that are creating a singleton object, @@ -84,10 +84,10 @@ public interface FactoryBean { * been fully initialized. It must not rely on state created during * initialization; of course, it can still use such state if available. *

NOTE: Autowiring will simply ignore FactoryBeans that return - * null here. Therefore it is highly recommended to implement + * {@code null} here. Therefore it is highly recommended to implement * this method properly, using the current state of the FactoryBean. * @return the type of object that this FactoryBean creates, - * or null if not known at the time of the call + * or {@code null} if not known at the time of the call * @see ListableBeanFactory#getBeansOfType */ Class getObjectType(); @@ -97,20 +97,20 @@ public interface FactoryBean { * will {@link #getObject()} always return the same object * (a reference that can be cached)? *

NOTE: If a FactoryBean indicates to hold a singleton object, - * the object returned from getObject() might get cached - * by the owning BeanFactory. Hence, do not return true + * the object returned from {@code getObject()} might get cached + * by the owning BeanFactory. Hence, do not return {@code true} * unless the FactoryBean always exposes the same reference. *

The singleton status of the FactoryBean itself will generally * be provided by the owning BeanFactory; usually, it has to be * defined as singleton there. - *

NOTE: This method returning false does not + *

NOTE: This method returning {@code false} does not * necessarily indicate that returned objects are independent instances. * An implementation of the extended {@link SmartFactoryBean} interface * may explicitly indicate independent instances through its * {@link SmartFactoryBean#isPrototype()} method. Plain {@link FactoryBean} * implementations which do not implement this extended interface are * simply assumed to always return independent instances if the - * isSingleton() implementation returns false. + * {@code isSingleton()} implementation returns {@code false}. * @return whether the exposed object is a singleton * @see #getObject() * @see SmartFactoryBean#isPrototype() diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBeanNotInitializedException.java b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBeanNotInitializedException.java index bffb2c14f9..66b317222f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBeanNotInitializedException.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBeanNotInitializedException.java @@ -19,7 +19,7 @@ package org.springframework.beans.factory; import org.springframework.beans.FatalBeanException; /** - * Exception to be thrown from a FactoryBean's getObject() method + * Exception to be thrown from a FactoryBean's {@code getObject()} method * if the bean is not fully initialized yet, for example because it is involved * in a circular reference. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/HierarchicalBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/HierarchicalBeanFactory.java index f471915b0a..d48bdba6d7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/HierarchicalBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/HierarchicalBeanFactory.java @@ -20,7 +20,7 @@ package org.springframework.beans.factory; * Sub-interface implemented by bean factories that can be part * of a hierarchy. * - *

The corresponding setParentBeanFactory method for bean + *

The corresponding {@code setParentBeanFactory} method for bean * factories that allow setting the parent in a configurable * fashion can be found in the ConfigurableBeanFactory interface. * @@ -32,18 +32,18 @@ package org.springframework.beans.factory; public interface HierarchicalBeanFactory extends BeanFactory { /** - * Return the parent bean factory, or null if there is none. + * Return the parent bean factory, or {@code null} if there is none. */ BeanFactory getParentBeanFactory(); /** * Return whether the local bean factory contains a bean of the given name, * ignoring beans defined in ancestor contexts. - *

This is an alternative to containsBean, ignoring a bean + *

This is an alternative to {@code containsBean}, ignoring a bean * of the given name from an ancestor bean factory. * @param name the name of the bean to query * @return whether a bean with the given name is defined in the local factory - * @see org.springframework.beans.factory.BeanFactory#containsBean + * @see BeanFactory#containsBean */ boolean containsLocalBean(String name); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java index 64e86dc2c4..6f8d57ff85 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java @@ -36,15 +36,15 @@ import org.springframework.beans.BeansException; *

The methods in this interface will just respect bean definitions of this factory. * They will ignore any singleton beans that have been registered by other means like * {@link org.springframework.beans.factory.config.ConfigurableBeanFactory}'s - * registerSingleton method, with the exception of - * getBeanNamesOfType and getBeansOfType which will check - * such manually registered singletons too. Of course, BeanFactory's getBean + * {@code registerSingleton} method, with the exception of + * {@code getBeanNamesOfType} and {@code getBeansOfType} which will check + * such manually registered singletons too. Of course, BeanFactory's {@code getBean} * does allow transparent access to such special beans as well. However, in typical * scenarios, all beans will be defined by external bean definitions anyway, so most * applications don't need to worry about this differentation. * - *

NOTE: With the exception of getBeanDefinitionCount - * and containsBeanDefinition, the methods in this interface + *

NOTE: With the exception of {@code getBeanDefinitionCount} + * and {@code containsBeanDefinition}, the methods in this interface * are not designed for frequent invocation. Implementations may be slow. * * @author Rod Johnson @@ -87,7 +87,7 @@ public interface ListableBeanFactory extends BeanFactory { /** * Return the names of beans matching the given type (including subclasses), - * judging from either bean definitions or the value of getObjectType + * judging from either bean definitions or the value of {@code getObjectType} * in the case of FactoryBeans. *

NOTE: This method introspects top-level beans only. It does not * check nested beans which might match the specified type as well. @@ -95,16 +95,16 @@ public interface ListableBeanFactory extends BeanFactory { * will get initialized. If the object created by the FactoryBean doesn't match, * the raw FactoryBean itself will be matched against the type. *

Does not consider any hierarchy this factory may participate in. - * Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors + * Use BeanFactoryUtils' {@code beanNamesForTypeIncludingAncestors} * to include beans in ancestor factories too. *

Note: Does not ignore singleton beans that have been registered * by other means than bean definitions. - *

This version of getBeanNamesForType matches all kinds of beans, + *

This version of {@code getBeanNamesForType} matches all kinds of beans, * be it singletons, prototypes, or FactoryBeans. In most implementations, the - * result will be the same as for getBeanNamesOfType(type, true, true). + * result will be the same as for {@code getBeanNamesOfType(type, true, true)}. *

Bean names returned by this method should always return bean names in the * order of definition in the backend configuration, as far as possible. - * @param type the class or interface to match, or null for all bean names + * @param type the class or interface to match, or {@code null} for all bean names * @return the names of beans (or objects created by FactoryBeans) matching * the given object type (including subclasses), or an empty array if none * @see FactoryBean#getObjectType @@ -114,7 +114,7 @@ public interface ListableBeanFactory extends BeanFactory { /** * Return the names of beans matching the given type (including subclasses), - * judging from either bean definitions or the value of getObjectType + * judging from either bean definitions or the value of {@code getObjectType} * in the case of FactoryBeans. *

NOTE: This method introspects top-level beans only. It does not * check nested beans which might match the specified type as well. @@ -124,13 +124,13 @@ public interface ListableBeanFactory extends BeanFactory { * type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked * (which doesn't require initialization of each FactoryBean). *

Does not consider any hierarchy this factory may participate in. - * Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors + * Use BeanFactoryUtils' {@code beanNamesForTypeIncludingAncestors} * to include beans in ancestor factories too. *

Note: Does not ignore singleton beans that have been registered * by other means than bean definitions. *

Bean names returned by this method should always return bean names in the * order of definition in the backend configuration, as far as possible. - * @param type the class or interface to match, or null for all bean names + * @param type the class or interface to match, or {@code null} for all bean names * @param includeNonSingletons whether to include prototype or scoped beans too * or just singletons (also applies to FactoryBeans) * @param allowEagerInit whether to initialize lazy-init singletons and @@ -148,24 +148,24 @@ public interface ListableBeanFactory extends BeanFactory { /** * Return the bean instances that match the given object type (including * subclasses), judging from either bean definitions or the value of - * getObjectType in the case of FactoryBeans. + * {@code getObjectType} in the case of FactoryBeans. *

NOTE: This method introspects top-level beans only. It does not * check nested beans which might match the specified type as well. *

Does consider objects created by FactoryBeans, which means that FactoryBeans * will get initialized. If the object created by the FactoryBean doesn't match, * the raw FactoryBean itself will be matched against the type. *

Does not consider any hierarchy this factory may participate in. - * Use BeanFactoryUtils' beansOfTypeIncludingAncestors + * Use BeanFactoryUtils' {@code beansOfTypeIncludingAncestors} * to include beans in ancestor factories too. *

Note: Does not ignore singleton beans that have been registered * by other means than bean definitions. *

This version of getBeansOfType matches all kinds of beans, be it * singletons, prototypes, or FactoryBeans. In most implementations, the - * result will be the same as for getBeansOfType(type, true, true). + * result will be the same as for {@code getBeansOfType(type, true, true)}. *

The Map returned by this method should always return bean names and * corresponding bean instances in the order of definition in the * backend configuration, as far as possible. - * @param type the class or interface to match, or null for all concrete beans + * @param type the class or interface to match, or {@code null} for all concrete beans * @return a Map with the matching beans, containing the bean names as * keys and the corresponding bean instances as values * @throws BeansException if a bean could not be created @@ -178,7 +178,7 @@ public interface ListableBeanFactory extends BeanFactory { /** * Return the bean instances that match the given object type (including * subclasses), judging from either bean definitions or the value of - * getObjectType in the case of FactoryBeans. + * {@code getObjectType} in the case of FactoryBeans. *

NOTE: This method introspects top-level beans only. It does not * check nested beans which might match the specified type as well. *

Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, @@ -187,14 +187,14 @@ public interface ListableBeanFactory extends BeanFactory { * type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked * (which doesn't require initialization of each FactoryBean). *

Does not consider any hierarchy this factory may participate in. - * Use BeanFactoryUtils' beansOfTypeIncludingAncestors + * Use BeanFactoryUtils' {@code beansOfTypeIncludingAncestors} * to include beans in ancestor factories too. *

Note: Does not ignore singleton beans that have been registered * by other means than bean definitions. *

The Map returned by this method should always return bean names and * corresponding bean instances in the order of definition in the * backend configuration, as far as possible. - * @param type the class or interface to match, or null for all concrete beans + * @param type the class or interface to match, or {@code null} for all concrete beans * @param includeNonSingletons whether to include prototype or scoped beans too * or just singletons (also applies to FactoryBeans) * @param allowEagerInit whether to initialize lazy-init singletons and @@ -212,7 +212,7 @@ public interface ListableBeanFactory extends BeanFactory { throws BeansException; /** - * Find all beans whose Class has the supplied {@link java.lang.annotation.Annotation} type. + * Find all beans whose {@code Class} has the supplied {@link java.lang.annotation.Annotation} type. * @param annotationType the type of annotation to look for * @return a Map with the matching beans, containing the bean names as * keys and the corresponding bean instances as values @@ -222,12 +222,12 @@ public interface ListableBeanFactory extends BeanFactory { throws BeansException; /** - * Find a {@link Annotation} of annotationType on the specified + * Find a {@link Annotation} of {@code annotationType} on the specified * bean, traversing its interfaces and super classes if no annotation can be * found on the given class itself. * @param beanName the name of the bean to look for annotations on * @param annotationType the annotation class to look for - * @return the annotation of the given type found, or null + * @return the annotation of the given type found, or {@code null} */ A findAnnotationOnBean(String beanName, Class annotationType); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java index b81ee6ca37..78640789b0 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java @@ -29,7 +29,7 @@ import org.springframework.beans.BeansException; * of the latter are normally meant to be defined as SPI instances in a * {@link BeanFactory}, while implementations of this class are normally meant * to be fed as an API to other beans (through injection). As such, the - * getObject() method has different exception handling behavior. + * {@code getObject()} method has different exception handling behavior. * * @author Colin Sampaleanu * @since 1.0.2 @@ -40,7 +40,7 @@ public interface ObjectFactory { /** * Return an instance (possibly shared or independent) * of the object managed by this factory. - * @return an instance of the bean (should never be null) + * @return an instance of the bean (should never be {@code null}) * @throws BeansException in case of creation errors */ T getObject() throws BeansException; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/SmartFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/SmartFactoryBean.java index c54676eda1..a8e20e049c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/SmartFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/SmartFactoryBean.java @@ -20,12 +20,12 @@ package org.springframework.beans.factory; * Extension of the {@link FactoryBean} interface. Implementations may * indicate whether they always return independent instances, for the * case where their {@link #isSingleton()} implementation returning - * false does not clearly indicate independent instances. + * {@code false} does not clearly indicate independent instances. * *

Plain {@link FactoryBean} implementations which do not implement * this extended interface are simply assumed to always return independent * instances if their {@link #isSingleton()} implementation returns - * false; the exposed object is only accessed on demand. + * {@code false}; the exposed object is only accessed on demand. * *

NOTE: This interface is a special purpose interface, mainly for * internal use within the framework and within collaborating frameworks. @@ -47,7 +47,7 @@ public interface SmartFactoryBean extends FactoryBean { * be provided by the owning {@link BeanFactory}; usually, it has to be * defined as singleton there. *

This method is supposed to strictly check for independent instances; - * it should not return true for scoped objects or other + * it should not return {@code true} for scoped objects or other * kinds of non-singleton, non-independent objects. For this reason, * this is not simply the inverted form of {@link #isSingleton()}. * @return whether the exposed object is a prototype @@ -62,7 +62,7 @@ public interface SmartFactoryBean extends FactoryBean { * of its singleton object (if any)? *

A standard FactoryBean is not expected to initialize eagerly: * Its {@link #getObject()} will only be called for actual access, even - * in case of a singleton object. Returning true from this + * in case of a singleton object. Returning {@code true} from this * method suggests that {@link #getObject()} should be called eagerly, * also applying post-processors eagerly. This may make sense in case * of a {@link #isSingleton() singleton} object, in particular if diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryLocator.java b/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryLocator.java index b4308aa7e9..ef2e40e34c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryLocator.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryLocator.java @@ -21,7 +21,7 @@ import org.springframework.beans.BeansException; /** * Defines a contract for the lookup, use, and release of a * {@link org.springframework.beans.factory.BeanFactory}, - * or a BeanFactory subclass such as an + * or a {@code BeanFactory} subclass such as an * {@link org.springframework.context.ApplicationContext}. * *

Where this interface is implemented as a singleton class such as @@ -29,20 +29,20 @@ import org.springframework.beans.BeansException; * suggests that it be used sparingly and with caution. By far the vast majority * of the code inside an application is best written in a Dependency Injection * style, where that code is served out of a - * BeanFactory/ApplicationContext container, and has + * {@code BeanFactory}/{@code ApplicationContext} container, and has * its own dependencies supplied by the container when it is created. However, * even such a singleton implementation sometimes has its use in the small glue * layers of code that is sometimes needed to tie other code together. For * example, third party code may try to construct new objects directly, without - * the ability to force it to get these objects out of a BeanFactory. + * the ability to force it to get these objects out of a {@code BeanFactory}. * If the object constructed by the third party code is just a small stub or * proxy, which then uses an implementation of this class to get a - * BeanFactory from which it gets the real object, to which it + * {@code BeanFactory} from which it gets the real object, to which it * delegates, then proper Dependency Injection has been achieved. * *

As another example, in a complex J2EE app with multiple layers, with each - * layer having its own ApplicationContext definition (in a - * hierarchy), a class like SingletonBeanFactoryLocator may be used + * layer having its own {@code ApplicationContext} definition (in a + * hierarchy), a class like {@code SingletonBeanFactoryLocator} may be used * to demand load these contexts. * * @author Colin Sampaleanu @@ -55,13 +55,13 @@ public interface BeanFactoryLocator { /** * Use the {@link org.springframework.beans.factory.BeanFactory} (or derived * interface such as {@link org.springframework.context.ApplicationContext}) - * specified by the factoryKey parameter. + * specified by the {@code factoryKey} parameter. *

The definition is possibly loaded/created as needed. - * @param factoryKey a resource name specifying which BeanFactory the - * BeanFactoryLocator must return for usage. The actual meaning of the - * resource name is specific to the implementation of BeanFactoryLocator. - * @return the BeanFactory instance, wrapped as a {@link BeanFactoryReference} object - * @throws BeansException if there is an error loading or accessing the BeanFactory + * @param factoryKey a resource name specifying which {@code BeanFactory} the + * {@code BeanFactoryLocator} must return for usage. The actual meaning of the + * resource name is specific to the implementation of {@code BeanFactoryLocator}. + * @return the {@code BeanFactory} instance, wrapped as a {@link BeanFactoryReference} object + * @throws BeansException if there is an error loading or accessing the {@code BeanFactory} */ BeanFactoryReference useBeanFactory(String factoryKey) throws BeansException; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryReference.java b/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryReference.java index 953b0cacf4..efe23a7479 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryReference.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/access/BeanFactoryReference.java @@ -34,7 +34,7 @@ public interface BeanFactoryReference { /** * Return the {@link BeanFactory} instance held by this reference. - * @throws IllegalStateException if invoked after release() has been called + * @throws IllegalStateException if invoked after {@code release()} has been called */ BeanFactory getFactory(); @@ -42,14 +42,14 @@ public interface BeanFactoryReference { * Indicate that the {@link BeanFactory} instance referred to by this object is not * needed any longer by the client code which obtained the {@link BeanFactoryReference}. *

Depending on the actual implementation of {@link BeanFactoryLocator}, and - * the actual type of BeanFactory, this may possibly not actually - * do anything; alternately in the case of a 'closeable' BeanFactory + * the actual type of {@code BeanFactory}, this may possibly not actually + * do anything; alternately in the case of a 'closeable' {@code BeanFactory} * or derived class (such as {@link org.springframework.context.ApplicationContext}) * may 'close' it, or may 'close' it once no more references remain. *

In an EJB usage scenario this would normally be called from - * ejbRemove() and ejbPassivate(). + * {@code ejbRemove()} and {@code ejbPassivate()}. *

This is safe to call multiple times. - * @throws FatalBeanException if the BeanFactory cannot be released + * @throws FatalBeanException if the {@code BeanFactory} cannot be released * @see BeanFactoryLocator * @see org.springframework.context.access.ContextBeanFactoryReference * @see org.springframework.context.ConfigurableApplicationContext#close() diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/access/SingletonBeanFactoryLocator.java b/spring-beans/src/main/java/org/springframework/beans/factory/access/SingletonBeanFactoryLocator.java index 61eea7a094..00fb3e690b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/access/SingletonBeanFactoryLocator.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/access/SingletonBeanFactoryLocator.java @@ -66,12 +66,12 @@ import org.springframework.core.io.support.ResourcePatternUtils; *

Consider an example application scenario: * *

@@ -107,7 +107,7 @@ import org.springframework.core.io.support.ResourcePatternUtils; * *

Given the above-mentioned three ApplicationContexts, consider the simplest * SingletonBeanFactoryLocator usage scenario, where there is only one single - * beanRefFactory.xml definition file: + * {@code beanRefFactory.xml} definition file: * *

<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
@@ -137,7 +137,7 @@ import org.springframework.core.io.support.ResourcePatternUtils;
  * MyClass zed = bf.getFactory().getBean("mybean");
  * 
* - * Another relatively simple variation of the beanRefFactory.xml definition file could be: + * Another relatively simple variation of the {@code beanRefFactory.xml} definition file could be: * *
<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
@@ -193,10 +193,10 @@ import org.springframework.core.io.support.ResourcePatternUtils;
  * actual definition file(s) for the SingletonBeanFactoryLocator maps that id to
  * a real context id.
  *
- * 

A final example is more complex, with a beanRefFactory.xml for every module. + *

A final example is more complex, with a {@code beanRefFactory.xml} for every module. * All the files are automatically combined to create the final definition. * - *

beanRefFactory.xml file inside jar for util module: + *

{@code beanRefFactory.xml} file inside jar for util module: * *

<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
@@ -211,7 +211,7 @@ import org.springframework.core.io.support.ResourcePatternUtils;
  * </beans>
  * 
* - * beanRefFactory.xml file inside jar for data-access module:
+ * {@code beanRefFactory.xml} file inside jar for data-access module:
* *
<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
@@ -230,7 +230,7 @@ import org.springframework.core.io.support.ResourcePatternUtils;
  * </beans>
  * 
* - * beanRefFactory.xml file inside jar for services module: + * {@code beanRefFactory.xml} file inside jar for services module: * *
<?xml version="1.0" encoding="UTF-8"?>
  * <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd">
@@ -249,7 +249,7 @@ import org.springframework.core.io.support.ResourcePatternUtils;
  * </beans>
  * 
* - * beanRefFactory.xml file inside jar for mypackage module. This doesn't + * {@code beanRefFactory.xml} file inside jar for mypackage module. This doesn't * create any of its own contexts, but allows the other ones to be referred to be * a name known to this module: * @@ -280,7 +280,7 @@ public class SingletonBeanFactoryLocator implements BeanFactoryLocator { /** * Returns an instance which uses the default "classpath*:beanRefFactory.xml", * as the name of the definition file(s). All resources returned by calling the - * current thread context ClassLoader's getResources method with + * current thread context ClassLoader's {@code getResources} method with * this name will be combined to create a BeanFactory definition set. * @return the corresponding BeanFactoryLocator instance * @throws BeansException in case of factory loading failure @@ -293,7 +293,7 @@ public class SingletonBeanFactoryLocator implements BeanFactoryLocator { * Returns an instance which uses the the specified selector, as the name of the * definition file(s). In the case of a name with a Spring 'classpath*:' prefix, * or with no prefix, which is treated the same, the current thread context - * ClassLoader's getResources method will be called with this value + * ClassLoader's {@code getResources} method will be called with this value * to get all resources having that name. These resources will then be combined to * form a definition. In the case where the name uses a Spring 'classpath:' prefix, * or a standard URL prefix, then only one resource file will be loaded as the diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/access/el/SpringBeanELResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/access/el/SpringBeanELResolver.java index 73a86c078c..6b439391e9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/access/el/SpringBeanELResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/access/el/SpringBeanELResolver.java @@ -30,7 +30,7 @@ import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.BeanFactory; /** - * Unified EL ELResolver that delegates to a Spring BeanFactory, + * Unified EL {@code ELResolver} that delegates to a Spring BeanFactory, * resolving name references to Spring-defined beans. * * @author Juergen Hoeller @@ -110,7 +110,7 @@ public abstract class SpringBeanELResolver extends ELResolver { /** * Retrieve the Spring BeanFactory to delegate bean name resolution to. * @param elContext the current ELContext - * @return the Spring BeanFactory (never null) + * @return the Spring BeanFactory (never {@code null}) */ protected abstract BeanFactory getBeanFactory(ELContext elContext); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AnnotatedBeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AnnotatedBeanDefinition.java index 4e53fec1ad..811898742d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AnnotatedBeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AnnotatedBeanDefinition.java @@ -34,7 +34,7 @@ public interface AnnotatedBeanDefinition extends BeanDefinition { /** * Obtain the annotation metadata (as well as basic class metadata) * for this bean definition's bean class. - * @return the annotation metadata object (never null) + * @return the annotation metadata object (never {@code null}) */ AnnotationMetadata getMetadata(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Autowired.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Autowired.java index 7d2178da0a..fc8b49bc20 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Autowired.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Autowired.java @@ -71,7 +71,7 @@ public @interface Autowired { /** * Declares whether the annotated dependency is required. - *

Defaults to true. + *

Defaults to {@code true}. */ boolean required() default true; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AutowiredAnnotationBeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AutowiredAnnotationBeanPostProcessor.java index 5b1d61b543..e1f0e2f392 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AutowiredAnnotationBeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/AutowiredAnnotationBeanPostProcessor.java @@ -67,10 +67,10 @@ import org.springframework.util.ReflectionUtils; * Spring's {@link Autowired @Autowired} and {@link Value @Value} annotations. * *

Also supports JSR-330's {@link javax.inject.Inject @Inject} annotation, - * if available, as a direct alternative to Spring's own @Autowired. + * if available, as a direct alternative to Spring's own {@code @Autowired}. * *

Only one constructor (at max) of any given bean class may carry this - * annotation with the 'required' parameter set to true, + * annotation with the 'required' parameter set to {@code true}, * indicating the constructor to autowire when used as a Spring bean. * If multiple non-required constructors carry the annotation, they * will be considered as candidates for autowiring. The constructor with @@ -187,8 +187,8 @@ public class AutowiredAnnotationBeanPostProcessor extends InstantiationAwareBean /** * Set the boolean value that marks a dependency as required *

For example if using 'required=true' (the default), - * this value should be true; but if using - * 'optional=false', this value should be false. + * this value should be {@code true}; but if using + * 'optional=false', this value should be {@code false}. * @see #setRequiredParameterName(String) */ public void setRequiredParameterValue(boolean requiredParameterValue) { @@ -292,7 +292,7 @@ public class AutowiredAnnotationBeanPostProcessor extends InstantiationAwareBean /** * 'Native' processing method for direct calls with an arbitrary target instance, - * resolving all of its fields and methods which are annotated with @Autowired. + * resolving all of its fields and methods which are annotated with {@code @Autowired}. * @param bean the target instance to process * @throws BeansException if autowiring failed */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Configurable.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Configurable.java index 84102e70e9..205fed0aeb 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Configurable.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/Configurable.java @@ -26,7 +26,7 @@ import java.lang.annotation.Target; /** * Marks a class as being eligible for Spring-driven configuration. * - *

Typically used with the AspectJ AnnotationBeanConfigurerAspect. + *

Typically used with the AspectJ {@code AnnotationBeanConfigurerAspect}. * * @author Rod Johnson * @author Rob Harrop diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/RequiredAnnotationBeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/RequiredAnnotationBeanPostProcessor.java index e4db17e1eb..862dbd6fa6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/RequiredAnnotationBeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/RequiredAnnotationBeanPostProcessor.java @@ -57,7 +57,7 @@ import org.springframework.util.Assert; * still be desirable), because all that this class does is enforce that a * 'required' property has actually been configured with a value. It does * not check anything else... In particular, it does not check that a - * configured value is not null. + * configured value is not {@code null}. * *

Note: A default RequiredAnnotationBeanPostProcessor will be registered * by the "context:annotation-config" and "context:component-scan" XML tags. @@ -163,7 +163,7 @@ public class RequiredAnnotationBeanPostProcessor extends InstantiationAwareBeanP * {@link #SKIP_REQUIRED_CHECK_ATTRIBUTE} attribute in the bean definition, if any. * @param beanFactory the BeanFactory to check against * @param beanName the name of the bean to check against - * @return true to skip the bean; false to process it + * @return {@code true} to skip the bean; {@code false} to process it */ protected boolean shouldSkip(ConfigurableListableBeanFactory beanFactory, String beanName) { if (beanFactory == null || !beanFactory.containsBeanDefinition(beanName)) { @@ -178,9 +178,9 @@ public class RequiredAnnotationBeanPostProcessor extends InstantiationAwareBeanP *

This implementation looks for the existence of a * {@link #setRequiredAnnotationType "required" annotation} * on the supplied {@link PropertyDescriptor property}. - * @param propertyDescriptor the target PropertyDescriptor (never null) - * @return true if the supplied property has been marked as being required; - * false if not, or if the supplied property does not have a setter method + * @param propertyDescriptor the target PropertyDescriptor (never {@code null}) + * @return {@code true} if the supplied property has been marked as being required; + * {@code false} if not, or if the supplied property does not have a setter method */ protected boolean isRequiredProperty(PropertyDescriptor propertyDescriptor) { Method setter = propertyDescriptor.getWriteMethod(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/AbstractFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/AbstractFactoryBean.java index 320db67077..5939524eea 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/AbstractFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/AbstractFactoryBean.java @@ -41,7 +41,7 @@ import org.springframework.util.ReflectionUtils; * Simple template superclass for {@link FactoryBean} implementations that * creates a singleton or a prototype object, depending on a flag. * - *

If the "singleton" flag is true (the default), + *

If the "singleton" flag is {@code true} (the default), * this class will create the object that it creates exactly once * on initialization and subsequently return said singleton instance * on all calls to the {@link #getObject()} method. @@ -78,7 +78,7 @@ public abstract class AbstractFactoryBean /** * Set if a singleton should be created, or a new object on each request - * otherwise. Default is true (a singleton). + * otherwise. Default is {@code true} (a singleton). */ public void setSingleton(boolean singleton) { this.singleton = singleton; @@ -211,11 +211,11 @@ public abstract class AbstractFactoryBean * FactoryBean is supposed to implement, for use with an 'early singleton * proxy' that will be exposed in case of a circular reference. *

The default implementation returns this FactoryBean's object type, - * provided that it is an interface, or null else. The latter + * provided that it is an interface, or {@code null} else. The latter * indicates that early singleton access is not supported by this FactoryBean. * This will lead to a FactoryBeanNotInitializedException getting thrown. * @return the interfaces to use for 'early singletons', - * or null to indicate a FactoryBeanNotInitializedException + * or {@code null} to indicate a FactoryBeanNotInitializedException * @see org.springframework.beans.factory.FactoryBeanNotInitializedException */ protected Class[] getEarlySingletonInterfaces() { 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 050ca889ca..2040f6f420 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 @@ -137,8 +137,8 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Configure the given raw bean: autowiring bean properties, applying - * bean property values, applying factory callbacks such as setBeanName - * and setBeanFactory, and also applying all bean post processors + * bean property values, applying factory callbacks such as {@code setBeanName} + * and {@code setBeanFactory}, and also applying all bean post processors * (including ones which might wrap the given raw bean). *

This is effectively a superset of what {@link #initializeBean} provides, * fully applying the configuration specified by the corresponding bean definition. @@ -158,7 +158,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { * Resolve the specified dependency against the beans defined in this factory. * @param descriptor the descriptor for the dependency * @param beanName the name of the bean which declares the present dependency - * @return the resolved object, or null if none found + * @return the resolved object, or {@code null} if none found * @throws BeansException in dependency resolution failed */ Object resolveDependency(DependencyDescriptor descriptor, String beanName) throws BeansException; @@ -190,7 +190,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 AUTOWIRE_NO in order to just apply + * Can also be invoked with {@code AUTOWIRE_NO} in order to just apply * before-instantiation callbacks (e.g. for annotation-driven injection). *

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

Does not apply standard {@link BeanPostProcessor BeanPostProcessors} * callbacks or perform any further initialization of the bean. This interface @@ -262,7 +262,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Initialize the given raw bean, applying factory callbacks - * such as setBeanName and setBeanFactory, + * such as {@code setBeanName} and {@code setBeanFactory}, * also applying all bean post processors (including ones which * might wrap the given raw bean). *

Note that no bean definition of the given name has to exist @@ -278,7 +278,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Apply {@link BeanPostProcessor BeanPostProcessors} to the given existing bean - * instance, invoking their postProcessBeforeInitialization methods. + * instance, invoking their {@code postProcessBeforeInitialization} methods. * The returned bean instance may be a wrapper around the original. * @param existingBean the new bean instance * @param beanName the name of the bean @@ -291,7 +291,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { /** * Apply {@link BeanPostProcessor BeanPostProcessors} to the given existing bean - * instance, invoking their postProcessAfterInitialization methods. + * instance, invoking their {@code postProcessAfterInitialization} methods. * The returned bean instance may be a wrapper around the original. * @param existingBean the new bean instance * @param beanName the name of the bean @@ -310,7 +310,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory { * resolving the present dependency) are supposed to be added to * @param typeConverter the TypeConverter to use for populating arrays and * collections - * @return the resolved object, or null if none found + * @return the resolved object, or {@code null} if none found * @throws BeansException in dependency resolution failed */ Object resolveDependency(DependencyDescriptor descriptor, String beanName, diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinition.java index f71ec5da20..4102753bfc 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinition.java @@ -54,16 +54,16 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { /** - * Role hint indicating that a BeanDefinition is a major part + * Role hint indicating that a {@code BeanDefinition} is a major part * of the application. Typically corresponds to a user-defined bean. */ int ROLE_APPLICATION = 0; /** - * Role hint indicating that a BeanDefinition is a supporting + * Role hint indicating that a {@code BeanDefinition} is a supporting * part of some larger configuration, typically an outer * {@link org.springframework.beans.factory.parsing.ComponentDefinition}. - * SUPPORT beans are considered important enough to be aware + * {@code SUPPORT} beans are considered important enough to be aware * of when looking more closely at a particular * {@link org.springframework.beans.factory.parsing.ComponentDefinition}, * but not when looking at the overall configuration of an application. @@ -71,7 +71,7 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { int ROLE_SUPPORT = 1; /** - * Role hint indicating that a BeanDefinition is providing an + * Role hint indicating that a {@code BeanDefinition} is providing an * entirely background role and has no relevance to the end-user. This hint is * used when registering beans that are completely part of the internal workings * of a {@link org.springframework.beans.factory.parsing.ComponentDefinition}. @@ -126,14 +126,14 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { * The method will be invoked on the specified factory bean, if any, * or otherwise as a static method on the local bean class. * @param factoryMethodName static factory method name, - * or null if normal constructor creation should be used + * or {@code null} if normal constructor creation should be used * @see #getBeanClassName() */ void setFactoryMethodName(String factoryMethodName); /** * Return the name of the current target scope for this bean, - * or null if not known yet. + * or {@code null} if not known yet. */ String getScope(); @@ -152,7 +152,7 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { /** * Set whether this bean should be lazily initialized. - *

If false, the bean will get instantiated on startup by bean + *

If {@code false}, the bean will get instantiated on startup by bean * factories that perform eager initialization of singletons. */ void setLazyInit(boolean lazyInit); @@ -196,14 +196,14 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { /** * Return the constructor argument values for this bean. *

The returned instance can be modified during bean factory post-processing. - * @return the ConstructorArgumentValues object (never null) + * @return the ConstructorArgumentValues object (never {@code null}) */ ConstructorArgumentValues getConstructorArgumentValues(); /** * Return the property values to be applied to a new instance of the bean. *

The returned instance can be modified during bean factory post-processing. - * @return the MutablePropertyValues object (never null) + * @return the MutablePropertyValues object (never {@code null}) */ MutablePropertyValues getPropertyValues(); @@ -228,9 +228,9 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { boolean isAbstract(); /** - * Get the role hint for this BeanDefinition. The role hint + * Get the role hint for this {@code BeanDefinition}. The role hint * provides tools with an indication of the importance of a particular - * BeanDefinition. + * {@code BeanDefinition}. * @see #ROLE_APPLICATION * @see #ROLE_INFRASTRUCTURE * @see #ROLE_SUPPORT @@ -249,7 +249,7 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { String getResourceDescription(); /** - * Return the originating BeanDefinition, or null if none. + * Return the originating BeanDefinition, or {@code null} if none. * Allows for retrieving the decorated bean definition, if any. *

Note that this method returns the immediate originator. Iterate through the * originator chain to find the original BeanDefinition as defined by the user. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinitionHolder.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinitionHolder.java index cd2dd25093..d14e2f3c0b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinitionHolder.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanDefinitionHolder.java @@ -57,7 +57,7 @@ public class BeanDefinitionHolder implements BeanMetadataElement { * Create a new BeanDefinitionHolder. * @param beanDefinition the BeanDefinition to wrap * @param beanName the name of the bean, as specified for the bean definition - * @param aliases alias names for the bean, or null if none + * @param aliases alias names for the bean, or {@code null} if none */ public BeanDefinitionHolder(BeanDefinition beanDefinition, String beanName, String[] aliases) { Assert.notNull(beanDefinition, "BeanDefinition must not be null"); @@ -71,7 +71,7 @@ public class BeanDefinitionHolder implements BeanMetadataElement { * Copy constructor: Create a new BeanDefinitionHolder with the * same contents as the given BeanDefinitionHolder instance. *

Note: The wrapped BeanDefinition reference is taken as-is; - * it is not deeply copied. + * it is {@code not} deeply copied. * @param beanDefinitionHolder the BeanDefinitionHolder to copy */ public BeanDefinitionHolder(BeanDefinitionHolder beanDefinitionHolder) { @@ -98,7 +98,7 @@ public class BeanDefinitionHolder implements BeanMetadataElement { /** * Return the alias names for the bean, as specified directly for the bean definition. - * @return the array of alias names, or null if none + * @return the array of alias names, or {@code null} if none */ public String[] getAliases() { return this.aliases; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanPostProcessor.java index ee23681759..52d03678bc 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanPostProcessor.java @@ -43,13 +43,13 @@ public interface BeanPostProcessor { /** * Apply this BeanPostProcessor to the given new bean instance before any bean - * initialization callbacks (like InitializingBean's afterPropertiesSet + * initialization callbacks (like InitializingBean's {@code afterPropertiesSet} * or a custom init-method). The bean will already be populated with property values. * The returned bean instance may be a wrapper around the original. * @param bean the new bean instance * @param beanName the name of the bean * @return the bean instance to use, either the original or a wrapped one; if - * null, no subsequent BeanPostProcessors will be invoked + * {@code null}, no subsequent BeanPostProcessors will be invoked * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet */ @@ -57,20 +57,20 @@ public interface BeanPostProcessor { /** * Apply this BeanPostProcessor to the given new bean instance after any bean - * initialization callbacks (like InitializingBean's afterPropertiesSet + * initialization callbacks (like InitializingBean's {@code afterPropertiesSet} * or a custom init-method). The bean will already be populated with property values. * The returned bean instance may be a wrapper around the original. *

In case of a FactoryBean, this callback will be invoked for both the FactoryBean * instance and the objects created by the FactoryBean (as of Spring 2.0). The * post-processor can decide whether to apply to either the FactoryBean or created - * objects or both through corresponding bean instanceof FactoryBean checks. + * objects or both through corresponding {@code bean instanceof FactoryBean} checks. *

This callback will also be invoked after a short-circuiting triggered by a * {@link InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation} method, * in contrast to all other BeanPostProcessor callbacks. * @param bean the new bean instance * @param beanName the name of the bean * @return the bean instance to use, either the original or a wrapped one; if - * null, no subsequent BeanPostProcessors will be invoked + * {@code null}, no subsequent BeanPostProcessors will be invoked * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet * @see org.springframework.beans.factory.FactoryBean diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReference.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReference.java index 2dac38ecc7..b396d2367b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReference.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReference.java @@ -33,7 +33,7 @@ import org.springframework.beans.BeanMetadataElement; public interface BeanReference extends BeanMetadataElement { /** - * Return the target bean name that this reference points to (never null). + * Return the target bean name that this reference points to (never {@code null}). */ String getBeanName(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReferenceFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReferenceFactoryBean.java index 1a382a6324..e7c232d97b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReferenceFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanReferenceFactoryBean.java @@ -30,7 +30,7 @@ import org.springframework.beans.factory.SmartFactoryBean; * using this FactoryBean to link it in and expose it under a different name. * Effectively, this corresponds to an alias for the target bean. * - *

NOTE: For XML bean definition files, an <alias> + *

NOTE: For XML bean definition files, an {@code <alias>} * tag is available that effectively achieves the same. * *

A special capability of this FactoryBean is enabled through its configuration 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 35e44cfeee..d04eb15d81 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 @@ -51,14 +51,14 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single /** * Scope identifier for the standard singleton scope: "singleton". - * Custom scopes can be added via registerScope. + * Custom scopes can be added via {@code registerScope}. * @see #registerScope */ String SCOPE_SINGLETON = "singleton"; /** * Scope identifier for the standard prototype scope: "prototype". - * Custom scopes can be added via registerScope. + * Custom scopes can be added via {@code registerScope}. * @see #registerScope */ String SCOPE_PROTOTYPE = "prototype"; @@ -83,7 +83,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single * Spring 2.0 by default: Bean definitions only carry bean class names, * to be resolved once the factory processes the bean definition. * @param beanClassLoader the class loader to use, - * or null to suggest the default class loader + * or {@code null} to suggest the default class loader */ void setBeanClassLoader(ClassLoader beanClassLoader); @@ -255,14 +255,14 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single *

This will only return explicitly registered scopes. * Built-in scopes such as "singleton" and "prototype" won't be exposed. * @param scopeName the name of the scope - * @return the registered Scope implementation, or null if none + * @return the registered Scope implementation, or {@code null} if none * @see #registerScope */ Scope getRegisteredScope(String scopeName); /** * Provides a security access control context relevant to this factory. - * @return the applicable AccessControlContext (never null) + * @return the applicable AccessControlContext (never {@code null}) * @since 3.0 */ AccessControlContext getAccessControlContext(); @@ -314,7 +314,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single * Determine whether the bean with the given name is a FactoryBean. * @param name the name of the bean to check * @return whether the bean is a FactoryBean - * (false means the bean exists but is not a FactoryBean) + * ({@code false} means the bean exists but is not a FactoryBean) * @throws NoSuchBeanDefinitionException if there is no bean with the given name * @since 2.5 */ 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 459003bb3d..956448d332 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 @@ -115,7 +115,7 @@ public interface ConfigurableListableBeanFactory /** * Return whether this factory's bean definitions are frozen, * i.e. are not supposed to be modified or post-processed any further. - * @return true if the factory's configuration is considered frozen + * @return {@code true} if the factory's configuration is considered frozen */ boolean isConfigurationFrozen(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java index 3a3aa9df17..4d013fae16 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java @@ -142,9 +142,9 @@ public class ConstructorArgumentValues { /** * Get argument value for the given index in the constructor argument list. * @param index the index in the constructor argument list - * @param requiredType the type to match (can be null to match + * @param requiredType the type to match (can be {@code null} to match * untyped values only) - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getIndexedArgumentValue(int index, Class requiredType) { return getIndexedArgumentValue(index, requiredType, null); @@ -153,11 +153,11 @@ public class ConstructorArgumentValues { /** * Get argument value for the given index in the constructor argument list. * @param index the index in the constructor argument list - * @param requiredType the type to match (can be null to match + * @param requiredType the type to match (can be {@code null} to match * untyped values only) - * @param requiredName the type to match (can be null to match + * @param requiredName the type to match (can be {@code null} to match * unnamed values only) - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getIndexedArgumentValue(int index, Class requiredType, String requiredName) { Assert.isTrue(index >= 0, "Index must not be negative"); @@ -245,7 +245,7 @@ public class ConstructorArgumentValues { /** * Look for a generic argument value that matches the given type. * @param requiredType the type to match - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getGenericArgumentValue(Class requiredType) { return getGenericArgumentValue(requiredType, null, null); @@ -255,7 +255,7 @@ public class ConstructorArgumentValues { * Look for a generic argument value that matches the given type. * @param requiredType the type to match * @param requiredName the name to match - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getGenericArgumentValue(Class requiredType, String requiredName) { return getGenericArgumentValue(requiredType, requiredName, null); @@ -265,13 +265,13 @@ public class ConstructorArgumentValues { * Look for the next generic argument value that matches the given type, * ignoring argument values that have already been used in the current * resolution process. - * @param requiredType the type to match (can be null to find + * @param requiredType the type to match (can be {@code null} to find * an arbitrary next generic argument value) - * @param requiredName the name to match (can be null to not + * @param requiredName the name to match (can be {@code null} to not * match argument values by name) * @param usedValueHolders a Set of ValueHolder objects that have already been used * in the current resolution process and should therefore not be returned again - * @return the ValueHolder for the argument, or null if none found + * @return the ValueHolder for the argument, or {@code null} if none found */ public ValueHolder getGenericArgumentValue(Class requiredType, String requiredName, Set usedValueHolders) { for (ValueHolder valueHolder : this.genericArgumentValues) { @@ -310,7 +310,7 @@ public class ConstructorArgumentValues { * in the constructor argument list or generically matches by type. * @param index the index in the constructor argument list * @param requiredType the type to match - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getArgumentValue(int index, Class requiredType) { return getArgumentValue(index, requiredType, null, null); @@ -322,7 +322,7 @@ public class ConstructorArgumentValues { * @param index the index in the constructor argument list * @param requiredType the type to match * @param requiredName the name to match - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getArgumentValue(int index, Class requiredType, String requiredName) { return getArgumentValue(index, requiredType, requiredName, null); @@ -332,13 +332,13 @@ public class ConstructorArgumentValues { * Look for an argument value that either corresponds to the given index * in the constructor argument list or generically matches by type. * @param index the index in the constructor argument list - * @param requiredType the type to match (can be null to find + * @param requiredType the type to match (can be {@code null} to find * an untyped argument value) * @param usedValueHolders a Set of ValueHolder objects that have already * been used in the current resolution process and should therefore not * be returned again (allowing to return the next generic argument match * in case of multiple generic argument values of the same type) - * @return the ValueHolder for the argument, or null if none set + * @return the ValueHolder for the argument, or {@code null} if none set */ public ValueHolder getArgumentValue(int index, Class requiredType, String requiredName, Set usedValueHolders) { Assert.isTrue(index >= 0, "Index must not be negative"); @@ -512,7 +512,7 @@ public class ConstructorArgumentValues { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { @@ -524,8 +524,8 @@ public class ConstructorArgumentValues { } /** - * Return whether this holder contains a converted value already (true), - * or whether the value still needs to be converted (false). + * Return whether this holder contains a converted value already ({@code true}), + * or whether the value still needs to be converted ({@code false}). */ public synchronized boolean isConverted() { return this.converted; @@ -551,7 +551,7 @@ public class ConstructorArgumentValues { /** * Determine whether the content of this ValueHolder is equal * to the content of the given other ValueHolder. - *

Note that ValueHolder does not implement equals + *

Note that ValueHolder does not implement {@code equals} * directly, to allow for multiple ValueHolder instances with the * same content to reside in the same Set. */ @@ -562,7 +562,7 @@ public class ConstructorArgumentValues { /** * Determine whether the hash code of the content of this ValueHolder. - *

Note that ValueHolder does not implement hashCode + *

Note that ValueHolder does not implement {@code hashCode} * directly, to allow for multiple ValueHolder instances with the * same content to reside in the same Set. */ 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 2118bdae98..d3e6796a7d 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 @@ -126,10 +126,10 @@ public class CustomEditorConfigurer implements BeanFactoryPostProcessor, BeanCla /** * Specify the {@link PropertyEditorRegistrar PropertyEditorRegistrars} * to apply to beans defined within the current application context. - *

This allows for sharing PropertyEditorRegistrars with + *

This allows for sharing {@code PropertyEditorRegistrars} with * {@link org.springframework.validation.DataBinder DataBinders}, etc. * Furthermore, it avoids the need for synchronization on custom editors: - * A PropertyEditorRegistrar will always create fresh editor + * A {@code PropertyEditorRegistrar} will always create fresh editor * instances for each bean creation attempt. * @see ConfigurableListableBeanFactory#addPropertyEditorRegistrar */ 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 ba38a85c4b..67559bea8e 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 @@ -143,7 +143,7 @@ public class DependencyDescriptor implements Serializable { /** * Return the wrapped MethodParameter, if any. *

Note: Either MethodParameter or Field is available. - * @return the MethodParameter, or null if none + * @return the MethodParameter, or {@code null} if none */ public MethodParameter getMethodParameter() { return this.methodParameter; @@ -152,7 +152,7 @@ public class DependencyDescriptor implements Serializable { /** * Return the wrapped Field, if any. *

Note: Either MethodParameter or Field is available. - * @return the Field, or null if none + * @return the Field, or {@code null} if none */ public Field getField() { return this.field; @@ -199,7 +199,7 @@ public class DependencyDescriptor implements Serializable { /** * Determine the name of the wrapped parameter/field. - * @return the declared name (never null) + * @return the declared name (never {@code null}) */ public String getDependencyName() { return (this.field != null ? this.field.getName() : this.methodParameter.getParameterName()); @@ -207,7 +207,7 @@ public class DependencyDescriptor implements Serializable { /** * Determine the declared (non-generic) type of the wrapped parameter/field. - * @return the declared type (never null) + * @return the declared type (never {@code null}) */ public Class getDependencyType() { if (this.field != null) { @@ -238,7 +238,7 @@ public class DependencyDescriptor implements Serializable { /** * Determine the generic element type of the wrapped Collection parameter/field, if any. - * @return the generic type, or null if none + * @return the generic type, or {@code null} if none */ public Class getCollectionType() { return (this.field != null ? @@ -248,7 +248,7 @@ public class DependencyDescriptor implements Serializable { /** * Determine the generic key type of the wrapped Map parameter/field, if any. - * @return the generic type, or null if none + * @return the generic type, or {@code null} if none */ public Class getMapKeyType() { return (this.field != null ? @@ -258,7 +258,7 @@ public class DependencyDescriptor implements Serializable { /** * Determine the generic value type of the wrapped Map parameter/field, if any. - * @return the generic type, or null if none + * @return the generic type, or {@code null} if none */ public Class getMapValueType() { return (this.field != null ? 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 c7acb6bdff..df8cb8447f 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 @@ -32,7 +32,7 @@ public interface DestructionAwareBeanPostProcessor extends BeanPostProcessor { /** * Apply this BeanPostProcessor to the given bean instance before * its destruction. Can invoke custom destruction callbacks. - *

Like DisposableBean's destroy and a custom destroy method, + *

Like DisposableBean's {@code destroy} and a custom destroy method, * this callback just applies to singleton beans in the factory (including * inner beans). * @param bean the bean instance to be destroyed diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/InstantiationAwareBeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/InstantiationAwareBeanPostProcessor.java index f0d5b59a92..7eca9097c1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/InstantiationAwareBeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/InstantiationAwareBeanPostProcessor.java @@ -61,7 +61,7 @@ public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor { * @param beanClass the class of the bean to be instantiated * @param beanName the name of the bean * @return the bean object to expose instead of a default instance of the target bean, - * or null to proceed with default instantiation + * or {@code null} to proceed with default instantiation * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.factory.support.AbstractBeanDefinition#hasBeanClass * @see org.springframework.beans.factory.support.AbstractBeanDefinition#getFactoryMethodName @@ -76,9 +76,9 @@ public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor { * for a typical example. * @param bean the bean instance created, with properties not having been set yet * @param beanName the name of the bean - * @return true if properties should be set on the bean; false - * if property population should be skipped. Normal implementations should return true. - * Returning false will also prevent any subsequent InstantiationAwareBeanPostProcessor + * @return {@code true} if properties should be set on the bean; {@code false} + * if property population should be skipped. Normal implementations should return {@code true}. + * Returning {@code false} will also prevent any subsequent InstantiationAwareBeanPostProcessor * instances being invoked on this bean instance. * @throws org.springframework.beans.BeansException in case of errors */ @@ -91,13 +91,13 @@ public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor { *

Also allows for replacing the property values to apply, typically through * creating a new MutablePropertyValues instance based on the original PropertyValues, * adding or removing specific values. - * @param pvs the property values that the factory is about to apply (never null) + * @param pvs the property values that the factory is about to apply (never {@code null}) * @param pds the relevant property descriptors for the target bean (with ignored * dependency types - which the factory handles specifically - already filtered out) * @param bean the bean instance created, but whose properties have not yet been set * @param beanName the name of the bean * @return the actual property values to apply to to the given bean - * (can be the passed-in PropertyValues instance), or null + * (can be the passed-in PropertyValues instance), or {@code null} * to skip property population * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.MutablePropertyValues diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ListFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ListFactoryBean.java index 7ceb21f753..299b588fc6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ListFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ListFactoryBean.java @@ -49,7 +49,7 @@ public class ListFactoryBean extends AbstractFactoryBean { /** * Set the class to use for the target List. Can be populated with a fully * qualified class name when defined in a Spring application context. - *

Default is a java.util.ArrayList. + *

Default is a {@code java.util.ArrayList}. * @see java.util.ArrayList */ public void setTargetListClass(Class targetListClass) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/MethodInvokingFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/MethodInvokingFactoryBean.java index 758092b812..b544f2f1e2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/MethodInvokingFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/MethodInvokingFactoryBean.java @@ -194,7 +194,7 @@ public class MethodInvokingFactoryBean extends ArgumentConvertingMethodInvoker /** * Return the type of object that this FactoryBean creates, - * or null if not known in advance. + * or {@code null} if not known in advance. */ public Class getObjectType() { if (!isPrepared()) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ObjectFactoryCreatingFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ObjectFactoryCreatingFactoryBean.java index d2fc8ab259..c9bf53b3ba 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ObjectFactoryCreatingFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ObjectFactoryCreatingFactoryBean.java @@ -57,7 +57,7 @@ import org.springframework.util.Assert; * *</beans>

* - *

The attendant MyClientBean class implementation might look + *

The attendant {@code MyClientBean} class implementation might look * something like this: * *

package a.b.c;
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PreferencesPlaceholderConfigurer.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PreferencesPlaceholderConfigurer.java
index 2e0aabceba..a202e5a958 100644
--- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PreferencesPlaceholderConfigurer.java
+++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PreferencesPlaceholderConfigurer.java
@@ -25,7 +25,7 @@ import org.springframework.beans.factory.InitializingBean;
 
 /**
  * Subclass of PropertyPlaceholderConfigurer that supports JDK 1.4's
- * Preferences API (java.util.prefs).
+ * Preferences API ({@code java.util.prefs}).
  *
  * 

Tries to resolve placeholders as keys first in the user preferences, * then in the system preferences, then in this configurer's properties. @@ -110,7 +110,7 @@ public class PreferencesPlaceholderConfigurer extends PropertyPlaceholderConfigu * @param path the preferences path (placeholder part before '/') * @param key the preferences key (placeholder part after '/') * @param preferences the Preferences to resolve against - * @return the value for the placeholder, or null if none found + * @return the value for the placeholder, or {@code null} if none found */ protected String resolvePlaceholder(String path, String key, Preferences preferences) { if (path != null) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java index 736a7d14fd..9dbcb9becb 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyOverrideConfigurer.java @@ -52,7 +52,7 @@ import org.springframework.beans.factory.BeanInitializationException; * the same bean property, the last one will win (due to the overriding mechanism). * *

Property values can be converted after reading them in, through overriding - * the convertPropertyValue method. For example, encrypted values + * the {@code convertPropertyValue} method. For example, encrypted values * can be detected and decrypted accordingly before processing them. * * @author Juergen Hoeller 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 442f541c50..197c2ad306 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 @@ -137,8 +137,8 @@ public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport /** * Resolve the given placeholder using the given properties, performing * a system properties check according to the given mode. - *

The default implementation delegates to resolvePlaceholder - * (placeholder, props) before/after the system properties check. + *

The default implementation delegates to {@code resolvePlaceholder + * (placeholder, props)} before/after the system properties check. *

Subclasses can override this for custom resolution strategies, * including customized points for the system properties check. * @param placeholder the placeholder to resolve @@ -174,7 +174,7 @@ public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport * after this method is invoked, according to the system properties mode. * @param placeholder the placeholder to resolve * @param props the merged properties of this configurer - * @return the resolved value, of null if none + * @return the resolved value, of {@code null} if none * @see #setSystemPropertiesMode */ protected String resolvePlaceholder(String placeholder, Properties props) { @@ -185,10 +185,10 @@ public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport * Resolve the given key as JVM system property, and optionally also as * system environment variable if no matching system property has been found. * @param key the placeholder to resolve as system property key - * @return the system property value, or null if not found + * @return the system property value, or {@code null} if not found * @see #setSearchSystemEnvironment - * @see java.lang.System#getProperty(String) - * @see java.lang.System#getenv(String) + * @see System#getProperty(String) + * @see System#getenv(String) */ protected String resolveSystemProperty(String key) { try { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ProviderCreatingFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ProviderCreatingFactoryBean.java index 317defbe96..0ce9e083cd 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ProviderCreatingFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ProviderCreatingFactoryBean.java @@ -31,8 +31,8 @@ import org.springframework.util.Assert; *

This is basically a JSR-330 compliant variant of Spring's good old * {@link ObjectFactoryCreatingFactoryBean}. It can be used for traditional * external dependency injection configuration that targets a property or - * constructor argument of type javax.inject.Provider, as an - * alternative to JSR-330's @Inject annotation-driven approach. + * constructor argument of type {@code javax.inject.Provider}, as an + * alternative to JSR-330's {@code @Inject} annotation-driven approach. * * @author Juergen Hoeller * @since 3.0.2 diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanNameReference.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanNameReference.java index 92e3fd1899..d9c775743d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanNameReference.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanNameReference.java @@ -49,7 +49,7 @@ public class RuntimeBeanNameReference implements BeanReference { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanReference.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanReference.java index 9bef3a1e81..55ab063ef6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanReference.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/RuntimeBeanReference.java @@ -74,7 +74,7 @@ public class RuntimeBeanReference implements BeanReference { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { 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 9da178b2ef..7e299321f0 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 @@ -38,14 +38,14 @@ import org.springframework.beans.factory.ObjectFactory; * this SPI is completely generic: It provides the ability to get and put * objects from any underlying storage mechanism, such as an HTTP session * or a custom conversation mechanism. The name passed into this class's - * get and remove methods will identify the + * {@code get} and {@code remove} methods will identify the * target object in the current scope. * - *

Scope implementations are expected to be thread-safe. - * One Scope instance can be used with multiple bean factories + *

{@code Scope} implementations are expected to be thread-safe. + * One {@code Scope} instance can be used with multiple bean factories * at the same time, if desired (unless it explicitly wants to be aware of * the containing BeanFactory), with any number of threads accessing - * the Scope concurrently from any number of factories. + * the {@code Scope} concurrently from any number of factories. * * @author Juergen Hoeller * @author Rob Harrop @@ -67,14 +67,14 @@ public interface Scope { * @param name the name of the object to retrieve * @param objectFactory the {@link ObjectFactory} to use to create the scoped * object if it is not present in the underlying storage mechanism - * @return the desired object (never null) + * @return the desired object (never {@code null}) */ Object get(String name, ObjectFactory objectFactory); /** - * Remove the object with the given name from the underlying scope. - *

Returns null if no object was found; otherwise - * returns the removed Object. + * Remove the object with the given {@code name} from the underlying scope. + *

Returns {@code null} if no object was found; otherwise + * returns the removed {@code Object}. *

Note that an implementation should also remove a registered destruction * callback for the specified object, if any. It does, however, not * need to execute a registered destruction callback in this case, @@ -83,7 +83,7 @@ public interface Scope { * {@link UnsupportedOperationException} if they do not support explicitly * removing an object. * @param name the name of the object to remove - * @return the removed object, or null if no object was present + * @return the removed object, or {@code null} if no object was present * @see #registerDestructionCallback */ Object remove(String name); @@ -122,7 +122,7 @@ public interface Scope { * Resolve the contextual object for the given key, if any. * E.g. the HttpServletRequest object for key "request". * @param key the contextual key - * @return the corresponding object, or null if none found + * @return the corresponding object, or {@code null} if none found */ Object resolveContextualObject(String key); @@ -135,9 +135,9 @@ public interface Scope { * case of a custom conversation that sits within the overall session, * the specific ID for the current conversation would be appropriate. *

Note: This is an optional operation. It is perfectly valid to - * return null in an implementation of this method if the + * return {@code null} in an implementation of this method if the * underlying storage mechanism has no obvious candidate for such an ID. - * @return the conversation ID, or null if there is no + * @return the conversation ID, or {@code null} if there is no * conversation ID for the current scope */ String getConversationId(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ServiceLocatorFactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ServiceLocatorFactoryBean.java index 192f6b7e66..1fb0c2005a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ServiceLocatorFactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ServiceLocatorFactoryBean.java @@ -36,8 +36,8 @@ import org.springframework.util.StringUtils; /** * A {@link FactoryBean} implementation that takes an interface which must have one or more - * methods with the signatures MyType xxx() or MyType xxx(MyIdType id) - * (typically, MyService getService() or MyService getService(String id)) + * methods with the signatures {@code MyType xxx()} or {@code MyType xxx(MyIdType id)} + * (typically, {@code MyService getService()} or {@code MyService getService(String id)}) * and creates a dynamic proxy which implements that interface, delegating to an * underlying {@link org.springframework.beans.factory.BeanFactory}. * @@ -51,7 +51,7 @@ import org.springframework.util.StringUtils; * setter or constructor injection of the target bean is preferable. * *

On invocation of the no-arg factory method, or the single-arg factory - * method with a String id of null or empty String, if exactly + * method with a String id of {@code null} or empty String, if exactly * one bean in the factory matches the return type of the factory * method, that bean is returned, otherwise a * {@link org.springframework.beans.factory.NoSuchBeanDefinitionException} @@ -64,7 +64,7 @@ import org.springframework.util.StringUtils; * *

A factory method argument will usually be a String, but can also be an * int or a custom enumeration type, for example, stringified via - * toString. The resulting String can be used as bean name as-is, + * {@code toString}. The resulting String can be used as bean name as-is, * provided that corresponding beans are defined in the bean factory. * Alternatively, {@link #setServiceMappings(java.util.Properties) a custom mapping} * between service ids and bean names can be defined. @@ -99,7 +99,7 @@ import org.springframework.util.StringUtils; * *</beans>

* - *

The attendant MyClientBean class implementation might then + *

The attendant {@code MyClientBean} class implementation might then * look something like this: * *

package a.b.c;
@@ -151,7 +151,7 @@ import org.springframework.util.StringUtils;
  *
  *</beans>
* - *

The attendant MyClientBean class implementation might then + *

The attendant {@code MyClientBean} class implementation might then * look something like this: * *

package a.b.c;
@@ -202,8 +202,8 @@ public class ServiceLocatorFactoryBean implements FactoryBean, BeanFacto
 
 	/**
 	 * Set the service locator interface to use, which must have one or more methods with
-	 * the signatures MyType xxx() or MyType xxx(MyIdType id)
-	 * (typically, MyService getService() or MyService getService(String id)).
+	 * the signatures {@code MyType xxx()} or {@code MyType xxx(MyIdType id)}
+	 * (typically, {@code MyService getService()} or {@code MyService getService(String id)}).
 	 * See the {@link ServiceLocatorFactoryBean class-level Javadoc} for
 	 * information on the semantics of such methods.
 	 */
@@ -214,8 +214,8 @@ public class ServiceLocatorFactoryBean implements FactoryBean, BeanFacto
 	/**
 	 * Set the exception class that the service locator should throw if service
 	 * lookup failed. The specified exception class must have a constructor
-	 * with one of the following parameter types: (String, Throwable)
-	 * or (Throwable) or (String).
+	 * with one of the following parameter types: {@code (String, Throwable)}
+	 * or {@code (Throwable)} or {@code (String)}.
 	 * 

If not specified, subclasses of Spring's BeansException will be thrown, * for example NoSuchBeanDefinitionException. As those are unchecked, the * caller does not need to handle them, so it might be acceptable that @@ -236,7 +236,7 @@ public class ServiceLocatorFactoryBean implements FactoryBean, BeanFacto * Set mappings between service ids (passed into the service locator) * and bean names (in the bean factory). Service ids that are not defined * here will be treated as bean names as-is. - *

The empty string as service id key defines the mapping for null and + *

The empty string as service id key defines the mapping for {@code null} and * empty string, and for factory methods without parameter. If not defined, * a single matching bean will be retrieved from the bean factory. * @param serviceMappings mappings between service ids and bean names, @@ -271,8 +271,8 @@ public class ServiceLocatorFactoryBean implements FactoryBean, BeanFacto * Determine the constructor to use for the given service locator exception * class. Only called in case of a custom service locator exception. *

The default implementation looks for a constructor with one of the - * following parameter types: (String, Throwable) - * or (Throwable) or (String). + * following parameter types: {@code (String, Throwable)} + * or {@code (Throwable)} or {@code (String)}. * @param exceptionClass the exception class * @return the constructor to use * @see #setServiceLocatorExceptionClass diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/SingletonBeanRegistry.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/SingletonBeanRegistry.java index 9bbc3ad07d..2d94806085 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/SingletonBeanRegistry.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/SingletonBeanRegistry.java @@ -37,9 +37,9 @@ public interface SingletonBeanRegistry { * under the given bean name. *

The given instance is supposed to be fully initialized; the registry * will not perform any initialization callbacks (in particular, it won't - * call InitializingBean's afterPropertiesSet method). + * call InitializingBean's {@code afterPropertiesSet} method). * The given instance will not receive any destruction callbacks - * (like DisposableBean's destroy method) either. + * (like DisposableBean's {@code destroy} method) either. *

When running within a full BeanFactory: Register a bean definition * instead of an existing instance if your bean is supposed to receive * initialization and/or destruction callbacks. @@ -65,23 +65,23 @@ public interface SingletonBeanRegistry { *

NOTE: This lookup method is not aware of FactoryBean prefixes or aliases. * You need to resolve the canonical bean name first before obtaining the singleton instance. * @param beanName the name of the bean to look for - * @return the registered singleton object, or null if none found + * @return the registered singleton object, or {@code null} if none found * @see ConfigurableListableBeanFactory#getBeanDefinition */ Object getSingleton(String beanName); /** * Check if this registry contains a singleton instance with the given name. - *

Only checks already instantiated singletons; does not return true + *

Only checks already instantiated singletons; does not return {@code true} * for singleton bean definitions which have not been instantiated yet. *

The main purpose of this method is to check manually registered singletons * (see {@link #registerSingleton}). Can also be used to check whether a * singleton defined by a bean definition has already been created. *

To check whether a bean factory contains a bean definition with a given name, - * use ListableBeanFactory's containsBeanDefinition. Calling both - * containsBeanDefinition and containsSingleton answers + * use ListableBeanFactory's {@code containsBeanDefinition}. Calling both + * {@code containsBeanDefinition} and {@code containsSingleton} answers * whether a specific bean factory contains a local bean instance with the given name. - *

Use BeanFactory's containsBean for general checks whether the + *

Use BeanFactory's {@code containsBean} for general checks whether the * factory knows about a bean with a given name (whether manually registered singleton * instance or created by bean definition), also checking ancestor factories. *

NOTE: This lookup method is not aware of FactoryBean prefixes or aliases. @@ -101,7 +101,7 @@ public interface SingletonBeanRegistry { *

The main purpose of this method is to check manually registered singletons * (see {@link #registerSingleton}). Can also be used to check which singletons * defined by a bean definition have already been created. - * @return the list of names as a String array (never null) + * @return the list of names as a String array (never {@code null}) * @see #registerSingleton * @see org.springframework.beans.factory.support.BeanDefinitionRegistry#getBeanDefinitionNames * @see org.springframework.beans.factory.ListableBeanFactory#getBeanDefinitionNames diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/SmartInstantiationAwareBeanPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/SmartInstantiationAwareBeanPostProcessor.java index ff28d38b94..fe77b35478 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/SmartInstantiationAwareBeanPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/SmartInstantiationAwareBeanPostProcessor.java @@ -41,16 +41,16 @@ public interface SmartInstantiationAwareBeanPostProcessor extends InstantiationA * processor's {@link #postProcessBeforeInstantiation} callback. * @param beanClass the raw class of the bean * @param beanName the name of the bean - * @return the type of the bean, or null if not predictable + * @return the type of the bean, or {@code null} if not predictable * @throws org.springframework.beans.BeansException in case of errors */ Class predictBeanType(Class beanClass, String beanName) throws BeansException; /** * Determine the candidate constructors to use for the given bean. - * @param beanClass the raw class of the bean (never null) + * @param beanClass the raw class of the bean (never {@code null}) * @param beanName the name of the bean - * @return the candidate constructors, or null if none specified + * @return the candidate constructors, or {@code null} if none specified * @throws org.springframework.beans.BeansException in case of errors */ Constructor[] determineCandidateConstructors(Class beanClass, String beanName) throws BeansException; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java index 01e7cb52e2..3f79e9ff5a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/TypedStringValue.java @@ -164,7 +164,7 @@ public class TypedStringValue implements BeanMetadataElement { /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/AliasDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/AliasDefinition.java index dd81c9d9b9..d37d64258c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/AliasDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/AliasDefinition.java @@ -48,7 +48,7 @@ public class AliasDefinition implements BeanMetadataElement { * Create a new AliasDefinition. * @param beanName the canonical name of the bean * @param alias the alias registered for the bean - * @param source the source object (may be null) + * @param source the source object (may be {@code null}) */ public AliasDefinition(String beanName, String alias, Object source) { Assert.notNull(beanName, "Bean name must not be null"); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java index 83dcab0f14..ff5da625e4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java @@ -54,7 +54,7 @@ public class BeanComponentDefinition extends BeanDefinitionHolder implements Com * Create a new BeanComponentDefinition for the given bean. * @param beanDefinition the BeanDefinition * @param beanName the name of the bean - * @param aliases alias names for the bean, or null if none + * @param aliases alias names for the bean, or {@code null} if none */ public BeanComponentDefinition(BeanDefinition beanDefinition, String beanName, String[] aliases) { super(beanDefinition, beanName, aliases); 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 b20786a201..0f16202654 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 @@ -33,18 +33,18 @@ import org.springframework.beans.factory.config.BeanReference; * 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 * that has concrete meaning to the end user. As such, {@link org.springframework.beans.factory.xml.NamespaceHandler} - * implementations are able to publish events in the form of a ComponentDefinition for each - * logical entity being configured. Third parties can then {@link org.springframework.beans.factory.parsing.ReaderEventListener subscribe to these events}, + * implementations are able to publish events in the form of a {@code ComponentDefinition} for each + * logical entity being configured. Third parties can then {@link ReaderEventListener subscribe to these events}, * allowing for a user-centric view of the bean metadata. * - *

Each ComponentDefinition has a {@link #getSource source object} which is configuration-specific. + *

Each {@code ComponentDefinition} has a {@link #getSource source object} which is configuration-specific. * In the case of XML-based configuration this is typically the {@link org.w3c.dom.Node} which contains the user * supplied configuration information. In addition to this, each {@link BeanDefinition} enclosed in a - * ComponentDefinition has its own {@link BeanDefinition#getSource() source object} which may point + * {@code ComponentDefinition} has its own {@link BeanDefinition#getSource() source object} which may point * to a different, more specific, set of configuration data. Beyond this, individual pieces of bean metadata such * as the {@link org.springframework.beans.PropertyValue PropertyValues} may also have a source object giving an * even greater level of detail. Source object extraction is handled through the - * {@link org.springframework.beans.factory.parsing.SourceExtractor} which can be customized as required. + * {@link SourceExtractor} which can be customized as required. * *

Whilst direct access to important {@link BeanReference BeanReferences} is provided through * {@link #getBeanReferences}, tools may wish to inspect all {@link BeanDefinition BeanDefinitions} to gather @@ -60,7 +60,7 @@ import org.springframework.beans.factory.config.BeanReference; * {@link BeanDefinition#getRole role identifier}. The role is essentially a hint to the tool as to how * important the configuration provider believes a {@link BeanDefinition} is to the end user. It is expected * that tools will not display all {@link BeanDefinition BeanDefinitions} for a given - * ComponentDefinition choosing instead to filter based on the role. Tools may choose to make + * {@code ComponentDefinition} choosing instead to filter based on the role. Tools may choose to make * this filtering user configurable. Particular notice should be given to the * {@link BeanDefinition#ROLE_INFRASTRUCTURE INFRASTRUCTURE role identifier}. {@link BeanDefinition BeanDefinitions} * classified with this role are completely unimportant to the end user and are required only for @@ -77,7 +77,7 @@ import org.springframework.beans.factory.config.BeanReference; public interface ComponentDefinition extends BeanMetadataElement { /** - * Get the user-visible name of this ComponentDefinition. + * Get the user-visible name of this {@code ComponentDefinition}. *

This should link back directly to the corresponding configuration data * for this component in a given context. */ @@ -86,14 +86,14 @@ public interface ComponentDefinition extends BeanMetadataElement { /** * Return a friendly description of the described component. *

Implementations are encouraged to return the same value from - * toString(). + * {@code toString()}. */ String getDescription(); /** * Return the {@link BeanDefinition BeanDefinitions} that were registered - * to form this ComponentDefinition. - *

It should be noted that a ComponentDefinition may well be related with + * to form this {@code ComponentDefinition}. + *

It should be noted that a {@code ComponentDefinition} may well be related with * other {@link BeanDefinition BeanDefinitions} via {@link BeanReference references}, * however these are not included as they may be not available immediately. * Important {@link BeanReference BeanReferences} are available from {@link #getBeanReferences()}. @@ -112,7 +112,7 @@ public interface ComponentDefinition extends BeanMetadataElement { /** * Return the set of {@link BeanReference BeanReferences} that are considered - * to be important to this ComponentDefinition. + * to be important to this {@code ComponentDefinition}. *

Other {@link BeanReference BeanReferences} may exist within the associated * {@link BeanDefinition BeanDefinitions}, however these are not considered * to be needed for validation or for user visualization. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ConstructorArgumentEntry.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ConstructorArgumentEntry.java index 86540ef078..b5a99a8890 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ConstructorArgumentEntry.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ConstructorArgumentEntry.java @@ -41,9 +41,9 @@ public class ConstructorArgumentEntry implements ParseState.Entry { /** * Creates a new instance of the {@link ConstructorArgumentEntry} class - * representing a constructor argument at the supplied index. + * representing a constructor argument at the supplied {@code index}. * @param index the index of the constructor argument - * @throws IllegalArgumentException if the supplied index + * @throws IllegalArgumentException if the supplied {@code index} * is less than zero */ public ConstructorArgumentEntry(int index) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/FailFastProblemReporter.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/FailFastProblemReporter.java index 97ce2d3dde..4462ef760f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/FailFastProblemReporter.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/FailFastProblemReporter.java @@ -41,7 +41,7 @@ public class FailFastProblemReporter implements ProblemReporter { /** * Set the {@link Log logger} that is to be used to report warnings. - *

If set to null then a default {@link Log logger} set to + *

If set to {@code null} then a default {@link Log logger} set to * the name of the instance class will be used. * @param logger the {@link Log logger} that is to be used to report warnings */ @@ -69,7 +69,7 @@ public class FailFastProblemReporter implements ProblemReporter { } /** - * Writes the supplied {@link Problem} to the {@link Log} at WARN level. + * Writes the supplied {@link Problem} to the {@link Log} at {@code WARN} level. * @param problem the source of the warning */ public void warning(Problem problem) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ImportDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ImportDefinition.java index 4b7a834d08..e58a4276bb 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ImportDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ImportDefinition.java @@ -47,7 +47,7 @@ public class ImportDefinition implements BeanMetadataElement { /** * Create a new ImportDefinition. * @param importedResource the location of the imported resource - * @param source the source object (may be null) + * @param source the source object (may be {@code null}) */ public ImportDefinition(String importedResource, Object source) { this(importedResource, null, source); @@ -56,7 +56,7 @@ public class ImportDefinition implements BeanMetadataElement { /** * Create a new ImportDefinition. * @param importedResource the location of the imported resource - * @param source the source object (may be null) + * @param source the source object (may be {@code null}) */ public ImportDefinition(String importedResource, Resource[] actualResources, Object source) { Assert.notNull(importedResource, "Imported resource must not be null"); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Location.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Location.java index c5cbcbecbe..71a155efe4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Location.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Location.java @@ -27,7 +27,7 @@ import org.springframework.util.Assert; * {@link #getSource() source} location might be 'The bean defined on * line 76 of beans.properties has an invalid Class'; another source might * be the actual DOM Element from a parsed XML {@link org.w3c.dom.Document}; - * or the source object might simply be null. + * or the source object might simply be {@code null}. * * @author Rob Harrop * @since 2.0 @@ -51,7 +51,7 @@ public class Location { * Create a new instance of the {@link Location} class. * @param resource the resource with which this location is associated * @param source the actual location within the associated resource - * (may be null) + * (may be {@code null}) */ public Location(Resource resource, Object source) { Assert.notNull(resource, "Resource must not be null"); @@ -69,7 +69,7 @@ public class Location { /** * Get the actual location within the associated {@link #getResource() resource} - * (may be null). + * (may be {@code null}). *

See the {@link Location class level javadoc for this class} for examples * of what the actual type of the returned object may be. */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/NullSourceExtractor.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/NullSourceExtractor.java index d95cf1ff1c..6726bbac41 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/NullSourceExtractor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/NullSourceExtractor.java @@ -19,7 +19,7 @@ package org.springframework.beans.factory.parsing; import org.springframework.core.io.Resource; /** - * Simple implementation of {@link SourceExtractor} that returns null + * Simple implementation of {@link SourceExtractor} that returns {@code null} * as the source metadata. * *

This is the default implementation and prevents too much metadata from being @@ -31,7 +31,7 @@ import org.springframework.core.io.Resource; public class NullSourceExtractor implements SourceExtractor { /** - * This implementation simply returns null for any input. + * This implementation simply returns {@code null} for any input. */ public Object extractSource(Object sourceCandidate, Resource definitionResource) { return null; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ParseState.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ParseState.java index 7ef3254da7..4f9882f293 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ParseState.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ParseState.java @@ -44,15 +44,15 @@ public final class ParseState { /** - * Create a new ParseState with an empty {@link Stack}. + * Create a new {@code ParseState} with an empty {@link Stack}. */ public ParseState() { this.state = new Stack(); } /** - * Create a new ParseState whose {@link Stack} is a {@link Object#clone clone} - * of that of the passed in ParseState. + * Create a new {@code ParseState} whose {@link Stack} is a {@link Object#clone clone} + * of that of the passed in {@code ParseState}. */ private ParseState(ParseState other) { this.state = (Stack) other.state.clone(); @@ -75,7 +75,7 @@ public final class ParseState { /** * Return the {@link Entry} currently at the top of the {@link Stack} or - * null if the {@link Stack} is empty. + * {@code null} if the {@link Stack} is empty. */ public Entry peek() { return (Entry) (this.state.empty() ? null : this.state.peek()); @@ -91,7 +91,7 @@ public final class ParseState { /** - * Returns a tree-style representation of the current ParseState. + * Returns a tree-style representation of the current {@code ParseState}. */ @Override public String toString() { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PassThroughSourceExtractor.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PassThroughSourceExtractor.java index 573244001d..f11e44e4f9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PassThroughSourceExtractor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PassThroughSourceExtractor.java @@ -35,9 +35,9 @@ import org.springframework.core.io.Resource; public class PassThroughSourceExtractor implements SourceExtractor { /** - * Simply returns the supplied sourceCandidate as-is. + * Simply returns the supplied {@code sourceCandidate} as-is. * @param sourceCandidate the source metadata - * @return the supplied sourceCandidate + * @return the supplied {@code sourceCandidate} */ public Object extractSource(Object sourceCandidate, Resource definingResource) { return sourceCandidate; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Problem.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Problem.java index b895ad23ba..42f1bc82e0 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Problem.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/Problem.java @@ -61,8 +61,8 @@ public class Problem { /** * Create a new instance of the {@link Problem} class. - * @param message a message detailing the problem - * @param rootCause the underlying expection that caused the error (may be null) + * @param message a message detailing the problem + * @param rootCause the underlying expection that caused the error (may be {@code null}) * @param parseState the {@link ParseState} at the time of the error * @param location the location within a bean configuration source that triggered the error */ @@ -100,14 +100,14 @@ public class Problem { } /** - * Get the {@link ParseState} at the time of the error (may be null). + * Get the {@link ParseState} at the time of the error (may be {@code null}). */ public ParseState getParseState() { return this.parseState; } /** - * Get the underlying expection that caused the error (may be null). + * Get the underlying expection that caused the error (may be {@code null}). */ public Throwable getRootCause() { return this.rootCause; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ProblemReporter.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ProblemReporter.java index a9e1bedbe9..0bbbb4deee 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ProblemReporter.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ProblemReporter.java @@ -31,21 +31,21 @@ public interface ProblemReporter { * Called when a fatal error is encountered during the parsing process. *

Implementations must treat the given problem as fatal, * i.e. they have to eventually raise an exception. - * @param problem the source of the error (never null) + * @param problem the source of the error (never {@code null}) */ void fatal(Problem problem); /** * Called when an error is encountered during the parsing process. *

Implementations may choose to treat errors as fatal. - * @param problem the source of the error (never null) + * @param problem the source of the error (never {@code null}) */ void error(Problem problem); /** * Called when a warning is raised during the parsing process. *

Warnings are never considered to be fatal. - * @param problem the source of the warning (never null) + * @param problem the source of the warning (never {@code null}) */ void warning(Problem problem); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PropertyEntry.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PropertyEntry.java index 18875d3af3..6d602ea28a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PropertyEntry.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/PropertyEntry.java @@ -32,7 +32,7 @@ public class PropertyEntry implements ParseState.Entry { /** * Creates a new instance of the {@link PropertyEntry} class. * @param name the name of the JavaBean property represented by this instance - * @throws IllegalArgumentException if the supplied name is null + * @throws IllegalArgumentException if the supplied {@code name} is {@code null} * or consists wholly of whitespace */ public PropertyEntry(String name) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/SourceExtractor.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/SourceExtractor.java index 55988c3726..88c2bcf9f4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/SourceExtractor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/SourceExtractor.java @@ -38,10 +38,10 @@ public interface SourceExtractor { /** * Extract the source metadata from the candidate object supplied * by the configuration parser. - * @param sourceCandidate the original source metadata (never null) + * @param sourceCandidate the original source metadata (never {@code null}) * @param definingResource the resource that defines the given source object - * (may be null) - * @return the source metadata object to store (may be null) + * (may be {@code null}) + * @return the source metadata object to store (may be {@code null}) */ Object extractSource(Object sourceCandidate, Resource definingResource); 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 7d06a13b08..92c74dde60 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 @@ -164,7 +164,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Create a new AbstractAutowireCapableBeanFactory with the given parent. - * @param parentBeanFactory parent bean factory, or null if none + * @param parentBeanFactory parent bean factory, or {@code null} if none */ public AbstractAutowireCapableBeanFactory(BeanFactory parentBeanFactory) { this(); @@ -467,13 +467,13 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Actually create the specified bean. Pre-creation processing has already happened - * at this point, e.g. checking postProcessBeforeInstantiation callbacks. + * at this point, e.g. 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 * @param mbd the merged bean definition for the bean * @param args arguments to use if creating a prototype using explicit arguments to a - * static factory method. This parameter must be null except in this case. + * static factory method. This parameter must be {@code null} except in this case. * @return a new instance of the bean * @throws BeanCreationException if the bean could not be created * @see #instantiateBean @@ -606,8 +606,8 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * @param beanName the name of the bean (for error handling purposes) * @param mbd the merged bean definition for the bean * @param typesToMatch the types to match in case of internal type matching purposes - * (also signals that the returned Class will never be exposed to application code) - * @return the type for the bean if determinable, or null else + * (also signals that the returned {@code Class} will never be exposed to application code) + * @return the type for the bean if determinable, or {@code null} else * @see #createBean */ protected Class getTypeForFactoryMethod(String beanName, RootBeanDefinition mbd, Class[] typesToMatch) { @@ -668,7 +668,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * This implementation attempts to query the FactoryBean's generic parameter metadata * if present to determine the object type. If not present, i.e. the FactoryBean is - * declared as a raw type, checks the FactoryBean's getObjectType method + * declared as a raw type, checks the FactoryBean's {@code getObjectType} method * on a plain instance of the FactoryBean, without bean properties applied yet. * If this doesn't return a type yet, a full creation of the FactoryBean is * used as fallback (through delegation to the superclass's implementation). @@ -755,11 +755,11 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Obtain a "shortcut" singleton FactoryBean instance to use for a - * getObjectType() call, without full initialization + * {@code getObjectType()} call, without full initialization * of the FactoryBean. * @param beanName the name of the bean * @param mbd the bean definition for the bean - * @return the FactoryBean instance, or null to indicate + * @return the FactoryBean instance, or {@code null} to indicate * that we couldn't obtain a shortcut FactoryBean instance */ private FactoryBean getSingletonFactoryBeanForTypeCheck(String beanName, RootBeanDefinition mbd) { @@ -796,11 +796,11 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Obtain a "shortcut" non-singleton FactoryBean instance to use for a - * getObjectType() call, without full initialization + * {@code getObjectType()} call, without full initialization * of the FactoryBean. * @param beanName the name of the bean * @param mbd the bean definition for the bean - * @return the FactoryBean instance, or null to indicate + * @return the FactoryBean instance, or {@code null} to indicate * that we couldn't obtain a shortcut FactoryBean instance */ private FactoryBean getNonSingletonFactoryBeanForTypeCheck(String beanName, RootBeanDefinition mbd) { @@ -827,7 +827,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Apply MergedBeanDefinitionPostProcessors to the specified bean definition, - * invoking their postProcessMergedBeanDefinition methods. + * invoking their {@code postProcessMergedBeanDefinition} methods. * @param mbd the merged bean definition for the bean * @param beanType the actual type of the managed bean instance * @param beanName the name of the bean @@ -856,7 +856,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * before-instantiation shortcut for the specified bean. * @param beanName the name of the bean * @param mbd the bean definition for the bean - * @return the shortcut-determined bean instance, or null if none + * @return the shortcut-determined bean instance, or {@code null} if none */ protected Object resolveBeforeInstantiation(String beanName, RootBeanDefinition mbd) { Object bean = null; @@ -875,13 +875,13 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** * Apply InstantiationAwareBeanPostProcessors to the specified bean definition - * (by class and name), invoking their postProcessBeforeInstantiation methods. + * (by class and name), invoking their {@code postProcessBeforeInstantiation} methods. *

Any returned object will be used as the bean instead of actually instantiating - * the target bean. A null return value from the post-processor will + * the target bean. A {@code null} return value from the post-processor will * result in the target bean being instantiated. * @param beanClass the class of the bean to be instantiated * @param beanName the name of the bean - * @return the bean object to use instead of a default instance of the target bean, or null + * @return the bean object to use instead of a default instance of the target bean, or {@code null} * @throws BeansException if any post-processing failed * @see InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation */ @@ -962,7 +962,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * {@link SmartInstantiationAwareBeanPostProcessor SmartInstantiationAwareBeanPostProcessors}. * @param beanClass the raw class of the bean * @param beanName the name of the bean - * @return the candidate constructors, or null if none specified + * @return the candidate constructors, or {@code null} if none specified * @throws org.springframework.beans.BeansException in case of errors * @see org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor#determineCandidateConstructors */ @@ -1019,7 +1019,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * @param beanName the name of the bean * @param mbd the bean definition for the bean * @param explicitArgs argument values passed in programmatically via the getBean method, - * or null if none (-> use constructor argument values from bean definition) + * or {@code null} if none (-> use constructor argument values from bean definition) * @return BeanWrapper for the new instance * @see #getBean(String, Object[]) */ @@ -1040,7 +1040,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * @param mbd the bean definition for the bean * @param ctors the chosen candidate constructors * @param explicitArgs argument values passed in programmatically via the getBean method, - * or null if none (-> use constructor argument values from bean definition) + * or {@code null} if none (-> use constructor argument values from bean definition) * @return BeanWrapper for the new instance */ protected BeanWrapper autowireConstructor( @@ -1452,7 +1452,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * @param beanName the bean name in the factory (for debugging purposes) * @param bean the new bean instance we may need to initialize * @param mbd the bean definition that the bean was created with - * (can also be null, if given an existing bean instance) + * (can also be {@code null}, if given an existing bean instance) * @return the initialized bean instance (potentially wrapped) * @see BeanNameAware * @see BeanClassLoaderAware @@ -1516,7 +1516,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac * @param beanName the bean name in the factory (for debugging purposes) * @param bean the new bean instance we may need to initialize * @param mbd the merged bean definition that the bean was created with - * (can also be null, if given an existing bean instance) + * (can also be {@code null}, if given an existing bean instance) * @throws Throwable if thrown by init methods or by the invocation process * @see #invokeCustomInitMethod */ @@ -1619,7 +1619,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac /** - * Applies the postProcessAfterInitialization callback of all + * Applies the {@code postProcessAfterInitialization} callback of all * registered BeanPostProcessors, giving them a chance to post-process the * object obtained from FactoryBeans (for example, to auto-proxy them). * @see #applyBeanPostProcessorsAfterInitialization 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 652d45afb2..db41eb0002 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 @@ -277,13 +277,13 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess * definition (presumably the child). *

    *
  • Will override beanClass if specified in the given bean definition. - *
  • Will always take abstract, scope, - * lazyInit, autowireMode, dependencyCheck, - * and dependsOn from the given bean definition. - *
  • Will add constructorArgumentValues, propertyValues, - * methodOverrides from the given bean definition to existing ones. - *
  • Will override factoryBeanName, factoryMethodName, - * initMethodName, and destroyMethodName if specified + *
  • Will always take {@code abstract}, {@code scope}, + * {@code lazyInit}, {@code autowireMode}, {@code dependencyCheck}, + * and {@code dependsOn} from the given bean definition. + *
  • Will add {@code constructorArgumentValues}, {@code propertyValues}, + * {@code methodOverrides} from the given bean definition to existing ones. + *
  • Will override {@code factoryBeanName}, {@code factoryMethodName}, + * {@code initMethodName}, and {@code destroyMethodName} if specified * in the given bean definition. *
*/ @@ -369,7 +369,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** * Return the class of the wrapped bean, if already resolved. - * @return the bean class, or null if none defined + * @return the bean class, or {@code null} if none defined * @throws IllegalStateException if the bean definition does not define a bean class, * or a specified bean class name has not been resolved into an actual Class */ @@ -499,7 +499,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** * Set whether this bean should be lazily initialized. - *

If false, the bean will get instantiated on startup by bean + *

If {@code false}, the bean will get instantiated on startup by bean * factories that perform eager initialization of singletons. */ public void setLazyInit(boolean lazyInit) { @@ -696,7 +696,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Specify whether to resolve constructors in lenient mode (true, + * Specify whether to resolve constructors in lenient mode ({@code true}, * which is the default) or to switch to strict resolution (throwing an exception * in case of ambigious constructors that all match when converting the arguments, * whereas lenient mode would use the one with the 'closest' type matches). @@ -721,7 +721,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Return constructor argument values for this bean (never null). + * Return constructor argument values for this bean (never {@code null}). */ public ConstructorArgumentValues getConstructorArgumentValues() { return this.constructorArgumentValues; @@ -742,7 +742,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Return property values for this bean (never null). + * Return property values for this bean (never {@code null}). */ public MutablePropertyValues getPropertyValues() { return this.propertyValues; @@ -782,7 +782,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Set the name of the initializer method. The default is null + * Set the name of the initializer method. The default is {@code null} * in which case there is no initializer method. */ public void setInitMethodName(String initMethodName) { @@ -798,7 +798,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** * Specify whether or not the configured init method is the default. - * Default value is false. + * Default value is {@code false}. * @see #setInitMethodName */ public void setEnforceInitMethod(boolean enforceInitMethod) { @@ -814,7 +814,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Set the name of the destroy method. The default is null + * Set the name of the destroy method. The default is {@code null} * in which case there is no destroy method. */ public void setDestroyMethodName(String destroyMethodName) { @@ -830,7 +830,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** * Specify whether or not the configured destroy method is the default. - * Default value is false. + * Default value is {@code false}. * @see #setDestroyMethodName */ public void setEnforceDestroyMethod(boolean enforceDestroyMethod) { @@ -849,7 +849,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** * Set whether this bean definition is 'synthetic', that is, not defined * by the application itself (for example, an infrastructure bean such - * as a helper for auto-proxying, created through <aop:config>). + * as a helper for auto-proxying, created through {@code <aop:config>}). */ public void setSynthetic(boolean synthetic) { this.synthetic = synthetic; @@ -864,14 +864,14 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess } /** - * Set the role hint for this BeanDefinition. + * Set the role hint for this {@code BeanDefinition}. */ public void setRole(int role) { this.role = role; } /** - * Return the role hint for this BeanDefinition. + * Return the role hint for this {@code BeanDefinition}. */ public int getRole() { return this.role; @@ -981,9 +981,9 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess /** - * Public declaration of Object's clone() method. + * Public declaration of Object's {@code clone()} method. * Delegates to {@link #cloneBeanDefinition()}. - * @see java.lang.Object#clone() + * @see Object#clone() */ @Override public Object clone() { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinitionReader.java index d0f524ed7d..615839c213 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinitionReader.java @@ -112,7 +112,7 @@ public abstract class AbstractBeanDefinitionReader implements EnvironmentCapable * will be capable of resolving resource patterns to Resource arrays. *

Default is PathMatchingResourcePatternResolver, also capable of * resource pattern resolving through the ResourcePatternResolver interface. - *

Setting this to null suggests that absolute resource loading + *

Setting this to {@code null} suggests that absolute resource loading * is not available for this bean definition reader. * @see org.springframework.core.io.support.ResourcePatternResolver * @see org.springframework.core.io.support.PathMatchingResourcePatternResolver @@ -127,10 +127,10 @@ public abstract class AbstractBeanDefinitionReader implements EnvironmentCapable /** * Set the ClassLoader to use for bean classes. - *

Default is null, which suggests to not load bean classes + *

Default is {@code null}, which suggests to not load bean classes * eagerly but rather to just register bean definitions with class names, * with the corresponding Classes to be resolved later (or never). - * @see java.lang.Thread#getContextClassLoader() + * @see Thread#getContextClassLoader() */ public void setBeanClassLoader(ClassLoader beanClassLoader) { this.beanClassLoader = beanClassLoader; @@ -187,7 +187,7 @@ public abstract class AbstractBeanDefinitionReader implements EnvironmentCapable * @param location the resource location, to be loaded with the ResourceLoader * (or ResourcePatternResolver) of this bean definition reader * @param actualResources a Set to be filled with the actual Resource objects - * that have been resolved during the loading process. May be null + * that have been resolved during the loading process. May be {@code null} * to indicate that the caller is not interested in those Resource objects. * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors 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 b5699c2fb8..8db728ae57 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 @@ -178,7 +178,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp /** * Create a new AbstractBeanFactory with the given parent. - * @param parentBeanFactory parent bean factory, or null if none + * @param parentBeanFactory parent bean factory, or {@code null} if none * @see #getBean */ public AbstractBeanFactory(BeanFactory parentBeanFactory) { @@ -718,7 +718,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp /** * Return the custom TypeConverter to use, if any. - * @return the custom TypeConverter, or null if none specified + * @return the custom TypeConverter, or {@code null} if none specified */ protected TypeConverter getCustomTypeConverter() { return this.typeConverter; @@ -858,7 +858,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp /** * Return a 'merged' BeanDefinition for the given bean name, * merging a child bean definition with its parent if necessary. - *

This getMergedBeanDefinition considers bean definition + *

This {@code getMergedBeanDefinition} considers bean definition * in ancestors as well. * @param name the name of the bean to retrieve the merged definition for * (may be an alias) @@ -1116,7 +1116,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * @param beanName the name of the bean definition * @param bd the original bean definition (Root/ChildBeanDefinition) * @param containingBd the containing bean definition in case of inner bean, - * or null in case of a top-level bean + * or {@code null} in case of a top-level bean * @return a (potentially merged) RootBeanDefinition for the given bean * @throws BeanDefinitionStoreException in case of an invalid bean definition */ @@ -1234,8 +1234,8 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * @param mbd the merged bean definition to determine the class for * @param beanName the name of the bean (for error handling purposes) * @param typesToMatch the types to match in case of internal type matching purposes - * (also signals that the returned Class will never be exposed to application code) - * @return the resolved bean class (or null if none) + * (also signals that the returned {@code Class} will never be exposed to application code) + * @return the resolved bean class (or {@code null} if none) * @throws CannotLoadBeanClassException if we failed to load the class */ protected Class resolveBeanClass(final RootBeanDefinition mbd, String beanName, final Class... typesToMatch) @@ -1313,8 +1313,8 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * @param beanName the name of the bean * @param mbd the merged bean definition to determine the type for * @param typesToMatch the types to match in case of internal type matching purposes - * (also signals that the returned Class will never be exposed to application code) - * @return the type of the bean, or null if not predictable + * (also signals that the returned {@code Class} will never be exposed to application code) + * @return the type of the bean, or {@code null} if not predictable */ protected Class predictBeanType(String beanName, RootBeanDefinition mbd, Class... typesToMatch) { if (mbd.getFactoryMethodName() != null) { @@ -1337,15 +1337,15 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp /** * Determine the bean type for the given FactoryBean definition, as far as possible. * Only called if there is no singleton instance registered for the target bean already. - *

The default implementation creates the FactoryBean via getBean - * to call its getObjectType method. Subclasses are encouraged to optimize + *

The default implementation creates the FactoryBean via {@code getBean} + * to call its {@code getObjectType} method. Subclasses are encouraged to optimize * this, typically by just instantiating the FactoryBean but not populating it yet, - * trying whether its getObjectType method already returns a type. + * trying whether its {@code getObjectType} method already returns a type. * If no type found, a full FactoryBean creation as performed by this implementation * should be used as fallback. * @param beanName the name of the bean * @param mbd the merged bean definition for the bean - * @return the type for the bean if determinable, or null else + * @return the type for the bean if determinable, or {@code null} else * @see org.springframework.beans.factory.FactoryBean#getObjectType() * @see #getBean(String) */ @@ -1381,7 +1381,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * Determine whether the specified bean is eligible for having * its bean definition metadata cached. * @param beanName the name of the bean - * @return true if the bean's metadata may be cached + * @return {@code true} if the bean's metadata may be cached * at this point already */ protected boolean isBeanEligibleForMetadataCaching(String beanName) { @@ -1392,7 +1392,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * Remove the singleton instance (if any) for the given bean name, * but only if it hasn't been used for other purposes than type checking. * @param beanName the name of the bean - * @return true if actually removed, false otherwise + * @return {@code true} if actually removed, {@code false} otherwise */ protected boolean removeSingletonIfCreatedForTypeCheckOnly(String beanName) { if (!this.alreadyCreated.containsKey(beanName)) { @@ -1512,7 +1512,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp /** * Check if this bean factory contains a bean definition with the given name. * Does not consider any hierarchy this factory may participate in. - * Invoked by containsBean when no cached singleton instance is found. + * Invoked by {@code containsBean} when no cached singleton instance is found. *

Depending on the nature of the concrete bean factory implementation, * this operation might be expensive (for example, because of directory lookups * in external registries). However, for listable bean factories, this usually @@ -1537,7 +1537,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * public interface there. The same implementation can serve for both this * template method and the public interface method in that case. * @param beanName the name of the bean to find a definition for - * @return the BeanDefinition for this prototype name (never null) + * @return the BeanDefinition for this prototype name (never {@code null}) * @throws org.springframework.beans.factory.NoSuchBeanDefinitionException * if the bean definition cannot be resolved * @throws BeansException in case of errors @@ -1557,7 +1557,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp * @param beanName the name of the bean * @param mbd the merged bean definition for the bean * @param args arguments to use if creating a prototype using explicit arguments to a - * static factory method. This parameter must be null except in this case. + * static factory method. This parameter must be {@code null} except in this case. * @return a new instance of the bean * @throws BeanCreationException if the bean could not be created */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateQualifier.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateQualifier.java index 58c560c917..6723fed6c6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateQualifier.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AutowireCandidateQualifier.java @@ -59,7 +59,7 @@ public class AutowireCandidateQualifier extends BeanMetadataAttributeAccessor { /** * Construct a qualifier to match against an annotation of the - * given type whose value attribute also matches + * given type whose {@code value} attribute also matches * the specified value. * @param type the annotation type * @param value the annotation value to match @@ -70,7 +70,7 @@ public class AutowireCandidateQualifier extends BeanMetadataAttributeAccessor { /** * Construct a qualifier to match against an annotation of the - * given type name whose value attribute also matches + * given type name whose {@code value} attribute also matches * the specified value. *

The type name may match the fully-qualified class name of * the annotation or the short class name (without the package). 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 0f30540e67..3906928b5f 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 @@ -42,7 +42,7 @@ public interface AutowireCandidateResolver { * Determine whether a default value is suggested for the given dependency. * @param descriptor the descriptor for the target method parameter or field * @return the value suggested (typically an expression String), - * or null if none found + * or {@code null} if none found * @since 3.0 */ Object getSuggestedValue(DependencyDescriptor descriptor); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java index 3b338d5b27..2b354882df 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java @@ -33,7 +33,7 @@ import org.springframework.util.ObjectUtils; public class BeanDefinitionBuilder { /** - * Create a new BeanDefinitionBuilder used to construct a {@link GenericBeanDefinition}. + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link GenericBeanDefinition}. */ public static BeanDefinitionBuilder genericBeanDefinition() { BeanDefinitionBuilder builder = new BeanDefinitionBuilder(); @@ -42,8 +42,8 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link GenericBeanDefinition}. - * @param beanClass the Class of the bean that the definition is being created for + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link GenericBeanDefinition}. + * @param beanClass the {@code Class} of the bean that the definition is being created for */ public static BeanDefinitionBuilder genericBeanDefinition(Class beanClass) { BeanDefinitionBuilder builder = new BeanDefinitionBuilder(); @@ -53,7 +53,7 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link GenericBeanDefinition}. + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link GenericBeanDefinition}. * @param beanClassName the class name for the bean that the definition is being created for */ public static BeanDefinitionBuilder genericBeanDefinition(String beanClassName) { @@ -64,16 +64,16 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link RootBeanDefinition}. - * @param beanClass the Class of the bean that the definition is being created for + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link RootBeanDefinition}. + * @param beanClass the {@code Class} of the bean that the definition is being created for */ public static BeanDefinitionBuilder rootBeanDefinition(Class beanClass) { return rootBeanDefinition(beanClass, null); } /** - * Create a new BeanDefinitionBuilder used to construct a {@link RootBeanDefinition}. - * @param beanClass the Class of the bean that the definition is being created for + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link RootBeanDefinition}. + * @param beanClass the {@code Class} of the bean that the definition is being created for * @param factoryMethodName the name of the method to use to construct the bean instance */ public static BeanDefinitionBuilder rootBeanDefinition(Class beanClass, String factoryMethodName) { @@ -85,7 +85,7 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link RootBeanDefinition}. + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link RootBeanDefinition}. * @param beanClassName the class name for the bean that the definition is being created for */ public static BeanDefinitionBuilder rootBeanDefinition(String beanClassName) { @@ -93,7 +93,7 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link RootBeanDefinition}. + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link RootBeanDefinition}. * @param beanClassName the class name for the bean that the definition is being created for * @param factoryMethodName the name of the method to use to construct the bean instance */ @@ -106,7 +106,7 @@ public class BeanDefinitionBuilder { } /** - * Create a new BeanDefinitionBuilder used to construct a {@link ChildBeanDefinition}. + * Create a new {@code BeanDefinitionBuilder} used to construct a {@link ChildBeanDefinition}. * @param parentName the name of the parent bean */ public static BeanDefinitionBuilder childBeanDefinition(String parentName) { @@ -117,7 +117,7 @@ public class BeanDefinitionBuilder { /** - * The BeanDefinition instance we are creating. + * The {@code BeanDefinition} instance we are creating. */ private AbstractBeanDefinition beanDefinition; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionDefaults.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionDefaults.java index 00d5c0bbc0..542f1d5b62 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionDefaults.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionDefaults.java @@ -19,7 +19,7 @@ package org.springframework.beans.factory.support; import org.springframework.util.StringUtils; /** - * A simple holder for BeanDefinition property defaults. + * A simple holder for {@code BeanDefinition} property defaults. * * @author Mark Fisher * @since 2.5 diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReader.java index e9ff9c9abe..813e8d4b6f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReader.java @@ -46,27 +46,27 @@ public interface BeanDefinitionReader { BeanDefinitionRegistry getRegistry(); /** - * Return the resource loader to use for resource locations. - * Can be checked for the ResourcePatternResolver interface and cast - * accordingly, for loading multiple resources for a given resource pattern. - *

Null suggests that absolute resource loading is not available - * for this bean definition reader. - *

This is mainly meant to be used for importing further resources - * from within a bean definition resource, for example via the "import" - * tag in XML bean definitions. It is recommended, however, to apply - * such imports relative to the defining resource; only explicit full - * resource locations will trigger absolute resource loading. - *

There is also a loadBeanDefinitions(String) method available, - * for loading bean definitions from a resource location (or location pattern). - * This is a convenience to avoid explicit ResourceLoader handling. - * @see #loadBeanDefinitions(String) - * @see org.springframework.core.io.support.ResourcePatternResolver - */ + * Return the resource loader to use for resource locations. + * Can be checked for the ResourcePatternResolver interface and cast + * accordingly, for loading multiple resources for a given resource pattern. + *

Null suggests that absolute resource loading is not available + * for this bean definition reader. + *

This is mainly meant to be used for importing further resources + * from within a bean definition resource, for example via the "import" + * tag in XML bean definitions. It is recommended, however, to apply + * such imports relative to the defining resource; only explicit full + * resource locations will trigger absolute resource loading. + *

There is also a {@code loadBeanDefinitions(String)} method available, + * for loading bean definitions from a resource location (or location pattern). + * This is a convenience to avoid explicit ResourceLoader handling. + * @see #loadBeanDefinitions(String) + * @see org.springframework.core.io.support.ResourcePatternResolver + */ ResourceLoader getResourceLoader(); /** * Return the class loader to use for bean classes. - *

null suggests to not load bean classes eagerly + *

{@code null} suggests to not load bean classes eagerly * but rather to just register bean definitions with class names, * with the corresponding Classes to be resolved later (or never). */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReaderUtils.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReaderUtils.java index 1d80a290cf..4a13bc1b2d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReaderUtils.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionReaderUtils.java @@ -49,7 +49,7 @@ public class BeanDefinitionReaderUtils { * @param parentName the name of the parent bean, if any * @param className the name of the bean class, if any * @param classLoader the ClassLoader to use for loading bean classes - * (can be null to just register bean classes by name) + * (can be {@code null} to just register bean classes by name) * @return the bean definition * @throws ClassNotFoundException if the bean class could not be loaded */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionRegistry.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionRegistry.java index 23191913de..fd50469024 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionRegistry.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionRegistry.java @@ -71,7 +71,7 @@ public interface BeanDefinitionRegistry extends AliasRegistry { /** * Return the BeanDefinition for the given bean name. * @param beanName name of the bean to find a definition for - * @return the BeanDefinition for the given name (never null) + * @return the BeanDefinition for the given name (never {@code null}) * @throws NoSuchBeanDefinitionException if there is no such bean definition */ BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionValueResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionValueResolver.java index 83bc48f20b..4ee6d218fa 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionValueResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionValueResolver.java @@ -94,7 +94,7 @@ class BeanDefinitionValueResolver { * Collections that will need to be resolved. *

  • A ManagedMap. In this case the value may be a RuntimeBeanReference * or Collection that will need to be resolved. - *
  • An ordinary object or null, in which case it's left alone. + *
  • An ordinary object or {@code null}, in which case it's left alone. * @param argName the name of the argument that the value is defined for * @param value the value object to resolve * @return the resolved object @@ -232,7 +232,7 @@ class BeanDefinitionValueResolver { /** * Resolve the target type in the given TypedStringValue. * @param value the TypedStringValue to resolve - * @return the resolved target type (or null if none specified) + * @return the resolved target type (or {@code null} if none specified) * @throws ClassNotFoundException if the specified type cannot be resolved * @see TypedStringValue#resolveTargetType */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/CglibSubclassingInstantiationStrategy.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/CglibSubclassingInstantiationStrategy.java index ce25df0711..dc601c3bd4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/CglibSubclassingInstantiationStrategy.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/CglibSubclassingInstantiationStrategy.java @@ -98,10 +98,10 @@ public class CglibSubclassingInstantiationStrategy extends SimpleInstantiationSt /** * Create a new instance of a dynamically generated subclasses implementing the * required lookups. - * @param ctor constructor to use. If this is null, use the + * @param ctor constructor to use. If this is {@code null}, use the * no-arg constructor (no parameterization, or Setter Injection) * @param args arguments to use for the constructor. - * Ignored if the ctor parameter is null. + * Ignored if the ctor parameter is {@code null}. * @return new instance of the dynamically generated class */ public Object instantiate(Constructor ctor, Object[] args) { 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 a14e5b2b4d..da0103b654 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 @@ -97,9 +97,9 @@ class ConstructorResolver { * dependency resolution. * @param beanName the name of the bean * @param mbd the merged bean definition for the bean - * @param chosenCtors chosen candidate constructors (or null if none) + * @param chosenCtors chosen candidate constructors (or {@code null} if none) * @param explicitArgs argument values passed in programmatically via the getBean method, - * or null if none (-> use constructor argument values from bean definition) + * or {@code null} if none (-> use constructor argument values from bean definition) * @return a BeanWrapper for the new instance */ public BeanWrapper autowireConstructor( @@ -333,7 +333,7 @@ class ConstructorResolver { * @param beanName the name of the bean * @param mbd the merged bean definition for the bean * @param explicitArgs argument values passed in programmatically via the getBean - * method, or null if none (-> use constructor argument values from bean definition) + * method, or {@code null} if none (-> use constructor argument values from bean definition) * @return a BeanWrapper for the new instance */ public BeanWrapper instantiateUsingFactoryMethod(final String beanName, final RootBeanDefinition mbd, final Object[] explicitArgs) { 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 306ffa03f5..ced19e9326 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 @@ -228,7 +228,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto } /** - * Return the autowire candidate resolver for this BeanFactory (never null). + * Return the autowire candidate resolver for this BeanFactory (never {@code null}). */ public AutowireCandidateResolver getAutowireCandidateResolver() { return this.autowireCandidateResolver; @@ -454,7 +454,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto } /** - * Find a {@link Annotation} of annotationType on the specified + * Find a {@link Annotation} of {@code annotationType} on the specified * bean, traversing its interfaces and super classes if no annotation can be * found on the given class itself, as well as checking its raw bean class * if not found on the exposed bean reference (e.g. in case of a proxy). @@ -847,7 +847,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto * (may be an array component type or collection element type) * @param descriptor the descriptor of the dependency to resolve * @return a Map of candidate names and candidate instances that match - * the required type (never null) + * the required type (never {@code null}) * @throws BeansException in case of errors * @see #autowireByType * @see #autowireConstructor @@ -881,7 +881,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto * @param candidateBeans a Map of candidate names and candidate instances * that match the required type, as returned by {@link #findAutowireCandidates} * @param descriptor the target dependency to match against - * @return the name of the primary candidate, or null if none found + * @return the name of the primary candidate, or {@code null} if none found */ protected String determinePrimaryCandidate(Map candidateBeans, DependencyDescriptor descriptor) { String primaryBeanName = null; @@ -1056,7 +1056,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto /** - * Separate inner class for avoiding a hard dependency on the javax.inject API. + * Separate inner class for avoiding a hard dependency on the {@code javax.inject} API. */ private class DependencyProviderFactory { 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 64346bd9f2..cbf7c872ff 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 @@ -173,7 +173,7 @@ public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements * reference to a currently created singleton (resolving a circular reference). * @param beanName the name of the bean to look for * @param allowEarlyReference whether early references should be created or not - * @return the registered singleton object, or null if none found + * @return the registered singleton object, or {@code null} if none found */ protected Object getSingleton(String beanName, boolean allowEarlyReference) { Object singletonObject = this.singletonObjects.get(beanName); @@ -469,7 +469,7 @@ public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements } /** - * Destroy the given bean. Delegates to destroyBean + * Destroy the given bean. Delegates to {@code destroyBean} * if a corresponding disposable bean instance is found. * @param beanName the name of the bean * @see #destroyBean diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/DisposableBeanAdapter.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/DisposableBeanAdapter.java index d493bc80d0..990438597f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/DisposableBeanAdapter.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/DisposableBeanAdapter.java @@ -94,7 +94,7 @@ class DisposableBeanAdapter implements DisposableBean, Runnable, Serializable { /** * Create a new DisposableBeanAdapter for the given bean. - * @param bean the bean instance (never null) + * @param bean the bean instance (never {@code null}) * @param beanName the name of the bean * @param beanDefinition the merged bean definition * @param postProcessors the List of BeanPostProcessors 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 37faa4357d..71a22243f7 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 @@ -50,7 +50,7 @@ public abstract class FactoryBeanRegistrySupport extends DefaultSingletonBeanReg * Determine the type for the given FactoryBean. * @param factoryBean the FactoryBean instance to check * @return the FactoryBean's object type, - * or null if the type cannot be determined yet + * or {@code null} if the type cannot be determined yet */ protected Class getTypeForFactoryBean(final FactoryBean factoryBean) { try { @@ -78,7 +78,7 @@ public abstract class FactoryBeanRegistrySupport extends DefaultSingletonBeanReg * in cached form. Quick check for minimal synchronization. * @param beanName the name of the bean * @return the object obtained from the FactoryBean, - * or null if not available + * or {@code null} if not available */ protected Object getCachedObjectForFactoryBean(String beanName) { Object object = this.factoryBeanObjectCache.get(beanName); 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 84dc678991..9ebb74b632 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 @@ -24,10 +24,10 @@ import org.springframework.beans.factory.config.BeanDefinition; * constructor argument values and property values. Additionally, deriving from a * parent bean definition can be flexibly configured through the "parentName" property. * - *

    In general, use this GenericBeanDefinition class for the purpose of + *

    In general, use this {@code GenericBeanDefinition} class for the purpose of * registering user-visible bean definitions (which a post-processor might operate on, - * potentially even reconfiguring the parent name). Use RootBeanDefinition / - * ChildBeanDefinition where parent/child relationships happen to be pre-determined. + * potentially even reconfiguring the parent name). Use {@code RootBeanDefinition} / + * {@code ChildBeanDefinition} where parent/child relationships happen to be pre-determined. * * @author Juergen Hoeller * @since 2.5 diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/InstantiationStrategy.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/InstantiationStrategy.java index eed3665757..6be1f2399c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/InstantiationStrategy.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/InstantiationStrategy.java @@ -37,7 +37,7 @@ public interface InstantiationStrategy { * Return an instance of the bean with the given name in this factory. * @param beanDefinition the bean definition * @param beanName name of the bean when it's created in this context. - * The name can be null if we're autowiring a bean that + * The name can be {@code null} if we're autowiring a bean that * doesn't belong to the factory. * @param owner owning BeanFactory * @return a bean instance for this bean definition @@ -51,7 +51,7 @@ public interface InstantiationStrategy { * creating it via the given constructor. * @param beanDefinition the bean definition * @param beanName name of the bean when it's created in this context. - * The name can be null if we're autowiring a bean + * The name can be {@code null} if we're autowiring a bean * that doesn't belong to the factory. * @param owner owning BeanFactory * @param ctor the constructor to use @@ -67,11 +67,11 @@ public interface InstantiationStrategy { * creating it via the given factory method. * @param beanDefinition bean definition * @param beanName name of the bean when it's created in this context. - * The name can be null if we're autowiring a bean + * The name can be {@code null} if we're autowiring a bean * that doesn't belong to the factory. * @param owner owning BeanFactory * @param factoryBean the factory bean instance to call the factory method on, - * or null in case of a static factory method + * or {@code null} in case of a static factory method * @param factoryMethod the factory method to use * @param args the factory method arguments to apply * @return a bean instance for this bean definition diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedList.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedList.java index 682e2a9548..353538c991 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedList.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedList.java @@ -49,7 +49,7 @@ public class ManagedList extends ArrayList implements Mergeable, BeanMetad /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedMap.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedMap.java index ccf1e1641d..0a0bd10a15 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedMap.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedMap.java @@ -50,7 +50,7 @@ public class ManagedMap extends LinkedHashMap implements Mergeable, /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedProperties.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedProperties.java index 91a433bc6c..a90f86dce9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedProperties.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedProperties.java @@ -37,7 +37,7 @@ public class ManagedProperties extends Properties implements Mergeable, BeanMeta /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedSet.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedSet.java index 70f53f05a8..a60272d12e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedSet.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/ManagedSet.java @@ -48,7 +48,7 @@ public class ManagedSet extends LinkedHashSet implements Mergeable, BeanMe /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverride.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverride.java index af32ccb075..c29fbaaa7d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverride.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverride.java @@ -76,7 +76,7 @@ public abstract class MethodOverride implements BeanMetadataElement { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverrides.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverrides.java index 72dd7fd4ca..d336ef8855 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverrides.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodOverrides.java @@ -86,7 +86,7 @@ public class MethodOverrides { /** * Return the override for the given method, if any. * @param method method to check for overrides for - * @return the method override, or null if none + * @return the method override, or {@code null} if none */ public MethodOverride getOverride(Method method) { for (MethodOverride override : this.overrides) { 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 1dde9b3e2d..8927b9b073 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 @@ -88,42 +88,42 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader public static final String SEPARATOR = "."; /** - * Special key to distinguish owner.(class)=com.myapp.MyClass- + * Special key to distinguish {@code owner.(class)=com.myapp.MyClass}- */ public static final String CLASS_KEY = "(class)"; /** - * Special key to distinguish owner.(parent)=parentBeanName. + * Special key to distinguish {@code owner.(parent)=parentBeanName}. */ public static final String PARENT_KEY = "(parent)"; /** - * Special key to distinguish owner.(scope)=prototype. + * Special key to distinguish {@code owner.(scope)=prototype}. * Default is "true". */ public static final String SCOPE_KEY = "(scope)"; /** - * Special key to distinguish owner.(singleton)=false. + * Special key to distinguish {@code owner.(singleton)=false}. * Default is "true". */ public static final String SINGLETON_KEY = "(singleton)"; /** - * Special key to distinguish owner.(abstract)=true + * Special key to distinguish {@code owner.(abstract)=true} * Default is "false". */ public static final String ABSTRACT_KEY = "(abstract)"; /** - * Special key to distinguish owner.(lazy-init)=true + * Special key to distinguish {@code owner.(lazy-init)=true} * Default is "false". */ public static final String LAZY_INIT_KEY = "(lazy-init)"; /** * Property suffix for references to other beans in the current - * BeanFactory: e.g. owner.dog(ref)=fido. + * BeanFactory: e.g. {@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. */ @@ -212,7 +212,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader * 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.' - * (can be empty or null) + * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors */ @@ -236,7 +236,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader * @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.' - * (can be empty or null) + * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors */ @@ -282,7 +282,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader * standard Java internationalization support. * @param rb the ResourceBundle to load from * @param prefix a filter within the keys in the map: e.g. 'beans.' - * (can be empty or null) + * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors */ @@ -319,7 +319,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader * 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.' - * (can be empty or null) + * (can be empty or {@code null}) * @return the number of bean definitions found * @throws BeansException in case of loading or parsing errors */ @@ -334,7 +334,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader * 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.' - * (can be empty or null) + * (can be empty or {@code null}) * @param resourceDescription description of the resource that the * Map came from (for logging purposes) * @return the number of bean definitions found 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 aaa6597275..2e5e49ac94 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 @@ -268,7 +268,7 @@ public class RootBeanDefinition extends AbstractBeanDefinition { /** * Return the resolved factory method as a Java Method object, if available. - * @return the factory method, or null if not found or not resolved yet + * @return the factory method, or {@code null} if not found or not resolved yet */ public Method getResolvedFactoryMethod() { synchronized (this.constructorArgumentLock) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/SimpleSecurityContextProvider.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/SimpleSecurityContextProvider.java index dbc12b05fc..7287049bc3 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/SimpleSecurityContextProvider.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/SimpleSecurityContextProvider.java @@ -31,7 +31,7 @@ public class SimpleSecurityContextProvider implements SecurityContextProvider { /** - * Construct a new SimpleSecurityContextProvider instance. + * Construct a new {@code SimpleSecurityContextProvider} instance. *

    The security context will be retrieved on each call from the current * thread. */ @@ -40,10 +40,10 @@ public class SimpleSecurityContextProvider implements SecurityContextProvider { } /** - * Construct a new SimpleSecurityContextProvider instance. + * Construct a new {@code SimpleSecurityContextProvider} instance. *

    If the given control context is null, the security context will be * retrieved on each call from the current thread. - * @param acc access control context (can be null) + * @param acc access control context (can be {@code null}) * @see AccessController#getContext() */ public SimpleSecurityContextProvider(AccessControlContext acc) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/package-info.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/package-info.java index 2523fc71fd..89971b330a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/package-info.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/package-info.java @@ -1,8 +1,7 @@ - /** * - * Classes supporting the org.springframework.beans.factory package. - * Contains abstract base classes for BeanFactory implementations. + * Classes supporting the {@code org.springframework.beans.factory} package. + * Contains abstract base classes for {@code BeanFactory} implementations. * * */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanConfigurerSupport.java b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanConfigurerSupport.java index 6bc42d0137..0e129d6e38 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanConfigurerSupport.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanConfigurerSupport.java @@ -36,7 +36,7 @@ import org.springframework.util.ClassUtils; *

    Subclasses may also need a custom metadata resolution strategy, in the * {@link BeanWiringInfoResolver} interface. The default implementation looks * for a bean with the same name as the fully-qualified class name. (This is - * the default name of the bean in a Spring XML file if the 'id' + * the default name of the bean in a Spring XML file if the '{@code id}' * attribute is not used.) * @author Rob Harrop @@ -87,7 +87,7 @@ public class BeanConfigurerSupport implements BeanFactoryAware, InitializingBean * Create the default BeanWiringInfoResolver to be used if none was * specified explicitly. *

    The default implementation builds a {@link ClassNameBeanWiringInfoResolver}. - * @return the default BeanWiringInfoResolver (never null) + * @return the default BeanWiringInfoResolver (never {@code null}) */ protected BeanWiringInfoResolver createDefaultBeanWiringInfoResolver() { return new ClassNameBeanWiringInfoResolver(); @@ -115,7 +115,7 @@ public class BeanConfigurerSupport implements BeanFactoryAware, InitializingBean *

    Subclasses can override this to provide custom configuration logic. * Typically called by an aspect, for all bean instances matched by a * pointcut. - * @param beanInstance the bean instance to configure (must not be null) + * @param beanInstance the bean instance to configure (must not be {@code null}) */ public void configureBean(Object beanInstance) { if (this.beanFactory == null) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfo.java b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfo.java index 5ed7b79f11..4ec68342d5 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfo.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfo.java @@ -22,7 +22,7 @@ import org.springframework.util.Assert; /** * Holder for bean wiring metadata information about a particular class. Used in * conjunction with the {@link org.springframework.beans.factory.annotation.Configurable} - * annotation and the AspectJ AnnotationBeanConfigurerAspect. + * annotation and the AspectJ {@code AnnotationBeanConfigurerAspect}. * * @author Rod Johnson * @author Juergen Hoeller @@ -67,7 +67,7 @@ public class BeanWiringInfo { /** * Create a new BeanWiringInfo that points to the given bean name. * @param beanName the name of the bean definition to take the property values from - * @throws IllegalArgumentException if the supplied beanName is null, + * @throws IllegalArgumentException if the supplied beanName is {@code null}, * is empty, or consists wholly of whitespace */ public BeanWiringInfo(String beanName) { @@ -79,7 +79,7 @@ public class BeanWiringInfo { * @param beanName the name of the bean definition to take the property values from * @param isDefaultBeanName whether the given bean name is a suggested * default bean name, not necessarily matching an actual bean definition - * @throws IllegalArgumentException if the supplied beanName is null, + * @throws IllegalArgumentException if the supplied beanName is {@code null}, * is empty, or consists wholly of whitespace */ public BeanWiringInfo(String beanName, boolean isDefaultBeanName) { @@ -94,7 +94,7 @@ public class BeanWiringInfo { * {@link #AUTOWIRE_BY_TYPE} * @param dependencyCheck whether to perform a dependency check for object * references in the bean instance (after autowiring) - * @throws IllegalArgumentException if the supplied autowireMode + * @throws IllegalArgumentException if the supplied {@code autowireMode} * is not one of the allowed values * @see #AUTOWIRE_BY_NAME * @see #AUTOWIRE_BY_TYPE diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfoResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfoResolver.java index a8b0873da4..ab648bdbb9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfoResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/wiring/BeanWiringInfoResolver.java @@ -37,7 +37,7 @@ public interface BeanWiringInfoResolver { /** * Resolve the BeanWiringInfo for the given bean instance. * @param beanInstance the bean instance to resolve info for - * @return the BeanWiringInfo, or null if not found + * @return the BeanWiringInfo, or {@code null} if not found */ BeanWiringInfo resolveWiringInfo(Object beanInstance); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java index 5a7315f81c..9782f086be 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java @@ -36,7 +36,7 @@ import org.springframework.util.StringUtils; *

    Use this {@link BeanDefinitionParser} implementation when you want * to parse some arbitrarily complex XML into one or more * {@link BeanDefinition BeanDefinitions}. If you just want to parse some - * XML into a single BeanDefinition, you may wish to consider + * XML into a single {@code BeanDefinition}, you may wish to consider * the simpler convenience extensions of this class, namely * {@link AbstractSingleBeanDefinitionParser} and * {@link AbstractSimpleBeanDefinitionParser}. @@ -121,8 +121,8 @@ public abstract class AbstractBeanDefinitionParser implements BeanDefinitionPars * {@link BeanDefinitionHolder bean} is actually even registered, or to * register even more beans. *

    The default implementation registers the supplied {@link BeanDefinitionHolder bean} - * with the supplied {@link BeanDefinitionRegistry registry} only if the isNested - * parameter is false, because one typically does not want inner beans + * with the supplied {@link BeanDefinitionRegistry registry} only if the {@code isNested} + * parameter is {@code false}, because one typically does not want inner beans * to be registered as top level beans. * @param definition the bean definition to be registered * @param registry the registry that the bean is to be registered with @@ -172,11 +172,11 @@ public abstract class AbstractBeanDefinitionParser implements BeanDefinitionPars * Controls whether this parser is supposed to fire a * {@link org.springframework.beans.factory.parsing.BeanComponentDefinition} * event after parsing the bean definition. - *

    This implementation returns true by default; that is, + *

    This implementation returns {@code true} by default; that is, * an event will be fired when a bean definition has been completely parsed. - * Override this to return false in order to suppress the event. - * @return true in order to fire a component registration event - * after parsing the bean definition; false to suppress the event + * Override this to return {@code false} in order to suppress the event. + * @return {@code true} in order to fire a component registration event + * after parsing the bean definition; {@code false} to suppress the event * @see #postProcessComponentDefinition * @see org.springframework.beans.factory.parsing.ReaderContext#fireComponentRegistered */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSimpleBeanDefinitionParser.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSimpleBeanDefinitionParser.java index b933e488cf..99bd416cb9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSimpleBeanDefinitionParser.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSimpleBeanDefinitionParser.java @@ -32,7 +32,7 @@ import org.springframework.util.StringUtils; * *

    Extend this parser class when you want to create a single * bean definition from a relatively simple custom XML element. The - * resulting BeanDefinition will be automatically + * resulting {@code BeanDefinition} will be automatically * registered with the relevant * {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}. * @@ -55,7 +55,7 @@ import org.springframework.util.StringUtils; * *

    All that is required of the Java developer tasked with writing * the parser to parse the above XML tag into an actual - * SimpleCache bean definition is the following: + * {@code SimpleCache} bean definition is the following: * *

    public class SimpleCacheBeanDefinitionParser extends AbstractSimpleBeanDefinitionParser {
      *
    @@ -64,7 +64,7 @@ import org.springframework.util.StringUtils;
      *     }
      * }
    * - *

    Please note that the AbstractSimpleBeanDefinitionParser + *

    Please note that the {@code AbstractSimpleBeanDefinitionParser} * is limited to populating the created bean definition with property values. * if you want to parse constructor arguments and nested elements from the * supplied XML element, then you will have to implement the @@ -74,7 +74,7 @@ import org.springframework.util.StringUtils; * classes directly. * *

    The process of actually registering the - * SimpleCacheBeanDefinitionParser with the Spring XML parsing + * {@code SimpleCacheBeanDefinitionParser} with the Spring XML parsing * infrastructure is described in the Spring Framework reference documentation * (in one of the appendices). * @@ -83,21 +83,21 @@ import org.springframework.util.StringUtils; * {@link org.springframework.beans.factory.xml.UtilNamespaceHandler.PropertiesBeanDefinitionParser}; * the observant (and even not so observant) reader will immediately notice that * there is next to no code in the implementation. The - * PropertiesBeanDefinitionParser populates a + * {@code PropertiesBeanDefinitionParser} populates a * {@link org.springframework.beans.factory.config.PropertiesFactoryBean} * from an XML element that looks like this: * *

    <util:properties location="jdbc.properties"/>
    * *

    The observant reader will notice that the sole attribute on the - * <util:properties/> element matches the + * {@code <util:properties/>} element matches the * {@link org.springframework.beans.factory.config.PropertiesFactoryBean#setLocation(org.springframework.core.io.Resource)} - * method name on the PropertiesFactoryBean (the general + * method name on the {@code PropertiesFactoryBean} (the general * usage thus illustrated holds true for any number of attributes). - * All that the PropertiesBeanDefinitionParser needs + * All that the {@code PropertiesBeanDefinitionParser} needs * actually do is supply an implementation of the * {@link #getBeanClass(org.w3c.dom.Element)} method to return the - * PropertiesFactoryBean type. + * {@code PropertiesFactoryBean} type. * * @author Rob Harrop * @author Rick Evans @@ -120,7 +120,7 @@ public abstract class AbstractSimpleBeanDefinitionParser extends AbstractSingleB * reconcile the name of an attribute with the name of a JavaBean * property. * @param element the XML element being parsed - * @param builder used to define the BeanDefinition + * @param builder used to define the {@code BeanDefinition} * @see #extractPropertyName(String) */ @Override @@ -144,7 +144,7 @@ public abstract class AbstractSimpleBeanDefinitionParser extends AbstractSingleB *

    The default implementation considers any attribute as eligible, * except for the "id" attribute and namespace declaration attributes. * @param attribute the XML attribute to check - * @param parserContext the ParserContext + * @param parserContext the {@code ParserContext} * @see #isEligibleAttribute(String) */ protected boolean isEligibleAttribute(Attr attribute, ParserContext parserContext) { @@ -177,7 +177,7 @@ public abstract class AbstractSimpleBeanDefinitionParser extends AbstractSingleB *

    The default implementation considers any attribute as eligible, * except for the "id" attribute. * @param attributeName the attribute name taken straight from the - * XML element being parsed (never null) + * XML element being parsed (never {@code null}) */ protected boolean isEligibleAttribute(String attributeName) { return !ID_ATTRIBUTE.equals(attributeName); @@ -190,11 +190,11 @@ public abstract class AbstractSimpleBeanDefinitionParser extends AbstractSingleB * method to perform the extraction. *

    The name returned must obey the standard JavaBean property name * conventions. For example for a class with a setter method - * 'setBingoHallFavourite(String)', the name returned had - * better be 'bingoHallFavourite' (with that exact casing). + * '{@code setBingoHallFavourite(String)}', the name returned had + * better be '{@code bingoHallFavourite}' (with that exact casing). * @param attributeName the attribute name taken straight from the - * XML element being parsed (never null) - * @return the extracted JavaBean property name (must never be null) + * XML element being parsed (never {@code null}) + * @return the extracted JavaBean property name (must never be {@code null}) */ protected String extractPropertyName(String attributeName) { return Conventions.attributeNameToPropertyName(attributeName); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSingleBeanDefinitionParser.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSingleBeanDefinitionParser.java index 1c32c4f22d..f86dc30f70 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSingleBeanDefinitionParser.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractSingleBeanDefinitionParser.java @@ -23,17 +23,17 @@ import org.springframework.beans.factory.support.BeanDefinitionBuilder; /** * Base class for those {@link BeanDefinitionParser} implementations that - * need to parse and define just a single BeanDefinition. + * need to parse and define just a single {@code BeanDefinition}. * *

    Extend this parser class when you want to create a single bean definition * from an arbitrarily complex XML element. You may wish to consider extending * the {@link AbstractSimpleBeanDefinitionParser} when you want to create a * single bean definition from a relatively simple custom XML element. * - *

    The resulting BeanDefinition will be automatically registered + *

    The resulting {@code BeanDefinition} will be automatically registered * with the {@link org.springframework.beans.factory.support.BeanDefinitionRegistry}. * Your job simply is to {@link #doParse parse} the custom XML {@link Element} - * into a single BeanDefinition. + * into a single {@code BeanDefinition}. * * @author Rob Harrop * @author Juergen Hoeller @@ -53,7 +53,7 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef * @param parserContext the object encapsulating the current state of the parsing process * @return the BeanDefinition resulting from the parsing of the supplied {@link Element} * @throws IllegalStateException if the bean {@link Class} returned from - * {@link #getBeanClass(org.w3c.dom.Element)} is null + * {@link #getBeanClass(org.w3c.dom.Element)} is {@code null} * @see #doParse */ @Override @@ -89,11 +89,11 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef /** * Determine the name for the parent of the currently parsed bean, * in case of the current bean being defined as a child bean. - *

    The default implementation returns null, + *

    The default implementation returns {@code null}, * indicating a root bean definition. - * @param element the Element that is being parsed + * @param element the {@code Element} that is being parsed * @return the name of the parent bean for the currently parsed bean, - * or null if none + * or {@code null} if none */ protected String getParentName(Element element) { return null; @@ -106,9 +106,9 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef * dependence on the bean implementation class. The BeanDefinitionParser * and its NamespaceHandler can be used within an IDE plugin then, even * if the application classes are not available on the plugin's classpath. - * @param element the Element that is being parsed + * @param element the {@code Element} that is being parsed * @return the {@link Class} of the bean that is being defined via parsing - * the supplied Element, or null if none + * the supplied {@code Element}, or {@code null} if none * @see #getBeanClassName */ protected Class getBeanClass(Element element) { @@ -117,9 +117,9 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef /** * Determine the bean class name corresponding to the supplied {@link Element}. - * @param element the Element that is being parsed + * @param element the {@code Element} that is being parsed * @return the class name of the bean that is being defined via parsing - * the supplied Element, or null if none + * the supplied {@code Element}, or {@code null} if none * @see #getBeanClass */ protected String getBeanClassName(Element element) { @@ -129,11 +129,11 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef /** * Parse the supplied {@link Element} and populate the supplied * {@link BeanDefinitionBuilder} as required. - *

    The default implementation delegates to the doParse + *

    The default implementation delegates to the {@code doParse} * version without ParserContext argument. * @param element the XML element being parsed * @param parserContext the object encapsulating the current state of the parsing process - * @param builder used to define the BeanDefinition + * @param builder used to define the {@code BeanDefinition} * @see #doParse(Element, BeanDefinitionBuilder) */ protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) { @@ -145,7 +145,7 @@ public abstract class AbstractSingleBeanDefinitionParser extends AbstractBeanDef * {@link BeanDefinitionBuilder} as required. *

    The default implementation does nothing. * @param element the XML element being parsed - * @param builder used to define the BeanDefinition + * @param builder used to define the {@code BeanDefinition} */ protected void doParse(Element element, BeanDefinitionBuilder builder) { } diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDecorator.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDecorator.java index b1a1d2c9e6..b1713f24e8 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDecorator.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDecorator.java @@ -21,16 +21,16 @@ import org.w3c.dom.Node; import org.springframework.beans.factory.config.BeanDefinitionHolder; /** - * Interface used by the {@link org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader} - * to handle custom, nested (directly under a <bean>) tags. + * Interface used by the {@link DefaultBeanDefinitionDocumentReader} + * to handle custom, nested (directly under a {@code <bean>}) tags. * *

    Decoration may also occur based on custom attributes applied to the - * <bean> tag. Implementations are free to turn the metadata in the + * {@code <bean>} tag. Implementations are free to turn the metadata in the * custom tag into as many * {@link org.springframework.beans.factory.config.BeanDefinition BeanDefinitions} as * required and to transform the * {@link org.springframework.beans.factory.config.BeanDefinition} of the enclosing - * <bean> tag, potentially even returning a completely different + * {@code <bean>} tag, potentially even returning a completely different * {@link org.springframework.beans.factory.config.BeanDefinition} to replace the * original. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java index ec161a0684..ecf5980def 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionDocumentReader.java @@ -27,7 +27,7 @@ import org.w3c.dom.Document; * *

    Instantiated per document to parse: Implementations can hold * state in instance variables during the execution of the - * registerBeanDefinitions method, for example global + * {@code registerBeanDefinitions} method, for example global * settings that are defined for all bean definitions in the document. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java index 1109ed3b8c..7041e4753b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java @@ -406,7 +406,7 @@ public class BeanDefinitionParserDelegate { } /** - * Return the defaults definition object, or null if the + * Return the defaults definition object, or {@code null} if the * defaults have been initialized yet. */ public DocumentDefaultsDefinition getDefaults() { @@ -415,7 +415,7 @@ public class BeanDefinitionParserDelegate { /** * Return the default settings for bean definitions as indicated within - * the attributes of the top-level <beans/> element. + * the attributes of the top-level {@code <beans/>} element. */ public BeanDefinitionDefaults getBeanDefinitionDefaults() { BeanDefinitionDefaults bdd = new BeanDefinitionDefaults(); @@ -429,7 +429,7 @@ public class BeanDefinitionParserDelegate { /** * Return any patterns provided in the 'default-autowire-candidates' - * attribute of the top-level <beans/> element. + * attribute of the top-level {@code <beans/>} element. */ public String[] getAutowireCandidatePatterns() { String candidatePattern = this.defaults.getAutowireCandidates(); @@ -438,7 +438,7 @@ public class BeanDefinitionParserDelegate { /** - * Parses the supplied <bean> element. May return null + * Parses the supplied {@code <bean>} element. May return {@code null} * if there were errors during parse. Errors are reported to the * {@link org.springframework.beans.factory.parsing.ProblemReporter}. */ @@ -447,7 +447,7 @@ public class BeanDefinitionParserDelegate { } /** - * Parses the supplied <bean> element. May return null + * Parses the supplied {@code <bean>} element. May return {@code null} * if there were errors during parse. Errors are reported to the * {@link org.springframework.beans.factory.parsing.ProblemReporter}. */ @@ -534,7 +534,7 @@ public class BeanDefinitionParserDelegate { /** * Parse the bean definition itself, without regard to name or aliases. May return - * null if problems occurred during the parsing of the bean definition. + * {@code null} if problems occurred during the parsing of the bean definition. */ public AbstractBeanDefinition parseBeanDefinitionElement( Element ele, String beanName, BeanDefinition containingBean) { @@ -1035,7 +1035,7 @@ public class BeanDefinitionParserDelegate { * constructor-arg element. * @param ele subelement of property element; we don't know which yet * @param defaultValueType the default type (class name) for any - * <value> tag that might be created + * {@code <value>} tag that might be created */ public Object parsePropertySubElement(Element ele, BeanDefinition bd, String defaultValueType) { if (!isDefaultNamespace(ele)) { @@ -1513,7 +1513,7 @@ public class BeanDefinitionParserDelegate { /** * Ges the local name for the supplied {@link Node}. The default implementation calls {@link Node#getLocalName}. * Subclasses may override the default implementation to provide a different mechanism for getting the local name. - * @param node the Node + * @param node the {@code Node} */ public String getLocalName(Node node) { return node.getLocalName(); 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 913c7db1a6..c6d9f5140a 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 @@ -46,7 +46,7 @@ import org.springframework.util.StringUtils; * *

    The structure, elements and attribute names of the required XML document * are hard-coded in this class. (Of course a transform could be run if necessary - * to produce this format). <beans> doesn't need to be the root + * to produce this format). {@code <beans>} doesn't need to be the root * element of the XML document: This class will parse all bean definition elements * in the XML file, not regarding the actual root element. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java index 56fe15eb80..6699253594 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java @@ -37,7 +37,7 @@ import org.springframework.util.CollectionUtils; * contained in mapping file. * *

    By default, this implementation looks for the mapping file at - * META-INF/spring.handlers, but this can be changed using the + * {@code META-INF/spring.handlers}, but this can be changed using the * {@link #DefaultNamespaceHandlerResolver(ClassLoader, String)} constructor. * * @author Rob Harrop @@ -68,7 +68,7 @@ public class DefaultNamespaceHandlerResolver implements NamespaceHandlerResolver /** - * Create a new DefaultNamespaceHandlerResolver using the + * Create a new {@code DefaultNamespaceHandlerResolver} using the * default mapping file location. *

    This constructor will result in the thread context ClassLoader being used * to load resources. @@ -79,10 +79,10 @@ public class DefaultNamespaceHandlerResolver implements NamespaceHandlerResolver } /** - * Create a new DefaultNamespaceHandlerResolver using the + * Create a new {@code DefaultNamespaceHandlerResolver} using the * default mapping file location. * @param classLoader the {@link ClassLoader} instance used to load mapping resources - * (may be null, in which case the thread context ClassLoader will be used) + * (may be {@code null}, in which case the thread context ClassLoader will be used) * @see #DEFAULT_HANDLER_MAPPINGS_LOCATION */ public DefaultNamespaceHandlerResolver(ClassLoader classLoader) { @@ -90,10 +90,10 @@ public class DefaultNamespaceHandlerResolver implements NamespaceHandlerResolver } /** - * Create a new DefaultNamespaceHandlerResolver using the + * Create a new {@code DefaultNamespaceHandlerResolver} using the * supplied mapping file location. * @param classLoader the {@link ClassLoader} instance used to load mapping resources - * may be null, in which case the thread context ClassLoader will be used) + * may be {@code null}, in which case the thread context ClassLoader will be used) * @param handlerMappingsLocation the mapping file location */ public DefaultNamespaceHandlerResolver(ClassLoader classLoader, String handlerMappingsLocation) { @@ -107,7 +107,7 @@ public class DefaultNamespaceHandlerResolver implements NamespaceHandlerResolver * Locate the {@link NamespaceHandler} for the supplied namespace URI * from the configured mappings. * @param namespaceUri the relevant namespace URI - * @return the located {@link NamespaceHandler}, or null if none found + * @return the located {@link NamespaceHandler}, or {@code null} if none found */ public NamespaceHandler resolve(String namespaceUri) { Map handlerMappings = getHandlerMappings(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java index cd33ef1476..4450b30bd7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java @@ -55,7 +55,7 @@ public class DelegatingEntityResolver implements EntityResolver { *

    Configures the {@link PluggableSchemaResolver} with the supplied * {@link ClassLoader}. * @param classLoader the ClassLoader to use for loading - * (can be null) to use the default ClassLoader) + * (can be {@code null}) to use the default ClassLoader) */ public DelegatingEntityResolver(ClassLoader classLoader) { this.dtdResolver = new BeansDtdResolver(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentDefaultsDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentDefaultsDefinition.java index 163e4ce9e9..b927112b63 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentDefaultsDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentDefaultsDefinition.java @@ -19,9 +19,9 @@ package org.springframework.beans.factory.xml; import org.springframework.beans.factory.parsing.DefaultsDefinition; /** - * Simple JavaBean that holds the defaults specified at the <beans> + * Simple JavaBean that holds the defaults specified at the {@code <beans>} * level in a standard Spring XML bean definition document: - * default-lazy-init, default-autowire, etc. + * {@code default-lazy-init}, {@code default-autowire}, etc. * * @author Juergen Hoeller * @since 2.0.2 @@ -146,7 +146,7 @@ public class DocumentDefaultsDefinition implements DefaultsDefinition { } /** - * Set the configuration source Object for this metadata element. + * Set the configuration source {@code Object} for this metadata element. *

    The exact type of the object will depend on the configuration mechanism used. */ public void setSource(Object source) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentLoader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentLoader.java index 676eacd289..348f4f6dc4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentLoader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DocumentLoader.java @@ -38,7 +38,7 @@ public interface DocumentLoader { * @param validationMode the type of validation * {@link org.springframework.util.xml.XmlValidationModeDetector#VALIDATION_DTD DTD} * or {@link org.springframework.util.xml.XmlValidationModeDetector#VALIDATION_XSD XSD}) - * @param namespaceAware true if support for XML namespaces is to be provided + * @param namespaceAware {@code true} if support for XML namespaces is to be provided * @return the loaded {@link Document document} * @throws Exception if an error occurs */ diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandler.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandler.java index a3bf241ae7..823e3015ce 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandler.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandler.java @@ -32,8 +32,8 @@ import org.springframework.beans.factory.config.BeanDefinitionHolder; * custom nested tags. * *

    The parser will call {@link #parse} when it encounters a custom tag - * directly under the <beans> tags and {@link #decorate} when - * it encounters a custom tag directly under a <bean> tag. + * directly under the {@code <beans>} tags and {@link #decorate} when + * it encounters a custom tag directly under a {@code <bean>} tag. * *

    Developers writing their own custom element extensions typically will * not implement this interface drectly, but rather make use of the provided @@ -59,14 +59,14 @@ public interface NamespaceHandler { * {@link BeanDefinition BeanDefinitions} with the * {@link org.springframework.beans.factory.support.BeanDefinitionRegistry} * that is embedded in the supplied {@link ParserContext}. - *

    Implementations should return the primary BeanDefinition + *

    Implementations should return the primary {@code BeanDefinition} * that results from the parse phase if they wish to be used nested - * inside (for example) a <property> tag. - *

    Implementations may return null if they will + * inside (for example) a {@code <property>} tag. + *

    Implementations may return {@code null} if they will * not be used in a nested scenario. - * @param element the element that is to be parsed into one or more BeanDefinitions + * @param element the element that is to be parsed into one or more {@code BeanDefinitions} * @param parserContext the object encapsulating the current state of the parsing process - * @return the primary BeanDefinition (can be null as explained above) + * @return the primary {@code BeanDefinition} (can be {@code null} as explained above) */ BeanDefinition parse(Element element, ParserContext parserContext); @@ -86,7 +86,7 @@ public interface NamespaceHandler { * @param parserContext the object encapsulating the current state of the parsing process * @return the decorated definition (to be registered in the BeanFactory), * or simply the original bean definition if no decoration is required. - * A null value is strictly speaking invalid, but will be leniently + * A {@code null} value is strictly speaking invalid, but will be leniently * treated like the case where the original bean definition gets returned. */ BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, ParserContext parserContext); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandlerResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandlerResolver.java index ba9d173b1d..12e95b0b42 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandlerResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/NamespaceHandlerResolver.java @@ -31,7 +31,7 @@ public interface NamespaceHandlerResolver { * Resolve the namespace URI and return the located {@link NamespaceHandler} * implementation. * @param namespaceUri the relevant namespace URI - * @return the located {@link NamespaceHandler} (may be null) + * @return the located {@link NamespaceHandler} (may be {@code null}) */ NamespaceHandler resolve(String namespaceUri); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java index d4f1f1bbf6..8c0d2e77a0 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java @@ -38,12 +38,12 @@ import org.springframework.util.CollectionUtils; * local {@link ClassPathResource classpath resources} using a set of mappings files. * *

    By default, this class will look for mapping files in the classpath using the pattern: - * META-INF/spring.schemas allowing for multiple files to exist on the + * {@code META-INF/spring.schemas} allowing for multiple files to exist on the * classpath at any one time. * - * The format of META-INF/spring.schemas is a properties - * file where each line should be of the form systemId=schema-location - * where schema-location should also be a schema file in the classpath. + * The format of {@code META-INF/spring.schemas} is a properties + * file where each line should be of the form {@code systemId=schema-location} + * where {@code schema-location} should also be a schema file in the classpath. * Since systemId is commonly a URL, one must be careful to escape any ':' characters * which are treated as delimiters in properties files. * @@ -77,7 +77,7 @@ public class PluggableSchemaResolver implements EntityResolver { * Loads the schema URL -> schema file location mappings using the default * mapping file pattern "META-INF/spring.schemas". * @param classLoader the ClassLoader to use for loading - * (can be null) to use the default ClassLoader) + * (can be {@code null}) to use the default ClassLoader) * @see PropertiesLoaderUtils#loadAllProperties(String, ClassLoader) */ public PluggableSchemaResolver(ClassLoader classLoader) { @@ -89,7 +89,7 @@ public class PluggableSchemaResolver implements EntityResolver { * Loads the schema URL -> schema file location mappings using the given * mapping file pattern. * @param classLoader the ClassLoader to use for loading - * (can be null) to use the default ClassLoader) + * (can be {@code null}) to use the default ClassLoader) * @param schemaMappingsLocation the location of the file that defines schema mappings * (must not be empty) * @see PropertiesLoaderUtils#loadAllProperties(String, ClassLoader) diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java index 69d2fc4164..ab933ffc9b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java @@ -29,21 +29,21 @@ import org.w3c.dom.Element; import org.w3c.dom.Node; /** - * Simple NamespaceHandler implementation that maps custom + * Simple {@code NamespaceHandler} implementation that maps custom * attributes directly through to bean properties. An important point to note is - * that this NamespaceHandler does not have a corresponding schema + * that this {@code NamespaceHandler} does not have a corresponding schema * since there is no way to know in advance all possible attribute names. * *

    - * An example of the usage of this NamespaceHandler is shown below: + * An example of the usage of this {@code NamespaceHandler} is shown below: * *

      * <bean id="author" class="..TestBean" c:name="Enescu" c:work-ref="compositions"/>
      * 
    * - * Here the 'c:name' corresponds directly to the 'name - * ' argument declared on the constructor of class 'TestBean'. The - * 'c:work-ref' attributes corresponds to the 'work' + * Here the '{@code c:name}' corresponds directly to the '{@code name} + * ' argument declared on the constructor of class '{@code TestBean}'. The + * '{@code c:work-ref}' attributes corresponds to the '{@code work}' * argument and, rather than being the concrete value, it contains the name of * the bean that will be considered as a parameter. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimplePropertyNamespaceHandler.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimplePropertyNamespaceHandler.java index ee8101b46e..259c592ef7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimplePropertyNamespaceHandler.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimplePropertyNamespaceHandler.java @@ -27,19 +27,19 @@ import org.springframework.beans.factory.config.RuntimeBeanReference; import org.springframework.core.Conventions; /** - * Simple NamespaceHandler implementation that maps custom attributes + * Simple {@code NamespaceHandler} implementation that maps custom attributes * directly through to bean properties. An important point to note is that this - * NamespaceHandler does not have a corresponding schema since there + * {@code NamespaceHandler} does not have a corresponding schema since there * is no way to know in advance all possible attribute names. * - *

    An example of the usage of this NamespaceHandler is shown below: + *

    An example of the usage of this {@code NamespaceHandler} is shown below: * *

      * <bean id="rob" class="..TestBean" p:name="Rob Harrop" p:spouse-ref="sally"/>
    * - * Here the 'p:name' corresponds directly to the 'name' - * property on class 'TestBean'. The 'p:spouse-ref' - * attributes corresponds to the 'spouse' property and, rather + * Here the '{@code p:name}' corresponds directly to the '{@code name}' + * property on class '{@code TestBean}'. The '{@code p:spouse-ref}' + * attributes corresponds to the '{@code spouse}' property and, rather * than being the concrete value, it contains the name of the bean that will * be injected into that property. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/UtilNamespaceHandler.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/UtilNamespaceHandler.java index 128da8a46f..064ffd30cb 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/UtilNamespaceHandler.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/UtilNamespaceHandler.java @@ -34,7 +34,7 @@ import org.springframework.beans.factory.support.BeanDefinitionBuilder; import org.springframework.util.StringUtils; /** - * {@link NamespaceHandler} for the util namespace. + * {@link NamespaceHandler} for the {@code util} namespace. * * @author Rob Harrop * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java index d858fe4def..c819bbb7a6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java @@ -136,7 +136,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { } /** - * Set whether to use XML validation. Default is true. + * Set whether to use XML validation. Default is {@code true}. *

    This method switches namespace awareness on if validation is turned off, * in order to still process schema namespaces properly in such a scenario. * @see #setValidationMode @@ -212,7 +212,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { /** * Specify the {@link SourceExtractor} to use. - *

    The default implementation is {@link NullSourceExtractor} which simply returns null + *

    The default implementation is {@link NullSourceExtractor} which simply returns {@code null} * as the source object. This means that - during normal runtime execution - * no additional source metadata is attached to the bean configuration metadata. */ @@ -266,7 +266,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { } /** - * Set an implementation of the org.xml.sax.ErrorHandler + * Set an implementation of the {@code org.xml.sax.ErrorHandler} * interface for custom handling of XML parsing errors and warnings. *

    If not set, a default SimpleSaxErrorHandler is used that simply * logs warnings using the logger instance of the view class, @@ -363,7 +363,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { * Load bean definitions from the specified XML file. * @param inputSource the SAX InputSource to read from * @param resourceDescription a description of the resource - * (can be null or empty) + * (can be {@code null} or empty) * @return the number of bean definitions found * @throws BeanDefinitionStoreException in case of loading or parsing errors */ @@ -439,7 +439,7 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { /** * Detects which kind of validation to perform on the XML file identified - * by the supplied {@link Resource}. If the file has a DOCTYPE + * by the supplied {@link Resource}. If the file has a {@code DOCTYPE} * definition then DTD validation is used otherwise XSD validation is assumed. *

    Override this method if you would like to customize resolution * of the {@link #VALIDATION_AUTO} mode. @@ -475,9 +475,9 @@ public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader { /** * Register the bean definitions contained in the given DOM document. - * Called by loadBeanDefinitions. + * Called by {@code loadBeanDefinitions}. *

    Creates a new instance of the parser class and invokes - * registerBeanDefinitions on it. + * {@code registerBeanDefinitions} on it. * @param doc the DOM document * @param resource the resource descriptor (for context information) * @return the number of bean definitions found diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/package-info.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/package-info.java index c3c0379244..1d2043d258 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/package-info.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/package-info.java @@ -1,7 +1,6 @@ - /** * - * Contains an abstract XML-based BeanFactory implementation, + * Contains an abstract XML-based {@code BeanFactory} implementation, * including a standard "spring-beans" DTD. * */ 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 5cdcb1d500..6e51f97fe5 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 @@ -21,22 +21,22 @@ import java.beans.PropertyEditorSupport; import org.springframework.util.StringUtils; /** - * Editor for a {@link java.lang.Character}, to populate a property - * of type Character or char from a String value. + * Editor for a {@link Character}, to populate a property + * of type {@code Character} or {@code char} from a String value. * *

    Note that the JDK does not contain a default - * {@link java.beans.PropertyEditor property editor} for char! + * {@link java.beans.PropertyEditor property editor} for {@code char}! * {@link org.springframework.beans.BeanWrapperImpl} will register this * editor by default. * *

    Also supports conversion from a Unicode character sequence; e.g. - * u0041 ('A'). + * {@code u0041} ('A'). * * @author Juergen Hoeller * @author Rob Harrop * @author Rick Evans * @since 1.2 - * @see java.lang.Character + * @see Character * @see org.springframework.beans.BeanWrapperImpl */ public class CharacterEditor extends PropertyEditorSupport { @@ -58,9 +58,9 @@ public class CharacterEditor extends PropertyEditorSupport { /** * Create a new CharacterEditor instance. *

    The "allowEmpty" parameter controls whether an empty String is - * to be allowed in parsing, i.e. be interpreted as the null + * to be allowed in parsing, i.e. be interpreted as the {@code null} * value when {@link #setAsText(String) text is being converted}. If - * false, an {@link IllegalArgumentException} will be thrown + * {@code false}, an {@link IllegalArgumentException} will be thrown * at that time. * @param allowEmpty if empty strings are to be allowed */ 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 5d742a9253..2c87af1f7a 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 @@ -22,11 +22,11 @@ import java.nio.charset.Charset; import org.springframework.util.StringUtils; /** - * Editor for java.nio.charset.Charset, translating charset + * Editor for {@code java.nio.charset.Charset}, translating charset * String representations into Charset objects and back. * *

    Expects the same syntax as Charset's {@link java.nio.charset.Charset#name()}, - * e.g. UTF-8, ISO-8859-16, etc. + * e.g. {@code UTF-8}, {@code ISO-8859-16}, etc. * * @author Arjen Poutsma * @since 2.5.4 diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassArrayEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassArrayEditor.java index 4db48197f8..42420f9fd0 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassArrayEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassArrayEditor.java @@ -23,9 +23,9 @@ import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** - * Property editor for an array of {@link java.lang.Class Classes}, to enable - * the direct population of a Class[] property without having to - * use a String class name property as bridge. + * Property editor for an array of {@link Class Classes}, to enable + * the direct population of a {@code Class[]} property without having to + * use a {@code String} class name property as bridge. * *

    Also supports "java.lang.String[]"-style array class names, in contrast * to the standard {@link Class#forName(String)} method. @@ -40,18 +40,18 @@ public class ClassArrayEditor extends PropertyEditorSupport { /** - * Create a default ClassEditor, using the thread - * context ClassLoader. + * Create a default {@code ClassEditor}, using the thread + * context {@code ClassLoader}. */ public ClassArrayEditor() { this(null); } /** - * Create a default ClassArrayEditor, using the given - * ClassLoader. - * @param classLoader the ClassLoader to use - * (or pass null for the thread context ClassLoader) + * Create a default {@code ClassArrayEditor}, using the given + * {@code ClassLoader}. + * @param classLoader the {@code ClassLoader} to use + * (or pass {@code null} for the thread context {@code ClassLoader}) */ public ClassArrayEditor(ClassLoader classLoader) { this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader()); diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassEditor.java index 4f5fffce46..59dba77c36 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/ClassEditor.java @@ -22,8 +22,8 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** - * Property editor for {@link java.lang.Class java.lang.Class}, to enable the direct - * population of a Class property without recourse to having to use a + * Property editor for {@link Class java.lang.Class}, to enable the direct + * population of a {@code Class} property without recourse to having to use a * String class name property as bridge. * *

    Also supports "java.lang.String[]"-style array class names, in contrast to the @@ -32,7 +32,7 @@ import org.springframework.util.StringUtils; * @author Juergen Hoeller * @author Rick Evans * @since 13.05.2003 - * @see java.lang.Class#forName + * @see Class#forName * @see org.springframework.util.ClassUtils#forName(String, ClassLoader) */ public class ClassEditor extends PropertyEditorSupport { @@ -50,7 +50,7 @@ public class ClassEditor extends PropertyEditorSupport { /** * Create a default ClassEditor, using the given ClassLoader. * @param classLoader the ClassLoader to use - * (or null for the thread context ClassLoader) + * (or {@code null} for the thread context ClassLoader) */ public ClassEditor(ClassLoader classLoader) { this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader()); diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CurrencyEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CurrencyEditor.java index 910016ac86..433e126749 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CurrencyEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CurrencyEditor.java @@ -20,7 +20,7 @@ import java.beans.PropertyEditorSupport; import java.util.Currency; /** - * Editor for java.util.Currency, translating currency codes into Currency + * Editor for {@code java.util.Currency}, translating currency codes into Currency * objects. Exposes the currency code as text representation of a Currency object. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomBooleanEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomBooleanEditor.java index b75520e06a..934fa37bb3 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomBooleanEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomBooleanEditor.java @@ -29,8 +29,8 @@ import org.springframework.util.StringUtils; * them in the UI form. * *

    In web MVC code, this editor will typically be registered with - * binder.registerCustomEditor calls in an implementation - * of BaseCommandController's initBinder method. + * {@code binder.registerCustomEditor} calls in an implementation + * of BaseCommandController's {@code initBinder} method. * * @author Juergen Hoeller * @since 10.06.2003 diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomCollectionEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomCollectionEditor.java index a355ffcb7a..b78db5ea5e 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomCollectionEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomCollectionEditor.java @@ -49,7 +49,7 @@ public class CustomCollectionEditor extends PropertyEditorSupport { /** * Create a new CustomCollectionEditor for the given target type, - * keeping an incoming null as-is. + * keeping an incoming {@code null} as-is. * @param collectionType the target type, which needs to be a * sub-interface of Collection or a concrete Collection class * @see java.util.Collection @@ -72,7 +72,7 @@ public class CustomCollectionEditor extends PropertyEditorSupport { * TreeSet for SortedSet, and LinkedHashSet for Set. * @param collectionType the target type, which needs to be a * sub-interface of Collection or a concrete Collection class - * @param nullAsEmptyCollection whether to convert an incoming null + * @param nullAsEmptyCollection whether to convert an incoming {@code null} * value to an empty Collection (of the appropriate type) * @see java.util.Collection * @see java.util.ArrayList @@ -198,7 +198,7 @@ public class CustomCollectionEditor extends PropertyEditorSupport { /** - * This implementation returns null to indicate that + * This implementation returns {@code null} to indicate that * there is no appropriate text representation. */ @Override diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomDateEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomDateEditor.java index 5f4acc9151..03e1d9c8f2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomDateEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomDateEditor.java @@ -24,8 +24,8 @@ import java.util.Date; import org.springframework.util.StringUtils; /** - * Property editor for java.util.Date, - * supporting a custom java.text.DateFormat. + * Property editor for {@code java.util.Date}, + * supporting a custom {@code java.text.DateFormat}. * *

    This is not meant to be used as system PropertyEditor but rather * as locale-specific date editor within custom controller code, @@ -33,8 +33,8 @@ import org.springframework.util.StringUtils; * and rendering them in the UI form. * *

    In web MVC code, this editor will typically be registered with - * binder.registerCustomEditor calls in a custom - * initBinder method. + * {@code binder.registerCustomEditor} calls in a custom + * {@code initBinder} method. * * @author Juergen Hoeller * @since 28.04.2003 @@ -76,7 +76,7 @@ public class CustomDateEditor extends PropertyEditorSupport { *

    The "exactDateLength" parameter states that IllegalArgumentException gets * thrown if the String does not exactly match the length specified. This is useful * because SimpleDateFormat does not enforce strict parsing of the year part, - * not even with setLenient(false). Without an "exactDateLength" + * not even with {@code setLenient(false)}. Without an "exactDateLength" * specified, the "01/01/05" would get parsed to "01/01/0005". However, even * with an "exactDateLength" specified, prepended zeros in the day or month * part may still allow for a shorter year part, so consider this as just diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomMapEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomMapEditor.java index d66eca4f17..81134a6931 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomMapEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomMapEditor.java @@ -40,7 +40,7 @@ public class CustomMapEditor extends PropertyEditorSupport { /** * Create a new CustomMapEditor for the given target type, - * keeping an incoming null as-is. + * keeping an incoming {@code null} as-is. * @param mapType the target type, which needs to be a * sub-interface of Map or a concrete Map class * @see java.util.Map @@ -63,7 +63,7 @@ public class CustomMapEditor extends PropertyEditorSupport { * and LinkedHashMap for Map. * @param mapType the target type, which needs to be a * sub-interface of Map or a concrete Map class - * @param nullAsEmptyMap ap whether to convert an incoming null + * @param nullAsEmptyMap ap whether to convert an incoming {@code null} * value to an empty Map (of the appropriate type) * @see java.util.Map * @see java.util.TreeMap @@ -189,7 +189,7 @@ public class CustomMapEditor extends PropertyEditorSupport { /** - * This implementation returns null to indicate that + * This implementation returns {@code null} to indicate that * there is no appropriate text representation. */ @Override diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomNumberEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomNumberEditor.java index eaf799f528..3e3072f0ec 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomNumberEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/CustomNumberEditor.java @@ -26,7 +26,7 @@ import org.springframework.util.StringUtils; * Property editor for any Number subclass such as Short, Integer, Long, * BigInteger, Float, Double, BigDecimal. Can use a given NumberFormat for * (locale-specific) parsing and rendering, or alternatively the default - * decode / valueOf / toString methods. + * {@code decode} / {@code valueOf} / {@code toString} methods. * *

    This is not meant to be used as system PropertyEditor but rather * as locale-specific number editor within custom controller code, @@ -34,12 +34,12 @@ import org.springframework.util.StringUtils; * and rendering them in the UI form. * *

    In web MVC code, this editor will typically be registered with - * binder.registerCustomEditor calls in a custom - * initBinder method. + * {@code binder.registerCustomEditor} calls in a custom + * {@code initBinder} method. * * @author Juergen Hoeller * @since 06.06.2003 - * @see java.lang.Number + * @see Number * @see java.text.NumberFormat * @see org.springframework.validation.DataBinder#registerCustomEditor * @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder @@ -55,10 +55,10 @@ public class CustomNumberEditor extends PropertyEditorSupport { /** * Create a new CustomNumberEditor instance, using the default - * valueOf methods for parsing and toString + * {@code valueOf} methods for parsing and {@code toString} * methods for rendering. *

    The "allowEmpty" parameter states if an empty String should - * be allowed for parsing, i.e. get interpreted as null value. + * be allowed for parsing, i.e. get interpreted as {@code null} value. * Else, an IllegalArgumentException gets thrown in that case. * @param numberClass Number subclass to generate * @param allowEmpty if empty strings should be allowed @@ -75,7 +75,7 @@ public class CustomNumberEditor extends PropertyEditorSupport { * Create a new CustomNumberEditor instance, using the given NumberFormat * for parsing and rendering. *

    The allowEmpty parameter states if an empty String should - * be allowed for parsing, i.e. get interpreted as null value. + * be allowed for parsing, i.e. get interpreted as {@code null} value. * Else, an IllegalArgumentException gets thrown in that case. * @param numberClass Number subclass to generate * @param numberFormat NumberFormat to use for parsing and rendering diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/FileEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/FileEditor.java index f21053e868..2fb351b55f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/FileEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/FileEditor.java @@ -27,7 +27,7 @@ import org.springframework.util.ResourceUtils; import org.springframework.util.StringUtils; /** - * Editor for java.io.File, to directly populate a File property + * Editor for {@code java.io.File}, to directly populate a File property * from a Spring resource location. * *

    Supports Spring-style URL notation: any fully qualified standard URL diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputSourceEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputSourceEditor.java index 3701b55cc3..982f9438d6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputSourceEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/InputSourceEditor.java @@ -26,7 +26,7 @@ import org.springframework.core.io.ResourceEditor; import org.springframework.util.Assert; /** - * Editor for org.xml.sax.InputSource, converting from a + * Editor for {@code org.xml.sax.InputSource}, converting from a * Spring resource location String to a SAX InputSource object. * *

    Supports Spring-style URL notation: any fully qualified standard URL @@ -37,8 +37,8 @@ import org.springframework.util.Assert; * @see org.xml.sax.InputSource * @see org.springframework.core.io.ResourceEditor * @see org.springframework.core.io.ResourceLoader - * @see org.springframework.beans.propertyeditors.URLEditor - * @see org.springframework.beans.propertyeditors.FileEditor + * @see URLEditor + * @see FileEditor */ public class InputSourceEditor extends PropertyEditorSupport { 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 7099897730..efa3908b2d 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 @@ -25,7 +25,7 @@ import org.springframework.util.Assert; /** * One-way PropertyEditor which can convert from a text String to a - * java.io.InputStream, interpreting the given String + * {@code java.io.InputStream}, interpreting the given String * as Spring resource location (e.g. a URL String). * *

    Supports Spring-style URL notation: any fully qualified standard URL @@ -79,7 +79,7 @@ public class InputStreamEditor extends PropertyEditorSupport { } /** - * This implementation returns null to indicate that + * This implementation returns {@code null} to indicate that * there is no appropriate text representation. */ @Override 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 9e0944662c..753ba19c5b 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 @@ -21,9 +21,9 @@ import java.beans.PropertyEditorSupport; import org.springframework.util.StringUtils; /** - * Editor for java.util.Locale, to directly populate a Locale property. + * Editor for {@code java.util.Locale}, to directly populate a Locale property. * - *

    Expects the same syntax as Locale's toString, i.e. language + + *

    Expects the same syntax as Locale's {@code toString}, i.e. language + * optionally country + optionally variant, separated by "_" (e.g. "en", "en_US"). * Also accepts spaces as separators, as alternative to underscores. * diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PatternEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PatternEditor.java index 41f9952b5c..886a1075c9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PatternEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PatternEditor.java @@ -20,8 +20,8 @@ import java.beans.PropertyEditorSupport; import java.util.regex.Pattern; /** - * Editor for java.util.regex.Pattern, to directly populate a Pattern property. - * Expects the same syntax as Pattern's compile method. + * Editor for {@code java.util.regex.Pattern}, to directly populate a Pattern property. + * Expects the same syntax as Pattern's {@code compile} method. * * @author Juergen Hoeller * @since 2.0.1 @@ -42,7 +42,7 @@ public class PatternEditor extends PropertyEditorSupport { /** * Create a new PatternEditor with the given settings. - * @param flags the java.util.regex.Pattern flags to apply + * @param flags the {@code java.util.regex.Pattern} flags to apply * @see java.util.regex.Pattern#compile(String, int) * @see java.util.regex.Pattern#CASE_INSENSITIVE * @see java.util.regex.Pattern#MULTILINE diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PropertiesEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PropertiesEditor.java index 7f5f291b70..a608128bee 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PropertiesEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/PropertiesEditor.java @@ -25,11 +25,11 @@ import java.util.Properties; /** * Custom {@link java.beans.PropertyEditor} for {@link Properties} objects. * - *

    Handles conversion from content {@link String} to Properties object. - * Also handles {@link Map} to Properties conversion, for populating - * a Properties object via XML "map" entries. + *

    Handles conversion from content {@link String} to {@code Properties} object. + * Also handles {@link Map} to {@code Properties} conversion, for populating + * a {@code Properties} object via XML "map" entries. * - *

    The required format is defined in the standard Properties + *

    The required format is defined in the standard {@code Properties} * documentation. Each property must be on a new line. * * @author Rod Johnson @@ -61,7 +61,7 @@ public class PropertiesEditor extends PropertyEditorSupport { } /** - * Take {@link Properties} as-is; convert {@link Map} into Properties. + * Take {@link Properties} as-is; convert {@link Map} into {@code Properties}. */ @Override public void setValue(Object value) { 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 5bcecaf973..716872c5e2 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 @@ -71,8 +71,8 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport { /** * Create a new StringArrayPropertyEditor with the given separator. * @param separator the separator to use for splitting a {@link String} - * @param emptyArrayAsNull true if an empty String array - * is to be transformed into null + * @param emptyArrayAsNull {@code true} if an empty String array + * is to be transformed into {@code null} */ public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull) { this(separator, null, emptyArrayAsNull); @@ -81,9 +81,9 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport { /** * Create a new StringArrayPropertyEditor with the given separator. * @param separator the separator to use for splitting a {@link String} - * @param emptyArrayAsNull true if an empty String array - * is to be transformed into null - * @param trimValues true if the values in the parsed arrays + * @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 * are to be be trimmed of whitespace (default is true). */ public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull, boolean trimValues) { @@ -96,8 +96,8 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport { * @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. - * @param emptyArrayAsNull true if an empty String array - * is to be transformed into null + * @param emptyArrayAsNull {@code true} if an empty String array + * is to be transformed into {@code null} */ public StringArrayPropertyEditor(String separator, String charsToDelete, boolean emptyArrayAsNull) { this(separator, charsToDelete, emptyArrayAsNull, true); @@ -109,9 +109,9 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport { * @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. - * @param emptyArrayAsNull true if an empty String array - * is to be transformed into null - * @param trimValues true if the values in the parsed arrays + * @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 * are to be be trimmed of whitespace (default is true). */ public StringArrayPropertyEditor(String separator, String charsToDelete, boolean emptyArrayAsNull, boolean trimValues) { 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 c277c44f74..f05dd43961 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 @@ -23,7 +23,7 @@ import org.springframework.util.StringUtils; /** * Property editor that trims Strings. * - *

    Optionally allows transforming an empty string into a null value. + *

    Optionally allows transforming an empty string into a {@code null} value. * Needs to be explicitly registered, e.g. for command binding. * * @author Juergen Hoeller @@ -39,8 +39,8 @@ public class StringTrimmerEditor extends PropertyEditorSupport { /** * Create a new StringTrimmerEditor. - * @param emptyAsNull true if an empty String is to be - * transformed into null + * @param emptyAsNull {@code true} if an empty String is to be + * transformed into {@code null} */ public StringTrimmerEditor(boolean emptyAsNull) { this.charsToDelete = null; @@ -52,8 +52,8 @@ public class StringTrimmerEditor extends PropertyEditorSupport { * @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. - * @param emptyAsNull true if an empty String is to be - * transformed into null + * @param emptyAsNull {@code true} if an empty String is to be + * transformed into {@code null} */ public StringTrimmerEditor(String charsToDelete, boolean emptyAsNull) { this.charsToDelete = charsToDelete; diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/TimeZoneEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/TimeZoneEditor.java index 832488ffaf..2059c660c4 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/TimeZoneEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/TimeZoneEditor.java @@ -20,7 +20,7 @@ import java.beans.PropertyEditorSupport; import java.util.TimeZone; /** - * Editor for java.util.TimeZone, translating timezone IDs into + * Editor for {@code java.util.TimeZone}, translating timezone IDs into * TimeZone objects. Does not expose a text representation for TimeZone objects. * * @author Juergen Hoeller @@ -35,7 +35,7 @@ public class TimeZoneEditor extends PropertyEditorSupport { } /** - * This implementation returns null to indicate that + * This implementation returns {@code null} to indicate that * there is no appropriate text representation. */ @Override diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java index add95f10c3..84febdf01d 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java @@ -27,7 +27,7 @@ import org.springframework.util.ResourceUtils; import org.springframework.util.StringUtils; /** - * Editor for java.net.URI, to directly populate a URI property + * Editor for {@code java.net.URI}, to directly populate a URI property * instead of using a String property as bridge. * *

    Supports Spring-style URI notation: any fully qualified standard URI @@ -79,7 +79,7 @@ public class URIEditor extends PropertyEditorSupport { * Create a new URIEditor, using the given ClassLoader to resolve * "classpath:" locations into physical resource URLs. * @param classLoader the ClassLoader to use for resolving "classpath:" locations - * (may be null to indicate the default ClassLoader) + * (may be {@code null} to indicate the default ClassLoader) */ public URIEditor(ClassLoader classLoader) { this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader()); @@ -90,7 +90,7 @@ public class URIEditor extends PropertyEditorSupport { * Create a new URIEditor, using the given ClassLoader to resolve * "classpath:" locations into physical resource URLs. * @param classLoader the ClassLoader to use for resolving "classpath:" locations - * (may be null to indicate the default ClassLoader) + * (may be {@code null} to indicate the default ClassLoader) * @param encode indicates whether Strings will be encoded or not */ public URIEditor(ClassLoader classLoader, boolean encode) { diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URLEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URLEditor.java index bffeffc1ef..be8bf5c69c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URLEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URLEditor.java @@ -25,7 +25,7 @@ import org.springframework.core.io.ResourceEditor; import org.springframework.util.Assert; /** - * Editor for java.net.URL, to directly populate a URL property + * Editor for {@code java.net.URL}, to directly populate a URL property * instead of using a String property as bridge. * *

    Supports Spring-style URL notation: any fully qualified standard URL diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/UUIDEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/UUIDEditor.java index 98c9ea54f5..fd938eef80 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/UUIDEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/UUIDEditor.java @@ -22,7 +22,7 @@ import java.util.UUID; import org.springframework.util.StringUtils; /** - * Editor for java.util.UUID, translating UUID + * Editor for {@code java.util.UUID}, translating UUID * String representations into UUID objects and back. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/support/ArgumentConvertingMethodInvoker.java b/spring-beans/src/main/java/org/springframework/beans/support/ArgumentConvertingMethodInvoker.java index 36c185f919..486d13ed74 100644 --- a/spring-beans/src/main/java/org/springframework/beans/support/ArgumentConvertingMethodInvoker.java +++ b/spring-beans/src/main/java/org/springframework/beans/support/ArgumentConvertingMethodInvoker.java @@ -125,7 +125,7 @@ public class ArgumentConvertingMethodInvoker extends MethodInvoker { * Actually find a method with matching parameter type, i.e. where each * argument value is assignable to the corresponding parameter type. * @param arguments the argument values to match against method parameters - * @return a matching method, or null if none + * @return a matching method, or {@code null} if none */ protected Method doFindMatchingMethod(Object[] arguments) { TypeConverter converter = getTypeConverter(); diff --git a/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java b/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java index c9a369c639..2f7892a963 100644 --- a/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/support/MutableSortDefinition.java @@ -76,7 +76,7 @@ public class MutableSortDefinition implements SortDefinition, Serializable { /** * Create a new MutableSortDefinition. * @param toggleAscendingOnSameProperty whether to toggle the ascending flag - * if the same property gets set again (that is, setProperty gets + * if the same property gets set again (that is, {@code setProperty} gets * called with already set property name again). */ public MutableSortDefinition(boolean toggleAscendingOnSameProperty) { diff --git a/spring-beans/src/main/java/org/springframework/beans/support/PagedListHolder.java b/spring-beans/src/main/java/org/springframework/beans/support/PagedListHolder.java index 2ed2c98955..9d09ca22a2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/support/PagedListHolder.java +++ b/spring-beans/src/main/java/org/springframework/beans/support/PagedListHolder.java @@ -288,9 +288,9 @@ public class PagedListHolder implements Serializable { /** - * Resort the list if necessary, i.e. if the current sort instance - * isn't equal to the backed-up sortUsed instance. - *

    Calls doSort to trigger actual sorting. + * Resort the list if necessary, i.e. if the current {@code sort} instance + * isn't equal to the backed-up {@code sortUsed} instance. + *

    Calls {@code doSort} to trigger actual sorting. * @see #doSort */ public void resort() { @@ -309,7 +309,7 @@ public class PagedListHolder implements Serializable { * Can be overridden in subclasses, in particular in case of custom * extensions to the SortDefinition interface. Is allowed to return * null, which means that no sort state will be held, triggering - * actual sorting for each resort call. + * actual sorting for each {@code resort} call. * @param sort the current SortDefinition object * @return a deep copy of the SortDefinition object * @see MutableSortDefinition#MutableSortDefinition(SortDefinition) diff --git a/spring-beans/src/main/java/org/springframework/beans/support/ResourceEditorRegistrar.java b/spring-beans/src/main/java/org/springframework/beans/support/ResourceEditorRegistrar.java index bcf6c8931c..3f4abc6568 100644 --- a/spring-beans/src/main/java/org/springframework/beans/support/ResourceEditorRegistrar.java +++ b/spring-beans/src/main/java/org/springframework/beans/support/ResourceEditorRegistrar.java @@ -91,7 +91,7 @@ public class ResourceEditorRegistrar implements PropertyEditorRegistrar { /** - * Populate the given registry with the following resource editors: + * Populate the given {@code registry} with the following resource editors: * ResourceEditor, InputStreamEditor, InputSourceEditor, FileEditor, URLEditor, * URIEditor, ClassEditor, ClassArrayEditor. *

    If this registrar has been configured with a {@link ResourcePatternResolver}, diff --git a/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java b/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java index 5c821a4f80..24d271c47b 100644 --- a/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java +++ b/spring-beans/src/test/java/org/springframework/beans/factory/DefaultListableBeanFactoryTests.java @@ -1310,7 +1310,7 @@ public class DefaultListableBeanFactoryTests { * Verifies that a dependency on a {@link FactoryBean} can not * be autowired by name, as & is an illegal character in * Java method names. In other words, you can't name a method - * set&FactoryBean(...). + * {@code set&FactoryBean(...)}. */ @Test(expected=TypeMismatchException.class) public void testAutowireBeanWithFactoryBeanByName() { diff --git a/spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheFactoryBean.java b/spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheFactoryBean.java index 2527180e03..fc2ad00022 100644 --- a/spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheFactoryBean.java +++ b/spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheFactoryBean.java @@ -112,7 +112,7 @@ public class EhCacheFactoryBean implements FactoryBean, BeanNameAware, /** * Set a CacheManager from which to retrieve a named Cache instance. - * By default, CacheManager.getInstance() will be called. + * By default, {@code CacheManager.getInstance()} will be called. *

    Note that in particular for persistent caches, it is advisable to * properly handle the shutdown of the CacheManager: Set up a separate * EhCacheManagerFactoryBean and pass a reference to this bean property. diff --git a/spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java b/spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java index 0e66d5ebe4..d47e3dcb92 100644 --- a/spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java +++ b/spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java @@ -99,7 +99,7 @@ public class JCacheCache implements Cache { /** * Convert the given value from the internal store to a user value - * returned from the get method (adapting null). + * returned from the get method (adapting {@code null}). * @param storeValue the store value * @return the value to return to the user */ @@ -112,7 +112,7 @@ public class JCacheCache implements Cache { /** * Convert the given user value, as passed into the put method, - * to a value in the internal store (adapting null). + * to a value in the internal store (adapting {@code null}). * @param userValue the given user value * @return the value to store */ diff --git a/spring-context-support/src/main/java/org/springframework/mail/SimpleMailMessage.java b/spring-context-support/src/main/java/org/springframework/mail/SimpleMailMessage.java index 518d846c1e..4691c85e0b 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/SimpleMailMessage.java +++ b/spring-context-support/src/main/java/org/springframework/mail/SimpleMailMessage.java @@ -26,7 +26,7 @@ import org.springframework.util.Assert; /** * Models a simple mail message, including data such as the from, to, cc, subject, and text fields. * - *

    Consider JavaMailSender and JavaMail MimeMessages for creating + *

    Consider {@code JavaMailSender} and JavaMail {@code MimeMessages} for creating * more sophisticated messages, for example messages with attachments, special * character encodings, or personal names that accompany mail addresses. * @@ -59,15 +59,15 @@ public class SimpleMailMessage implements MailMessage, Serializable { /** - * Create a new SimpleMailMessage. + * Create a new {@code SimpleMailMessage}. */ public SimpleMailMessage() { } /** - * Copy constructor for creating a new SimpleMailMessage from the state - * of an existing SimpleMailMessage instance. - * @throws IllegalArgumentException if the supplied message is null + * Copy constructor for creating a new {@code SimpleMailMessage} from the state + * of an existing {@code SimpleMailMessage} instance. + * @throws IllegalArgumentException if the supplied message is {@code null} */ public SimpleMailMessage(SimpleMailMessage original) { Assert.notNull(original, "The 'original' message argument cannot be null"); @@ -167,8 +167,8 @@ public class SimpleMailMessage implements MailMessage, Serializable { /** * Copy the contents of this message to the given target message. - * @param target the MailMessage to copy to - * @throws IllegalArgumentException if the supplied target is null + * @param target the {@code MailMessage} to copy to + * @throws IllegalArgumentException if the supplied {@code target} is {@code null} */ public void copyTo(MailMessage target) { Assert.notNull(target, "The 'target' message argument cannot be null"); diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/ConfigurableMimeFileTypeMap.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/ConfigurableMimeFileTypeMap.java index e0fdfadf7e..f3ceba872e 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/ConfigurableMimeFileTypeMap.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/ConfigurableMimeFileTypeMap.java @@ -27,9 +27,9 @@ import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.Resource; /** - * Spring-configurable FileTypeMap implementation that will read + * Spring-configurable {@code FileTypeMap} implementation that will read * MIME type to file extension mappings from a standard JavaMail MIME type - * mapping file, using a standard MimetypesFileTypeMap underneath. + * mapping file, using a standard {@code MimetypesFileTypeMap} underneath. * *

    The mapping file should be in the following format, as specified by the * Java Activation Framework: @@ -38,18 +38,18 @@ import org.springframework.core.io.Resource; * # map text/html to .htm and .html files * text/html html htm HTML HTM * - * Lines starting with # are treated as comments and are ignored. All + * Lines starting with {@code #} are treated as comments and are ignored. All * other lines are treated as mappings. Each mapping line should contain the MIME * type as the first entry and then each file extension to map to that MIME type * as subsequent entries. Each entry is separated by spaces or tabs. * - *

    By default, the mappings in the mime.types file located in the + *

    By default, the mappings in the {@code mime.types} file located in the * same package as this class are used, which cover many common file extensions - * (in contrast to the out-of-the-box mappings in activation.jar). - * This can be overridden using the mappingLocation property. + * (in contrast to the out-of-the-box mappings in {@code activation.jar}). + * This can be overridden using the {@code mappingLocation} property. * - *

    Additional mappings can be added via the mappings bean property, - * as lines that follow the mime.types file format. + *

    Additional mappings can be added via the {@code mappings} bean property, + * as lines that follow the {@code mime.types} file format. * * @author Rob Harrop * @author Juergen Hoeller @@ -61,7 +61,7 @@ import org.springframework.core.io.Resource; public class ConfigurableMimeFileTypeMap extends FileTypeMap implements InitializingBean { /** - * The Resource to load the mapping file from. + * The {@code Resource} to load the mapping file from. */ private Resource mappingLocation = new ClassPathResource("mime.types", getClass()); @@ -72,16 +72,16 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali /** * The delegate FileTypeMap, compiled from the mappings in the mapping file - * and the entries in the mappings property. + * and the entries in the {@code mappings} property. */ private FileTypeMap fileTypeMap; /** - * Specify the Resource from which mappings are loaded. - *

    Needs to follow the mime.types file format, as specified + * Specify the {@code Resource} from which mappings are loaded. + *

    Needs to follow the {@code mime.types} file format, as specified * by the Java Activation Framework, containing lines such as:
    - * text/html html htm HTML HTM + * {@code text/html html htm HTML HTM} */ public void setMappingLocation(Resource mappingLocation) { this.mappingLocation = mappingLocation; @@ -89,9 +89,9 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali /** * Specify additional MIME type mappings as lines that follow the - * mime.types file format, as specified by the + * {@code mime.types} file format, as specified by the * Java Activation Framework, for example:
    - * text/html html htm HTML HTM + * {@code text/html html htm HTML HTM} */ public void setMappings(String[] mappings) { this.mappings = mappings; @@ -107,7 +107,7 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali /** * Return the delegate FileTypeMap, compiled from the mappings in the mapping file - * and the entries in the mappings property. + * and the entries in the {@code mappings} property. * @see #setMappingLocation * @see #setMappings * @see #createFileTypeMap @@ -131,8 +131,8 @@ public class ConfigurableMimeFileTypeMap extends FileTypeMap implements Initiali *

    The default implementation creates an Activation Framework {@link MimetypesFileTypeMap}, * passing in an InputStream from the mapping resource (if any) and registering * the mapping lines programmatically. - * @param mappingLocation a mime.types mapping resource (can be null) - * @param mappings MIME type mapping lines (can be null) + * @param mappingLocation a {@code mime.types} mapping resource (can be {@code null}) + * @param mappings MIME type mapping lines (can be {@code null}) * @return the compiled FileTypeMap * @throws IOException if resource access failed * @see javax.activation.MimetypesFileTypeMap#MimetypesFileTypeMap(java.io.InputStream) diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/InternetAddressEditor.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/InternetAddressEditor.java index 2647d76ef4..057d6f78e2 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/InternetAddressEditor.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/InternetAddressEditor.java @@ -24,7 +24,7 @@ import javax.mail.internet.InternetAddress; import org.springframework.util.StringUtils; /** - * Editor for java.mail.internet.InternetAddress, + * Editor for {@code java.mail.internet.InternetAddress}, * to directly populate an InternetAddress property. * *

    Expects the same syntax as InternetAddress's constructor with diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSender.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSender.java index ea2a0efbd0..bae5d7fb96 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSender.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/JavaMailSender.java @@ -49,8 +49,8 @@ import org.springframework.mail.MailSender; * {@link org.springframework.mail.MailSender} client, but still straightforward * compared to traditional JavaMail code: Just let {@link #createMimeMessage()} * return a plain {@link MimeMessage} created with a - * Session.getInstance(new Properties()) call, and check the passed-in - * messages in your mock implementations of the various send methods. + * {@code Session.getInstance(new Properties())} call, and check the passed-in + * messages in your mock implementations of the various {@code send} methods. * * @author Juergen Hoeller * @since 07.10.2003 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 8c4557974c..ed9151bfdf 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 @@ -51,8 +51,8 @@ import org.springframework.util.Assert; * specified, possibly pulled from an application server's JNDI environment. * *

    Non-default properties in this object will always override the settings - * in the JavaMail Session. Note that if overriding all values locally, - * there is no added value in setting a pre-configured Session. + * in the JavaMail {@code Session}. Note that if overriding all values locally, + * there is no added value in setting a pre-configured {@code Session}. * * @author Dmitriy Kopylenko * @author Juergen Hoeller @@ -97,7 +97,7 @@ public class JavaMailSenderImpl implements JavaMailSender { /** - * Create a new instance of the JavaMailSenderImpl class. + * Create a new instance of the {@code JavaMailSenderImpl} class. *

    Initializes the {@link #setDefaultFileTypeMap "defaultFileTypeMap"} * property with a default {@link ConfigurableMimeFileTypeMap}. */ @@ -109,8 +109,8 @@ public class JavaMailSenderImpl implements JavaMailSender { /** - * Set JavaMail properties for the Session. - *

    A new Session will be created with those properties. + * Set JavaMail properties for the {@code Session}. + *

    A new {@code Session} will be created with those properties. * Use either this method or {@link #setSession}, but not both. *

    Non-default properties in this instance will override given * JavaMail properties. @@ -133,11 +133,11 @@ public class JavaMailSenderImpl implements JavaMailSender { } /** - * Set the JavaMail Session, possibly pulled from JNDI. - *

    Default is a new Session without defaults, that is + * Set the JavaMail {@code Session}, possibly pulled from JNDI. + *

    Default is a new {@code Session} without defaults, that is * completely configured via this instance's properties. - *

    If using a pre-configured Session, non-default properties - * in this instance will override the settings in the Session. + *

    If using a pre-configured {@code Session}, non-default properties + * in this instance will override the settings in the {@code Session}. * @see #setJavaMailProperties */ public synchronized void setSession(Session session) { @@ -146,7 +146,7 @@ public class JavaMailSenderImpl implements JavaMailSender { } /** - * Return the JavaMail Session, + * Return the JavaMail {@code Session}, * lazily initializing it if hasn't been specified explicitly. */ public synchronized Session getSession() { @@ -203,11 +203,11 @@ public class JavaMailSenderImpl implements JavaMailSender { /** * Set the username for the account at the mail host, if any. - *

    Note that the underlying JavaMail Session has to be - * configured with the property "mail.smtp.auth" set to - * true, else the specified username will not be sent to the + *

    Note that the underlying JavaMail {@code Session} has to be + * configured with the property {@code "mail.smtp.auth"} set to + * {@code true}, else the specified username will not be sent to the * mail server by the JavaMail runtime. If you are not explicitly passing - * in a Session to use, simply specify this setting via + * in a {@code Session} to use, simply specify this setting via * {@link #setJavaMailProperties}. * @see #setSession * @see #setPassword @@ -225,11 +225,11 @@ public class JavaMailSenderImpl implements JavaMailSender { /** * Set the password for the account at the mail host, if any. - *

    Note that the underlying JavaMail Session has to be - * configured with the property "mail.smtp.auth" set to - * true, else the specified password will not be sent to the + *

    Note that the underlying JavaMail {@code Session} has to be + * configured with the property {@code "mail.smtp.auth"} set to + * {@code true}, else the specified password will not be sent to the * mail server by the JavaMail runtime. If you are not explicitly passing - * in a Session to use, simply specify this setting via + * in a {@code Session} to use, simply specify this setting via * {@link #setJavaMailProperties}. * @see #setSession * @see #setUsername @@ -256,7 +256,7 @@ public class JavaMailSenderImpl implements JavaMailSender { /** * Return the default encoding for {@link MimeMessage MimeMessages}, - * or null if none. + * or {@code null} if none. */ public String getDefaultEncoding() { return this.defaultEncoding; @@ -265,14 +265,14 @@ public class JavaMailSenderImpl implements JavaMailSender { /** * Set the default Java Activation {@link FileTypeMap} to use for * {@link MimeMessage MimeMessages} created by this instance. - *

    A FileTypeMap specified here will be autodetected by + *

    A {@code FileTypeMap} specified here will be autodetected by * {@link MimeMessageHelper}, avoiding the need to specify the - * FileTypeMap for each MimeMessageHelper instance. + * {@code FileTypeMap} for each {@code MimeMessageHelper} instance. *

    For example, you can specify a custom instance of Spring's * {@link ConfigurableMimeFileTypeMap} here. If not explicitly specified, - * a default ConfigurableMimeFileTypeMap will be used, containing + * a default {@code ConfigurableMimeFileTypeMap} will be used, containing * an extended set of MIME type mappings (as defined by the - * mime.types file contained in the Spring jar). + * {@code mime.types} file contained in the Spring jar). * @see MimeMessageHelper#setFileTypeMap */ public void setDefaultFileTypeMap(FileTypeMap defaultFileTypeMap) { @@ -281,7 +281,7 @@ public class JavaMailSenderImpl implements JavaMailSender { /** * Return the default Java Activation {@link FileTypeMap} for - * {@link MimeMessage MimeMessages}, or null if none. + * {@link MimeMessage MimeMessages}, or {@code null} if none. */ public FileTypeMap getDefaultFileTypeMap() { return this.defaultFileTypeMap; 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 bef2498eea..840320741b 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 @@ -355,7 +355,7 @@ public class MimeMessageHelper { /** * Set the given MimeMultipart objects for use by this MimeMessageHelper. * @param root the root MimeMultipart object, which attachments will be added to; - * or null to indicate no multipart at all + * or {@code null} to indicate no multipart at all * @param main the main MimeMultipart object, which text(s) and inline elements * will be added to (can be the same as the root multipart object, or an element * nested underneath the root multipart element) @@ -420,7 +420,7 @@ public class MimeMessageHelper { * Determine the default encoding for the given MimeMessage. * @param mimeMessage the passed-in MimeMessage * @return the default encoding associated with the MimeMessage, - * or null if none found + * or {@code null} if none found */ protected String getDefaultEncoding(MimeMessage mimeMessage) { if (mimeMessage instanceof SmartMimeMessage) { @@ -456,12 +456,12 @@ public class MimeMessageHelper { } /** - * Set the Java Activation Framework FileTypeMap to use + * Set the Java Activation Framework {@code FileTypeMap} to use * for determining the content type of inline content and attachments * that get added to the message. - *

    Default is the FileTypeMap that the underlying + *

    Default is the {@code FileTypeMap} that the underlying * MimeMessage carries, if any, or the Activation Framework's default - * FileTypeMap instance else. + * {@code FileTypeMap} instance else. * @see #addInline * @see #addAttachment * @see #getDefaultFileTypeMap(javax.mail.internet.MimeMessage) @@ -474,7 +474,7 @@ public class MimeMessageHelper { } /** - * Return the FileTypeMap used by this MimeMessageHelper. + * Return the {@code FileTypeMap} used by this MimeMessageHelper. */ public FileTypeMap getFileTypeMap() { return this.fileTypeMap; @@ -485,7 +485,7 @@ public class MimeMessageHelper { * Set whether to validate all addresses which get passed to this helper. * Default is "false". *

    Note that this is by default just available for JavaMail >= 1.3. - * You can override the default validateAddress method for + * You can override the default {@code validateAddress method} for * validation on older JavaMail versions (or for custom validation). * @see #validateAddress */ @@ -503,7 +503,7 @@ public class MimeMessageHelper { /** * Validate the given mail address. * Called by all of MimeMessageHelper's address setters and adders. - *

    Default implementation invokes InternetAddress.validate(), + *

    Default implementation invokes {@code InternetAddress.validate()}, * provided that address validation is activated for the helper instance. *

    Note that this method will just work on JavaMail >= 1.3. You can override * it for validation on older JavaMail versions or for custom validation. @@ -730,7 +730,7 @@ public class MimeMessageHelper { /** * Set the sent-date of the message. - * @param sentDate the date to set (never null) + * @param sentDate the date to set (never {@code null}) * @throws MessagingException in case of errors */ public void setSentDate(Date sentDate) throws MessagingException { @@ -758,7 +758,7 @@ public class MimeMessageHelper { * Set the given text directly as content in non-multipart mode * or as default body part in multipart mode. * Always applies the default content type "text/plain". - *

    NOTE: Invoke {@link #addInline} after setText; + *

    NOTE: Invoke {@link #addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param text the text for the message * @throws MessagingException in case of errors @@ -771,7 +771,7 @@ public class MimeMessageHelper { * Set the given text directly as content in non-multipart mode * or as default body part in multipart mode. * The "html" flag determines the content type to apply. - *

    NOTE: Invoke {@link #addInline} after setText; + *

    NOTE: Invoke {@link #addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param text the text for the message * @param html whether to apply content type "text/html" for an @@ -798,7 +798,7 @@ public class MimeMessageHelper { /** * Set the given plain text and HTML text as alternatives, offering * both options to the email client. Requires multipart mode. - *

    NOTE: Invoke {@link #addInline} after setText; + *

    NOTE: Invoke {@link #addInline} after {@code setText}; * else, mail readers might not be able to resolve inline references correctly. * @param plainText the plain text for the message * @param htmlText the HTML text for the message @@ -860,16 +860,16 @@ public class MimeMessageHelper { /** * Add an inline element to the MimeMessage, taking the content from a - * javax.activation.DataSource. + * {@code javax.activation.DataSource}. *

    Note that the InputStream returned by the DataSource implementation * needs to be a fresh one on each call, as JavaMail will invoke - * getInputStream() multiple times. - *

    NOTE: Invoke addInline after {@link #setText}; + * {@code getInputStream()} multiple times. + *

    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>". * Can be referenced in HTML source via src="cid:myId" expressions. - * @param dataSource the javax.activation.DataSource to take + * @param dataSource the {@code javax.activation.DataSource} to take * the content from, determining the InputStream and the content type * @throws MessagingException in case of errors * @see #addInline(String, java.io.File) @@ -889,11 +889,11 @@ public class MimeMessageHelper { /** * Add an inline element to the MimeMessage, taking the content from a - * java.io.File. + * {@code java.io.File}. *

    The content type will be determined by the name of the given * content file. Do not use this for temporary files with arbitrary * filenames (possibly ending in ".tmp" or the like)! - *

    NOTE: Invoke addInline after {@link #setText}; + *

    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>". @@ -913,14 +913,14 @@ public class MimeMessageHelper { /** * Add an inline element to the MimeMessage, taking the content from a - * org.springframework.core.io.Resource. + * {@code org.springframework.core.io.Resource}. *

    The content type will be determined by the name of the given * content file. Do not use this for temporary files with arbitrary * filenames (possibly ending in ".tmp" or the like)! *

    Note that the InputStream returned by the Resource implementation * needs to be a fresh one on each call, as JavaMail will invoke - * getInputStream() multiple times. - *

    NOTE: Invoke addInline after {@link #setText}; + * {@code getInputStream()} multiple times. + *

    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>". @@ -939,14 +939,14 @@ public class MimeMessageHelper { /** * Add an inline element to the MimeMessage, taking the content from an - * org.springframework.core.InputStreamResource, and + * {@code org.springframework.core.InputStreamResource}, and * specifying the content type explicitly. *

    You can determine the content type for any given filename via a Java * Activation Framework's FileTypeMap, for example the one held by this helper. *

    Note that the InputStream returned by the InputStreamSource implementation * needs to be a fresh one on each call, as JavaMail will invoke - * getInputStream() multiple times. - *

    NOTE: Invoke addInline after setText; + * {@code getInputStream()} multiple times. + *

    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>". @@ -974,13 +974,13 @@ public class MimeMessageHelper { /** * Add an attachment to the MimeMessage, taking the content from a - * javax.activation.DataSource. + * {@code javax.activation.DataSource}. *

    Note that the InputStream returned by the DataSource implementation * needs to be a fresh one on each call, as JavaMail will invoke - * getInputStream() multiple times. + * {@code getInputStream()} multiple times. * @param attachmentFilename the name of the attachment as it will * appear in the mail (the content type will be determined by this) - * @param dataSource the javax.activation.DataSource to take + * @param dataSource the {@code javax.activation.DataSource} to take * the content from, determining the InputStream and the content type * @throws MessagingException in case of errors * @see #addAttachment(String, org.springframework.core.io.InputStreamSource) @@ -998,7 +998,7 @@ public class MimeMessageHelper { /** * Add an attachment to the MimeMessage, taking the content from a - * java.io.File. + * {@code java.io.File}. *

    The content type will be determined by the name of the given * content file. Do not use this for temporary files with arbitrary * filenames (possibly ending in ".tmp" or the like)! @@ -1018,13 +1018,13 @@ public class MimeMessageHelper { /** * Add an attachment to the MimeMessage, taking the content from an - * org.springframework.core.io.InputStreamResource. + * {@code org.springframework.core.io.InputStreamResource}. *

    The content type will be determined by the given filename for * the attachment. Thus, any content source will be fine, including * temporary files with arbitrary filenames. *

    Note that the InputStream returned by the InputStreamSource * implementation needs to be a fresh one on each call, as - * JavaMail will invoke getInputStream() multiple times. + * JavaMail will invoke {@code getInputStream()} multiple times. * @param attachmentFilename the name of the attachment as it will * appear in the mail * @param inputStreamSource the resource to take the content from @@ -1043,10 +1043,10 @@ public class MimeMessageHelper { /** * Add an attachment to the MimeMessage, taking the content from an - * org.springframework.core.io.InputStreamResource. + * {@code org.springframework.core.io.InputStreamResource}. *

    Note that the InputStream returned by the InputStreamSource * implementation needs to be a fresh one on each call, as - * JavaMail will invoke getInputStream() multiple times. + * JavaMail will invoke {@code getInputStream()} multiple times. * @param attachmentFilename the name of the attachment as it will * appear in the mail * @param inputStreamSource the resource to take the content from diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessagePreparator.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessagePreparator.java index 8ac0e8be2e..dd6417b182 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessagePreparator.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/MimeMessagePreparator.java @@ -21,7 +21,7 @@ import javax.mail.internet.MimeMessage; /** * Callback interface for the preparation of JavaMail MIME messages. * - *

    The corresponding send methods of {@link JavaMailSender} + *

    The corresponding {@code send} methods of {@link JavaMailSender} * will take care of the actual creation of a {@link MimeMessage} instance, * and of proper exception conversion. * diff --git a/spring-context-support/src/main/java/org/springframework/mail/javamail/SmartMimeMessage.java b/spring-context-support/src/main/java/org/springframework/mail/javamail/SmartMimeMessage.java index 6a3bcd4957..2e46fa1029 100644 --- a/spring-context-support/src/main/java/org/springframework/mail/javamail/SmartMimeMessage.java +++ b/spring-context-support/src/main/java/org/springframework/mail/javamail/SmartMimeMessage.java @@ -45,8 +45,8 @@ class SmartMimeMessage extends MimeMessage { /** * Create a new SmartMimeMessage. * @param session the JavaMail Session to create the message for - * @param defaultEncoding the default encoding, or null if none - * @param defaultFileTypeMap the default FileTypeMap, or null if none + * @param defaultEncoding the default encoding, or {@code null} if none + * @param defaultFileTypeMap the default FileTypeMap, or {@code null} if none */ public SmartMimeMessage(Session session, String defaultEncoding, FileTypeMap defaultFileTypeMap) { super(session); @@ -56,14 +56,14 @@ class SmartMimeMessage extends MimeMessage { /** - * Return the default encoding of this message, or null if none. + * Return the default encoding of this message, or {@code null} if none. */ public final String getDefaultEncoding() { return this.defaultEncoding; } /** - * Return the default FileTypeMap of this message, or null if none. + * Return the default FileTypeMap of this message, or {@code null} if none. */ public final FileTypeMap getDefaultFileTypeMap() { return this.defaultFileTypeMap; diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/commonj/ScheduledTimerListener.java b/spring-context-support/src/main/java/org/springframework/scheduling/commonj/ScheduledTimerListener.java index 34a61b8f17..25931464c9 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/commonj/ScheduledTimerListener.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/commonj/ScheduledTimerListener.java @@ -179,7 +179,7 @@ public class ScheduledTimerListener { *

    Note: A period of 0 (for example as fixed delay) is * supported, because the CommonJ specification defines this as a legal value. * Hence a value of 0 will result in immediate re-execution after a job has - * finished (not in one-time execution like with java.util.Timer). + * finished (not in one-time execution like with {@code java.util.Timer}). * @see #setFixedRate * @see #isOneTimeTask() * @see commonj.timers.TimerManager#schedule(commonj.timers.TimerListener, long, long) @@ -197,7 +197,7 @@ public class ScheduledTimerListener { /** * Is this task only ever going to execute once? - * @return true if this task is only ever going to execute once + * @return {@code true} if this task is only ever going to execute once * @see #getPeriod() */ public boolean isOneTimeTask() { diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/commonj/TimerManagerAccessor.java b/spring-context-support/src/main/java/org/springframework/scheduling/commonj/TimerManagerAccessor.java index 46db6ee2c0..2eae87785d 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/commonj/TimerManagerAccessor.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/commonj/TimerManagerAccessor.java @@ -74,8 +74,8 @@ public abstract class TimerManagerAccessor extends JndiLocatorSupport *

    Default is "false", i.e. managing an independent TimerManager instance. * This is what the CommonJ specification suggests that application servers * are supposed to offer via JNDI lookups, typically declared as a - * resource-ref of type commonj.timers.TimerManager - * in web.xml, with res-sharing-scope set to 'Unshareable'. + * {@code resource-ref} of type {@code commonj.timers.TimerManager} + * in {@code web.xml}, with {@code res-sharing-scope} set to 'Unshareable'. *

    Switch this flag to "true" if you are obtaining a shared TimerManager, * typically through specifying the JNDI location of a TimerManager that * has been explicitly declared as 'Shareable'. Note that WebLogic's diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerBean.java index cee2683dce..a8beff8eba 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerBean.java @@ -33,7 +33,7 @@ import org.springframework.util.Assert; * Convenience subclass of Quartz's {@link org.quartz.CronTrigger} class, * making bean-style usage easier. * - *

    CronTrigger itself is already a JavaBean but lacks sensible defaults. + *

    {@code CronTrigger} itself is already a JavaBean but lacks sensible defaults. * This class uses the Spring bean name as job name, the Quartz default group * ("DEFAULT") as job group, the current time as start time, and indefinite * repetition, if not specified. @@ -44,7 +44,7 @@ import org.springframework.util.Assert; * instead of registering the JobDetail separately. * *

    NOTE: This convenience subclass does not work against Quartz 2.0. - * Use Quartz 2.0's native JobDetailImpl class or the new Quartz 2.0 + * Use Quartz 2.0's native {@code JobDetailImpl} class or the new Quartz 2.0 * builder API instead. Alternatively, switch to Spring's {@link CronTriggerFactoryBean} * which largely is a drop-in replacement for this class and its properties and * consistently works against Quartz 1.x as well as Quartz 2.0/2.1. @@ -90,7 +90,7 @@ public class CronTriggerBean extends CronTrigger /** * Set the misfire instruction via the name of the corresponding * constant in the {@link org.quartz.CronTrigger} class. - * Default is MISFIRE_INSTRUCTION_SMART_POLICY. + * Default is {@code MISFIRE_INSTRUCTION_SMART_POLICY}. * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING * @see org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java index b205e6d73a..101c3fdf04 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/CronTriggerFactoryBean.java @@ -40,7 +40,7 @@ import org.springframework.util.ReflectionUtils; * A Spring {@link FactoryBean} for creating a Quartz {@link org.quartz.CronTrigger} * instance, supporting bean-style usage for trigger configuration. * - *

    CronTrigger(Impl) itself is already a JavaBean but lacks sensible defaults. + *

    {@code CronTrigger(Impl)} itself is already a JavaBean but lacks sensible defaults. * This class uses the Spring bean name as job name, the Quartz default group ("DEFAULT") * as job group, the current time as start time, and indefinite repetition, if not specified. * @@ -58,9 +58,9 @@ import org.springframework.util.ReflectionUtils; * @see #setGroup * @see #setStartDelay * @see #setJobDetail - * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers - * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails - * @see org.springframework.scheduling.quartz.SimpleTriggerBean + * @see SchedulerFactoryBean#setTriggers + * @see SchedulerFactoryBean#setJobDetails + * @see SimpleTriggerBean */ public class CronTriggerFactoryBean implements FactoryBean, BeanNameAware, InitializingBean { @@ -182,7 +182,7 @@ public class CronTriggerFactoryBean implements FactoryBean, BeanNam /** * Set the misfire instruction via the name of the corresponding * constant in the {@link org.quartz.CronTrigger} class. - * Default is MISFIRE_INSTRUCTION_SMART_POLICY. + * Default is {@code MISFIRE_INSTRUCTION_SMART_POLICY}. * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW * @see org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING * @see org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailAwareTrigger.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailAwareTrigger.java index dcbfdc12dc..0971d96d54 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailAwareTrigger.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailAwareTrigger.java @@ -49,7 +49,7 @@ public interface JobDetailAwareTrigger { /** * Return the JobDetail that this Trigger is associated with. - * @return the associated JobDetail, or null if none + * @return the associated JobDetail, or {@code null} if none */ JobDetail getJobDetail(); diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailBean.java index 34c8395c93..44830fea5d 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailBean.java @@ -31,12 +31,12 @@ import org.springframework.context.ApplicationContextAware; * Convenience subclass of Quartz's {@link org.quartz.JobDetail} class, * making bean-style usage easier. * - *

    JobDetail itself is already a JavaBean but lacks + *

    {@code JobDetail} itself is already a JavaBean but lacks * sensible defaults. This class uses the Spring bean name as job name, * and the Quartz default group ("DEFAULT") as job group if not specified. * *

    NOTE: This convenience subclass does not work against Quartz 2.0. - * Use Quartz 2.0's native JobDetailImpl class or the new Quartz 2.0 + * Use Quartz 2.0's native {@code JobDetailImpl} class or the new Quartz 2.0 * builder API instead. Alternatively, switch to Spring's {@link JobDetailFactoryBean} * which largely is a drop-in replacement for this class and its properties and * consistently works against Quartz 1.x as well as Quartz 2.0/2.1. diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailFactoryBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailFactoryBean.java index 921a5e03d4..81d370646a 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailFactoryBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/JobDetailFactoryBean.java @@ -35,7 +35,7 @@ import org.springframework.context.ApplicationContextAware; * A Spring {@link FactoryBean} for creating a Quartz {@link org.quartz.JobDetail} * instance, supporting bean-style usage for JobDetail configuration. * - *

    JobDetail(Impl) itself is already a JavaBean but lacks + *

    {@code JobDetail(Impl)} itself is already a JavaBean but lacks * sensible defaults. This class uses the Spring bean name as job name, * and the Quartz default group ("DEFAULT") as job group if not specified. * diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/LocalTaskExecutorThreadPool.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/LocalTaskExecutorThreadPool.java index 71bcd7852c..e0307f6e25 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/LocalTaskExecutorThreadPool.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/LocalTaskExecutorThreadPool.java @@ -83,8 +83,8 @@ public class LocalTaskExecutorThreadPool implements ThreadPool { // The present implementation always returns 1, making Quartz (1.6) // always schedule any tasks that it feels like scheduling. // This could be made smarter for specific TaskExecutors, - // for example calling getMaximumPoolSize() - getActiveCount() - // on a java.util.concurrent.ThreadPoolExecutor. + // for example calling {@code getMaximumPoolSize() - getActiveCount()} + // on a {@code java.util.concurrent.ThreadPoolExecutor}. return 1; } diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/QuartzJobBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/QuartzJobBean.java index 6b193b43d5..7886278857 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/QuartzJobBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/QuartzJobBean.java @@ -92,7 +92,7 @@ public abstract class QuartzJobBean implements Job { /** * This implementation applies the passed-in job data map as bean property - * values, and delegates to executeInternal afterwards. + * values, and delegates to {@code executeInternal} afterwards. * @see #executeInternal */ public final void execute(JobExecutionContext context) throws JobExecutionException { diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java index 07e85c514c..9c65590231 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java @@ -333,8 +333,8 @@ public abstract class SchedulerAccessor implements ResourceLoaderAware { * Add the given job to the Scheduler, if it doesn't already exist. * Overwrites the job in any case if "overwriteExistingJobs" is set. * @param jobDetail the job to add - * @return true if the job was actually added, - * false if it already existed before + * @return {@code true} if the job was actually added, + * {@code false} if it already existed before * @see #setOverwriteExistingJobs */ private boolean addJobToScheduler(JobDetail jobDetail) throws SchedulerException { @@ -351,8 +351,8 @@ public abstract class SchedulerAccessor implements ResourceLoaderAware { * Add the given trigger to the Scheduler, if it doesn't already exist. * Overwrites the trigger in any case if "overwriteExistingJobs" is set. * @param trigger the trigger to add - * @return true if the trigger was actually added, - * false if it already existed before + * @return {@code true} if the trigger was actually added, + * {@code false} if it already existed before * @see #setOverwriteExistingJobs */ private boolean addTriggerToScheduler(Trigger trigger) throws SchedulerException { 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 966ad09b74..17940bece4 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 @@ -57,7 +57,7 @@ import org.springframework.util.CollectionUtils; * *

    For dynamic registration of jobs at runtime, use a bean reference to * this SchedulerFactoryBean to get direct access to the Quartz Scheduler - * (org.quartz.Scheduler). This allows you to create new jobs + * ({@code org.quartz.Scheduler}). This allows you to create new jobs * and triggers, and also to control and monitor the entire Scheduler. * *

    Note that Quartz instantiates a new Job for each execution, in @@ -201,7 +201,7 @@ public class SchedulerFactoryBean extends SchedulerAccessor implements FactoryBe /** * Set the Quartz SchedulerFactory implementation to use. *

    Default is StdSchedulerFactory, reading in the standard - * quartz.properties from quartz.jar. + * {@code quartz.properties} from {@code quartz.jar}. * To use custom Quartz properties, specify the "configLocation" * or "quartzProperties" bean property on this FactoryBean. * @see org.quartz.impl.StdSchedulerFactory @@ -571,7 +571,7 @@ public class SchedulerFactoryBean extends SchedulerAccessor implements FactoryBe /** * Create the Scheduler instance for the given factory and scheduler name. * Called by {@link #afterPropertiesSet}. - *

    The default implementation invokes SchedulerFactory's getScheduler + *

    The default implementation invokes SchedulerFactory's {@code getScheduler} * method. Can be overridden for custom Scheduler creation. * @param schedulerFactory the factory to create the Scheduler with * @param schedulerName the name of the scheduler to create diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerBean.java index ca9d44c658..045478804f 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerBean.java @@ -32,7 +32,7 @@ import org.springframework.core.Constants; * Convenience subclass of Quartz's {@link org.quartz.SimpleTrigger} class, * making bean-style usage easier. * - *

    SimpleTrigger itself is already a JavaBean but lacks sensible defaults. + *

    {@code SimpleTrigger} itself is already a JavaBean but lacks sensible defaults. * This class uses the Spring bean name as job name, the Quartz default group * ("DEFAULT") as job group, the current time as start time, and indefinite * repetition, if not specified. @@ -43,7 +43,7 @@ import org.springframework.core.Constants; * instead of registering the JobDetail separately. * *

    NOTE: This convenience subclass does not work against Quartz 2.0. - * Use Quartz 2.0's native JobDetailImpl class or the new Quartz 2.0 + * Use Quartz 2.0's native {@code JobDetailImpl} class or the new Quartz 2.0 * builder API instead. Alternatively, switch to Spring's {@link SimpleTriggerFactoryBean} * which largely is a drop-in replacement for this class and its properties and * consistently works against Quartz 1.x as well as Quartz 2.0/2.1. @@ -93,7 +93,7 @@ public class SimpleTriggerBean extends SimpleTrigger /** * Set the misfire instruction via the name of the corresponding * constant in the {@link org.quartz.SimpleTrigger} class. - * Default is MISFIRE_INSTRUCTION_SMART_POLICY. + * Default is {@code MISFIRE_INSTRUCTION_SMART_POLICY}. * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_FIRE_NOW * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerFactoryBean.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerFactoryBean.java index 5baffd047d..15d1e901ab 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerFactoryBean.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SimpleTriggerFactoryBean.java @@ -40,7 +40,7 @@ import org.springframework.util.ReflectionUtils; * A Spring {@link FactoryBean} for creating a Quartz {@link org.quartz.SimpleTrigger} * instance, supporting bean-style usage for trigger configuration. * - *

    SimpleTrigger(Impl) itself is already a JavaBean but lacks sensible defaults. + *

    {@code SimpleTrigger(Impl)} itself is already a JavaBean but lacks sensible defaults. * This class uses the Spring bean name as job name, the Quartz default group ("DEFAULT") * as job group, the current time as start time, and indefinite repetition, if not specified. * @@ -58,9 +58,9 @@ import org.springframework.util.ReflectionUtils; * @see #setGroup * @see #setStartDelay * @see #setJobDetail - * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setTriggers - * @see org.springframework.scheduling.quartz.SchedulerFactoryBean#setJobDetails - * @see org.springframework.scheduling.quartz.CronTriggerBean + * @see SchedulerFactoryBean#setTriggers + * @see SchedulerFactoryBean#setJobDetails + * @see CronTriggerBean */ public class SimpleTriggerFactoryBean implements FactoryBean, BeanNameAware, InitializingBean { @@ -183,7 +183,7 @@ public class SimpleTriggerFactoryBean implements FactoryBean, Bea /** * Set the misfire instruction via the name of the corresponding * constant in the {@link org.quartz.SimpleTrigger} class. - * Default is MISFIRE_INSTRUCTION_SMART_POLICY. + * Default is {@code MISFIRE_INSTRUCTION_SMART_POLICY}. * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_FIRE_NOW * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT * @see org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SpringBeanJobFactory.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SpringBeanJobFactory.java index 5e555e2d04..c6811478ae 100644 --- a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SpringBeanJobFactory.java +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SpringBeanJobFactory.java @@ -53,7 +53,7 @@ public class SpringBeanJobFactory extends AdaptableJobFactory implements Schedul /** * Specify the unknown properties (not found in the bean) that should be ignored. - *

    Default is null, indicating that all unknown properties + *

    Default is {@code null}, indicating that all unknown properties * should be ignored. Specify an empty array to throw an exception in case * of any unknown properties, or a list of property names that should be * ignored if there is no corresponding property found on the particular diff --git a/spring-context-support/src/main/java/org/springframework/ui/freemarker/FreeMarkerConfigurationFactory.java b/spring-context-support/src/main/java/org/springframework/ui/freemarker/FreeMarkerConfigurationFactory.java index 2abf6296e2..d4f050e8a8 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/freemarker/FreeMarkerConfigurationFactory.java +++ b/spring-context-support/src/main/java/org/springframework/ui/freemarker/FreeMarkerConfigurationFactory.java @@ -47,12 +47,12 @@ import org.springframework.util.CollectionUtils; *

    The optional "configLocation" property sets the location of a FreeMarker * properties file, within the current application. FreeMarker properties can be * overridden via "freemarkerSettings". All of these properties will be set by - * calling FreeMarker's Configuration.setSettings() method and are + * calling FreeMarker's {@code Configuration.setSettings()} method and are * subject to constraints set by FreeMarker. * *

    The "freemarkerVariables" property can be used to specify a Map of * shared variables that will be applied to the Configuration via the - * setAllSharedVariables() method. Like setSettings(), + * {@code setAllSharedVariables()} method. Like {@code setSettings()}, * these entries are subject to FreeMarker constraints. * *

    The simplest way to use this class is to specify a "templateLoaderPath"; @@ -109,7 +109,7 @@ public class FreeMarkerConfigurationFactory { /** * Set properties that contain well-known FreeMarker keys which will be - * passed to FreeMarker's Configuration.setSettings method. + * passed to FreeMarker's {@code Configuration.setSettings} method. * @see freemarker.template.Configuration#setSettings */ public void setFreemarkerSettings(Properties settings) { @@ -118,7 +118,7 @@ public class FreeMarkerConfigurationFactory { /** * Set a Map that contains well-known FreeMarker objects which will be passed - * to FreeMarker's Configuration.setAllSharedVariables() method. + * to FreeMarker's {@code Configuration.setAllSharedVariables()} method. * @see freemarker.template.Configuration#setAllSharedVariables */ public void setFreemarkerVariables(Map variables) { @@ -138,7 +138,7 @@ public class FreeMarkerConfigurationFactory { } /** - * Set a List of TemplateLoaders that will be used to search + * Set a List of {@code TemplateLoader}s that will be used to search * for templates. For example, one or more custom loaders such as database * loaders could be configured and injected here. * @deprecated as of Spring 2.0.1, in favor of the "preTemplateLoaders" @@ -154,7 +154,7 @@ public class FreeMarkerConfigurationFactory { } /** - * Set a List of TemplateLoaders that will be used to search + * Set a List of {@code TemplateLoader}s that will be used to search * for templates. For example, one or more custom loaders such as database * loaders could be configured and injected here. *

    The {@link TemplateLoader TemplateLoaders} specified here will be @@ -169,7 +169,7 @@ public class FreeMarkerConfigurationFactory { } /** - * Set a List of TemplateLoaders that will be used to search + * Set a List of {@code TemplateLoader}s that will be used to search * for templates. For example, one or more custom loaders such as database * loaders can be configured. *

    The {@link TemplateLoader TemplateLoaders} specified here will be @@ -198,13 +198,13 @@ public class FreeMarkerConfigurationFactory { * pseudo URLs are supported, as understood by ResourceEditor. Allows for * relative paths when running in an ApplicationContext. *

    Will define a path for the default FreeMarker template loader. - * If a specified resource cannot be resolved to a java.io.File, + * If a specified resource cannot be resolved to a {@code java.io.File}, * a generic SpringTemplateLoader will be used, without modification detection. *

    To enforce the use of SpringTemplateLoader, i.e. to not resolve a path * as file system resource in any case, turn off the "preferFileSystemAccess" * flag. See the latter's javadoc for details. *

    If you wish to specify your own list of TemplateLoaders, do not set this - * property and instead use setTemplateLoaders(List templateLoaders) + * property and instead use {@code setTemplateLoaders(List templateLoaders)} * @see org.springframework.core.io.ResourceEditor * @see org.springframework.context.ApplicationContext#getResource * @see freemarker.template.Configuration#setDirectoryForTemplateLoading @@ -323,7 +323,7 @@ public class FreeMarkerConfigurationFactory { /** * Return a new Configuration object. Subclasses can override this for * custom initialization, or for using a mock object for testing. - *

    Called by createConfiguration(). + *

    Called by {@code createConfiguration()}. * @return the Configuration object * @throws IOException if a config file wasn't found * @throws TemplateException on FreeMarker initialization failure @@ -374,7 +374,7 @@ public class FreeMarkerConfigurationFactory { * To be overridden by subclasses that want to to register custom * TemplateLoader instances after this factory created its default * template loaders. - *

    Called by createConfiguration(). Note that specified + *

    Called by {@code createConfiguration()}. Note that specified * "postTemplateLoaders" will be registered after any loaders * registered by this callback; as a consequence, they are are not * included in the given List. @@ -411,7 +411,7 @@ public class FreeMarkerConfigurationFactory { * To be overridden by subclasses that want to to perform custom * post-processing of the Configuration object after this factory * performed its default initialization. - *

    Called by createConfiguration(). + *

    Called by {@code createConfiguration()}. * @param config the current Configuration object * @throws IOException if a config file wasn't found * @throws TemplateException on FreeMarker initialization failure diff --git a/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java b/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java index a4da611b26..b74611a4b0 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java +++ b/spring-context-support/src/main/java/org/springframework/ui/jasperreports/JasperReportsUtils.java @@ -46,13 +46,13 @@ import net.sf.jasperreports.engine.export.JRXlsExporter; public abstract class JasperReportsUtils { /** - * Convert the given report data value to a JRDataSource. - *

    In the default implementation, a JRDataSource, - * java.util.Collection or object array is detected. - * The latter are converted to JRBeanCollectionDataSource - * or JRBeanArrayDataSource, respectively. + * Convert the given report data value to a {@code JRDataSource}. + *

    In the default implementation, a {@code JRDataSource}, + * {@code java.util.Collection} or object array is detected. + * The latter are converted to {@code JRBeanCollectionDataSource} + * or {@code JRBeanArrayDataSource}, respectively. * @param value the report data value to convert - * @return the JRDataSource (never null) + * @return the JRDataSource (never {@code null}) * @throws IllegalArgumentException if the value could not be converted * @see net.sf.jasperreports.engine.JRDataSource * @see net.sf.jasperreports.engine.data.JRBeanCollectionDataSource @@ -74,14 +74,14 @@ public abstract class JasperReportsUtils { } /** - * Render the supplied JasperPrint instance using the - * supplied JRAbstractExporter instance and write the results - * to the supplied Writer. - *

    Make sure that the JRAbstractExporter implementation - * you supply is capable of writing to a Writer. - * @param exporter the JRAbstractExporter to use to render the report - * @param print the JasperPrint instance to render - * @param writer the Writer to write the result to + * Render the supplied {@code JasperPrint} instance using the + * supplied {@code JRAbstractExporter} instance and write the results + * to the supplied {@code Writer}. + *

    Make sure that the {@code JRAbstractExporter} implementation + * you supply is capable of writing to a {@code Writer}. + * @param exporter the {@code JRAbstractExporter} to use to render the report + * @param print the {@code JasperPrint} instance to render + * @param writer the {@code Writer} to write the result to * @throws JRException if rendering failed */ public static void render(JRExporter exporter, JasperPrint print, Writer writer) @@ -93,14 +93,14 @@ public abstract class JasperReportsUtils { } /** - * Render the supplied JasperPrint instance using the - * supplied JRAbstractExporter instance and write the results - * to the supplied OutputStream. - *

    Make sure that the JRAbstractExporter implementation you - * supply is capable of writing to a OutputStream. - * @param exporter the JRAbstractExporter to use to render the report - * @param print the JasperPrint instance to render - * @param outputStream the OutputStream to write the result to + * Render the supplied {@code JasperPrint} instance using the + * supplied {@code JRAbstractExporter} instance and write the results + * to the supplied {@code OutputStream}. + *

    Make sure that the {@code JRAbstractExporter} implementation you + * supply is capable of writing to a {@code OutputStream}. + * @param exporter the {@code JRAbstractExporter} to use to render the report + * @param print the {@code JasperPrint} instance to render + * @param outputStream the {@code OutputStream} to write the result to * @throws JRException if rendering failed */ public static void render(JRExporter exporter, JasperPrint print, OutputStream outputStream) @@ -113,11 +113,11 @@ public abstract class JasperReportsUtils { /** * Render a report in CSV format using the supplied report data. - * Writes the results to the supplied Writer. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code Writer}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param writer the Writer to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param writer the {@code Writer} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @throws JRException if rendering failed * @see #convertReportData @@ -131,11 +131,11 @@ public abstract class JasperReportsUtils { /** * Render a report in CSV format using the supplied report data. - * Writes the results to the supplied Writer. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code Writer}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param writer the Writer to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param writer the {@code Writer} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @param exporterParameters a {@link Map} of {@link JRExporterParameter exporter parameters} * @throws JRException if rendering failed @@ -152,11 +152,11 @@ public abstract class JasperReportsUtils { /** * Render a report in HTML format using the supplied report data. - * Writes the results to the supplied Writer. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code Writer}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param writer the Writer to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param writer the {@code Writer} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @throws JRException if rendering failed * @see #convertReportData @@ -170,11 +170,11 @@ public abstract class JasperReportsUtils { /** * Render a report in HTML format using the supplied report data. - * Writes the results to the supplied Writer. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code Writer}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param writer the Writer to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param writer the {@code Writer} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @param exporterParameters a {@link Map} of {@link JRExporterParameter exporter parameters} * @throws JRException if rendering failed @@ -191,11 +191,11 @@ public abstract class JasperReportsUtils { /** * Render a report in PDF format using the supplied report data. - * Writes the results to the supplied OutputStream. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code OutputStream}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param stream the OutputStream to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param stream the {@code OutputStream} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @throws JRException if rendering failed * @see #convertReportData @@ -209,11 +209,11 @@ public abstract class JasperReportsUtils { /** * Render a report in PDF format using the supplied report data. - * Writes the results to the supplied OutputStream. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code OutputStream}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param stream the OutputStream to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param stream the {@code OutputStream} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @param exporterParameters a {@link Map} of {@link JRExporterParameter exporter parameters} * @throws JRException if rendering failed @@ -230,11 +230,11 @@ public abstract class JasperReportsUtils { /** * Render a report in XLS format using the supplied report data. - * Writes the results to the supplied OutputStream. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code OutputStream}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param stream the OutputStream to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param stream the {@code OutputStream} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @throws JRException if rendering failed * @see #convertReportData @@ -248,11 +248,11 @@ public abstract class JasperReportsUtils { /** * Render a report in XLS format using the supplied report data. - * Writes the results to the supplied OutputStream. - * @param report the JasperReport instance to render + * Writes the results to the supplied {@code OutputStream}. + * @param report the {@code JasperReport} instance to render * @param parameters the parameters to use for rendering - * @param stream the OutputStream to write the rendered report to - * @param reportData a JRDataSource, java.util.Collection or object array + * @param stream the {@code OutputStream} to write the rendered report to + * @param reportData a {@code JRDataSource}, {@code java.util.Collection} or object array * (converted accordingly), representing the report data to read fields from * @param exporterParameters a {@link Map} of {@link JRExporterParameter exporter parameters} * @throws JRException if rendering failed diff --git a/spring-context-support/src/main/java/org/springframework/ui/velocity/CommonsLoggingLogSystem.java b/spring-context-support/src/main/java/org/springframework/ui/velocity/CommonsLoggingLogSystem.java index b845d6c6ae..160516db63 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/velocity/CommonsLoggingLogSystem.java +++ b/spring-context-support/src/main/java/org/springframework/ui/velocity/CommonsLoggingLogSystem.java @@ -26,14 +26,14 @@ import org.apache.velocity.runtime.log.LogSystem; * Velocity LogSystem implementation for Jakarta Commons Logging. * Used by VelocityConfigurer to redirect log output. * - *

    NOTE: To be replaced by Velocity 1.5's LogChute mechanism - * and Velocity 1.6's CommonsLogLogChute implementation once we + *

    NOTE: To be replaced by Velocity 1.5's {@code LogChute} mechanism + * and Velocity 1.6's {@code CommonsLogLogChute} implementation once we * upgrade to Velocity 1.6+ (likely Velocity 1.7+) in a future version of Spring. * * @author Juergen Hoeller * @since 07.08.2003 * @see VelocityEngineFactoryBean - * @deprecated as of Spring 3.2, in favor of Velocity 1.6's CommonsLogLogChute + * @deprecated as of Spring 3.2, in favor of Velocity 1.6's {@code CommonsLogLogChute} */ @Deprecated public class CommonsLoggingLogSystem implements LogSystem { diff --git a/spring-context-support/src/main/java/org/springframework/ui/velocity/SpringResourceLoader.java b/spring-context-support/src/main/java/org/springframework/ui/velocity/SpringResourceLoader.java index e93ed15530..f03a8e6190 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/velocity/SpringResourceLoader.java +++ b/spring-context-support/src/main/java/org/springframework/ui/velocity/SpringResourceLoader.java @@ -32,15 +32,15 @@ import org.springframework.util.StringUtils; /** * Velocity ResourceLoader adapter that loads via a Spring ResourceLoader. * Used by VelocityEngineFactory for any resource loader path that cannot - * be resolved to a java.io.File. + * be resolved to a {@code java.io.File}. * *

    Note that this loader does not allow for modification detection: - * Use Velocity's default FileResourceLoader for java.io.File + * Use Velocity's default FileResourceLoader for {@code java.io.File} * resources. * *

    Expects "spring.resource.loader" and "spring.resource.loader.path" * application attributes in the Velocity runtime: the former of type - * org.springframework.core.io.ResourceLoader, the latter a String. + * {@code org.springframework.core.io.ResourceLoader}, the latter a String. * * @author Juergen Hoeller * @since 14.03.2004 diff --git a/spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactory.java b/spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactory.java index 302f989f7b..0ff54aeba0 100644 --- a/spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactory.java +++ b/spring-context-support/src/main/java/org/springframework/ui/velocity/VelocityEngineFactory.java @@ -131,7 +131,7 @@ public class VelocityEngineFactory { * pseudo URLs are supported, as understood by ResourceLoader. Allows for * relative paths when running in an ApplicationContext. *

    Will define a path for the default Velocity resource loader with the name - * "file". If the specified resource cannot be resolved to a java.io.File, + * "file". If the specified resource cannot be resolved to a {@code java.io.File}, * a generic SpringResourceLoader will be used under the name "spring", without * modification detection. *

    Note that resource caching will be enabled in any case. With the file @@ -270,7 +270,7 @@ public class VelocityEngineFactory { /** * Return a new VelocityEngine. Subclasses can override this for * custom initialization, or for using a mock object for testing. - *

    Called by createVelocityEngine(). + *

    Called by {@code createVelocityEngine()}. * @return the VelocityEngine instance * @throws IOException if a config file wasn't found * @throws VelocityException on Velocity initialization failure @@ -283,7 +283,7 @@ public class VelocityEngineFactory { /** * Initialize a Velocity resource loader for the given VelocityEngine: * either a standard Velocity FileResourceLoader or a SpringResourceLoader. - *

    Called by createVelocityEngine(). + *

    Called by {@code createVelocityEngine()}. * @param velocityEngine the VelocityEngine to configure * @param resourceLoaderPath the path to load Velocity resources from * @see org.apache.velocity.runtime.resource.loader.FileResourceLoader @@ -334,7 +334,7 @@ public class VelocityEngineFactory { /** * Initialize a SpringResourceLoader for the given VelocityEngine. - *

    Called by initVelocityResourceLoader. + *

    Called by {@code initVelocityResourceLoader}. * @param velocityEngine the VelocityEngine to configure * @param resourceLoaderPath the path to load Velocity resources from * @see SpringResourceLoader @@ -357,7 +357,7 @@ public class VelocityEngineFactory { * To be implemented by subclasses that want to to perform custom * post-processing of the VelocityEngine after this FactoryBean * performed its default configuration (but before VelocityEngine.init). - *

    Called by createVelocityEngine(). + *

    Called by {@code createVelocityEngine()}. * @param velocityEngine the current VelocityEngine * @throws IOException if a config file wasn't found * @throws VelocityException on Velocity initialization failure 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 32cedfe6de..5035789d1e 100644 --- a/spring-context/src/main/java/org/springframework/cache/Cache.java +++ b/spring-context/src/main/java/org/springframework/cache/Cache.java @@ -40,10 +40,10 @@ public interface Cache { /** * Return the value to which this cache maps the specified key. Returns - * null if the cache contains no mapping for this key. + * {@code null} if the cache contains no mapping for this key. * @param key key whose associated value is to be returned. * @return the value to which this cache maps the specified key, - * or null if the cache contains no mapping for this key + * or {@code null} if the cache contains no mapping for this key */ ValueWrapper get(Object key); diff --git a/spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCache.java b/spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCache.java index 0da4c6850b..11891d48bb 100644 --- a/spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCache.java +++ b/spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCache.java @@ -73,7 +73,7 @@ public class ConcurrentMapCache implements Cache { * given internal ConcurrentMap to use. * @param name the name of the cache * @param store the ConcurrentMap to use as an internal store - * @param allowNullValues whether to allow null values + * @param allowNullValues whether to allow {@code null} values * (adapting them to an internal null holder value) */ public ConcurrentMapCache(String name, ConcurrentMap store, boolean allowNullValues) { @@ -115,7 +115,7 @@ public class ConcurrentMapCache implements Cache { /** * Convert the given value from the internal store to a user value - * returned from the get method (adapting null). + * returned from the get method (adapting {@code null}). * @param storeValue the store value * @return the value to return to the user */ @@ -128,7 +128,7 @@ public class ConcurrentMapCache implements Cache { /** * Convert the given user value, as passed into the put method, - * to a value in the internal store (adapting null). + * to a value in the internal store (adapting {@code null}). * @param userValue the given user value * @return the value to store */ diff --git a/spring-context/src/main/java/org/springframework/cache/support/SimpleValueWrapper.java b/spring-context/src/main/java/org/springframework/cache/support/SimpleValueWrapper.java index 8f2fb39166..5ff3aaf9e8 100644 --- a/spring-context/src/main/java/org/springframework/cache/support/SimpleValueWrapper.java +++ b/spring-context/src/main/java/org/springframework/cache/support/SimpleValueWrapper.java @@ -32,7 +32,7 @@ public class SimpleValueWrapper implements ValueWrapper { /** * Create a new SimpleValueWrapper instance for exposing the given value. - * @param value the value to expose (may be null) + * @param value the value to expose (may be {@code null}) */ public SimpleValueWrapper(Object value) { this.value = value; 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 2ded439068..2565e481a3 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationContext.java @@ -59,7 +59,7 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact /** * Return the unique id of this application context. - * @return the unique id of the context, or null if none + * @return the unique id of the context, or {@code null} if none */ String getId(); @@ -71,8 +71,8 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact /** * Return a friendly name for this context. - * @return a display name for this context (never null) - */ + * @return a display name for this context (never {@code null}) + */ String getDisplayName(); /** @@ -82,9 +82,9 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact long getStartupDate(); /** - * Return the parent context, or null if there is no parent + * Return the parent context, or {@code null} if there is no parent * and this is the root of the context hierarchy. - * @return the parent context, or null if there is no parent + * @return the parent context, or {@code null} if there is no parent */ ApplicationContext getParent(); @@ -101,7 +101,7 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact * @return the AutowireCapableBeanFactory for this context * @throws IllegalStateException if the context does not support * the AutowireCapableBeanFactory interface or does not hold an autowire-capable - * bean factory yet (usually if refresh() has never been called) + * bean factory yet (usually if {@code refresh()} has never been called) * @see ConfigurableApplicationContext#refresh() * @see ConfigurableApplicationContext#getBeanFactory() */ diff --git a/spring-context/src/main/java/org/springframework/context/ApplicationContextAware.java b/spring-context/src/main/java/org/springframework/context/ApplicationContextAware.java index 8c74f2974a..594af464c0 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationContextAware.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationContextAware.java @@ -29,7 +29,7 @@ import org.springframework.beans.factory.Aware; * for bean lookup purposes. * *

    This interface can also be implemented if an object needs access to file - * resources, i.e. wants to call getResource, wants to publish + * resources, i.e. wants to call {@code getResource}, wants to publish * an application event, or requires access to the MessageSource. However, * it is preferable to implement the more specific {@link ResourceLoaderAware}, * {@link ApplicationEventPublisherAware} or {@link MessageSourceAware} interface diff --git a/spring-context/src/main/java/org/springframework/context/ApplicationContextException.java b/spring-context/src/main/java/org/springframework/context/ApplicationContextException.java index 9c9f4066a4..9956972b12 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationContextException.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationContextException.java @@ -26,7 +26,7 @@ import org.springframework.beans.FatalBeanException; public class ApplicationContextException extends FatalBeanException { /** - * Create a new ApplicationContextException + * Create a new {@code ApplicationContextException} * with the specified detail message and no root cause. * @param msg the detail message */ @@ -35,7 +35,7 @@ public class ApplicationContextException extends FatalBeanException { } /** - * Create a new ApplicationContextException + * Create a new {@code ApplicationContextException} * with the specified detail message and the given root cause. * @param msg the detail message * @param cause the root cause diff --git a/spring-context/src/main/java/org/springframework/context/ApplicationEvent.java b/spring-context/src/main/java/org/springframework/context/ApplicationEvent.java index 66bddfcfd2..464a440af6 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationEvent.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationEvent.java @@ -36,7 +36,7 @@ public abstract class ApplicationEvent extends EventObject { /** * Create a new ApplicationEvent. - * @param source the component that published the event (never null) + * @param source the component that published the event (never {@code null}) */ public ApplicationEvent(Object source) { super(source); diff --git a/spring-context/src/main/java/org/springframework/context/ApplicationListener.java b/spring-context/src/main/java/org/springframework/context/ApplicationListener.java index fc40e50222..d79e741cff 100644 --- a/spring-context/src/main/java/org/springframework/context/ApplicationListener.java +++ b/spring-context/src/main/java/org/springframework/context/ApplicationListener.java @@ -20,7 +20,7 @@ import java.util.EventListener; /** * Interface to be implemented by application event listeners. - * Based on the standard java.util.EventListener interface + * Based on the standard {@code java.util.EventListener} interface * for the Observer design pattern. * *

    As of Spring 3.0, an ApplicationListener can generically declare the event type diff --git a/spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java b/spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java index 264d9b569e..9d0bdc4b7c 100644 --- a/spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java @@ -153,10 +153,10 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life /** * Close this application context, releasing all resources and locks that the * implementation might hold. This includes destroying all cached singleton beans. - *

    Note: Does not invoke close on a parent context; + *

    Note: Does not invoke {@code close} on a parent context; * parent contexts have their own, independent lifecycle. *

    This method can be called multiple times without side effects: Subsequent - * close calls on an already closed context will be ignored. + * {@code close} calls on an already closed context will be ignored. */ void close(); diff --git a/spring-context/src/main/java/org/springframework/context/HierarchicalMessageSource.java b/spring-context/src/main/java/org/springframework/context/HierarchicalMessageSource.java index dc15274a85..3339abe70e 100644 --- a/spring-context/src/main/java/org/springframework/context/HierarchicalMessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/HierarchicalMessageSource.java @@ -30,12 +30,12 @@ public interface HierarchicalMessageSource extends MessageSource { * that this object can't resolve. * @param parent the parent MessageSource that will be used to * resolve messages that this object can't resolve. - * May be null, in which case no further resolution is possible. + * May be {@code null}, in which case no further resolution is possible. */ void setParentMessageSource(MessageSource parent); /** - * Return the parent of this MessageSource, or null if none. + * Return the parent of this MessageSource, or {@code null} if none. */ MessageSource getParentMessageSource(); 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 748bb35041..b1d00e13f2 100644 --- a/spring-context/src/main/java/org/springframework/context/Lifecycle.java +++ b/spring-context/src/main/java/org/springframework/context/Lifecycle.java @@ -68,7 +68,7 @@ public interface Lifecycle { /** * Check whether this component is currently running. - *

    In the case of a container, this will return true + *

    In the case of a container, this will return {@code true} * only if all components that apply are currently running. * @return whether the component is currently running */ 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 b83ec2a014..62e1f9729b 100644 --- a/spring-context/src/main/java/org/springframework/context/MessageSource.java +++ b/spring-context/src/main/java/org/springframework/context/MessageSource.java @@ -44,7 +44,7 @@ public interface MessageSource { * qualified class name, thus avoiding conflict and ensuring maximum clarity. * @param args array of arguments that will be filled in for params within * the message (params look like "{0}", "{1,date}", "{2,time}" within a message), - * or null if none. + * or {@code null} if none. * @param defaultMessage String to return if the lookup fails * @param locale the Locale in which to do the lookup * @return the resolved message if the lookup was successful; @@ -58,7 +58,7 @@ public interface MessageSource { * @param code the code to lookup up, such as 'calculator.noRateSet' * @param args Array of arguments that will be filled in for params within * the message (params look like "{0}", "{1,date}", "{2,time}" within a message), - * or null if none. + * or {@code null} if none. * @param locale the Locale in which to do the lookup * @return the resolved message * @throws NoSuchMessageException if the message wasn't found @@ -68,10 +68,10 @@ public interface MessageSource { /** * Try to resolve the message using all the attributes contained within the - * MessageSourceResolvable argument that was passed in. - *

    NOTE: We must throw a NoSuchMessageException on this method + * {@code MessageSourceResolvable} argument that was passed in. + *

    NOTE: We must throw a {@code NoSuchMessageException} on this method * since at the time of calling this method we aren't able to determine if the - * defaultMessage property of the resolvable is null or not. + * {@code defaultMessage} property of the resolvable is null or not. * @param resolvable value object storing attributes required to properly resolve a message * @param locale the Locale in which to do the lookup * @return the resolved message diff --git a/spring-context/src/main/java/org/springframework/context/MessageSourceResolvable.java b/spring-context/src/main/java/org/springframework/context/MessageSourceResolvable.java index 6590f111d5..d344a6dadf 100644 --- a/spring-context/src/main/java/org/springframework/context/MessageSourceResolvable.java +++ b/spring-context/src/main/java/org/springframework/context/MessageSourceResolvable.java @@ -46,7 +46,7 @@ public interface MessageSourceResolvable { /** * Return the default message to be used to resolve this message. - * @return the default message, or null if no default + * @return the default message, or {@code null} if no default */ String getDefaultMessage(); diff --git a/spring-context/src/main/java/org/springframework/context/ResourceLoaderAware.java b/spring-context/src/main/java/org/springframework/context/ResourceLoaderAware.java index 6b413e6204..c13e5902f3 100644 --- a/spring-context/src/main/java/org/springframework/context/ResourceLoaderAware.java +++ b/spring-context/src/main/java/org/springframework/context/ResourceLoaderAware.java @@ -41,7 +41,7 @@ import org.springframework.core.io.ResourceLoader; * to resolve resource patterns into arrays of Resource objects. This will always * work when running in an ApplicationContext (the context interface extends * ResourcePatternResolver). Use a PathMatchingResourcePatternResolver as default. - * See also the ResourcePatternUtils.getResourcePatternResolver method. + * See also the {@code ResourcePatternUtils.getResourcePatternResolver} method. * *

    As alternative to a ResourcePatternResolver dependency, consider exposing * bean properties of type Resource array, populated via pattern Strings with @@ -64,11 +64,11 @@ public interface ResourceLoaderAware extends Aware { /** * Set the ResourceLoader that this object runs in. *

    This might be a ResourcePatternResolver, which can be checked - * through instanceof ResourcePatternResolver. See also the - * ResourcePatternUtils.getResourcePatternResolver method. + * through {@code instanceof ResourcePatternResolver}. See also the + * {@code ResourcePatternUtils.getResourcePatternResolver} method. *

    Invoked after population of normal bean properties but before an init callback - * like InitializingBean's afterPropertiesSet or a custom init-method. - * Invoked before ApplicationContextAware's setApplicationContext. + * like InitializingBean's {@code afterPropertiesSet} or a custom init-method. + * Invoked before ApplicationContextAware's {@code setApplicationContext}. * @param resourceLoader ResourceLoader object to be used by this object * @see org.springframework.core.io.support.ResourcePatternResolver * @see org.springframework.core.io.support.ResourcePatternUtils#getResourcePatternResolver diff --git a/spring-context/src/main/java/org/springframework/context/access/ContextBeanFactoryReference.java b/spring-context/src/main/java/org/springframework/context/access/ContextBeanFactoryReference.java index 43d674367d..4a608ec060 100644 --- a/spring-context/src/main/java/org/springframework/context/access/ContextBeanFactoryReference.java +++ b/spring-context/src/main/java/org/springframework/context/access/ContextBeanFactoryReference.java @@ -25,9 +25,9 @@ import org.springframework.context.ConfigurableApplicationContext; * ApplicationContext-specific implementation of BeanFactoryReference, * wrapping a newly created ApplicationContext, closing it on release. * - *

    As per BeanFactoryReference contract, release may be called + *

    As per BeanFactoryReference contract, {@code release} may be called * more than once, with subsequent calls not doing anything. However, calling - * getFactory after a release call will cause an exception. + * {@code getFactory} after a {@code release} call will cause an exception. * * @author Juergen Hoeller * @author Colin Sampaleanu diff --git a/spring-context/src/main/java/org/springframework/context/access/ContextJndiBeanFactoryLocator.java b/spring-context/src/main/java/org/springframework/context/access/ContextJndiBeanFactoryLocator.java index 9996b9473b..8372bb00b9 100644 --- a/spring-context/src/main/java/org/springframework/context/access/ContextJndiBeanFactoryLocator.java +++ b/spring-context/src/main/java/org/springframework/context/access/ContextJndiBeanFactoryLocator.java @@ -50,9 +50,9 @@ public class ContextJndiBeanFactoryLocator extends JndiLocatorSupport implements /** * Load/use a bean factory, as specified by a factory key which is a JNDI - * address, of the form java:comp/env/ejb/BeanFactoryPath. The + * address, of the form {@code java:comp/env/ejb/BeanFactoryPath}. The * contents of this JNDI location must be a string containing one or more - * classpath resource names (separated by any of the delimiters ',; \t\n' + * classpath resource names (separated by any of the delimiters '{@code ,; \t\n}' * if there is more than one. The resulting BeanFactory (or ApplicationContext) * will be created from the combined resources. * @see #createBeanFactory @@ -77,7 +77,7 @@ public class ContextJndiBeanFactoryLocator extends JndiLocatorSupport implements * Create the BeanFactory instance, given an array of class path resource Strings * which should be combined. This is split out as a separate method so that * subclasses can override the actual BeanFactory implementation class. - *

    Delegates to createApplicationContext by default, + *

    Delegates to {@code createApplicationContext} by default, * wrapping the result in a ContextBeanFactoryReference. * @param resources an array of Strings representing classpath resource names * @return the created BeanFactory, wrapped in a BeanFactoryReference diff --git a/spring-context/src/main/java/org/springframework/context/access/ContextSingletonBeanFactoryLocator.java b/spring-context/src/main/java/org/springframework/context/access/ContextSingletonBeanFactoryLocator.java index cc250cafdd..2f9d9d5cc8 100644 --- a/spring-context/src/main/java/org/springframework/context/access/ContextSingletonBeanFactoryLocator.java +++ b/spring-context/src/main/java/org/springframework/context/access/ContextSingletonBeanFactoryLocator.java @@ -60,7 +60,7 @@ public class ContextSingletonBeanFactoryLocator extends SingletonBeanFactoryLoca /** * Returns an instance which uses the default "classpath*:beanRefContext.xml", as * the name of the definition file(s). All resources returned by the current - * thread's context class loader's getResources method with this + * thread's context class loader's {@code getResources} method with this * name will be combined to create a definition, which is just a BeanFactory. * @return the corresponding BeanFactoryLocator instance * @throws BeansException in case of factory loading failure @@ -73,7 +73,7 @@ public class ContextSingletonBeanFactoryLocator extends SingletonBeanFactoryLoca * Returns an instance which uses the the specified selector, as the name of the * definition file(s). In the case of a name with a Spring "classpath*:" prefix, * or with no prefix, which is treated the same, the current thread's context class - * loader's getResources method will be called with this value to get + * loader's {@code getResources} method will be called with this value to get * all resources having that name. These resources will then be combined to form a * definition. In the case where the name uses a Spring "classpath:" prefix, or * a standard URL prefix, then only one resource file will be loaded as the 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 1a185248ba..c09600998c 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 @@ -79,7 +79,7 @@ public class AnnotationBeanNameGenerator implements BeanNameGenerator { /** * Derive a bean name from one of the annotations on the class. * @param annotatedDef the annotation-aware bean definition - * @return the bean name, or null if none is found + * @return the bean name, or {@code null} if none is found */ protected String determineBeanNameFromAnnotation(AnnotatedBeanDefinition annotatedDef) { AnnotationMetadata amd = annotatedDef.getMetadata(); @@ -103,7 +103,7 @@ public class AnnotationBeanNameGenerator implements BeanNameGenerator { /** * Check whether the given annotation is a stereotype that is allowed - * to suggest a component name through its annotation value(). + * to suggest a component name through its annotation {@code value()}. * @param annotationType the name of the annotation class to check * @param metaAnnotationTypes the names of meta-annotations on the given annotation * @param attributes the map of attributes for the given annotation @@ -124,7 +124,7 @@ public class AnnotationBeanNameGenerator implements BeanNameGenerator { *

    The default implementation delegates to {@link #buildDefaultBeanName(BeanDefinition)}. * @param definition the bean definition to build a bean name for * @param registry the registry that the given bean definition is being registered with - * @return the default bean name (never null) + * @return the default bean name (never {@code null}) */ protected String buildDefaultBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) { return buildDefaultBeanName(definition); @@ -138,7 +138,7 @@ public class AnnotationBeanNameGenerator implements BeanNameGenerator { * "outerClassName.innerClassName", which because of the period in the * name may be an issue if you are autowiring by name. * @param definition the bean definition to build a bean name for - * @return the default bean name (never null) + * @return the default bean name (never {@code null}) */ protected String buildDefaultBeanName(BeanDefinition definition) { String shortClassName = ClassUtils.getShortName(definition.getBeanClassName()); diff --git a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigUtils.java b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigUtils.java index 793ba314b4..f283bb6d2c 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigUtils.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigUtils.java @@ -170,7 +170,7 @@ public class AnnotationConfigUtils { * Register all relevant annotation post processors in the given registry. * @param registry the registry to operate on * @param source the configuration source element (already extracted) - * that this registration was triggered from. May be null. + * that this registration was triggered from. May be {@code null}. * @return a Set of BeanDefinitionHolders, containing all bean definitions * that have actually been registered by this call */ diff --git a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationScopeMetadataResolver.java b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationScopeMetadataResolver.java index 493745bd82..f678425ea8 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/AnnotationScopeMetadataResolver.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/AnnotationScopeMetadataResolver.java @@ -44,7 +44,7 @@ public class AnnotationScopeMetadataResolver implements ScopeMetadataResolver { private final ScopedProxyMode defaultProxyMode; /** - * Create a new instance of the AnnotationScopeMetadataResolver class. + * Create a new instance of the {@code AnnotationScopeMetadataResolver} class. * @see #AnnotationScopeMetadataResolver(ScopedProxyMode) * @see ScopedProxyMode#NO */ @@ -53,7 +53,7 @@ public class AnnotationScopeMetadataResolver implements ScopeMetadataResolver { } /** - * Create a new instance of the AnnotationScopeMetadataResolver class. + * Create a new instance of the {@code AnnotationScopeMetadataResolver} class. * @param defaultProxyMode the desired scoped-proxy mode */ public AnnotationScopeMetadataResolver(ScopedProxyMode defaultProxyMode) { 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 4f40ea26ae..a0c8ab1159 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 @@ -78,7 +78,7 @@ import org.springframework.beans.factory.support.AbstractBeanDefinition; * classes. In this case, bean methods may reference other {@code @Bean} methods * in the same class by calling them directly. This ensures that references between * beans are strongly typed and navigable. Such so-called 'inter-bean references' are - * guaranteed to respect scoping and AOP semantics, just like getBean() lookups + * guaranteed to respect scoping and AOP semantics, just like {@code getBean()} lookups * would. These are the semantics known from the original 'Spring JavaConfig' project * which require CGLIB subclassing of each such configuration class at runtime. As a * consequence, {@code @Configuration} classes and their factory methods must not be 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 bc2ed4e63c..9b6917c580 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 @@ -291,8 +291,8 @@ public class ClassPathBeanDefinitionScanner extends ClassPathScanningCandidateCo * bean definition needs to be registered or conflicts with an existing definition. * @param beanName the suggested name for the bean * @param beanDefinition the corresponding bean definition - * @return true if the bean can be registered as-is; - * false if it should be skipped because there is an + * @return {@code true} if the bean can be registered as-is; + * {@code false} if it should be skipped because there is an * existing, compatible bean definition for the specified name * @throws ConflictingBeanDefinitionException if an existing, incompatible * bean definition has been found for the specified name 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 4de429f2c4..a105e147f7 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 @@ -69,7 +69,7 @@ import org.springframework.util.StringUtils; /** * {@link org.springframework.beans.factory.config.BeanPostProcessor} implementation * that supports common Java annotations out of the box, in particular the JSR-250 - * annotations in the javax.annotation package. These common Java + * annotations in the {@code javax.annotation} package. These common Java * annotations are supported in many Java EE 5 technologies (e.g. JSF 1.2), * as well as in Java 6's JAX-WS. * @@ -80,9 +80,9 @@ import org.springframework.util.StringUtils; * *

    The central element is the {@link javax.annotation.Resource} annotation * for annotation-driven injection of named beans, by default from the containing - * Spring BeanFactory, with only mappedName references resolved in JNDI. + * Spring BeanFactory, with only {@code mappedName} references resolved in JNDI. * The {@link #setAlwaysUseJndiLookup "alwaysUseJndiLookup" flag} enforces JNDI lookups - * equivalent to standard Java EE 5 resource injection for name references + * equivalent to standard Java EE 5 resource injection for {@code name} references * and default names as well. The target beans can be simple POJOs, with no special * requirements other than the type having to match. * @@ -116,9 +116,9 @@ import org.springframework.util.StringUtils; * <property name="alwaysUseJndiLookup" value="true"/> * </bean> * - * mappedName references will always be resolved in JNDI, + * {@code mappedName} references will always be resolved in JNDI, * allowing for global JNDI names (including "java:" prefix) as well. The - * "alwaysUseJndiLookup" flag just affects name references and + * "alwaysUseJndiLookup" flag just affects {@code name} references and * default names (inferred from the field name / property name). * *

    NOTE: A default CommonAnnotationBeanPostProcessor will be registered @@ -196,9 +196,9 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean /** - * Ignore the given resource type when resolving @Resource + * Ignore the given resource type when resolving {@code @Resource} * annotations. - *

    By default, the javax.xml.ws.WebServiceContext interface + *

    By default, the {@code javax.xml.ws.WebServiceContext} interface * will be ignored, since it will be resolved by the JAX-WS runtime. * @param resourceType the resource type to ignore */ @@ -223,11 +223,11 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean /** * Set whether to always use JNDI lookups equivalent to standard Java EE 5 resource - * injection, even for name attributes and default names. + * injection, even for {@code name} attributes and default names. *

    Default is "false": Resource names are used for Spring bean lookups in the - * containing BeanFactory; only mappedName attributes point directly + * containing BeanFactory; only {@code mappedName} attributes point directly * into JNDI. Switch this flag to "true" for enforcing Java EE style JNDI lookups - * in any case, even for name attributes and default names. + * in any case, even for {@code name} attributes and default names. * @see #setJndiFactory * @see #setResourceFactory */ @@ -236,11 +236,11 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean } /** - * Specify the factory for objects to be injected into @Resource / - * @WebServiceRef / @EJB annotated fields and setter methods, - * for mappedName attributes that point directly into JNDI. + * Specify the factory for objects to be injected into {@code @Resource} / + * {@code @WebServiceRef} / {@code @EJB} annotated fields and setter methods, + * for {@code mappedName} attributes that point directly into JNDI. * This factory will also be used if "alwaysUseJndiLookup" is set to "true" in order - * to enforce JNDI lookups even for name attributes and default names. + * to enforce JNDI lookups even for {@code name} attributes and default names. *

    The default is a {@link org.springframework.jndi.support.SimpleJndiBeanFactory} * for JNDI lookup behavior equivalent to standard Java EE 5 resource injection. * @see #setResourceFactory @@ -252,15 +252,15 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean } /** - * Specify the factory for objects to be injected into @Resource / - * @WebServiceRef / @EJB annotated fields and setter methods, - * for name attributes and default names. + * Specify the factory for objects to be injected into {@code @Resource} / + * {@code @WebServiceRef} / {@code @EJB} annotated fields and setter methods, + * for {@code name} attributes and default names. *

    The default is the BeanFactory that this post-processor is defined in, * if any, looking up resource names as Spring bean names. Specify the resource * factory explicitly for programmatic usage of this post-processor. *

    Specifying Spring's {@link org.springframework.jndi.support.SimpleJndiBeanFactory} * leads to JNDI lookup behavior equivalent to standard Java EE 5 resource injection, - * even for name attributes and default names. This is the same behavior + * even for {@code name} attributes and default names. This is the same behavior * that the "alwaysUseJndiLookup" flag enables. * @see #setAlwaysUseJndiLookup */ @@ -399,7 +399,7 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean * Obtain the resource object for the given name and type. * @param element the descriptor for the annotated field/method * @param requestingBeanName the name of the requesting bean - * @return the resource object (never null) + * @return the resource object (never {@code null}) * @throws BeansException if we failed to obtain the target resource */ protected Object getResource(LookupElement element, String requestingBeanName) throws BeansException { @@ -422,7 +422,7 @@ public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBean * @param factory the factory to autowire against * @param element the descriptor for the annotated field/method * @param requestingBeanName the name of the requesting bean - * @return the resource object (never null) + * @return the resource object (never {@code null}) * @throws BeansException if we failed to obtain the target resource */ protected Object autowireResource(BeanFactory factory, LookupElement element, String requestingBeanName) diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ScopeMetadataResolver.java b/spring-context/src/main/java/org/springframework/context/annotation/ScopeMetadataResolver.java index 54bafe39a5..03a8a1306f 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/ScopeMetadataResolver.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/ScopeMetadataResolver.java @@ -29,15 +29,15 @@ public interface ScopeMetadataResolver { /** * Resolve the {@link ScopeMetadata} appropriate to the supplied - * bean definition. + * bean {@code definition}. *

    Implementations can of course use any strategy they like to * determine the scope metadata, but some implementations that spring * immediately to mind might be to use source level annotations * present on {@link BeanDefinition#getBeanClassName() the class} of the - * supplied definition, or to use metadata present in the - * {@link BeanDefinition#attributeNames()} of the supplied definition. + * supplied {@code definition}, or to use metadata present in the + * {@link BeanDefinition#attributeNames()} of the supplied {@code definition}. * @param definition the target bean definition - * @return the relevant scope metadata; never null + * @return the relevant scope metadata; never {@code null} */ ScopeMetadata resolveScopeMetadata(BeanDefinition definition); diff --git a/spring-context/src/main/java/org/springframework/context/config/ContextNamespaceHandler.java b/spring-context/src/main/java/org/springframework/context/config/ContextNamespaceHandler.java index 62f83a8f0d..b095d47d98 100644 --- a/spring-context/src/main/java/org/springframework/context/config/ContextNamespaceHandler.java +++ b/spring-context/src/main/java/org/springframework/context/config/ContextNamespaceHandler.java @@ -22,7 +22,7 @@ import org.springframework.context.annotation.ComponentScanBeanDefinitionParser; /** * {@link org.springframework.beans.factory.xml.NamespaceHandler} - * for the 'context' namespace. + * for the '{@code context}' namespace. * * @author Mark Fisher * @author Juergen Hoeller diff --git a/spring-context/src/main/java/org/springframework/context/event/ApplicationContextEvent.java b/spring-context/src/main/java/org/springframework/context/event/ApplicationContextEvent.java index bc9dbb3d5f..9e79349feb 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ApplicationContextEvent.java +++ b/spring-context/src/main/java/org/springframework/context/event/ApplicationContextEvent.java @@ -20,7 +20,7 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationEvent; /** - * Base class for events raised for an ApplicationContext. + * Base class for events raised for an {@code ApplicationContext}. * * @author Juergen Hoeller * @since 2.5 @@ -29,15 +29,15 @@ public abstract class ApplicationContextEvent extends ApplicationEvent { /** * Create a new ContextStartedEvent. - * @param source the ApplicationContext that the event is raised for - * (must not be null) + * @param source the {@code ApplicationContext} that the event is raised for + * (must not be {@code null}) */ public ApplicationContextEvent(ApplicationContext source) { super(source); } /** - * Get the ApplicationContext that the event was raised for. + * Get the {@code ApplicationContext} that the event was raised for. */ public final ApplicationContext getApplicationContext() { return (ApplicationContext) getSource(); diff --git a/spring-context/src/main/java/org/springframework/context/event/ContextClosedEvent.java b/spring-context/src/main/java/org/springframework/context/event/ContextClosedEvent.java index e53df33896..82a5b47eba 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ContextClosedEvent.java +++ b/spring-context/src/main/java/org/springframework/context/event/ContextClosedEvent.java @@ -19,7 +19,7 @@ package org.springframework.context.event; import org.springframework.context.ApplicationContext; /** - * Event raised when an ApplicationContext gets closed. + * Event raised when an {@code ApplicationContext} gets closed. * * @author Juergen Hoeller * @since 12.08.2003 @@ -29,8 +29,8 @@ public class ContextClosedEvent extends ApplicationContextEvent { /** * Creates a new ContextClosedEvent. - * @param source the ApplicationContext that has been closed - * (must not be null) + * @param source the {@code ApplicationContext} that has been closed + * (must not be {@code null}) */ public ContextClosedEvent(ApplicationContext source) { super(source); diff --git a/spring-context/src/main/java/org/springframework/context/event/ContextRefreshedEvent.java b/spring-context/src/main/java/org/springframework/context/event/ContextRefreshedEvent.java index 9b448cb3b4..bc6d2255b7 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ContextRefreshedEvent.java +++ b/spring-context/src/main/java/org/springframework/context/event/ContextRefreshedEvent.java @@ -19,7 +19,7 @@ package org.springframework.context.event; import org.springframework.context.ApplicationContext; /** - * Event raised when an ApplicationContext gets initialized or refreshed. + * Event raised when an {@code ApplicationContext} gets initialized or refreshed. * * @author Juergen Hoeller * @since 04.03.2003 @@ -29,8 +29,8 @@ public class ContextRefreshedEvent extends ApplicationContextEvent { /** * Create a new ContextRefreshedEvent. - * @param source the ApplicationContext that has been initialized - * or refreshed (must not be null) + * @param source the {@code ApplicationContext} that has been initialized + * or refreshed (must not be {@code null}) */ public ContextRefreshedEvent(ApplicationContext source) { super(source); diff --git a/spring-context/src/main/java/org/springframework/context/event/ContextStartedEvent.java b/spring-context/src/main/java/org/springframework/context/event/ContextStartedEvent.java index bc3e7163c1..edef2350db 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ContextStartedEvent.java +++ b/spring-context/src/main/java/org/springframework/context/event/ContextStartedEvent.java @@ -19,7 +19,7 @@ package org.springframework.context.event; import org.springframework.context.ApplicationContext; /** - * Event raised when an ApplicationContext gets started. + * Event raised when an {@code ApplicationContext} gets started. * * @author Mark Fisher * @author Juergen Hoeller @@ -30,8 +30,8 @@ public class ContextStartedEvent extends ApplicationContextEvent { /** * Create a new ContextStartedEvent. - * @param source the ApplicationContext that has been started - * (must not be null) + * @param source the {@code ApplicationContext} that has been started + * (must not be {@code null}) */ public ContextStartedEvent(ApplicationContext source) { super(source); diff --git a/spring-context/src/main/java/org/springframework/context/event/ContextStoppedEvent.java b/spring-context/src/main/java/org/springframework/context/event/ContextStoppedEvent.java index a00f82baea..5e995ab6c3 100644 --- a/spring-context/src/main/java/org/springframework/context/event/ContextStoppedEvent.java +++ b/spring-context/src/main/java/org/springframework/context/event/ContextStoppedEvent.java @@ -19,7 +19,7 @@ package org.springframework.context.event; import org.springframework.context.ApplicationContext; /** - * Event raised when an ApplicationContext gets stopped. + * Event raised when an {@code ApplicationContext} gets stopped. * * @author Mark Fisher * @author Juergen Hoeller @@ -30,8 +30,8 @@ public class ContextStoppedEvent extends ApplicationContextEvent { /** * Create a new ContextStoppedEvent. - * @param source the ApplicationContext that has been stopped - * (must not be null) + * @param source the {@code ApplicationContext} that has been stopped + * (must not be {@code null}) */ public ContextStoppedEvent(ApplicationContext source) { super(source); diff --git a/spring-context/src/main/java/org/springframework/context/event/EventPublicationInterceptor.java b/spring-context/src/main/java/org/springframework/context/event/EventPublicationInterceptor.java index 98d08dbcf3..abaddb72b3 100644 --- a/spring-context/src/main/java/org/springframework/context/event/EventPublicationInterceptor.java +++ b/spring-context/src/main/java/org/springframework/context/event/EventPublicationInterceptor.java @@ -28,8 +28,8 @@ import org.springframework.context.ApplicationEventPublisherAware; /** * {@link MethodInterceptor Interceptor} that publishes an - * ApplicationEvent to all ApplicationListeners - * registered with an ApplicationEventPublisher after each + * {@code ApplicationEvent} to all {@code ApplicationListeners} + * registered with an {@code ApplicationEventPublisher} after each * successful method invocation. * *

    Note that this interceptor is only capable of publishing stateless @@ -56,11 +56,11 @@ public class EventPublicationInterceptor /** * Set the application event class to publish. *

    The event class must have a constructor with a single - * Object argument for the event source. The interceptor + * {@code Object} argument for the event source. The interceptor * will pass in the invoked object. - * @throws IllegalArgumentException if the supplied Class is - * null or if it is not an ApplicationEvent subclass or - * if it does not expose a constructor that takes a single Object argument + * @throws IllegalArgumentException if the supplied {@code Class} is + * {@code null} or if it is not an {@code ApplicationEvent} subclass or + * if it does not expose a constructor that takes a single {@code Object} argument */ public void setApplicationEventClass(Class applicationEventClass) { if (ApplicationEvent.class.equals(applicationEventClass) || 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 d84d0d17b0..dcaf8fc14e 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 @@ -27,7 +27,7 @@ import org.springframework.context.ApplicationListener; * *

    Multicasts all events to all registered listeners, leaving it up to * the listeners to ignore events that they are not interested in. - * Listeners will usually perform corresponding instanceof + * Listeners will usually perform corresponding {@code instanceof} * checks on the passed-in event object. * *

    By default, all listeners are invoked in the calling thread. diff --git a/spring-context/src/main/java/org/springframework/context/expression/MapAccessor.java b/spring-context/src/main/java/org/springframework/context/expression/MapAccessor.java index 53ed9ce911..efd11eb77d 100644 --- a/spring-context/src/main/java/org/springframework/context/expression/MapAccessor.java +++ b/spring-context/src/main/java/org/springframework/context/expression/MapAccessor.java @@ -63,7 +63,7 @@ public class MapAccessor implements PropertyAccessor { /** - * Exception thrown from read in order to reset a cached + * Exception thrown from {@code read} in order to reset a cached * PropertyAccessor, allowing other accessors to have a try. */ private static class MapAccessException extends AccessException { diff --git a/spring-context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java b/spring-context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java index 5f3cabedf4..6ace399333 100644 --- a/spring-context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java +++ b/spring-context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java @@ -25,7 +25,7 @@ import org.springframework.core.NamedThreadLocal; * Simple holder class that associates a LocaleContext instance * with the current thread. The LocaleContext will be inherited * by any child threads spawned by the current thread if the - * inheritable flag is set to true. + * {@code inheritable} flag is set to {@code true}. * *

    Used as a central holder for the current Locale in Spring, * wherever necessary: for example, in MessageSourceAccessor. @@ -68,9 +68,9 @@ public abstract class LocaleContextHolder { /** * Associate the given LocaleContext with the current thread. * @param localeContext the current LocaleContext, - * or null to reset the thread-bound context + * or {@code null} to reset the thread-bound context * @param inheritable whether to expose the LocaleContext as inheritable - * for child threads (using an {@link java.lang.InheritableThreadLocal}) + * for child threads (using an {@link InheritableThreadLocal}) */ public static void setLocaleContext(LocaleContext localeContext, boolean inheritable) { if (localeContext == null) { @@ -90,7 +90,7 @@ public abstract class LocaleContextHolder { /** * Return the LocaleContext associated with the current thread, if any. - * @return the current LocaleContext, or null if none + * @return the current LocaleContext, or {@code null} if none */ public static LocaleContext getLocaleContext() { LocaleContext localeContext = localeContextHolder.get(); @@ -104,7 +104,7 @@ public abstract class LocaleContextHolder { * Associate the given Locale with the current thread. *

    Will implicitly create a LocaleContext for the given Locale, * not exposing it as inheritable for child threads. - * @param locale the current Locale, or null to reset + * @param locale the current Locale, or {@code null} to reset * the thread-bound context * @see SimpleLocaleContext#SimpleLocaleContext(java.util.Locale) */ @@ -115,10 +115,10 @@ public abstract class LocaleContextHolder { /** * Associate the given Locale with the current thread. *

    Will implicitly create a LocaleContext for the given Locale. - * @param locale the current Locale, or null to reset + * @param locale the current Locale, or {@code null} to reset * the thread-bound context * @param inheritable whether to expose the LocaleContext as inheritable - * for child threads (using an {@link java.lang.InheritableThreadLocal}) + * for child threads (using an {@link InheritableThreadLocal}) * @see SimpleLocaleContext#SimpleLocaleContext(java.util.Locale) */ public static void setLocale(Locale locale, boolean inheritable) { diff --git a/spring-context/src/main/java/org/springframework/context/i18n/SimpleLocaleContext.java b/spring-context/src/main/java/org/springframework/context/i18n/SimpleLocaleContext.java index c55773f320..b21e35e772 100644 --- a/spring-context/src/main/java/org/springframework/context/i18n/SimpleLocaleContext.java +++ b/spring-context/src/main/java/org/springframework/context/i18n/SimpleLocaleContext.java @@ -22,7 +22,7 @@ import org.springframework.util.Assert; /** * Simple implementation of the {@link LocaleContext} interface, - * always returning a specified Locale. + * always returning a specified {@code Locale}. * * @author Juergen Hoeller * @since 1.2 @@ -34,7 +34,7 @@ public class SimpleLocaleContext implements LocaleContext { /** * Create a new SimpleLocaleContext that exposes the specified Locale. - * Every getLocale() will return this Locale. + * Every {@code getLocale()} will return this Locale. * @param locale the Locale to expose */ public SimpleLocaleContext(Locale locale) { 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 120ee42154..6bfc380aa5 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 @@ -264,14 +264,14 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Return a friendly name for this context. - * @return a display name for this context (never null) + * @return a display name for this context (never {@code null}) */ public String getDisplayName() { return this.displayName; } /** - * Return the parent context, or null if there is no parent + * Return the parent context, or {@code null} if there is no parent * (that is, this context is the root of the context hierarchy). */ public ApplicationContext getParent() { @@ -339,7 +339,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Return the internal ApplicationEventMulticaster used by the context. - * @return the internal ApplicationEventMulticaster (never null) + * @return the internal ApplicationEventMulticaster (never {@code null}) * @throws IllegalStateException if the context has not been initialized yet */ private ApplicationEventMulticaster getApplicationEventMulticaster() throws IllegalStateException { @@ -352,7 +352,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Return the internal LifecycleProcessor used by the context. - * @return the internal LifecycleProcessor (never null) + * @return the internal LifecycleProcessor (never {@code null}) * @throws IllegalStateException if the context has not been initialized yet */ private LifecycleProcessor getLifecycleProcessor() { @@ -371,7 +371,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader *

    Can be overridden in subclasses, for extended resolution strategies, * for example in a web environment. *

    Do not call this when needing to resolve a location pattern. - * Call the context's getResources method instead, which + * Call the context's {@code getResources} method instead, which * will delegate to the ResourcePatternResolver. * @return the ResourcePatternResolver for this context * @see #getResources @@ -952,7 +952,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } /** - * Cancel this context's refresh attempt, resetting the active flag + * Cancel this context's refresh attempt, resetting the {@code active} flag * after an exception got thrown. * @param ex the exception that led to the cancellation */ @@ -966,8 +966,8 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Register a shutdown hook with the JVM runtime, closing this context * on JVM shutdown unless it has already been closed at that time. - *

    Delegates to doClose() for the actual closing procedure. - * @see java.lang.Runtime#addShutdownHook + *

    Delegates to {@code doClose()} for the actual closing procedure. + * @see Runtime#addShutdownHook * @see #close() * @see #doClose() */ @@ -989,7 +989,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader * Only called when the ApplicationContext itself is running * as a bean in another BeanFactory or ApplicationContext, * which is rather unusual. - *

    The close method is the native way to + *

    The {@code close} method is the native way to * shut down an ApplicationContext. * @see #close() * @see org.springframework.beans.factory.access.SingletonBeanFactoryLocator @@ -1000,7 +1000,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Close this application context, destroying all beans in its bean factory. - *

    Delegates to doClose() for the actual closing procedure. + *

    Delegates to {@code doClose()} for the actual closing procedure. * Also removes a JVM shutdown hook, if registered, as it's not needed anymore. * @see #doClose() * @see #registerShutdownHook() @@ -1024,7 +1024,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Actually performs context closing: publishes a ContextClosedEvent and * destroys the singletons in the bean factory of this application context. - *

    Called by both close() and a JVM shutdown hook, if any. + *

    Called by both {@code close()} and a JVM shutdown hook, if any. * @see org.springframework.context.event.ContextClosedEvent * @see #destroyBeans() * @see #close() @@ -1078,7 +1078,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Template method for destroying all beans that this context manages. * The default implementation destroy all cached singletons in this context, - * invoking DisposableBean.destroy() and/or the specified + * invoking {@code DisposableBean.destroy()} and/or the specified * "destroy-method". *

    Can be overridden to add context-specific bean destruction steps * right before or right after standard singleton destruction, @@ -1240,7 +1240,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader /** * Return the internal MessageSource used by the context. - * @return the internal MessageSource (never null) + * @return the internal MessageSource (never {@code null}) * @throws IllegalStateException if the context has not been initialized yet */ private MessageSource getMessageSource() throws IllegalStateException { @@ -1318,7 +1318,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader *

    Note: Subclasses should check whether the context is still active before * returning the internal bean factory. The internal factory should generally be * considered unavailable once the context has been closed. - * @return this application context's internal bean factory (never null) + * @return this application context's internal bean factory (never {@code null}) * @throws IllegalStateException if the context does not hold an internal bean factory yet * (usually if {@link #refresh()} has never been called) or if the context has been * closed already 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 3d9231a0fc..a7f44dca16 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 @@ -164,13 +164,13 @@ public abstract class AbstractMessageSource extends MessageSourceSupport impleme /** * Resolve the given code and arguments as message in the given Locale, - * returning null if not found. Does not fall back to - * the code as default message. Invoked by getMessage methods. + * returning {@code null} if not found. Does not fall back to + * the code as default message. Invoked by {@code getMessage} methods. * @param code the code to lookup up, such as 'calculator.noRateSet' * @param args array of arguments that will be filled in for params * within the message * @param locale the Locale in which to do the lookup - * @return the resolved message, or null if not found + * @return the resolved message, or {@code null} if not found * @see #getMessage(String, Object[], String, Locale) * @see #getMessage(String, Object[], Locale) * @see #getMessage(MessageSourceResolvable, Locale) @@ -220,7 +220,7 @@ public abstract class AbstractMessageSource extends MessageSourceSupport impleme * @param args array of arguments that will be filled in for params * within the message * @param locale the Locale in which to do the lookup - * @return the resolved message, or null if not found + * @return the resolved message, or {@code null} if not found * @see #getParentMessageSource() */ protected String getMessageFromParent(String code, Object[] args, Locale locale) { @@ -244,10 +244,10 @@ public abstract class AbstractMessageSource extends MessageSourceSupport impleme * Return a fallback default message for the given code, if any. *

    Default is to return the code itself if "useCodeAsDefaultMessage" is activated, * or return no fallback else. In case of no fallback, the caller will usually - * receive a NoSuchMessageException from getMessage. + * receive a NoSuchMessageException from {@code getMessage}. * @param code the message code that we couldn't resolve * and that we didn't receive an explicit default message for - * @return the default message to use, or null if none + * @return the default message to use, or {@code null} if none * @see #setUseCodeAsDefaultMessage */ protected String getDefaultMessage(String code) { @@ -289,14 +289,14 @@ public abstract class AbstractMessageSource extends MessageSourceSupport impleme *

    The default implementation does use MessageFormat, through * delegating to the {@link #resolveCode} method. Subclasses are encouraged * to replace this with optimized resolution. - *

    Unfortunately, java.text.MessageFormat is not implemented + *

    Unfortunately, {@code java.text.MessageFormat} is not implemented * in an efficient fashion. In particular, it does not detect that a message * pattern doesn't contain argument placeholders in the first place. Therefore, * it is advisable to circumvent MessageFormat for messages without arguments. * @param code the code of the message to resolve * @param locale the Locale to resolve the code for * (subclasses are encouraged to support internationalization) - * @return the message String, or null if not found + * @return the message String, or {@code null} if not found * @see #resolveCode * @see java.text.MessageFormat */ @@ -320,7 +320,7 @@ public abstract class AbstractMessageSource extends MessageSourceSupport impleme * @param code the code of the message to resolve * @param locale the Locale to resolve the code for * (subclasses are encouraged to support internationalization) - * @return the MessageFormat for the message, or null if not found + * @return the MessageFormat for the message, or {@code null} if not found * @see #resolveCodeWithoutArguments(String, java.util.Locale) */ protected abstract MessageFormat resolveCode(String code, Locale locale); diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractRefreshableConfigApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/AbstractRefreshableConfigApplicationContext.java index 77155fb220..5e8377c999 100644 --- a/spring-context/src/main/java/org/springframework/context/support/AbstractRefreshableConfigApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/AbstractRefreshableConfigApplicationContext.java @@ -90,9 +90,9 @@ public abstract class AbstractRefreshableConfigApplicationContext extends Abstra * Return an array of resource locations, referring to the XML bean definition * files that this context should be built with. Can also include location * patterns, which will get resolved via a ResourcePatternResolver. - *

    The default implementation returns null. Subclasses can override + *

    The default implementation returns {@code null}. Subclasses can override * this to provide a set of resource locations to load bean definitions from. - * @return an array of resource locations, or null if none + * @return an array of resource locations, or {@code null} if none * @see #getResources * @see #getResourcePatternResolver */ @@ -103,7 +103,7 @@ public abstract class AbstractRefreshableConfigApplicationContext extends Abstra /** * Return the default config locations to use, for the case where no * explicit config locations have been specified. - *

    The default implementation returns null, + *

    The default implementation returns {@code null}, * requiring explicit config locations. * @return an array of default config locations, if any * @see #setConfigLocations 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 20c2734f76..3f88a900db 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 @@ -63,7 +63,7 @@ public abstract class AbstractXmlApplicationContext extends AbstractRefreshableC /** - * Set whether to use XML validation. Default is true. + * Set whether to use XML validation. Default is {@code true}. */ public void setValidating(boolean validating) { this.validating = validating; @@ -131,9 +131,9 @@ public abstract class AbstractXmlApplicationContext extends AbstractRefreshableC /** * Return an array of Resource objects, referring to the XML bean definition * files that this context should be built with. - *

    The default implementation returns null. Subclasses can override + *

    The default implementation returns {@code null}. Subclasses can override * this to provide pre-built Resource objects rather than location Strings. - * @return an array of Resource objects, or null if none + * @return an array of Resource objects, or {@code null} if none * @see #getConfigLocations() */ protected Resource[] getConfigResources() { 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 675cb8f200..a872b76b78 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 @@ -95,7 +95,7 @@ public abstract class ApplicationObjectSupport implements ApplicationContextAwar /** * Determine the context class that any context passed to - * setApplicationContext must be an instance of. + * {@code setApplicationContext} must be an instance of. * Can be overridden in subclasses. * @see #setApplicationContext */ @@ -105,7 +105,7 @@ public abstract class ApplicationObjectSupport implements ApplicationContextAwar /** * Subclasses can override this for custom initialization behavior. - * Gets called by setApplicationContext after setting the context instance. + * Gets called by {@code setApplicationContext} after setting the context instance. *

    Note: Does not get called on reinitialization of the context * but rather just on first initialization of this object's context reference. *

    The default implementation calls the overloaded {@link #initApplicationContext()} diff --git a/spring-context/src/main/java/org/springframework/context/support/ContextTypeMatchClassLoader.java b/spring-context/src/main/java/org/springframework/context/support/ContextTypeMatchClassLoader.java index 9570bcb0d5..6930177ded 100644 --- a/spring-context/src/main/java/org/springframework/context/support/ContextTypeMatchClassLoader.java +++ b/spring-context/src/main/java/org/springframework/context/support/ContextTypeMatchClassLoader.java @@ -28,7 +28,7 @@ import org.springframework.util.ReflectionUtils; /** * Special variant of an overriding ClassLoader, used for temporary type * matching in {@link AbstractApplicationContext}. Redefines classes from - * a cached byte array for every loadClass call in order to + * a cached byte array for every {@code loadClass} call in order to * pick up recently loaded types in the parent ClassLoader. * * @author Juergen Hoeller diff --git a/spring-context/src/main/java/org/springframework/context/support/DefaultMessageSourceResolvable.java b/spring-context/src/main/java/org/springframework/context/support/DefaultMessageSourceResolvable.java index dab8670443..67c9bc99c6 100644 --- a/spring-context/src/main/java/org/springframework/context/support/DefaultMessageSourceResolvable.java +++ b/spring-context/src/main/java/org/springframework/context/support/DefaultMessageSourceResolvable.java @@ -131,7 +131,7 @@ public class DefaultMessageSourceResolvable implements MessageSourceResolvable, /** * Default implementation exposes the attributes of this MessageSourceResolvable. * To be overridden in more specific subclasses, potentially including the - * resolvable content through resolvableToString(). + * resolvable content through {@code resolvableToString()}. * @see #resolvableToString() */ @Override 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 8a5da83ddc..83c6db1b52 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 @@ -178,7 +178,7 @@ public class GenericApplicationContext extends AbstractApplicationContext implem /** * Set a ResourceLoader to use for this context. If set, the context will - * delegate all getResource calls to the given ResourceLoader. + * delegate all {@code getResource} calls to the given ResourceLoader. * If not set, default resource loading will apply. *

    The main reason to specify a custom ResourceLoader is to resolve * resource paths (without URL prefix) in a specific fashion. @@ -186,7 +186,7 @@ public class GenericApplicationContext extends AbstractApplicationContext implem * To resolve resource paths as file system locations, specify a * FileSystemResourceLoader here. *

    You can also pass in a full ResourcePatternResolver, which will - * be autodetected by the context and used for getResources + * be autodetected by the context and used for {@code getResources} * calls as well. Else, default resource pattern matching will apply. * @see #getResource * @see org.springframework.core.io.DefaultResourceLoader diff --git a/spring-context/src/main/java/org/springframework/context/support/GenericXmlApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/GenericXmlApplicationContext.java index 00b6555849..5384a333be 100644 --- a/spring-context/src/main/java/org/springframework/context/support/GenericXmlApplicationContext.java +++ b/spring-context/src/main/java/org/springframework/context/support/GenericXmlApplicationContext.java @@ -84,7 +84,7 @@ public class GenericXmlApplicationContext extends GenericApplicationContext { } /** - * Set whether to use XML validation. Default is true. + * Set whether to use XML validation. Default is {@code true}. */ public void setValidating(boolean validating) { this.reader.setValidating(validating); 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 34cb5e51db..e026e5c98f 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 @@ -97,7 +97,7 @@ public class MessageSourceAccessor { /** * Retrieve the message for the given code and the default Locale. * @param code code of the message - * @param args arguments for the message, or null if none + * @param args arguments for the message, or {@code null} if none * @param defaultMessage String to return if the lookup fails * @return the message */ @@ -108,7 +108,7 @@ public class MessageSourceAccessor { /** * Retrieve the message for the given code and the given Locale. * @param code code of the message - * @param args arguments for the message, or null if none + * @param args arguments for the message, or {@code null} if none * @param defaultMessage String to return if the lookup fails * @param locale Locale in which to do lookup * @return the message @@ -141,7 +141,7 @@ public class MessageSourceAccessor { /** * Retrieve the message for the given code and the default Locale. * @param code code of the message - * @param args arguments for the message, or null if none + * @param args arguments for the message, or {@code null} if none * @return the message * @throws org.springframework.context.NoSuchMessageException if not found */ @@ -152,7 +152,7 @@ public class MessageSourceAccessor { /** * Retrieve the message for the given code and the given Locale. * @param code code of the message - * @param args arguments for the message, or null if none + * @param args arguments for the message, or {@code null} if none * @param locale Locale in which to do lookup * @return the message * @throws org.springframework.context.NoSuchMessageException if not found diff --git a/spring-context/src/main/java/org/springframework/context/support/MessageSourceResourceBundle.java b/spring-context/src/main/java/org/springframework/context/support/MessageSourceResourceBundle.java index c5fe46acf5..4dd8bce351 100644 --- a/spring-context/src/main/java/org/springframework/context/support/MessageSourceResourceBundle.java +++ b/spring-context/src/main/java/org/springframework/context/support/MessageSourceResourceBundle.java @@ -67,7 +67,7 @@ public class MessageSourceResourceBundle extends ResourceBundle { /** * This implementation resolves the code in the MessageSource. - * Returns null if the message could not be resolved. + * Returns {@code null} if the message could not be resolved. */ @Override protected Object handleGetObject(String code) { @@ -80,7 +80,7 @@ public class MessageSourceResourceBundle extends ResourceBundle { } /** - * This implementation returns null, as a MessageSource does + * This implementation returns {@code null}, as a MessageSource does * not allow for enumerating the defined message codes. */ @Override @@ -90,7 +90,7 @@ public class MessageSourceResourceBundle extends ResourceBundle { /** * This implementation exposes the specified Locale for introspection - * through the standard ResourceBundle.getLocale() method. + * through the standard {@code ResourceBundle.getLocale()} method. */ @Override public Locale getLocale() { diff --git a/spring-context/src/main/java/org/springframework/context/support/MessageSourceSupport.java b/spring-context/src/main/java/org/springframework/context/support/MessageSourceSupport.java index b7601375a7..d863add687 100644 --- a/spring-context/src/main/java/org/springframework/context/support/MessageSourceSupport.java +++ b/spring-context/src/main/java/org/springframework/context/support/MessageSourceSupport.java @@ -32,7 +32,7 @@ import org.springframework.util.ObjectUtils; * methods defined in the {@link org.springframework.context.MessageSource}. * *

    {@link AbstractMessageSource} derives from this class, providing concrete - * getMessage implementations that delegate to a central template + * {@code getMessage} implementations that delegate to a central template * method for message code resolution. * * @author Juergen Hoeller @@ -87,12 +87,12 @@ public abstract class MessageSourceSupport { * Render the given default message String. The default message is * passed in as specified by the caller and can be rendered into * a fully formatted default message shown to the user. - *

    The default implementation passes the String to formatMessage, + *

    The default implementation passes the String to {@code formatMessage}, * resolving any argument placeholders found in them. Subclasses may override * this method to plug in custom processing of default messages. * @param defaultMessage the passed-in default message String * @param args array of arguments that will be filled in for params within - * the message, or null if none. + * the message, or {@code null} if none. * @param locale the Locale used for formatting * @return the rendered default message (with resolved arguments) * @see #formatMessage(String, Object[], java.util.Locale) @@ -107,7 +107,7 @@ public abstract class MessageSourceSupport { * any argument placeholders found in them. * @param msg the message to format * @param args array of arguments that will be filled in for params within - * the message, or null if none + * the message, or {@code null} if none * @param locale the Locale used for formatting * @return the formatted message (with resolved arguments) */ 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 44d284c9a5..e428c760b9 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 @@ -174,7 +174,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractMessageSource /** * Set the default charset to use for parsing properties files. * Used if no file-specific charset is specified for a file. - *

    Default is none, using the java.util.Properties + *

    Default is none, using the {@code java.util.Properties} * default encoding: ISO-8859-1. *

    Only applies to classic properties files, not to XML files. * @param defaultEncoding the default charset @@ -205,7 +205,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractMessageSource * fallback will be the default file (e.g. "messages.properties" for * basename "messages"). *

    Falling back to the system Locale is the default behavior of - * java.util.ResourceBundle. However, this is often not desirable + * {@code java.util.ResourceBundle}. However, this is often not desirable * in an application server environment, where the system Locale is not relevant * to the application at all: Set this flag to "false" in such a scenario. */ @@ -217,7 +217,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractMessageSource * Set the number of seconds to cache loaded properties files. *