Add support for YearMonth and MonthDay in @DateTimeFormat

See gh-1215

Author: kazuki43zoo

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

@@ -21,6 +21,8 @@
 import java.time.LocalTime;
 import java.time.OffsetDateTime;
 import java.time.OffsetTime;
+import java.time.MonthDay;
+import java.time.YearMonth;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 import java.time.temporal.TemporalAccessor;
@@ -43,6 +45,7 @@
  *
  * @author Juergen Hoeller
  * @author Sam Brannen
+ * @author Kazuki Shimizu
  * @since 4.0
  * @see org.springframework.format.annotation.DateTimeFormat
  */
@@ -60,6 +63,8 @@ public class Jsr310DateTimeFormatAnnotationFormatterFactory extends EmbeddedValu
 		fieldTypes.add(ZonedDateTime.class);
 		fieldTypes.add(OffsetDateTime.class);
 		fieldTypes.add(OffsetTime.class);
+		fieldTypes.add(YearMonth.class);
+		fieldTypes.add(MonthDay.class);
 		FIELD_TYPES = Collections.unmodifiableSet(fieldTypes);
 	}
 

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

@@ -20,8 +20,10 @@
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.time.LocalTime;
+import java.time.MonthDay;
 import java.time.OffsetDateTime;
 import java.time.OffsetTime;
+import java.time.YearMonth;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 import java.time.format.DateTimeParseException;
@@ -38,6 +40,7 @@
  *
  * @author Juergen Hoeller
  * @author Sam Brannen
+ * @author Kazuki Shimizu
  * @since 4.0
  * @see DateTimeContextHolder#getFormatter
  * @see java.time.LocalDate#parse(CharSequence, java.time.format.DateTimeFormatter)
@@ -46,6 +49,8 @@
  * @see java.time.ZonedDateTime#parse(CharSequence, java.time.format.DateTimeFormatter)
  * @see java.time.OffsetDateTime#parse(CharSequence, java.time.format.DateTimeFormatter)
  * @see java.time.OffsetTime#parse(CharSequence, java.time.format.DateTimeFormatter)
+ * @see java.time.YearMonth#parse(CharSequence, java.time.format.DateTimeFormatter)
+ * @see java.time.MonthDay#parse(CharSequence, java.time.format.DateTimeFormatter)
  */
 public final class TemporalAccessorParser implements Parser<TemporalAccessor> {
 
@@ -128,6 +133,12 @@ else if (OffsetDateTime.class == this.temporalAccessorType) {
 		else if (OffsetTime.class == this.temporalAccessorType) {
 			return OffsetTime.parse(text, formatterToUse);
 		}
+		else if (YearMonth.class == this.temporalAccessorType) {
+			return YearMonth.parse(text, formatterToUse);
+		}
+		else if (MonthDay.class == this.temporalAccessorType) {
+			return MonthDay.parse(text, formatterToUse);
+		}
 		else {
 			throw new IllegalStateException("Unsupported TemporalAccessor type: " + this.temporalAccessorType);
 		}

spring-context/src/test/java/org/springframework/format/datetime/standard/DateTimeFormattingTests.java

@@ -64,6 +64,7 @@
  * @author Juergen Hoeller
  * @author Phillip Webb
  * @author Sam Brannen
+ * @author Kazuki Shimizu
  */
 class DateTimeFormattingTests {
 
@@ -467,6 +468,16 @@ void testBindYearMonth() {
 		assertThat(binder.getBindingResult().getFieldValue("yearMonth").toString().equals("2007-12")).isTrue();
 	}
 
+	@Test
+	public void testBindYearMonthAnnotatedPattern() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("yearMonthAnnotatedPattern", "12/2007");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertTrue(binder.getBindingResult().getFieldValue("yearMonthAnnotatedPattern").toString().equals("12/2007"));
+		assertEquals(YearMonth.parse("2007-12"), binder.getBindingResult().getRawFieldValue("yearMonthAnnotatedPattern"));
+	}
+
 	@Test
 	void testBindMonthDay() {
 		MutablePropertyValues propertyValues = new MutablePropertyValues();
@@ -557,6 +568,16 @@ void patternLocalDateWithUnsupportedPattern() {
 		}
 	}
 
+	@Test
+	public void testBindMonthDayAnnotatedPattern() {
+		MutablePropertyValues propertyValues = new MutablePropertyValues();
+		propertyValues.add("monthDayAnnotatedPattern", "1/3");
+		binder.bind(propertyValues);
+		assertEquals(0, binder.getBindingResult().getErrorCount());
+		assertTrue(binder.getBindingResult().getFieldValue("monthDayAnnotatedPattern").toString().equals("1/3"));
+		assertEquals(MonthDay.parse("--01-03"), binder.getBindingResult().getRawFieldValue("monthDayAnnotatedPattern"));
+	}
+
 
 	public static class DateTimeBean {
 
@@ -611,6 +632,12 @@ public static class DateTimeBean {
 
 		private YearMonth yearMonth;
 
+		@DateTimeFormat(pattern="MM/uuuu")
+		private YearMonth yearMonthAnnotatedPattern;
+
+		@DateTimeFormat(pattern="M/d")
+		private MonthDay monthDayAnnotatedPattern;
+
 		private MonthDay monthDay;
 
 		private final List<DateTimeBean> children = new ArrayList<>();
@@ -775,6 +802,14 @@ public void setYearMonth(YearMonth yearMonth) {
 			this.yearMonth = yearMonth;
 		}
 
+		public YearMonth getYearMonthAnnotatedPattern() {
+			return yearMonthAnnotatedPattern;
+		}
+
+		public void setYearMonthAnnotatedPattern(YearMonth yearMonthAnnotatedPattern) {
+			this.yearMonthAnnotatedPattern = yearMonthAnnotatedPattern;
+		}
+
 		public MonthDay getMonthDay() {
 			return this.monthDay;
 		}
@@ -783,6 +818,14 @@ public void setMonthDay(MonthDay monthDay) {
 			this.monthDay = monthDay;
 		}
 
+		public MonthDay getMonthDayAnnotatedPattern() {
+			return monthDayAnnotatedPattern;
+		}
+
+		public void setMonthDayAnnotatedPattern(MonthDay monthDayAnnotatedPattern) {
+			this.monthDayAnnotatedPattern = monthDayAnnotatedPattern;
+		}
+
 		public List<DateTimeBean> getChildren() {
 			return this.children;
 		}