Polishing

Author: jhoeller

spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -30,33 +30,33 @@
  *
  * <p>The default placeholder syntax follows the Ant / Log4J / JSP EL style:
  *
- *<pre class="code">${...}</pre>
+ * <pre class="code">${...}</pre>
  *
  * Example XML bean definition:
  *
- *<pre class="code">{@code
- *<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>
- *    <property name="driverClassName" value="}${driver}{@code "/>
- *    <property name="url" value="jdbc:}${dbname}{@code "/>
- *</bean>
- *}</pre>
+ * <pre class="code">
+ * <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>
+ *   <property name="driverClassName" value="${driver}"/>
+ *   <property name="url" value="jdbc:${dbname}"/>
+ * </bean>
+ * </pre>
  *
  * Example properties file:
  *
- * <pre class="code"> driver=com.mysql.jdbc.Driver
+ * <pre class="code">driver=com.mysql.jdbc.Driver
  * dbname=mysql:mydb</pre>
  *
  * Annotated bean definitions may take advantage of property replacement using
  * the {@link org.springframework.beans.factory.annotation.Value @Value} annotation:
  *
- *<pre class="code">@Value("${person.age}")</pre>
+ * <pre class="code">@Value("${person.age}")</pre>
  *
  * Implementations check simple property values, lists, maps, props, and bean names
  * in bean references. Furthermore, placeholder values can also cross-reference
  * other placeholders, like:
  *
- *<pre class="code">rootPath=myrootdir
- *subPath=${rootPath}/subdir</pre>
+ * <pre class="code">rootPath=myrootdir
+ * subPath=${rootPath}/subdir</pre>
  *
  * In contrast to {@link PropertyOverrideConfigurer}, subclasses of this type allow
  * filling in of explicit placeholders in bean definitions.
@@ -75,9 +75,9 @@
  *
  * <p>Example XML property with default value:
  *
- *<pre class="code">{@code
- *  <property name="url" value="jdbc:}${dbname:defaultdb}{@code "/>
- *}</pre>
+ * <pre class="code">
+ *   <property name="url" value="jdbc:${dbname:defaultdb}"/>
+ * </pre>
  *
  * @author Chris Beams
  * @author Juergen Hoeller
@@ -107,14 +107,14 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi
 	/** Defaults to {@value #DEFAULT_VALUE_SEPARATOR} */
 	protected String valueSeparator = DEFAULT_VALUE_SEPARATOR;
 
-	protected boolean ignoreUnresolvablePlaceholders = false;
-
 	protected String nullValue;
 
-	private BeanFactory beanFactory;
+	protected boolean ignoreUnresolvablePlaceholders = false;
 
 	private String beanName;
 
+	private BeanFactory beanFactory;
+
 
 	/**
 	 * Set the prefix that a placeholder string starts with.
@@ -143,13 +143,13 @@ public void setValueSeparator(String valueSeparator) {
 	}
 
 	/**
-	 * Set a value that should be treated as {@code null} when
-	 * resolved as a placeholder value: e.g. "" (empty String) or "null".
+	 * Set a value that should be treated as {@code null} when resolved
+	 * as a placeholder value: e.g. "" (empty String) or "null".
 	 * <p>Note that this will only apply to full property values,
 	 * not to parts of concatenated values.
 	 * <p>By default, no such null value is defined. This means that
-	 * there is no way to express {@code null} as a property
-	 * value unless you explicitly map a corresponding value here.
+	 * there is no way to express {@code null} as a property value
+	 * unless you explicitly map a corresponding value here.
 	 */
 	public void setNullValue(String nullValue) {
 		this.nullValue = nullValue;

spring-context-support/src/main/java/org/springframework/cache/ehcache/EhCacheCacheManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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,6 @@
 
 import org.springframework.cache.Cache;
 import org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager;
-import org.springframework.util.Assert;
 
 /**
  * CacheManager backed by an EhCache {@link net.sf.ehcache.CacheManager}.
@@ -81,8 +80,10 @@ public void afterPropertiesSet() {
 	@Override
 	protected Collection<Cache> loadCaches() {
 		Status status = getCacheManager().getStatus();
-		Assert.isTrue(Status.STATUS_ALIVE.equals(status),
-				"An 'alive' EhCache CacheManager is required - current cache is " + status.toString());
+		if (!Status.STATUS_ALIVE.equals(status)) {
+			throw new IllegalStateException(
+					"An 'alive' EhCache CacheManager is required - current cache is " + status.toString());
+		}
 
 		String[] names = getCacheManager().getCacheNames();
 		Collection<Cache> caches = new LinkedHashSet<Cache>(names.length);
@@ -94,8 +95,7 @@ protected Collection<Cache> loadCaches() {
 
 	@Override
 	protected Cache getMissingCache(String name) {
-		// check the EhCache cache again
-		// (in case the cache was added at runtime)
+		// Check the EhCache cache again (in case the cache was added at runtime)
 		Ehcache ehcache = getCacheManager().getEhcache(name);
 		if (ehcache != null) {
 			return new EhCacheCache(ehcache);

spring-context-support/src/test/java/org/springframework/cache/ehcache/EhCacheCacheManagerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -30,9 +30,12 @@
 public class EhCacheCacheManagerTests extends AbstractTransactionSupportingCacheManagerTests<EhCacheCacheManager> {
 
 	private CacheManager nativeCacheManager;
+
 	private EhCacheCacheManager cacheManager;
+
 	private EhCacheCacheManager transactionalCacheManager;
 
+
 	@Before
 	public void setup() {
 		nativeCacheManager = new CacheManager(new Configuration().name("EhCacheCacheManagerTests")
@@ -58,7 +61,8 @@ public void tearDown() {
 	protected EhCacheCacheManager getCacheManager(boolean transactionAware) {
 		if (transactionAware) {
 			return transactionalCacheManager;
-		} else {
+		}
+		else {
 			return cacheManager;
 		}
 	}
@@ -77,4 +81,5 @@ protected void addNativeCache(String cacheName) {
 	protected void removeNativeCache(String cacheName) {
 		nativeCacheManager.removeCache(cacheName);
 	}
+
 }

spring-context-support/src/test/java/org/springframework/cache/jcache/JCacheCacheManagerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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,9 +33,12 @@
 public class JCacheCacheManagerTests extends AbstractTransactionSupportingCacheManagerTests<JCacheCacheManager> {
 
 	private CacheManagerMock cacheManagerMock;
+
 	private JCacheCacheManager cacheManager;
+
 	private JCacheCacheManager transactionalCacheManager;
 
+
 	@Before
 	public void setupOnce() {
 		cacheManagerMock = new CacheManagerMock();
@@ -55,7 +58,8 @@ public void setupOnce() {
 	protected JCacheCacheManager getCacheManager(boolean transactionAware) {
 		if (transactionAware) {
 			return transactionalCacheManager;
-		} else {
+		}
+		else {
 			return cacheManager;
 		}
 	}
@@ -75,9 +79,11 @@ protected void removeNativeCache(String cacheName) {
 		cacheManagerMock.removeCache(cacheName);
 	}
 
+
 	private static class CacheManagerMock {
 
 		private final List<String> cacheNames;
+
 		private final CacheManager cacheManager;
 
 		private CacheManagerMock() {
@@ -103,4 +109,5 @@ public void removeCache(String name) {
 			given(cacheManager.getCache(name)).willReturn(null);
 		}
 	}
+
 }

spring-context-support/src/test/java/org/springframework/cache/transaction/AbstractTransactionSupportingCacheManagerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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,11 +42,10 @@ public abstract class AbstractTransactionSupportingCacheManagerTests<T extends C
 
 	/**
 	 * Returns the {@link CacheManager} to use.
-	 *
 	 * @param transactionAware if the requested cache manager should be aware
 	 * of the transaction
 	 * @return the cache manager to use
-	 * @see org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager#setTransactionAware(boolean)
+	 * @see org.springframework.cache.transaction.AbstractTransactionSupportingCacheManager#setTransactionAware
 	 */
 	protected abstract T getCacheManager(boolean transactionAware);
 
@@ -65,6 +64,7 @@ public abstract class AbstractTransactionSupportingCacheManagerTests<T extends C
 	 */
 	protected abstract void removeNativeCache(String cacheName);
 
+
 	@Test
 	public void getOnExistingCache() {
 		assertThat(getCacheManager(false).getCache(CACHE_NAME), is(instanceOf(getCacheType())));
@@ -77,10 +77,10 @@ public void getOnNewCache() {
 		addNativeCache(cacheName);
 		assertFalse(cacheManager.getCacheNames().contains(cacheName));
 		try {
-			assertThat(cacheManager.getCache(cacheName),
-					is(instanceOf(getCacheType())));
+			assertThat(cacheManager.getCache(cacheName), is(instanceOf(getCacheType())));
 			assertTrue(cacheManager.getCacheNames().contains(cacheName));
-		} finally {
+		}
+		finally {
 			removeNativeCache(cacheName);
 		}
 	}
@@ -109,8 +109,10 @@ public void getTransactionalOnNewCache() {
 			assertThat(cacheManager.getCache(cacheName),
 					is(instanceOf(TransactionAwareCacheDecorator.class)));
 			assertTrue(cacheManager.getCacheNames().contains(cacheName));
-		} finally {
+		}
+		finally {
 			removeNativeCache(cacheName);
 		}
 	}
+
 }

spring-context/src/main/java/org/springframework/cache/support/AbstractCacheManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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 @@ public abstract class AbstractCacheManager implements CacheManager, Initializing
 
 	private final ConcurrentMap<String, Cache> cacheMap = new ConcurrentHashMap<String, Cache>(16);
 
-	private Set<String> cacheNames = new LinkedHashSet<String>(16);
+	private final Set<String> cacheNames = new LinkedHashSet<String>(16);
 
 
 	// Early cache initialization on startup
@@ -96,6 +96,16 @@ protected final void addCache(Cache cache) {
 		this.cacheNames.add(cache.getName());
 	}
 
+	/**
+	 * Check for a registered cache of the given name.
+	 * In contrast to {@link #getCache(String)}, this method does not trigger
+	 * the lazy creation of missing caches via {@link #getMissingCache(String)}.
+	 * @param name the cache identifier (must not be {@code null})
+	 * @return the associated Cache instance, or {@code null} if none found
+	 * @since 4.1
+	 * @see #getCache(String)
+	 * @see #getMissingCache(String)
+	 */
 	protected final Cache lookupCache(String name) {
 		return this.cacheMap.get(name);
 	}
@@ -120,6 +130,7 @@ protected Cache decorateCache(Cache cache) {
 	 * @param name the name of the cache to retrieve
 	 * @return the missing cache or {@code null} if no such cache exists or could be
 	 * created
+	 * @since 4.1
 	 * @see #getCache(String)
 	 */
 	protected Cache getMissingCache(String name) {

spring-context/src/main/java/org/springframework/scripting/ScriptEvaluator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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,7 +44,7 @@ public interface ScriptEvaluator {
 	 * Evaluate the given script with the given arguments.
 	 * @param script the ScriptSource for the script to evaluate
 	 * @param arguments the key-value pairs to expose to the script,
-	 * typically as script variables. May be {@code null}.
+	 * typically as script variables (may be {@code null} or empty)
 	 * @return the return value of the script, if any
 	 * @throws ScriptCompilationException if the evaluator failed to read,
 	 * compile or evaluate the script