Polishing

Author: jhoeller

spring-aop/src/main/java/org/springframework/aop/framework/ObjenesisCglibAopProxy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2019 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,7 +26,7 @@
 
 /**
  * Objenesis-based extension of {@link CglibAopProxy} to create proxy instances
- * without invoking the constructor of the class.
+ * without invoking the constructor of the class. Used by default as of Spring 4.
  *
  * @author Oliver Gierke
  * @author Juergen Hoeller
@@ -50,7 +50,6 @@ public ObjenesisCglibAopProxy(AdvisedSupport config) {
 
 
 	@Override
-	@SuppressWarnings("unchecked")
 	protected Object createProxyClassAndInstance(Enhancer enhancer, Callback[] callbacks) {
 		Class<?> proxyClass = enhancer.createClass();
 		Object proxyInstance = null;

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/AbstractJCacheOperation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2019 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.
@@ -19,6 +19,7 @@
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedHashSet;
 import java.util.List;
@@ -32,8 +33,6 @@
 import org.springframework.util.Assert;
 import org.springframework.util.ExceptionTypeFilter;
 
-import static java.util.Arrays.*;
-
 /**
  * A base {@link JCacheOperation} implementation.
  *
@@ -50,24 +49,27 @@ abstract class AbstractJCacheOperation<A extends Annotation> implements JCacheOp
 
 
 	/**
-	 * Create a new instance.
+	 * Construct a new {@code AbstractJCacheOperation}.
 	 * @param methodDetails the {@link CacheMethodDetails} related to the cached method
 	 * @param cacheResolver the cache resolver to resolve regular caches
 	 */
 	protected AbstractJCacheOperation(CacheMethodDetails<A> methodDetails, CacheResolver cacheResolver) {
-		Assert.notNull(methodDetails, "method details must not be null.");
-		Assert.notNull(cacheResolver, "cache resolver must not be null.");
+		Assert.notNull(methodDetails, "CacheMethodDetails must not be null");
+		Assert.notNull(cacheResolver, "CacheResolver must not be null");
 		this.methodDetails = methodDetails;
 		this.cacheResolver = cacheResolver;
 		this.allParameterDetails = initializeAllParameterDetails(methodDetails.getMethod());
 	}
 
-
-	/**
-	 * Return the {@link ExceptionTypeFilter} to use to filter exceptions thrown while
-	 * invoking the method.
-	 */
-	public abstract ExceptionTypeFilter getExceptionTypeFilter();
+	private static List<CacheParameterDetail> initializeAllParameterDetails(Method method) {
+		int parameterCount = method.getParameterTypes().length;
+		List<CacheParameterDetail> result = new ArrayList<CacheParameterDetail>(parameterCount);
+		for (int i = 0; i < parameterCount; i++) {
+			CacheParameterDetail detail = new CacheParameterDetail(method, i);
+			result.add(detail);
+		}
+		return result;
+	}
 
 
 	@Override
@@ -113,12 +115,25 @@ public CacheInvocationParameter[] getAllParameters(Object... values) {
 		return result.toArray(new CacheInvocationParameter[result.size()]);
 	}
 
+
+	/**
+	 * Return the {@link ExceptionTypeFilter} to use to filter exceptions thrown while
+	 * invoking the method.
+	 * @see #createExceptionTypeFilter
+	 */
+	public abstract ExceptionTypeFilter getExceptionTypeFilter();
+
+	/**
+	 * Convenience method for subclasses to create a specific {@code ExceptionTypeFilter}.
+	 * @see #getExceptionTypeFilter()
+	 */
 	protected ExceptionTypeFilter createExceptionTypeFilter(
 			Class<? extends Throwable>[] includes, Class<? extends Throwable>[] excludes) {
 
-		return new ExceptionTypeFilter(asList(includes), asList(excludes), true);
+		return new ExceptionTypeFilter(Arrays.asList(includes), Arrays.asList(excludes), true);
 	}
 
+
 	@Override
 	public String toString() {
 		return getOperationDescription().append("]").toString();
@@ -137,16 +152,9 @@ protected StringBuilder getOperationDescription() {
 	}
 
 
-	private static List<CacheParameterDetail> initializeAllParameterDetails(Method method) {
-		List<CacheParameterDetail> result = new ArrayList<CacheParameterDetail>();
-		for (int i = 0; i < method.getParameterTypes().length; i++) {
-			CacheParameterDetail detail = new CacheParameterDetail(method, i);
-			result.add(detail);
-		}
-		return result;
-	}
-
-
+	/**
+	 * Details for a single cache parameter.
+	 */
 	protected static class CacheParameterDetail {
 
 		private final Class<?> rawType;
@@ -196,6 +204,9 @@ public CacheInvocationParameter toCacheInvocationParameter(Object value) {
 	}
 
 
+	/**
+	 * A single cache invocation parameter.
+	 */
 	protected static class CacheInvocationParameterImpl implements CacheInvocationParameter {
 
 		private final CacheParameterDetail detail;

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/JCacheOperation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2019 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,9 +24,10 @@
 import org.springframework.cache.interceptor.CacheResolver;
 
 /**
- * Model the base of JSR-107 cache operation.
- * <p>A cache operation can be statically cached as it does not contain
- * any runtime operation of a specific cache invocation.
+ * Model the base of JSR-107 cache operation through an interface contract.
+ *
+ * <p>A cache operation can be statically cached as it does not contain any
+ * runtime operation of a specific cache invocation.
  *
  * @author Stephane Nicoll
  * @since 4.1
@@ -48,4 +49,4 @@ public interface JCacheOperation<A extends Annotation> extends BasicOperation, C
 	 */
 	CacheInvocationParameter[] getAllParameters(Object... values);
 
-}
+}

spring-context/src/main/java/org/springframework/context/ResourceLoaderAware.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2019 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,44 +20,44 @@
 import org.springframework.core.io.ResourceLoader;
 
 /**
- * Interface to be implemented by any object that wishes to be notified of
- * the <b>ResourceLoader</b> (typically the ApplicationContext) that it runs in.
- * This is an alternative to a full ApplicationContext dependency via the
- * ApplicationContextAware interface.
+ * Interface to be implemented by any object that wishes to be notified of the
+ * {@link ResourceLoader} (typically the ApplicationContext) that it runs in.
+ * This is an alternative to a full {@link ApplicationContext} dependency via
+ * the {@link org.springframework.context.ApplicationContextAware} interface.
  *
- * <p>Note that Resource dependencies can also be exposed as bean properties
- * of type Resource, populated via Strings with automatic type conversion by
- * the bean factory. This removes the need for implementing any callback
- * interface just for the purpose of accessing a specific file resource.
+ * <p>Note that {@link org.springframework.core.io.Resource} dependencies can also
+ * be exposed as bean properties of type {@code Resource}, populated via Strings
+ * with automatic type conversion by the bean factory. This removes the need for
+ * implementing any callback interface just for the purpose of accessing a
+ * specific file resource.
  *
- * <p>You typically need a ResourceLoader when your application object has
- * to access a variety of file resources whose names are calculated. A good
- * strategy is to make the object use a DefaultResourceLoader but still
- * implement ResourceLoaderAware to allow for overriding when running in an
- * ApplicationContext. See ReloadableResourceBundleMessageSource for an example.
+ * <p>You typically need a {@link ResourceLoader} when your application object has to
+ * access a variety of file resources whose names are calculated. A good strategy is
+ * to make the object use a {@link org.springframework.core.io.DefaultResourceLoader}
+ * but still implement {@code ResourceLoaderAware} to allow for overriding when
+ * running in an {@code ApplicationContext}. See
+ * {@link org.springframework.context.support.ReloadableResourceBundleMessageSource}
+ * for an example.
  *
- * <p>A passed-in ResourceLoader can also be checked for the
- * <b>ResourcePatternResolver</b> interface and cast accordingly, to be able
- * 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 {@code ResourcePatternUtils.getResourcePatternResolver} method.
+ * <p>A passed-in {@code ResourceLoader} can also be checked for the
+ * {@link org.springframework.core.io.support.ResourcePatternResolver} interface
+ * and cast accordingly, in order to resolve resource patterns into arrays of
+ * {@code Resource} objects. This will always work when running in an ApplicationContext
+ * (since the context interface extends the ResourcePatternResolver interface). Use a
+ * {@link org.springframework.core.io.support.PathMatchingResourcePatternResolver} as
+ * default; see also the {@code ResourcePatternUtils.getResourcePatternResolver} method.
  *
- * <p>As alternative to a ResourcePatternResolver dependency, consider exposing
- * bean properties of type Resource array, populated via pattern Strings with
- * automatic type conversion by the bean factory.
+ * <p>As an alternative to a {@code ResourcePatternResolver} dependency, consider
+ * exposing bean properties of type {@code Resource} array, populated via pattern
+ * Strings with automatic type conversion by the bean factory at binding time.
  *
  * @author Juergen Hoeller
  * @author Chris Beams
  * @since 10.03.2004
  * @see ApplicationContextAware
- * @see org.springframework.beans.factory.InitializingBean
  * @see org.springframework.core.io.Resource
+ * @see org.springframework.core.io.ResourceLoader
  * @see org.springframework.core.io.support.ResourcePatternResolver
- * @see org.springframework.core.io.support.ResourcePatternUtils#getResourcePatternResolver
- * @see org.springframework.core.io.DefaultResourceLoader
- * @see org.springframework.core.io.support.PathMatchingResourcePatternResolver
- * @see org.springframework.context.support.ReloadableResourceBundleMessageSource
  */
 public interface ResourceLoaderAware extends Aware {
 
@@ -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
 	 */

spring-core/src/main/java/org/springframework/core/io/support/ResourcePatternUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2019 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,10 +48,10 @@ public static boolean isUrl(String resourceLocation) {
 	}
 
 	/**
-	 * Return a default ResourcePatternResolver for the given ResourceLoader.
-	 * <p>This might be the ResourceLoader itself, if it implements the
-	 * ResourcePatternResolver extension, or a PathMatchingResourcePatternResolver
-	 * built on the given ResourceLoader.
+	 * Return a default {@link ResourcePatternResolver} for the given {@link ResourceLoader}.
+	 * <p>This might be the {@code ResourceLoader} itself, if it implements the
+	 * {@code ResourcePatternResolver} extension, or a default
+	 * {@link PathMatchingResourcePatternResolver} built on the given {@code ResourceLoader}.
 	 * @param resourceLoader the ResourceLoader to build a pattern resolver for
 	 * (may be {@code null} to indicate a default ResourceLoader)
 	 * @return the ResourcePatternResolver

spring-expression/src/main/java/org/springframework/expression/spel/ast/CompoundExpression.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2019 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,8 @@
 import org.springframework.expression.spel.SpelEvaluationException;
 
 /**
- * Represents a DOT separated expression sequence, such as 'property1.property2.methodOne()'
+ * Represents a DOT separated expression sequence, such as
+ * {@code 'property1.property2.methodOne()'}.
  *
  * @author Andy Clement
  * @since 3.0
@@ -111,7 +112,7 @@ public String toStringAST() {
 		}
 		return sb.toString();
 	}
-	
+
 	@Override
 	public boolean isCompilable() {
 		for (SpelNodeImpl child: this.children) {
@@ -121,11 +122,11 @@ public boolean isCompilable() {
 		}
 		return true;
 	}
-	
+
 	@Override
 	public void generateCode(MethodVisitor mv, CodeFlow cf) {
-		for (int i = 0; i < this.children.length;i++) {
-			this.children[i].generateCode(mv, cf);
+		for (SpelNodeImpl child : this.children) {
+			child.generateCode(mv, cf);
 		}
 		cf.pushDescriptor(this.exitTypeDescriptor);
 	}

spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttribute.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2019 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,8 @@
 
 /**
  * This interface adds a {@code rollbackOn} specification to {@link TransactionDefinition}.
- * As custom {@code rollbackOn} is only possible with AOP, this class resides
- * in the AOP transaction package.
+ * As custom {@code rollbackOn} is only possible with AOP, it resides in the AOP-related
+ * transaction subpackage.
  *
  * @author Rod Johnson
  * @author Juergen Hoeller
@@ -35,6 +35,7 @@ public interface TransactionAttribute extends TransactionDefinition {
 	 * Return a qualifier value associated with this transaction attribute.
 	 * <p>This may be used for choosing a corresponding transaction manager
 	 * to process this specific transaction.
+	 * @since 3.0
 	 */
 	String getQualifier();