Polishing

(cherry picked from commit ede2150)

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -67,7 +67,7 @@ public class TransactionAwareCacheManagerProxy implements CacheManager, Initiali
 
 	public void afterPropertiesSet() {
 		if (this.targetCacheManager == null) {
-			throw new IllegalStateException("'targetCacheManager' is required");
+			throw new IllegalArgumentException("Property 'targetCacheManager' is required");
 		}
 	}
 

spring-web/src/main/java/org/springframework/http/converter/feed/AbstractWireFeedHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2014 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,7 +38,7 @@ import org.springframework.util.StringUtils;
 
 /**
  * Abstract base class for Atom and RSS Feed message converters, using the
- * <a href="http://rometools.org/">ROME tools</a> project.
+ * <a href="https://rome.dev.java.net">ROME tools</a> project.
  *
  * @author Arjen Poutsma
  * @since 3.0.2
@@ -49,14 +49,17 @@ public abstract class AbstractWireFeedHttpMessageConverter<T extends WireFeed> e
 
 	public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
 
+
 	protected AbstractWireFeedHttpMessageConverter(MediaType supportedMediaType) {
 		super(supportedMediaType);
 	}
 
+
 	@Override
 	@SuppressWarnings("unchecked")
 	protected T readInternal(Class<? extends T> clazz, HttpInputMessage inputMessage)
 			throws IOException, HttpMessageNotReadableException {
+
 		WireFeedInput feedInput = new WireFeedInput();
 		MediaType contentType = inputMessage.getHeaders().getContentType();
 		Charset charset;
@@ -77,6 +80,7 @@ public abstract class AbstractWireFeedHttpMessageConverter<T extends WireFeed> e
 	@Override
 	protected void writeInternal(T wireFeed, HttpOutputMessage outputMessage)
 			throws IOException, HttpMessageNotWritableException {
+
 		String wireFeedEncoding = wireFeed.getEncoding();
 		if (!StringUtils.hasLength(wireFeedEncoding)) {
 			wireFeedEncoding = DEFAULT_CHARSET.name();
@@ -89,13 +93,13 @@ public abstract class AbstractWireFeedHttpMessageConverter<T extends WireFeed> e
 		}
 
 		WireFeedOutput feedOutput = new WireFeedOutput();
-
 		try {
 			Writer writer = new OutputStreamWriter(outputMessage.getBody(), wireFeedEncoding);
 			feedOutput.output(wireFeed, writer);
 		}
 		catch (FeedException ex) {
-			throw new HttpMessageNotWritableException("Could not write WiredFeed: " + ex.getMessage(), ex);
+			throw new HttpMessageNotWritableException("Could not write WireFeed: " + ex.getMessage(), ex);
 		}
 	}
+
 }

spring-web/src/main/java/org/springframework/http/converter/feed/AtomFeedHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,16 +21,16 @@ import com.sun.syndication.feed.atom.Feed;
 import org.springframework.http.MediaType;
 
 /**
- * Implementation of {@link org.springframework.http.converter.HttpMessageConverter} that can read and write Atom feeds.
- * Specifically, this converter can handle {@link Feed} objects, from the <a href="https://rome.dev.java.net/">ROME</a>
- * project.
+ * Implementation of {@link org.springframework.http.converter.HttpMessageConverter}
+ * that can read and write Atom feeds. Specifically, this converter can handle {@link Feed}
+ * objects from the <a href="https://rome.dev.java.net/">ROME</a> project.
  *
- * <p>By default, this converter reads and writes the media type ({@code application/atom+xml}). This can
- * be overridden by setting the {@link #setSupportedMediaTypes(java.util.List) supportedMediaTypes} property.
+ * <p>By default, this converter reads and writes the media type ({@code application/atom+xml}).
+ * This can be overridden through the {@link #setSupportedMediaTypes supportedMediaTypes} property.
  *
  * @author Arjen Poutsma
- * @see Feed
  * @since 3.0.2
+ * @see Feed
  */
 public class AtomFeedHttpMessageConverter extends AbstractWireFeedHttpMessageConverter<Feed> {
 
@@ -43,5 +43,4 @@ public class AtomFeedHttpMessageConverter extends AbstractWireFeedHttpMessageCon
 		return Feed.class.isAssignableFrom(clazz);
 	}
 
-
 }

spring-web/src/main/java/org/springframework/http/converter/feed/RssChannelHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,16 +21,16 @@ import com.sun.syndication.feed.rss.Channel;
 import org.springframework.http.MediaType;
 
 /**
- * Implementation of {@link org.springframework.http.converter.HttpMessageConverter} that can read and write RSS feeds.
- * Specifically, this converter can handle {@link Channel} objects, from the <a href="https://rome.dev.java.net/">ROME</a>
- * project.
+ * Implementation of {@link org.springframework.http.converter.HttpMessageConverter}
+ * that can read and write RSS feeds. Specifically, this converter can handle {@link Channel}
+ * objects from the <a href="https://rome.dev.java.net/">ROME</a> project.
  *
- * <p>By default, this converter reads and writes the media type ({@code application/rss+xml}). This can
- * be overridden by setting the {@link #setSupportedMediaTypes(java.util.List) supportedMediaTypes} property.
+ * <p>By default, this converter reads and writes the media type ({@code application/rss+xml}).
+ * This can be overridden through the {@link #setSupportedMediaTypes supportedMediaTypes} property.
  *
  * @author Arjen Poutsma
- * @see Channel
  * @since 3.0.2
+ * @see Channel
  */
 public class RssChannelHttpMessageConverter extends AbstractWireFeedHttpMessageConverter<Channel> {
 

spring-web/src/main/java/org/springframework/http/converter/feed/package-info.java

@@ -1,23 +1,8 @@
-/*
- * Copyright 2002-2010 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.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
 
 /**
  *
  * Provides HttpMessageConverter implementations for handling Atom and RSS feeds.
+ * Based on the <a href="https://rome.dev.java.net/">ROME tools</a> project.
  *
  */
 package org.springframework.http.converter.feed;
-

spring-web/src/test/java/org/springframework/http/converter/feed/AtomFeedHttpMessageConverterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,10 +24,7 @@ import java.util.List;
 
 import com.sun.syndication.feed.atom.Entry;
 import com.sun.syndication.feed.atom.Feed;
-import static org.custommonkey.xmlunit.XMLAssert.*;
 import org.custommonkey.xmlunit.XMLUnit;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
 import org.junit.Before;
 import org.junit.Test;
 import org.xml.sax.SAXException;
@@ -36,7 +33,13 @@ import org.springframework.http.MediaType;
 import org.springframework.http.MockHttpInputMessage;
 import org.springframework.http.MockHttpOutputMessage;
 
-/** @author Arjen Poutsma */
+import static org.custommonkey.xmlunit.XMLAssert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author Arjen Poutsma
+ */
 public class AtomFeedHttpMessageConverterTests {
 
 	private AtomFeedHttpMessageConverter converter;
@@ -70,7 +73,7 @@ public class AtomFeedHttpMessageConverterTests {
 		Feed result = converter.read(Feed.class, inputMessage);
 		assertEquals("title", result.getTitle());
 		assertEquals("subtitle", result.getSubtitle().getValue());
-		List entries = result.getEntries();
+		List<?> entries = result.getEntries();
 		assertEquals(2, entries.size());
 
 		Entry entry1 = (Entry) entries.get(0);
@@ -95,7 +98,7 @@ public class AtomFeedHttpMessageConverterTests {
 		entry2.setId("id2");
 		entry2.setTitle("title2");
 
-		List entries = new ArrayList(2);
+		List<Entry> entries = new ArrayList<Entry>(2);
 		entries.add(entry1);
 		entries.add(entry2);
 		feed.setEntries(entries);
@@ -109,7 +112,6 @@ public class AtomFeedHttpMessageConverterTests {
 				"<entry><id>id1</id><title>title1</title></entry>" +
 				"<entry><id>id2</id><title>title2</title></entry></feed>";
 		assertXMLEqual(expected, outputMessage.getBodyAsString(utf8));
-
 	}
 
 	@Test
@@ -126,5 +128,4 @@ public class AtomFeedHttpMessageConverterTests {
 				outputMessage.getHeaders().getContentType());
 	}
 
-
 }

spring-web/src/test/java/org/springframework/http/converter/feed/RssChannelHttpMessageConverterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2014 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,10 +24,7 @@ import java.util.List;
 
 import com.sun.syndication.feed.rss.Channel;
 import com.sun.syndication.feed.rss.Item;
-import static org.custommonkey.xmlunit.XMLAssert.*;
 import org.custommonkey.xmlunit.XMLUnit;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
 import org.junit.Before;
 import org.junit.Test;
 import org.xml.sax.SAXException;
@@ -36,7 +33,13 @@ import org.springframework.http.MediaType;
 import org.springframework.http.MockHttpInputMessage;
 import org.springframework.http.MockHttpOutputMessage;
 
-/** @author Arjen Poutsma */
+import static org.custommonkey.xmlunit.XMLAssert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author Arjen Poutsma
+ */
 public class RssChannelHttpMessageConverterTests {
 
 	private RssChannelHttpMessageConverter converter;
@@ -72,7 +75,7 @@ public class RssChannelHttpMessageConverterTests {
 		assertEquals("http://example.com", result.getLink());
 		assertEquals("description", result.getDescription());
 
-		List items = result.getItems();
+		List<?> items = result.getItems();
 		assertEquals(2, items.size());
 
 		Item item1 = (Item) items.get(0);
@@ -95,7 +98,7 @@ public class RssChannelHttpMessageConverterTests {
 		Item item2 = new Item();
 		item2.setTitle("title2");
 
-		List items = new ArrayList(2);
+		List<Item> items = new ArrayList<Item>(2);
 		items.add(item1);
 		items.add(item2);
 		channel.setItems(items);
@@ -111,7 +114,6 @@ public class RssChannelHttpMessageConverterTests {
 				"<item><title>title2</title></item>" +
 				"</channel></rss>";
 		assertXMLEqual(expected, outputMessage.getBodyAsString(utf8));
-
 	}
 
 	@Test
@@ -134,5 +136,4 @@ public class RssChannelHttpMessageConverterTests {
 				outputMessage.getHeaders().getContentType());
 	}
 
-
-}
+}

spring-webmvc/src/main/java/org/springframework/web/servlet/config/AnnotationDrivenBeanDefinitionParser.java

@@ -72,7 +72,7 @@ import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolv
 
 /**
  * A {@link BeanDefinitionParser} that provides the configuration for the
- * {@code <annotation-driven/>} MVC namespace  element.
+ * {@code <annotation-driven/>} MVC namespace element.
  *
  * <p>This class registers the following {@link HandlerMapping}s:</p>
  * <ul>

spring-webmvc/src/main/java/org/springframework/web/servlet/view/feed/AbstractAtomFeedView.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2014 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,7 +21,6 @@ import java.util.Map;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
-import com.sun.syndication.feed.WireFeed;
 import com.sun.syndication.feed.atom.Entry;
 import com.sun.syndication.feed.atom.Feed;
 
@@ -31,17 +30,15 @@ import com.sun.syndication.feed.atom.Feed;
  *
  * <p>Application-specific view classes will extend this class.
  * The view will be held in the subclass itself, not in a template.
- *
- * <p>Main entry points are the {@link #buildFeedMetadata(Map, WireFeed, HttpServletRequest)} and
- * {@link #buildFeedEntries(Map, HttpServletRequest, HttpServletResponse)}.
+ * Main entry points are the {@link #buildFeedMetadata} and {@link #buildFeedEntries}.
  *
  * <p>Thanks to Jettro Coenradie and Sergio Bossa for the original feed view prototype!
  *
  * @author Arjen Poutsma
  * @author Juergen Hoeller
  * @since 3.0
- * @see #buildFeedMetadata(Map, WireFeed, HttpServletRequest)
- * @see #buildFeedEntries(Map, HttpServletRequest, HttpServletResponse)
+ * @see #buildFeedMetadata
+ * @see #buildFeedEntries
  * @see <a href="http://www.atomenabled.org/developers/syndication/">Atom Syndication Format</a>
  */
 public abstract class AbstractAtomFeedView extends AbstractFeedView<Feed> {
@@ -56,7 +53,7 @@ public abstract class AbstractAtomFeedView extends AbstractFeedView<Feed> {
 	}
 
 	/**
-	 * Sets the Rome feed type to use.
+	 * Set the Rome feed type to use.
 	 * <p>Defaults to Atom 1.0.
 	 * @see Feed#setFeedType(String)
 	 * @see #DEFAULT_FEED_TYPE
@@ -96,7 +93,7 @@ public abstract class AbstractAtomFeedView extends AbstractFeedView<Feed> {
 	 * @param request in case we need locale etc. Shouldn't look at attributes.
 	 * @param response in case we need to set cookies. Shouldn't write to it.
 	 * @return the feed entries to be added to the feed
-	 * @throws Exception any exception that occured during document building
+	 * @throws Exception any exception that occurred during document building
 	 * @see Entry
 	 */
 	protected abstract List<Entry> buildFeedEntries(

spring-webmvc/src/main/java/org/springframework/web/servlet/view/feed/AbstractRssFeedView.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2014 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,7 +21,6 @@ import java.util.Map;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
-import com.sun.syndication.feed.WireFeed;
 import com.sun.syndication.feed.rss.Channel;
 import com.sun.syndication.feed.rss.Item;
 
@@ -31,17 +30,15 @@ import com.sun.syndication.feed.rss.Item;
  *
  * <p>Application-specific view classes will extend this class.
  * The view will be held in the subclass itself, not in a template.
- *
- * <p>Main entry points are the {@link #buildFeedMetadata(Map, WireFeed , HttpServletRequest)}
- * and {@link #buildFeedItems(Map, HttpServletRequest, HttpServletResponse)}.
+ * Main entry points are the {@link #buildFeedMetadata} and {@link #buildFeedItems}.
  *
  * <p>Thanks to Jettro Coenradie and Sergio Bossa for the original feed view prototype!
  *
  * @author Arjen Poutsma
  * @author Juergen Hoeller
  * @since 3.0
- * @see #buildFeedMetadata(Map, WireFeed , HttpServletRequest)
- * @see #buildFeedItems(Map, HttpServletRequest, HttpServletResponse)
+ * @see #buildFeedMetadata
+ * @see #buildFeedItems
  */
 public abstract class AbstractRssFeedView extends AbstractFeedView<Channel> {
 
@@ -79,7 +76,7 @@ public abstract class AbstractRssFeedView extends AbstractFeedView<Channel> {
 	 * @param request  in case we need locale etc. Shouldn't look at attributes.
 	 * @param response in case we need to set cookies. Shouldn't write to it.
 	 * @return the feed items to be added to the feed
-	 * @throws Exception any exception that occured during document building
+	 * @throws Exception any exception that occurred during document building
 	 * @see Item
 	 */
 	protected abstract List<Item> buildFeedItems(

spring-webmvc/src/main/java/org/springframework/web/servlet/view/feed/package-info.java

@@ -1,8 +1,8 @@
 
 /**
  *
- * Support classes for feed generation, providing View implementations for Atom and RSS
+ * Support classes for feed generation, providing View implementations for Atom and RSS.
+ * Based on the <a href="https://rome.dev.java.net/">ROME tools</a> project.
  *
  */
 package org.springframework.web.servlet.view.feed;
-

spring-webmvc/src/test/java/org/springframework/web/servlet/view/feed/AtomFeedViewTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -67,6 +67,7 @@ public class AtomFeedViewTests {
 		assertXMLEqual(expected, response.getContentAsString());
 	}
 
+
 	private static class MyAtomFeedView extends AbstractAtomFeedView {
 
 		@Override
@@ -90,4 +91,5 @@ public class AtomFeedViewTests {
 			return entries;
 		}
 	}
+
 }

spring-webmvc/src/test/java/org/springframework/web/servlet/view/feed/RssFeedViewTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright ${YEAR} the original author or authors.
+ * Copyright 2002-2014 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.
@@ -17,7 +17,6 @@
 package org.springframework.web.servlet.view.feed;
 
 import java.util.ArrayList;
-import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -48,7 +47,6 @@ public class RssFeedViewTests {
 	public void createView() throws Exception {
 		view = new MyRssFeedView();
 		setIgnoreWhitespace(true);
-
 	}
 
 	@Test
@@ -69,6 +67,7 @@ public class RssFeedViewTests {
 		assertXMLEqual(expected, response.getContentAsString());
 	}
 
+
 	private static class MyRssFeedView extends AbstractRssFeedView {
 
 		@Override
@@ -79,11 +78,9 @@ public class RssFeedViewTests {
 		}
 
 		@Override
-		protected List<Item> buildFeedItems(Map model, HttpServletRequest request, HttpServletResponse response)
-				throws Exception {
+		protected List<Item> buildFeedItems(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception {
 			List<Item> items = new ArrayList<Item>();
-			for (Iterator iterator = model.keySet().iterator(); iterator.hasNext();) {
-				String name = (String) iterator.next();
+			for (String name : model.keySet()) {
 				Item item = new Item();
 				item.setTitle(name);
 				Description description = new Description();
@@ -94,4 +91,5 @@ public class RssFeedViewTests {
 			return items;
 		}
 	}
+
 }