Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc checkstyle issues

Browse Source 
Fix checkstyle violations for javadoc.

Issue: SPR-16968
This commit is contained in:
Phillip Webb
2018-06-20 18:45:54 -07:00
committed by Juergen Hoeller
parent 032096d699
commit e0480f75ac
928 changed files with 3729 additions and 2686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-context/src/main/java/org/springframework/cache/annotation/AnnotationCacheOperationSource.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -120,7 +120,7 @@ public class AnnotationCacheOperationSource extends AbstractFallbackCacheOperati
/**
* Determine the cache operation(s) for the given {@link CacheOperationProvider}.
* <p>This implementation delegates to configured
* {@link CacheAnnotationParser}s for parsing known annotations into
* {@link CacheAnnotationParser CacheAnnotationParsers} for parsing known annotations into
* Spring's metadata attribute class.
* <p>Can be overridden to support custom annotations that carry
* caching metadata.

6
spring-context/src/main/java/org/springframework/cache/annotation/CacheAnnotationParser.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ public interface CacheAnnotationParser {
* metadata attribute class. Returns {@code null} if the class
* is not cacheable.
* @param type the annotated class
* @return CacheOperation the configured caching operation,
* @return the configured caching operation,
* or {@code null} if none was found
* @see AnnotationCacheOperationSource#findCacheOperations(Class)
*/
@@ -55,7 +55,7 @@ public interface CacheAnnotationParser {
* metadata attribute class. Returns {@code null} if the method
* is not cacheable.
* @param method the annotated method
* @return CacheOperation the configured caching operation,
* @return the configured caching operation,
* or {@code null} if none was found
* @see AnnotationCacheOperationSource#findCacheOperations(Method)
*/

31
spring-context/src/main/java/org/springframework/cache/annotation/EnableCaching.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -56,25 +56,24 @@ import org.springframework.core.Ordered;
* configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans&gt;
*
* <cache:annotation-driven/>
* &lt;cache:annotation-driven/&gt;
*
* <bean id="myService" class="com.foo.MyService"/>
* &lt;bean id="myService" class="com.foo.MyService"/&gt;
*
* <bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager">
* <property name="caches">
* <set>
* <bean class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean">
* <property name="name" value="default"/>
* </bean>
* </set>
* </property>
* </bean>
* &lt;bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager"&gt;
* &lt;property name="caches"&gt;
* &lt;set&gt;
* &lt;bean class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"&gt;
* &lt;property name="name" value="default"/&gt;
* &lt;/bean&gt;
* &lt;/set&gt;
* &lt;/property&gt;
* &lt;/bean&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* In both of the scenarios above, {@code @EnableCaching} and {@code
* <cache:annotation-driven/>} are responsible for registering the necessary Spring

12
spring-context/src/main/java/org/springframework/cache/config/AnnotationDrivenCacheBeanDefinitionParser.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -175,12 +175,12 @@ class AnnotationDrivenCacheBeanDefinitionParser implements BeanDefinitionParser
}
/**
* Registers a
* Registers a cache aspect.
* <pre class="code">
* <bean id="cacheAspect" class="org.springframework.cache.aspectj.AnnotationCacheAspect" factory-method="aspectOf">
* <property name="cacheManager" ref="cacheManager"/>
* <property name="keyGenerator" ref="keyGenerator"/>
* </bean>
* &lt;bean id="cacheAspect" class="org.springframework.cache.aspectj.AnnotationCacheAspect" factory-method="aspectOf"&gt;
* &lt;property name="cacheManager" ref="cacheManager"/&gt;
* &lt;property name="keyGenerator" ref="keyGenerator"/&gt;
* &lt;/bean&gt;
* </pre>
*/
private static void registerCacheAspect(Element element, ParserContext parserContext) {

14
spring-context/src/main/java/org/springframework/cache/config/CacheManagementConfigUtils.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -24,15 +24,27 @@ package org.springframework.cache.config;
*/
public class CacheManagementConfigUtils {
/**
* The name of the cache advisor bean.
*/
public static final String CACHE_ADVISOR_BEAN_NAME =
"org.springframework.cache.config.internalCacheAdvisor";
/**
* The name of the cache aspect bean.
*/
public static final String CACHE_ASPECT_BEAN_NAME =
"org.springframework.cache.config.internalCacheAspect";
/**
* The name of the JCache advisor bean.
*/
public static final String JCACHE_ADVISOR_BEAN_NAME =
"org.springframework.cache.config.internalJCacheAdvisor";
/**
* The name of the JCache advisor bean.
*/
public static final String JCACHE_ASPECT_BEAN_NAME =
"org.springframework.cache.config.internalJCacheAspect";

3
spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java vendored
View File

@@ -650,6 +650,9 @@ public abstract class CacheAspectSupport extends AbstractCacheInvoker
}
/**
* A {@link CacheOperationInvocationContext} context for a {@link CacheOperation}.
*/
protected class CacheOperationContext implements CacheOperationInvocationContext<CacheOperation> {
private final CacheOperationMetadata metadata;

4
spring-context/src/main/java/org/springframework/cache/interceptor/CacheEvictOperation.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -31,6 +31,7 @@ public class CacheEvictOperation extends CacheOperation {
/**
* Create a new {@link CacheEvictOperation} instance from the given builder.
* @since 4.3
*/
public CacheEvictOperation(CacheEvictOperation.Builder b) {
@@ -50,6 +51,7 @@ public class CacheEvictOperation extends CacheOperation {
/**
* A builder that can be used to create a {@link CacheEvictOperation}.
* @since 4.3
*/
public static class Builder extends CacheOperation.Builder {

4
spring-context/src/main/java/org/springframework/cache/interceptor/CacheOperation.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -50,6 +50,7 @@ public abstract class CacheOperation implements BasicOperation {
/**
* Create a new {@link CacheOperation} instance from the given builder.
* @since 4.3
*/
protected CacheOperation(Builder b) {
@@ -126,6 +127,7 @@ public abstract class CacheOperation implements BasicOperation {
/**
* Base class for builders that can be used to create a {@link CacheOperation}.
* @since 4.3
*/
public abstract static class Builder {

3
spring-context/src/main/java/org/springframework/cache/interceptor/CacheOperationInvocationContext.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@ import java.lang.reflect.Method;
*
* @author Stephane Nicoll
* @since 4.1
* @param <O> the operation type
*/
public interface CacheOperationInvocationContext<O extends BasicOperation> {

4
spring-context/src/main/java/org/springframework/cache/interceptor/CachePutOperation.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@ public class CachePutOperation extends CacheOperation {
/**
* Create a new {@link CachePutOperation} instance from the given builder.
* @since 4.3
*/
public CachePutOperation(CachePutOperation.Builder b) {
@@ -48,6 +49,7 @@ public class CachePutOperation extends CacheOperation {
/**
* A builder that can be used to create a {@link CachePutOperation}.
* @since 4.3
*/
public static class Builder extends CacheOperation.Builder {

4
spring-context/src/main/java/org/springframework/cache/interceptor/CacheableOperation.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@ public class CacheableOperation extends CacheOperation {
/**
* Create a new {@link CacheableOperation} instance from the given builder.
* @since 4.3
*/
public CacheableOperation(CacheableOperation.Builder b) {
@@ -55,6 +56,7 @@ public class CacheableOperation extends CacheOperation {
/**
* A builder that can be used to create a {@link CacheableOperation}.
* @since 4.3
*/
public static class Builder extends CacheOperation.Builder {

4
spring-context/src/main/java/org/springframework/cache/interceptor/NameMatchCacheOperationSource.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@ public class NameMatchCacheOperationSource implements CacheOperationSource, Seri
protected static final Log logger = LogFactory.getLog(NameMatchCacheOperationSource.class);
/** Keys are method names; values are TransactionAttributes */
/** Keys are method names; values are TransactionAttributes. */
private Map<String, Collection<CacheOperation>> nameMap = new LinkedHashMap<>();

4
spring-context/src/main/java/org/springframework/cache/interceptor/SimpleCacheResolver.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ import org.springframework.cache.CacheManager;
/**
* A simple {@link CacheResolver} that resolves the {@link Cache} instance(s)
* based on a configurable {@link CacheManager} and the name of the
* cache(s) as provided by {@link BasicOperation#getCacheNames() getCacheNames()}
* cache(s) as provided by {@link BasicOperation#getCacheNames() getCacheNames()}.
*
* @author Stephane Nicoll
* @since 4.1

5
spring-context/src/main/java/org/springframework/cache/interceptor/SimpleKey.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -32,6 +32,9 @@ import org.springframework.util.StringUtils;
@SuppressWarnings("serial")
public class SimpleKey implements Serializable {
/**
* An empty key.
*/
public static final SimpleKey EMPTY = new SimpleKey();
private final Object[] params;

4
spring-context/src/main/java/org/springframework/cache/support/NoOpCache.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ public class NoOpCache implements Cache {
/**
* Create a {@link NoOpCache} instance with the specified name
* Create a {@link NoOpCache} instance with the specified name.
* @param name the name of the cache
*/
public NoOpCache(String name) {

3
spring-context/src/main/java/org/springframework/context/ApplicationContextInitializer.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2011 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@ package org.springframework.context;
*
* @author Chris Beams
* @since 3.1
* @param <C> the application context type
* @see org.springframework.web.context.ContextLoader#customizeContext
* @see org.springframework.web.context.ContextLoader#CONTEXT_INITIALIZER_CLASSES_PARAM
* @see org.springframework.web.servlet.FrameworkServlet#setContextInitializerClasses

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -27,10 +27,10 @@ import java.util.EventObject;
*/
public abstract class ApplicationEvent extends EventObject {
/** use serialVersionUID from Spring 1.2 for interoperability */
/** use serialVersionUID from Spring 1.2 for interoperability. */
private static final long serialVersionUID = 7099057708183571937L;
/** System time when the event happened */
/** System time when the event happened. */
private final long timestamp;

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -54,8 +54,8 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
/**
* Name of the ConversionService bean in the factory.
* If none is supplied, default conversion rules apply.
* @see org.springframework.core.convert.ConversionService
* @since 3.0
* @see org.springframework.core.convert.ConversionService
*/
String CONVERSION_SERVICE_BEAN_NAME = "conversionService";

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,10 +21,10 @@ import org.springframework.util.StringValueResolver;
/**
* Interface to be implemented by any object that wishes to be notified of a
* <b>StringValueResolver</b> for the <b> resolution of embedded definition values.
* {@code StringValueResolver} for the resolution of embedded definition values.
*
* <p>This is an alternative to a full ConfigurableBeanFactory dependency via the
* ApplicationContextAware/BeanFactoryAware interfaces.
* {@code ApplicationContextAware}/{@code BeanFactoryAware} interfaces.
*
* @author Juergen Hoeller
* @author Chris Beams

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -69,7 +69,7 @@ public interface ResourceLoaderAware extends Aware {
* <p>Invoked after population of normal bean properties but before an init callback
* 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
* @param resourceLoader the ResourceLoader object to be used by this object
* @see org.springframework.core.io.support.ResourcePatternResolver
* @see org.springframework.core.io.support.ResourcePatternUtils#getResourcePatternResolver
*/

8
spring-context/src/main/java/org/springframework/context/annotation/AdviceMode.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -28,8 +28,14 @@ package org.springframework.context.annotation;
*/
public enum AdviceMode {
/**
* JDK proxy-based advice.
*/
PROXY,
/**
* AspectJ weaving-based advice.
*/
ASPECTJ
}

5
spring-context/src/main/java/org/springframework/context/annotation/AdviceModeImportSelector.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,6 +35,9 @@ import org.springframework.util.Assert;
*/
public abstract class AdviceModeImportSelector<A extends Annotation> implements ImportSelector {
/**
* The default advice mode attribute name.
*/
public static final String DEFAULT_ADVICE_MODE_ATTRIBUTE_NAME = "mode";

6
spring-context/src/main/java/org/springframework/context/annotation/BeanMethod.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2011 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@ import org.springframework.beans.factory.parsing.ProblemReporter;
import org.springframework.core.type.MethodMetadata;
/**
* Represents a {@link Configuration} class method marked with the
* {@link Bean} annotation.
* Represents a {@link Configuration @Configuration} class method marked with the
* {@link Bean @Bean} annotation.
*
* @author Chris Beams
* @author Juergen Hoeller

2
spring-context/src/main/java/org/springframework/context/annotation/ConditionContext.java
View File

@@ -23,7 +23,7 @@ import org.springframework.core.io.ResourceLoader;
import org.springframework.lang.Nullable;
/**
* Context information for use by {@link Condition}s.
* Context information for use by {@link Condition Conditions}.
*
* @author Phillip Webb
* @author Juergen Hoeller

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -62,7 +62,7 @@ import java.lang.annotation.Target;
public @interface Conditional {
/**
* All {@link Condition}s that must {@linkplain Condition#matches match}
* All {@link Condition Conditions} that must {@linkplain Condition#matches match}
* in order for the component to be registered.
*/
Class<? extends Condition>[] value();

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -69,11 +69,11 @@ import org.springframework.stereotype.Component;
* {@code AnnotationConfigApplicationContext}, {@code @Configuration} classes may be
* declared as normal {@code <bean>} definitions within Spring XML files:
* <pre class="code">
* {@code
* <beans>
* <context:annotation-config/>
* <bean class="com.acme.AppConfig"/>
* </beans>}</pre>
* &lt;beans&gt;
* &lt;context:annotation-config/&gt;
* &lt;bean class="com.acme.AppConfig"/&gt;
* &lt;/beans&gt;
* </pre>
*
* In the example above, {@code <context:annotation-config/>} is required in order to
* enable {@link ConfigurationClassPostProcessor} and other annotation-related

2
spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassEnhancer.java
View File

@@ -169,7 +169,7 @@ class ConfigurationClassEnhancer {
/**
* A {@link CallbackFilter} that works by interrogating {@link Callback}s in the order
* A {@link CallbackFilter} that works by interrogating {@link Callback Callbacks} in the order
* that they are defined via {@link ConditionalCallback}.
*/
private static class ConditionalCallbackFilter implements CallbackFilter {

2
spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassParser.java
View File

@@ -705,7 +705,7 @@ class ConfigurationClassParser {
}
/**
* Factory method to obtain {@link SourceClass}s from class names.
* Factory method to obtain {@link SourceClass SourceClasss} from class names.
*/
private Collection<SourceClass> asSourceClasses(String... classNames) throws IOException {
List<SourceClass> annotatedClasses = new ArrayList<>(classNames.length);

8
spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassUtils.java
View File

@@ -39,7 +39,7 @@ import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
/**
* Utilities for identifying @{@link Configuration} classes.
* Utilities for identifying {@link Configuration} classes.
*
* @author Chris Beams
* @author Juergen Hoeller
@@ -239,8 +239,8 @@ abstract class ConfigurationClassUtils {
/**
* Determine the order for the given configuration class metadata.
* @param metadata the metadata of the annotated class
* @return the {@link @Order} annotation value on the configuration class,
* or {@link Ordered#LOWEST_PRECEDENCE} if none declared
* @return the {@code @Order} annotation value on the configuration class,
* or {@code Ordered.LOWEST_PRECEDENCE} if none declared
* @since 5.0
*/
@Nullable
@@ -253,7 +253,7 @@ abstract class ConfigurationClassUtils {
* Determine the order for the given configuration class bean definition,
* as set by {@link #checkConfigurationClassCandidate}.
* @param beanDef the bean definition to check
* @return the {@link @Order} annotation value on the configuration class,
* @return the {@link Order @Order} annotation value on the configuration class,
* or {@link Ordered#LOWEST_PRECEDENCE} if none declared
* @since 4.2
*/

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@ package org.springframework.context.annotation;
/**
* A {@link Condition} that offers more fine-grained control when used with
* {@code @Configuration}. Allows certain {@link Condition}s to adapt when they match
* {@code @Configuration}. Allows certain {@link Condition Conditions} to adapt when they match
* based on the configuration phase. For example, a condition that checks if a bean
* has already been registered might choose to only be evaluated during the
* {@link ConfigurationPhase#REGISTER_BEAN REGISTER_BEAN} {@link ConfigurationPhase}.

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2013 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,6 +21,8 @@ import org.springframework.beans.factory.parsing.ProblemReporter;
import org.springframework.core.type.MethodMetadata;
/**
* Base class for a {@link Configuration @Configuration} class method.
*
* @author Chris Beams
* @since 3.1
*/

2
spring-context/src/main/java/org/springframework/context/annotation/DeferredImportSelector.java
View File

@@ -28,7 +28,7 @@ import org.springframework.lang.Nullable;
*
* <p>Implementations can also extend the {@link org.springframework.core.Ordered}
* interface or use the {@link org.springframework.core.annotation.Order} annotation to
* indicate a precedence against other {@link DeferredImportSelector}s.
* indicate a precedence against other {@link DeferredImportSelector DeferredImportSelectors}.
*
* <p>Implementations may also provide an {@link #getImportGroup() import group} which
* can provide additional sorting and filtering logic across different selectors.

34
spring-context/src/main/java/org/springframework/context/annotation/EnableLoadTimeWeaving.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -44,15 +44,14 @@ import org.springframework.instrument.classloading.LoadTimeWeaver;
* The example above is equivalent to the following Spring XML configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans&gt;
*
* <context:load-time-weaver/>
* &lt;context:load-time-weaver/&gt;
*
* <!-- application-specific <bean> definitions -->
* &lt;!-- application-specific &lt;bean&gt; definitions --&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* <h2>The {@code LoadTimeWeaverAware} interface</h2>
* Any bean that implements the {@link
@@ -85,13 +84,12 @@ import org.springframework.instrument.classloading.LoadTimeWeaver;
* <p>The example above can be compared to the following Spring XML configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans&gt;
*
* <context:load-time-weaver weaverClass="com.acme.MyLoadTimeWeaver"/>
* &lt;context:load-time-weaver weaverClass="com.acme.MyLoadTimeWeaver"/&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* <p>The code example differs from the XML example in that it actually instantiates the
* {@code MyLoadTimeWeaver} type, meaning that it can also configure the instance, e.g.
@@ -115,13 +113,12 @@ import org.springframework.instrument.classloading.LoadTimeWeaver;
* <p>The example above can be compared to the following Spring XML configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans&gt;
*
* <context:load-time-weaver aspectj-weaving="on"/>
* &lt;context:load-time-weaver aspectj-weaving="on"/&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* <p>The two examples are equivalent with one significant exception: in the XML case,
* the functionality of {@code <context:spring-configured>} is implicitly enabled when
@@ -147,6 +144,9 @@ public @interface EnableLoadTimeWeaving {
AspectJWeaving aspectjWeaving() default AspectJWeaving.AUTODETECT;
/**
* AspectJ weaving enablement options.
*/
enum AspectJWeaving {
/**

6
spring-context/src/main/java/org/springframework/context/annotation/ImportRegistry.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,8 +20,10 @@ import org.springframework.core.type.AnnotationMetadata;
import org.springframework.lang.Nullable;
/**
* Registry of imported class {@link AnnotationMetadata}.
*
* @author Juergen Hoeller
* @author Phil Webb
* @author Phillip Webb
*/
interface ImportRegistry {

11
spring-context/src/main/java/org/springframework/context/annotation/MBeanExportConfiguration.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -131,8 +131,14 @@ public class MBeanExportConfiguration implements ImportAware, EnvironmentAware,
}
/**
* Specific platforms that might need custom MBean handling.
*/
public enum SpecificPlatform {
/**
* Weblogic.
*/
WEBLOGIC("weblogic.management.Helper") {
@Override
public MBeanServer getMBeanServer() {
@@ -145,6 +151,9 @@ public class MBeanExportConfiguration implements ImportAware, EnvironmentAware,
}
},
/**
* Websphere.
*/
WEBSPHERE("com.ibm.websphere.management.AdminServiceFactory") {
@Override
public MBeanServer getMBeanServer() {

4
spring-context/src/main/java/org/springframework/context/event/SmartApplicationListener.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ import org.springframework.lang.Nullable;
* Extended variant of the standard {@link ApplicationListener} interface,
* exposing further metadata such as the supported event type.
*
* <p>Users are <bold>strongly advised</bold> to use the {@link GenericApplicationListener}
* <p>Users are <b>strongly advised</b> to use the {@link GenericApplicationListener}
* interface instead as it provides an improved detection of generics-based
* event types.
*

5
spring-context/src/main/java/org/springframework/context/expression/CachedExpressionEvaluator.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -96,6 +96,9 @@ public abstract class CachedExpressionEvaluator {
}
/**
* An expression key.
*/
protected static class ExpressionKey implements Comparable<ExpressionKey> {
private final AnnotatedElementKey element;

4
spring-context/src/main/java/org/springframework/context/expression/StandardBeanExpressionResolver.java
View File

@@ -49,10 +49,10 @@ import org.springframework.util.StringUtils;
*/
public class StandardBeanExpressionResolver implements BeanExpressionResolver {
/** Default expression prefix: "#{" */
/** Default expression prefix: "#{". */
public static final String DEFAULT_EXPRESSION_PREFIX = "#{";
/** Default expression suffix: "}" */
/** Default expression suffix: "}". */
public static final String DEFAULT_EXPRESSION_SUFFIX = "}";

32
spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java
View File

@@ -160,58 +160,58 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader
/** Logger used by this class. Available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
/** Unique id for this context, if any */
/** Unique id for this context, if any. */
private String id = ObjectUtils.identityToString(this);
/** Display name */
/** Display name. */
private String displayName = ObjectUtils.identityToString(this);
/** Parent context */
/** Parent context. */
@Nullable
private ApplicationContext parent;
/** Environment used by this context */
/** Environment used by this context. */
@Nullable
private ConfigurableEnvironment environment;
/** BeanFactoryPostProcessors to apply on refresh */
/** BeanFactoryPostProcessors to apply on refresh. */
private final List<BeanFactoryPostProcessor> beanFactoryPostProcessors = new ArrayList<>();
/** System time in milliseconds when this context started */
/** System time in milliseconds when this context started. */
private long startupDate;
/** Flag that indicates whether this context is currently active */
/** Flag that indicates whether this context is currently active. */
private final AtomicBoolean active = new AtomicBoolean();
/** Flag that indicates whether this context has been closed already */
/** Flag that indicates whether this context has been closed already. */
private final AtomicBoolean closed = new AtomicBoolean();
/** Synchronization monitor for the "refresh" and "destroy" */
/** Synchronization monitor for the "refresh" and "destroy". */
private final Object startupShutdownMonitor = new Object();
/** Reference to the JVM shutdown hook, if registered */
/** Reference to the JVM shutdown hook, if registered. */
@Nullable
private Thread shutdownHook;
/** ResourcePatternResolver used by this context */
/** ResourcePatternResolver used by this context. */
private ResourcePatternResolver resourcePatternResolver;
/** LifecycleProcessor for managing the lifecycle of beans within this context */
/** LifecycleProcessor for managing the lifecycle of beans within this context. */
@Nullable
private LifecycleProcessor lifecycleProcessor;
/** MessageSource we delegate our implementation of this interface to */
/** MessageSource we delegate our implementation of this interface to. */
@Nullable
private MessageSource messageSource;
/** Helper class used in event publishing */
/** Helper class used in event publishing. */
@Nullable
private ApplicationEventMulticaster applicationEventMulticaster;
/** Statically specified listeners */
/** Statically specified listeners. */
private final Set<ApplicationListener<?>> applicationListeners = new LinkedHashSet<>();
/** ApplicationEvents published early */
/** ApplicationEvents published early. */
@Nullable
private Set<ApplicationEvent> earlyApplicationEvents;

6
spring-context/src/main/java/org/springframework/context/support/AbstractRefreshableApplicationContext.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -70,11 +70,11 @@ public abstract class AbstractRefreshableApplicationContext extends AbstractAppl
@Nullable
private Boolean allowCircularReferences;
/** Bean factory for this context */
/** Bean factory for this context. */
@Nullable
private DefaultListableBeanFactory beanFactory;
/** Synchronization monitor for the internal BeanFactory */
/** Synchronization monitor for the internal BeanFactory. */
private final Object beanFactoryMonitor = new Object();

10
spring-context/src/main/java/org/springframework/context/support/ApplicationObjectSupport.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,14 +48,14 @@ import org.springframework.util.Assert;
*/
public abstract class ApplicationObjectSupport implements ApplicationContextAware {
/** Logger that is available to subclasses */
/** Logger that is available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
/** ApplicationContext this object runs in */
/** ApplicationContext this object runs in. */
@Nullable
private ApplicationContext applicationContext;
/** MessageSourceAccessor for easy message access */
/** MessageSourceAccessor for easy message access. */
@Nullable
private MessageSourceAccessor messageSourceAccessor;
@@ -111,7 +111,7 @@ public abstract class ApplicationObjectSupport implements ApplicationContextAwar
/**
* Subclasses can override this for custom initialization behavior.
* Gets called by {@code setApplicationContext} after setting the context instance.
* <p>Note: Does </i>not</i> get called on reinitialization of the context
* <p>Note: Does <i>not</i> get called on re-initialization of the context
* but rather just on first initialization of this object's context reference.
* <p>The default implementation calls the overloaded {@link #initApplicationContext()}
* method without ApplicationContext reference.

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -56,7 +56,7 @@ class ContextTypeMatchClassLoader extends DecoratingClassLoader implements Smart
}
/** Cache for byte array per class name */
/** Cache for byte array per class name. */
private final Map<String, byte[]> bytesCache = new ConcurrentHashMap<>(256);

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

@@ -162,7 +162,7 @@ public class DefaultLifecycleProcessor implements LifecycleProcessor, BeanFactor
/**
* Start the specified bean as part of the given set of Lifecycle beans,
* making sure that any beans that it depends on are started first.
* @param lifecycleBeans Map with bean name as key and Lifecycle instance as value
* @param lifecycleBeans a Map with bean name as key and Lifecycle instance as value
* @param beanName the name of the bean to start
*/
private void doStart(Map<String, ? extends Lifecycle> lifecycleBeans, String beanName, boolean autoStartupOnly) {
@@ -214,7 +214,7 @@ public class DefaultLifecycleProcessor implements LifecycleProcessor, BeanFactor
/**
* Stop the specified bean as part of the given set of Lifecycle beans,
* making sure that any beans that depends on it are stopped first.
* @param lifecycleBeans Map with bean name as key and Lifecycle instance as value
* @param lifecycleBeans a Map with bean name as key and Lifecycle instance as value
* @param beanName the name of the bean to stop
*/
private void doStop(Map<String, ? extends Lifecycle> lifecycleBeans, final String beanName,

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -150,7 +150,7 @@ public class FileSystemXmlApplicationContext extends AbstractXmlApplicationConte
* interpreted as relative to the current VM working directory.
* This is consistent with the semantics in a Servlet container.
* @param path path to the resource
* @return Resource handle
* @return the Resource handle
* @see org.springframework.web.context.support.XmlWebApplicationContext#getResourceByPath
*/
@Override

8
spring-context/src/main/java/org/springframework/context/support/LiveBeansView.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -52,8 +52,14 @@ import org.springframework.util.StringUtils;
*/
public class LiveBeansView implements LiveBeansViewMBean, ApplicationContextAware {
/**
* The "MBean Domain" property name.
*/
public static final String MBEAN_DOMAIN_PROPERTY_NAME = "spring.liveBeansView.mbeanDomain";
/**
* The MBean application key.
*/
public static final String MBEAN_APPLICATION_KEY = "application";
private static final Set<ConfigurableApplicationContext> applicationContexts = new LinkedHashSet<>();

20
spring-context/src/main/java/org/springframework/context/support/MessageSourceAccessor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -80,7 +80,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the default Locale.
* @param code code of the message
* @param defaultMessage String to return if the lookup fails
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
public String getMessage(String code, String defaultMessage) {
@@ -91,8 +91,8 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param defaultMessage String to return if the lookup fails
* @param locale Locale in which to do lookup
* @param defaultMessage the String to return if the lookup fails
* @param locale the Locale in which to do lookup
* @return the message
*/
public String getMessage(String code, String defaultMessage, Locale locale) {
@@ -104,7 +104,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 {@code null} if none
* @param defaultMessage String to return if the lookup fails
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
public String getMessage(String code, @Nullable Object[] args, String defaultMessage) {
@@ -116,8 +116,8 @@ 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 {@code null} if none
* @param defaultMessage String to return if the lookup fails
* @param locale Locale in which to do lookup
* @param defaultMessage the String to return if the lookup fails
* @param locale the Locale in which to do lookup
* @return the message
*/
public String getMessage(String code, @Nullable Object[] args, String defaultMessage, Locale locale) {
@@ -138,7 +138,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param locale Locale in which to do lookup
* @param locale the Locale in which to do lookup
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -161,7 +161,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 {@code null} if none
* @param locale Locale in which to do lookup
* @param locale the Locale in which to do lookup
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -184,7 +184,7 @@ public class MessageSourceAccessor {
* Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance)
* in the given Locale.
* @param resolvable the MessageSourceResolvable
* @param locale Locale in which to do lookup
* @param locale the Locale in which to do lookup
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public abstract class MessageSourceSupport {
private static final MessageFormat INVALID_MESSAGE_FORMAT = new MessageFormat("");
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
private boolean alwaysUseMessageFormat = false;

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

@@ -115,7 +115,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractResourceBased
/**
* Set per-file charsets to use for parsing properties files.
* <p>Only applies to classic properties files, not to XML files.
* @param fileEncodings Properties with filenames as keys and charset
* @param fileEncodings a Properties with filenames as keys and charset
* names as values. Filenames have to match the basename syntax,
* with optional locale-specific components: e.g. "WEB-INF/messages"
* or "WEB-INF/messages_en".
@@ -554,7 +554,7 @@ public class ReloadableResourceBundleMessageSource extends AbstractResourceBased
private final ReentrantLock refreshLock = new ReentrantLock();
/** Cache to hold already generated MessageFormats per message code */
/** Cache to hold already generated MessageFormats per message code. */
private final ConcurrentMap<String, Map<Locale, MessageFormat>> cachedMessageFormats =
new ConcurrentHashMap<>();

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -36,7 +36,7 @@ import org.springframework.util.Assert;
*/
public class StaticMessageSource extends AbstractMessageSource {
/** Map from 'code + locale' keys to message Strings */
/** Map from 'code + locale' keys to message Strings. */
private final Map<String, String> messages = new HashMap<>();
private final Map<String, MessageFormat> cachedMessageFormats = new HashMap<>();

5
spring-context/src/main/java/org/springframework/context/weaving/AspectJWeavingEnabler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -44,6 +44,9 @@ import org.springframework.lang.Nullable;
public class AspectJWeavingEnabler
implements BeanFactoryPostProcessor, BeanClassLoaderAware, LoadTimeWeaverAware, Ordered {
/**
* The {@code aop.xml} resource location.
*/
public static final String ASPECTJ_AOP_XML_RESOURCE = "META-INF/aop.xml";

6
spring-context/src/main/java/org/springframework/ejb/access/LocalStatelessSessionProxyFactoryBean.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -52,14 +52,14 @@ import org.springframework.util.ClassUtils;
public class LocalStatelessSessionProxyFactoryBean extends LocalSlsbInvokerInterceptor
implements FactoryBean<Object>, BeanClassLoaderAware {
/** The business interface of the EJB we're proxying */
/** The business interface of the EJB we're proxying. */
@Nullable
private Class<?> businessInterface;
@Nullable
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();
/** EJBLocalObject */
/** EJBLocalObject. */
@Nullable
private Object proxy;

6
spring-context/src/main/java/org/springframework/ejb/access/SimpleRemoteStatelessSessionProxyFactoryBean.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -62,14 +62,14 @@ import org.springframework.util.ClassUtils;
public class SimpleRemoteStatelessSessionProxyFactoryBean extends SimpleRemoteSlsbInvokerInterceptor
implements FactoryBean<Object>, BeanClassLoaderAware {
/** The business interface of the EJB we're proxying */
/** The business interface of the EJB we're proxying. */
@Nullable
private Class<?> businessInterface;
@Nullable
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();
/** EJBObject */
/** EJBObject. */
@Nullable
private Object proxy;

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -33,8 +33,8 @@ public interface FormatterRegistry extends ConverterRegistry {
* Adds a Formatter to format fields of a specific type.
* The field type is implied by the parameterized Formatter instance.
* @param formatter the formatter to add
* @see #addFormatterForFieldType(Class, Formatter)
* @since 3.1
* @see #addFormatterForFieldType(Class, Formatter)
*/
void addFormatter(Formatter<?> formatter);

4
spring-context/src/main/java/org/springframework/format/datetime/DateFormatter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -126,7 +126,7 @@ public class DateFormatter implements Formatter<Date> {
* <li>'L' = Long</li>
* <li>'F' = Full</li>
* <li>'-' = Omitted</li>
* <ul>
* </ul>
* This method mimics the styles supported by Joda-Time.
* @param stylePattern two characters from the set {"S", "M", "L", "F", "-"}
* @since 3.2

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -78,7 +78,7 @@ public class DefaultFormattingConversionService extends FormattingConversionServ
* Create a new {@code DefaultFormattingConversionService} with the set of
* {@linkplain DefaultConversionService#addDefaultConverters default converters} and,
* based on the value of {@code registerDefaultFormatters}, the set of
* {@linkplain #addDefaultFormatters default formatters}
* {@linkplain #addDefaultFormatters default formatters}.
* @param embeddedValueResolver delegated to {@link #setEmbeddedValueResolver(StringValueResolver)}
* prior to calling {@link #addDefaultFormatters}.
* @param registerDefaultFormatters whether to register default formatters

4
spring-context/src/main/java/org/springframework/instrument/classloading/ResourceOverridingShadowingClassLoader.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -49,7 +49,7 @@ public class ResourceOverridingShadowingClassLoader extends ShadowingClassLoader
/**
* Key is asked for value: value is actual value
* Key is asked for value: value is actual value.
*/
private Map<String, String> overrides = new HashMap<>();

4
spring-context/src/main/java/org/springframework/instrument/classloading/ShadowingClassLoader.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@ import org.springframework.util.StringUtils;
*/
public class ShadowingClassLoader extends DecoratingClassLoader {
/** Packages that are excluded by default */
/** Packages that are excluded by default. */
public static final String[] DEFAULT_EXCLUDED_PACKAGES =
new String[] {"java.", "javax.", "sun.", "oracle.", "com.sun.", "com.ibm.", "COM.ibm.",
"org.w3c.", "org.xml.", "org.dom4j.", "org.eclipse", "org.aspectj.", "net.sf.cglib",

4
spring-context/src/main/java/org/springframework/jmx/access/MBeanClientInterceptor.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -92,7 +92,7 @@ import org.springframework.util.StringUtils;
public class MBeanClientInterceptor
implements MethodInterceptor, BeanClassLoaderAware, InitializingBean, DisposableBean {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
@Nullable

4
spring-context/src/main/java/org/springframework/jmx/access/NotificationListenerRegistrar.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -49,7 +49,7 @@ import org.springframework.util.CollectionUtils;
public class NotificationListenerRegistrar extends NotificationListenerHolder
implements InitializingBean, DisposableBean {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
private final ConnectorDelegate connector = new ConnectorDelegate();

34
spring-context/src/main/java/org/springframework/jmx/export/MBeanExporter.java
View File

@@ -130,58 +130,58 @@ public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExpo
*/
private static final String WILDCARD = "*";
/** Constant for the JMX {@code mr_type} "ObjectReference" */
/** Constant for the JMX {@code mr_type} "ObjectReference". */
private static final String MR_TYPE_OBJECT_REFERENCE = "ObjectReference";
/** Prefix for the autodetect constants defined in this class */
/** Prefix for the autodetect constants defined in this class. */
private static final String CONSTANT_PREFIX_AUTODETECT = "AUTODETECT_";
/** Constants instance for this class */
/** Constants instance for this class. */
private static final Constants constants = new Constants(MBeanExporter.class);
/** The beans to be exposed as JMX managed resources, with JMX names as keys */
/** The beans to be exposed as JMX managed resources, with JMX names as keys. */
@Nullable
private Map<String, Object> beans;
/** The autodetect mode to use for this MBeanExporter */
/** The autodetect mode to use for this MBeanExporter. */
@Nullable
private Integer autodetectMode;
/** Whether to eagerly initialize candidate beans when autodetecting MBeans */
/** Whether to eagerly initialize candidate beans when autodetecting MBeans. */
private boolean allowEagerInit = false;
/** Stores the MBeanInfoAssembler to use for this exporter */
/** Stores the MBeanInfoAssembler to use for this exporter. */
private MBeanInfoAssembler assembler = new SimpleReflectiveMBeanInfoAssembler();
/** The strategy to use for creating ObjectNames for an object */
/** The strategy to use for creating ObjectNames for an object. */
private ObjectNamingStrategy namingStrategy = new KeyNamingStrategy();
/** Indicates whether Spring should modify generated ObjectNames */
/** Indicates whether Spring should modify generated ObjectNames. */
private boolean ensureUniqueRuntimeObjectNames = true;
/** Indicates whether Spring should expose the managed resource ClassLoader in the MBean */
/** Indicates whether Spring should expose the managed resource ClassLoader in the MBean. */
private boolean exposeManagedResourceClassLoader = true;
/** A set of bean names that should be excluded from autodetection */
/** A set of bean names that should be excluded from autodetection. */
private Set<String> excludedBeans = new HashSet<>();
/** The MBeanExporterListeners registered with this exporter. */
@Nullable
private MBeanExporterListener[] listeners;
/** The NotificationListeners to register for the MBeans registered by this exporter */
/** The NotificationListeners to register for the MBeans registered by this exporter. */
@Nullable
private NotificationListenerBean[] notificationListeners;
/** Map of actually registered NotificationListeners */
/** Map of actually registered NotificationListeners. */
private final Map<NotificationListenerBean, ObjectName[]> registeredNotificationListeners = new LinkedHashMap<>();
/** Stores the ClassLoader to use for generating lazy-init proxies */
/** Stores the ClassLoader to use for generating lazy-init proxies. */
@Nullable
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();
/** Stores the BeanFactory for use in autodetection process */
/** Stores the BeanFactory for use in autodetection process. */
@Nullable
private ListableBeanFactory beanFactory;
@@ -197,7 +197,7 @@ public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExpo
* Bean instances are typically linked in through bean references.
* Bean names will be resolved as beans in the current factory, respecting
* lazy-init markers (that is, not triggering initialization of such beans).
* @param beans Map with JMX names as keys and bean instances or bean names
* @param beans a Map with JMX names as keys and bean instances or bean names
* as values
* @see #setNamingStrategy
* @see org.springframework.jmx.export.naming.KeyNamingStrategy
@@ -1029,7 +1029,7 @@ public class MBeanExporter extends MBeanRegistrationSupport implements MBeanExpo
}
/**
/**
* Notifies all registered {@link MBeanExporterListener MBeanExporterListeners} of the
* registration of the MBean identified by the supplied {@link ObjectName}.
*/

6
spring-context/src/main/java/org/springframework/jmx/export/assembler/InterfaceBasedMBeanInfoAssembler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -64,14 +64,14 @@ public class InterfaceBasedMBeanInfoAssembler extends AbstractConfigurableMBeanI
@Nullable
private Class<?>[] managedInterfaces;
/** Mappings of bean keys to an array of classes */
/** Mappings of bean keys to an array of classes. */
@Nullable
private Properties interfaceMappings;
@Nullable
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();
/** Mappings of bean keys to an array of classes */
/** Mappings of bean keys to an array of classes. */
@Nullable
private Map<String, Class<?>[]> resolvedInterfaceMappings;

8
spring-context/src/main/java/org/springframework/jmx/export/assembler/SimpleReflectiveMBeanInfoAssembler.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -45,9 +45,9 @@ public class SimpleReflectiveMBeanInfoAssembler extends AbstractConfigurableMBea
return true;
}
/**
* Always returns {@code true}.
*/
/**
* Always returns {@code true}.
*/
@Override
protected boolean includeOperation(Method method, String beanKey) {
return true;

5
spring-context/src/main/java/org/springframework/jmx/export/metadata/ManagedAttribute.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,6 +29,9 @@ import org.springframework.lang.Nullable;
*/
public class ManagedAttribute extends AbstractJmxAttribute {
/**
* Empty attributes.
*/
public static final ManagedAttribute EMPTY = new ManagedAttribute();

8
spring-context/src/main/java/org/springframework/jmx/export/naming/IdentityNamingStrategy.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -38,8 +38,14 @@ import org.springframework.util.ObjectUtils;
*/
public class IdentityNamingStrategy implements ObjectNamingStrategy {
/**
* The type key.
*/
public static final String TYPE_KEY = "type";
/**
* The hash code key.
*/
public static final String HASH_CODE_KEY = "hashCode";

5
spring-context/src/main/java/org/springframework/jmx/export/notification/ModelMBeanNotificationPublisher.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -103,8 +103,9 @@ public class ModelMBeanNotificationPublisher implements NotificationPublisher {
}
/**
* Replaces the notification source if necessary to do so.
* From the {@link Notification javadoc}:
* <p><i>"It is strongly recommended that notification senders use the object name
* <i>"It is strongly recommended that notification senders use the object name
* rather than a reference to the MBean object as the source."</i>
* @param notification the {@link Notification} whose
* {@link javax.management.Notification#getSource()} might need massaging

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -56,7 +56,7 @@ import org.springframework.util.CollectionUtils;
public class ConnectorServerFactoryBean extends MBeanRegistrationSupport
implements FactoryBean<JMXConnectorServer>, InitializingBean, DisposableBean {
/** The default service URL */
/** The default service URL. */
public static final String DEFAULT_SERVICE_URL = "service:jmx:jmxmp://localhost:9875";

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -143,7 +143,7 @@ public class MBeanServerConnectionFactoryBean
}
/**
* Creates lazy proxies for the {@code JMXConnector} and {@code MBeanServerConnection}
* Creates lazy proxies for the {@code JMXConnector} and {@code MBeanServerConnection}.
*/
private void createLazyConnection() {
this.connectorTargetSource = new JMXConnectorLazyInitTargetSource();

3
spring-context/src/main/java/org/springframework/jndi/JndiCallback.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@ import org.springframework.lang.Nullable;
* convenience methods.
*
* @author Rod Johnson
* @param <T> the resulting object type
* @see JndiTemplate
* @see org.springframework.jdbc.core.JdbcTemplate
*/

4
spring-context/src/main/java/org/springframework/jndi/JndiLocatorSupport.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ import org.springframework.util.Assert;
*/
public abstract class JndiLocatorSupport extends JndiAccessor {
/** JNDI prefix used in a Java EE container */
/** JNDI prefix used in a Java EE container. */
public static final String CONTAINER_PREFIX = "java:comp/env/";

4
spring-context/src/main/java/org/springframework/jndi/JndiTemplate.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -79,7 +79,7 @@ public class JndiTemplate {
/**
* Execute the given JNDI context callback implementation.
* @param contextCallback JndiCallback implementation
* @param contextCallback the JndiCallback implementation to use
* @return a result object returned by the callback, or {@code null}
* @throws NamingException thrown by the callback implementation
* @see #createInitialContext

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

@@ -63,10 +63,10 @@ public class SimpleJndiBeanFactory extends JndiLocatorSupport implements BeanFac
/** JNDI names of resources that are known to be shareable, i.e. can be cached */
private final Set<String> shareableResources = new HashSet<>();
/** Cache of shareable singleton objects: bean name --> bean instance */
/** Cache of shareable singleton objects: bean name to bean instance. */
private final Map<String, Object> singletonObjects = new HashMap<>();
/** Cache of the types of nonshareable resources: bean name --> bean type */
/** Cache of the types of nonshareable resources: bean name to bean type. */
private final Map<String, Class<?>> resourceTypes = new HashMap<>();

4
spring-context/src/main/java/org/springframework/remoting/RemoteAccessException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ import org.springframework.core.NestedRuntimeException;
*/
public class RemoteAccessException extends NestedRuntimeException {
/** Use serialVersionUID from Spring 1.2 for interoperability */
/** Use serialVersionUID from Spring 1.2 for interoperability. */
private static final long serialVersionUID = -4906825139312227864L;

4
spring-context/src/main/java/org/springframework/remoting/rmi/RemoteInvocationSerializingExporter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -50,7 +50,7 @@ public abstract class RemoteInvocationSerializingExporter extends RemoteInvocati
implements InitializingBean {
/**
* Default content type: "application/x-java-serialized-object"
* Default content type: "application/x-java-serialized-object".
*/
public static final String CONTENT_TYPE_SERIALIZED_OBJECT = "application/x-java-serialized-object";

4
spring-context/src/main/java/org/springframework/remoting/rmi/RmiInvocationWrapper.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ class RmiInvocationWrapper implements RmiInvocationHandler {
/**
* Create a new RmiInvocationWrapper for the given object
* Create a new RmiInvocationWrapper for the given object.
* @param wrappedObject the object to wrap with an RmiInvocationHandler
* @param rmiExporter the RMI exporter to handle the actual invocation
*/

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -49,7 +49,7 @@ import org.springframework.util.ClassUtils;
*/
public class RemoteInvocation implements Serializable {
/** use serialVersionUID from Spring 1.1 for interoperability */
/** use serialVersionUID from Spring 1.1 for interoperability. */
private static final long serialVersionUID = 6876024250231820554L;

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ import org.springframework.lang.Nullable;
*/
public class RemoteInvocationResult implements Serializable {
/** Use serialVersionUID from Spring 1.1 for interoperability */
/** Use serialVersionUID from Spring 1.1 for interoperability. */
private static final long serialVersionUID = 2138555143707773549L;

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ import org.springframework.util.ClassUtils;
*/
public abstract class RemotingSupport implements BeanClassLoaderAware {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();

3
spring-context/src/main/java/org/springframework/scheduling/annotation/AsyncResult.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -41,6 +41,7 @@ import org.springframework.util.concurrent.SuccessCallback;
* @author Juergen Hoeller
* @author Rossen Stoyanchev
* @since 3.0
* @param <V> the value type
* @see Async
* @see #forValue(Object)
* @see #forExecutionException(Throwable)

17
spring-context/src/main/java/org/springframework/scheduling/annotation/EnableAsync.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -112,19 +112,18 @@ import org.springframework.core.Ordered;
* configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans&gt;
*
* <task:annotation-driven executor="myExecutor" exception-handler="exceptionHandler"/>
* &lt;task:annotation-driven executor="myExecutor" exception-handler="exceptionHandler"/&gt;
*
* <task:executor id="myExecutor" pool-size="7-42" queue-capacity="11"/>
* &lt;task:executor id="myExecutor" pool-size="7-42" queue-capacity="11"/&gt;
*
* <bean id="asyncBean" class="com.foo.MyAsyncBean"/>
* &lt;bean id="asyncBean" class="com.foo.MyAsyncBean"/&gt;
*
* <bean id="exceptionHandler" class="com.foo.MyAsyncUncaughtExceptionHandler"/>
* &lt;bean id="exceptionHandler" class="com.foo.MyAsyncUncaughtExceptionHandler"/&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* The above XML-based and JavaConfig-based examples are equivalent except for the
* setting of the <em>thread name prefix</em> of the {@code Executor}; this is because

19
spring-context/src/main/java/org/springframework/scheduling/annotation/EnableScheduling.java
View File

@@ -165,21 +165,20 @@ import org.springframework.scheduling.config.ScheduledTaskRegistrar;
* configuration:
*
* <pre class="code">
* {@code
* <beans>
* &lt;beans>
*
* <task:annotation-driven scheduler="taskScheduler"/>
* &lt;task:annotation-driven scheduler="taskScheduler"/&gt;
*
* <task:scheduler id="taskScheduler" pool-size="42"/>
* &lt;task:scheduler id="taskScheduler" pool-size="42"/&gt;
*
* <task:scheduled-tasks scheduler="taskScheduler">
* <task:scheduled ref="myTask" method="work" fixed-rate="1000"/>
* </task:scheduled-tasks>
* &lt;task:scheduled-tasks scheduler="taskScheduler"&gt;
* &lt;task:scheduled ref="myTask" method="work" fixed-rate="1000"/&gt;
* &lt;/task:scheduled-tasks&gt;
*
* <bean id="myTask" class="com.foo.MyTask"/>
* &lt;bean id="myTask" class="com.foo.MyTask"/&gt;
*
* </beans>
* }</pre>
* &lt;/beans&gt;
* </pre>
*
* The examples are equivalent save that in XML a <em>fixed-rate</em> period is used
* instead of a custom <em>{@code Trigger}</em> implementation; this is because the

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ public interface SchedulingConfigurer {
/**
* Callback allowing a {@link org.springframework.scheduling.TaskScheduler
* TaskScheduler} and specific {@link org.springframework.scheduling.config.Task Task}
* instances to be registered against the given the {@link ScheduledTaskRegistrar}
* instances to be registered against the given the {@link ScheduledTaskRegistrar}.
* @param taskRegistrar the registrar to be configured.
*/
void configureTasks(ScheduledTaskRegistrar taskRegistrar);

2
spring-context/src/main/java/org/springframework/scheduling/config/ScheduledTaskRegistrar.java
View File

@@ -254,7 +254,7 @@ public class ScheduledTaskRegistrar implements ScheduledTaskHolder, Initializing
}
/**
* Add a Runnable task to be triggered per the given cron expression
* Add a Runnable task to be triggered per the given cron expression.
*/
public void addCronTask(Runnable task, String expression) {
addCronTask(new CronTask(task, expression));

6
spring-context/src/main/java/org/springframework/scheduling/support/PeriodicTrigger.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,8 +29,8 @@ import org.springframework.util.Assert;
* fixed-rate or fixed-delay, and an initial delay value may also be configured.
* The default initial delay is 0, and the default behavior is fixed-delay
* (i.e. the interval between successive executions is measured from each
* <emphasis>completion</emphasis> time). To measure the interval between the
* scheduled <emphasis>start</emphasis> time of each execution instead, set the
* <i>completion</i> time). To measure the interval between the
* scheduled <i>start</i> time of each execution instead, set the
* 'fixedRate' property to {@code true}.
*
* <p>Note that the TaskScheduler interface already defines methods for scheduling

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@ public class SimpleTriggerContext implements TriggerContext {
/**
* Create a SimpleTriggerContext with all time values set to {@code null}.
*/
public SimpleTriggerContext() {
public SimpleTriggerContext() {
}
/**

4
spring-context/src/main/java/org/springframework/scripting/config/LangNamespaceUtils.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@ import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.scripting.support.ScriptFactoryPostProcessor;
/**
* Utilities for use with {@link LangNamespaceHandler}.
*
* @author Rob Harrop
* @author Mark Fisher
* @since 2.5

4
spring-context/src/main/java/org/springframework/scripting/config/ScriptingDefaultsParser.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -25,6 +25,8 @@ import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
/**
* A {@link BeanDefinitionParser} for use when loading scripting XML.
*
* @author Mark Fisher
* @since 2.5
*/

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -47,7 +47,7 @@ import org.springframework.util.StringUtils;
*/
public class ResourceScriptSource implements ScriptSource {
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
private EncodedResource resource;

13
spring-context/src/main/java/org/springframework/scripting/support/ScriptFactoryPostProcessor.java
View File

@@ -147,12 +147,21 @@ public class ScriptFactoryPostProcessor extends InstantiationAwareBeanPostProces
*/
public static final String INLINE_SCRIPT_PREFIX = "inline:";
/**
* The {@code refreshCheckDelay} attribute.
*/
public static final String REFRESH_CHECK_DELAY_ATTRIBUTE = Conventions.getQualifiedAttributeName(
ScriptFactoryPostProcessor.class, "refreshCheckDelay");
/**
* The {@code proxyTargetClass} attribute.
*/
public static final String PROXY_TARGET_CLASS_ATTRIBUTE = Conventions.getQualifiedAttributeName(
ScriptFactoryPostProcessor.class, "proxyTargetClass");
/**
* The {@code language} attribute.
*/
public static final String LANGUAGE_ATTRIBUTE = Conventions.getQualifiedAttributeName(
ScriptFactoryPostProcessor.class, "language");
@@ -161,7 +170,7 @@ public class ScriptFactoryPostProcessor extends InstantiationAwareBeanPostProces
private static final String SCRIPTED_OBJECT_NAME_PREFIX = "scriptedObject.";
/** Logger available to subclasses */
/** Logger available to subclasses. */
protected final Log logger = LogFactory.getLog(getClass());
private long defaultRefreshCheckDelay = -1;
@@ -178,7 +187,7 @@ public class ScriptFactoryPostProcessor extends InstantiationAwareBeanPostProces
final DefaultListableBeanFactory scriptBeanFactory = new DefaultListableBeanFactory();
/** Map from bean name String to ScriptSource object */
/** Map from bean name String to ScriptSource object. */
private final Map<String, ScriptSource> scriptSourceCache = new HashMap<>();

4
spring-context/src/main/java/org/springframework/ui/ConcurrentModel.java
View File

@@ -81,10 +81,10 @@ public class ConcurrentModel extends ConcurrentHashMap<String, Object> implement
/**
* Add the supplied attribute to this {@code Map} using a
* {@link org.springframework.core.Conventions#getVariableName generated name}.
* <p><emphasis>Note: Empty {@link Collection Collections} are not added to
* <p><i>Note: Empty {@link Collection Collections} are not added to
* the model when using this method because we cannot correctly determine
* the true convention name. View code should check for {@code null} rather
* than for empty collections as is already done by JSTL tags.</emphasis>
* than for empty collections as is already done by JSTL tags.</i>
* @param attributeValue the model attribute value (never {@code null} for {@code ConcurrentModel},
* with the {@code Nullable} declaration inherited from {@link Model#addAttribute(String, Object)})
*/

6
spring-context/src/main/java/org/springframework/ui/Model.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -41,10 +41,10 @@ public interface Model {
/**
* Add the supplied attribute to this {@code Map} using a
* {@link org.springframework.core.Conventions#getVariableName generated name}.
* <p><emphasis>Note: Empty {@link java.util.Collection Collections} are not added to
* <p><i>Note: Empty {@link java.util.Collection Collections} are not added to
* the model when using this method because we cannot correctly determine
* the true convention name. View code should check for {@code null} rather
* than for empty collections as is already done by JSTL tags.</emphasis>
* than for empty collections as is already done by JSTL tags.</i>
* @param attributeValue the model attribute value (never {@code null})
*/
Model addAttribute(Object attributeValue);

6
spring-context/src/main/java/org/springframework/ui/ModelMap.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -80,10 +80,10 @@ public class ModelMap extends LinkedHashMap<String, Object> {
/**
* Add the supplied attribute to this {@code Map} using a
* {@link org.springframework.core.Conventions#getVariableName generated name}.
* <p><emphasis>Note: Empty {@link Collection Collections} are not added to
* <p><i>Note: Empty {@link Collection Collections} are not added to
* the model when using this method because we cannot correctly determine
* the true convention name. View code should check for {@code null} rather
* than for empty collections as is already done by JSTL tags.</emphasis>
* than for empty collections as is already done by JSTL tags.</i>
* @param attributeValue the model attribute value (never {@code null})
*/
public ModelMap addAttribute(Object attributeValue) {

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -61,7 +61,7 @@ public class ResourceBundleThemeSource implements HierarchicalThemeSource, BeanC
@Nullable
private ClassLoader beanClassLoader;
/** Map from theme name to Theme instance */
/** Map from theme name to Theme instance. */
private final Map<String, Theme> themeCache = new ConcurrentHashMap<>();

4
spring-context/src/main/java/org/springframework/validation/DataBinder.java
View File

@@ -108,10 +108,10 @@ import org.springframework.util.StringUtils;
*/
public class DataBinder implements PropertyEditorRegistry, TypeConverter {
/** Default object name used for binding: "target" */
/** Default object name used for binding: "target". */
public static final String DEFAULT_OBJECT_NAME = "target";
/** Default limit for array and collection growing: 256 */
/** Default limit for array and collection growing: 256. */
public static final int DEFAULT_AUTO_GROW_COLLECTION_LIMIT = 256;

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -194,7 +194,7 @@ public interface Errors {
/**
* Get all errors, both global and field ones.
* @return List of {@link ObjectError} instances
* @return a list of {@link ObjectError} instances
*/
List<ObjectError> getAllErrors();
@@ -214,7 +214,7 @@ public interface Errors {
/**
* Get all global errors.
* @return List of ObjectError instances
* @return a list of {@link ObjectError} instances
*/
List<ObjectError> getGlobalErrors();