Merge pull request #161 from philwebb/SPR-7121

* SPR-7121:
  Support for custom global Joda DateTimeFormatters
  Move JRuby dependency below Joda
  Support DateTimeFormat annotation without Joda
  Corrected date pattern in JavaDocs
  Polish whitespace and formatting

Author: philwebb

build.gradle

@@ -262,12 +262,12 @@ project('spring-context') {
         }
         compile("org.beanshell:bsh:2.0b4", optional)
         compile("org.codehaus.groovy:groovy-all:1.6.3", optional)
-        compile("org.jruby:jruby:1.4.0", optional)
         compile("org.hibernate:hibernate-validator:4.2.0.Final") { dep ->
             optional dep
             exclude group: 'org.slf4j', module: 'slf4j-api'
         }
         compile("joda-time:joda-time:1.6", optional)
+        compile("org.jruby:jruby:1.4.0", optional)
         compile("javax.cache:cache-api:0.5", optional)
         compile("net.sf.ehcache:ehcache-core:2.0.0", optional)
         compile("org.slf4j:slf4j-api:1.6.1", optional)

spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java

@@ -26,7 +26,7 @@
  * Supports formatting by style pattern, ISO date time pattern, or custom format pattern string.
  * Can be applied to <code>java.util.Date</code>, <code>java.util.Calendar</code>, <code>java.long.Long</code>, or Joda Time fields.
  * <p>
- * For style-based formatting, set the {@link #style()} attribute to be the style pattern code.  
+ * For style-based formatting, set the {@link #style()} attribute to be the style pattern code.
  * The first character of the code is the date style, and the second character is the time style.
  * Specify a character of 'S' for short style, 'M' for medium, 'L' for long, and 'F' for full.
  * A date or time may be omitted by specifying the style character '-'.
@@ -39,7 +39,7 @@
  * When the pattern attribute is specified, it takes precedence over both the style and ISO attribute.
  * When the iso attribute is specified, if takes precedence over the style attribute.
  * When no annotation attributes are specified, the default format applied is style-based with a style code of 'SS' (short date, short time).
- * 
+ *
  * @author Keith Donald
  * @author Juergen Hoeller
  * @since 3.0
@@ -76,23 +76,23 @@
 	 * Common ISO date time format patterns.
 	 */
 	public enum ISO {
-		
-		/** 
+
+		/**
 		 * The most common ISO Date Format <code>yyyy-MM-dd</code> e.g. 2000-10-31.
 		 */
 		DATE,
 
-		/** 
-		 * The most common ISO Time Format <code>hh:mm:ss.SSSZ</code> e.g. 01:30:00.000-05:00.
+		/**
+		 * The most common ISO Time Format <code>HH:mm:ss.SSSZ</code> e.g. 01:30:00.000-05:00.
 		 */
 		TIME,
 
-		/** 
-		 * The most common ISO DateTime Format <code>yyyy-MM-dd'T'hh:mm:ss.SSSZ</code> e.g. 2000-10-31 01:30:00.000-05:00.
+		/**
+		 * The most common ISO DateTime Format <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code> e.g. 2000-10-31 01:30:00.000-05:00.
 		 * The default if no annotation value is specified.
 		 */
 		DATE_TIME,
-		
+
 		/**
 		 * Indicates that no ISO-based format pattern should be applied.
 		 */

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2012 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,27 +19,49 @@
 import java.text.DateFormat;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
+import java.util.Collections;
 import java.util.Date;
+import java.util.HashMap;
 import java.util.Locale;
+import java.util.Map;
 import java.util.TimeZone;
 
 import org.springframework.format.Formatter;
+import org.springframework.format.annotation.DateTimeFormat;
+import org.springframework.format.annotation.DateTimeFormat.ISO;
+import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
 
 /**
  * A formatter for {@link java.util.Date} types.
  * Allows the configuration of an explicit date pattern and locale.
  *
  * @author Keith Donald
  * @author Juergen Hoeller
+ * @author Phillip Webb
  * @since 3.0
- * @see SimpleDateFormat 
+ * @see SimpleDateFormat
  */
 public class DateFormatter implements Formatter<Date> {
 
+	private static final Map<ISO, String> ISO_PATTERNS;
+	static {
+		Map<ISO, String> formats = new HashMap<DateTimeFormat.ISO, String>();
+		formats.put(ISO.DATE, "yyyy-MM-dd");
+		formats.put(ISO.TIME, "HH:mm:ss.SSSZ");
+		formats.put(ISO.DATE_TIME, "yyyy-MM-dd'T'HH:mm:ss.SSSZ");
+		ISO_PATTERNS = Collections.unmodifiableMap(formats);
+	}
+
+
 	private String pattern;
 
 	private int style = DateFormat.DEFAULT;
 
+	private String stylePattern;
+
+	private ISO iso;
+
 	private TimeZone timeZone;
 
 	private boolean lenient = false;
@@ -80,6 +102,32 @@ public void setStyle(int style) {
 		this.style = style;
 	}
 
+	/**
+	 * Set the two character to use to format date values. The first character used for
+	 * the date style, the second is for the time style. Supported characters are
+	 * <ul>
+	 * <li>'S' = Small</li>
+	 * <li>'M' = Medium</li>
+	 * <li>'L' = Long</li>
+	 * <li>'F' = Full</li>
+	 * <li>'-' = Omitted</li>
+	 * <ul>
+	 * This method mimics the styles supported by Joda Time.
+	 * @param stylePattern two characters from the set {"S", "M", "L", "F", "-"}
+	 * @since 3.2
+	 */
+	public void setStylePattern(String stylePattern) {
+		this.stylePattern = stylePattern;
+	}
+
+	/**
+	 * Set the ISO format used for this date.
+	 * @param iso the {@link ISO} format
+	 * @since 3.2
+	 */
+	public void setIso(ISO iso) {
+		this.iso = iso;
+	}
 	/**
 	 * Set the TimeZone to normalize the date values into, if any.
 	 */
@@ -107,18 +155,53 @@ public Date parse(String text, Locale locale) throws ParseException {
 
 
 	protected DateFormat getDateFormat(Locale locale) {
-		DateFormat dateFormat;
-		if (this.pattern != null) {
-			dateFormat = new SimpleDateFormat(this.pattern, locale);
-		}
-		else {
-			dateFormat = DateFormat.getDateInstance(this.style, locale);
-		}
+		DateFormat dateFormat = createDateFormat(locale);
 		if (this.timeZone != null) {
 			dateFormat.setTimeZone(this.timeZone);
 		}
 		dateFormat.setLenient(this.lenient);
 		return dateFormat;
 	}
 
+	private DateFormat createDateFormat(Locale locale) {
+		if (StringUtils.hasLength(this.pattern)) {
+			return new SimpleDateFormat(this.pattern, locale);
+		}
+		if (iso != null && iso != ISO.NONE) {
+			String pattern = ISO_PATTERNS.get(iso);
+			Assert.state(pattern != null, "Unsupported ISO format " + iso);
+			SimpleDateFormat format = new SimpleDateFormat(pattern);
+			format.setTimeZone(TimeZone.getTimeZone("UTC"));
+			return format;
+		}
+		if(StringUtils.hasLength(stylePattern)) {
+			int dateStyle = getStylePatternForChar(0);
+			int timeStyle = getStylePatternForChar(1);
+			if(dateStyle != -1 && timeStyle != -1) {
+				return DateFormat.getDateTimeInstance(dateStyle, timeStyle, locale);
+			}
+			if(dateStyle != -1) {
+				return DateFormat.getDateInstance(dateStyle, locale);
+			}
+			if(timeStyle != -1) {
+				return DateFormat.getTimeInstance(timeStyle, locale);
+			}
+			throw new IllegalStateException("Unsupported style pattern '"+ stylePattern+ "'");
+
+		}
+		return DateFormat.getDateInstance(this.style, locale);
+	}
+
+	private int getStylePatternForChar(int index) {
+		if(stylePattern != null && stylePattern.length() > index) {
+			switch (stylePattern.charAt(index)) {
+				case 'S': return DateFormat.SHORT;
+				case 'M': return DateFormat.MEDIUM;
+				case 'L': return DateFormat.LONG;
+				case 'F': return DateFormat.FULL;
+				case '-': return -1;
+			}
+		}
+		throw new IllegalStateException("Unsupported style pattern '"+ stylePattern+ "'");
+	}
 }

spring-context/src/main/java/org/springframework/format/datetime/DateFormatterRegistrar.java

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2002-2012 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.
+ */
+
+package org.springframework.format.datetime;
+
+import java.util.Calendar;
+import java.util.Date;
+
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.core.convert.converter.ConverterRegistry;
+import org.springframework.format.FormatterRegistrar;
+import org.springframework.format.FormatterRegistry;
+import org.springframework.format.datetime.joda.JodaTimeFormatterRegistrar;
+import org.springframework.util.Assert;
+
+/**
+ * Configures Date formatting for use with Spring.
+ * <p>
+ * Designed for direct instantiation but also exposes the static
+ * {@link #addDateConverters(ConverterRegistry)} utility method for ad hoc use against any
+ * {@code ConverterRegistry} instance.
+ *
+ * @author Phillip Webb
+ * @since 3.2
+ * @see JodaTimeFormatterRegistrar
+ * @see FormatterRegistrar#registerFormatters
+ */
+public class DateFormatterRegistrar implements FormatterRegistrar {
+
+
+	private DateFormatter dateFormatter = new DateFormatter();
+
+
+	public void registerFormatters(FormatterRegistry registry) {
+		addDateConverters(registry);
+		registry.addFormatter(dateFormatter);
+		registry.addFormatterForFieldType(Calendar.class, dateFormatter);
+		registry.addFormatterForFieldAnnotation(new DateTimeFormatAnnotationFormatterFactory());
+	}
+
+	/**
+	 * Set the date formatter to register. If not specified default {@link DateFormatter}
+	 * will be used. This method can be used if additional formatter configuration is
+	 * required.
+	 * @param dateFormatter the date formatter
+	 */
+	public void setFormatter(DateFormatter dateFormatter) {
+		Assert.notNull(dateFormatter,"DateFormatter must not be null");
+		this.dateFormatter = dateFormatter;
+	}
+
+	/**
+	 * Add date converters to the specified registry.
+	 * @param converterRegistry the registry of converters to add to
+	 */
+	public static void addDateConverters(ConverterRegistry converterRegistry) {
+		converterRegistry.addConverter(new DateToLongConverter());
+		converterRegistry.addConverter(new DateToCalendarConverter());
+		converterRegistry.addConverter(new CalendarToDateConverter());
+		converterRegistry.addConverter(new CalendarToLongConverter());
+		converterRegistry.addConverter(new LongToDateConverter());
+		converterRegistry.addConverter(new LongToCalendarConverter());
+	}
+
+
+	private static class DateToLongConverter implements Converter<Date, Long> {
+		public Long convert(Date source) {
+			return source.getTime();
+		}
+	}
+
+
+	private static class DateToCalendarConverter implements Converter<Date, Calendar> {
+		public Calendar convert(Date source) {
+			Calendar calendar = Calendar.getInstance();
+			calendar.setTime(source);
+			return calendar;
+		}
+	}
+
+
+	private static class CalendarToDateConverter implements Converter<Calendar, Date> {
+		public Date convert(Calendar source) {
+			return source.getTime();
+		}
+	}
+
+
+	private static class CalendarToLongConverter implements Converter<Calendar, Long> {
+		public Long convert(Calendar source) {
+			return source.getTime().getTime();
+		}
+	}
+
+
+	private static class LongToDateConverter implements Converter<Long, Date> {
+		public Date convert(Long source) {
+			return new Date(source);
+		}
+	}
+
+
+	private static class LongToCalendarConverter implements Converter<Long, Calendar> {
+
+		private DateToCalendarConverter dateToCalendarConverter = new DateToCalendarConverter();
+
+		public Calendar convert(Long source) {
+			return dateToCalendarConverter.convert(new Date(source));
+		}
+	}
+}