From a5070d562c1c45db0ffcc4565403c89587ed46c5 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Tue, 13 Sep 2016 21:36:41 +0200 Subject: [PATCH] Correct ISO DateTime example Issue: SPR-14675 (cherry picked from commit 68332bf) --- .../format/annotation/DateTimeFormat.java | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java b/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java index d2184e735fe..62de5432d33 100644 --- a/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java +++ b/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 the original author or authors. + * Copyright 2002-2016 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. @@ -16,6 +16,7 @@ package org.springframework.format.annotation; +import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @@ -28,19 +29,19 @@ import java.lang.annotation.Target; * Can be applied to {@code java.util.Date}, {@code java.util.Calendar}, {@code java.long.Long}, * Joda-Time value types; and as of Spring 4 and JDK 8, to JSR-310 java.time types too. * - *

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 '-'. * - *

For ISO-based formatting, set the {@link #iso()} attribute to be the desired {@link ISO} format, + *

For ISO-based formatting, set the {@link #iso} attribute to be the desired {@link ISO} format, * such as {@link ISO#DATE}. For custom formatting, set the {@link #pattern()} attribute to be the * DateTime pattern, such as {@code yyyy/MM/dd hh:mm:ss a}. * *

Each attribute is mutually exclusive, so only set one attribute per annotation instance * (the one most convenient one for your formatting needs). * 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 the {@link #iso} attribute is specified, it 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). * @@ -49,8 +50,9 @@ import java.lang.annotation.Target; * @since 3.0 * @see org.joda.time.format.DateTimeFormat */ -@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE}) +@Documented @Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE}) public @interface DateTimeFormat { /** @@ -80,23 +82,23 @@ public @interface DateTimeFormat { /** * Common ISO date time format patterns. */ - public enum ISO { + enum ISO { /** * The most common ISO Date Format {@code yyyy-MM-dd}, - * e.g. 2000-10-31. + * e.g. "2000-10-31". */ DATE, /** * The most common ISO Time Format {@code HH:mm:ss.SSSZ}, - * e.g. 01:30:00.000-05:00. + * e.g. "01:30:00.000-05:00". */ TIME, /** * The most common ISO DateTime Format {@code yyyy-MM-dd'T'HH:mm:ss.SSSZ}, - * e.g. 2000-10-31 01:30:00.000-05:00. + * e.g. "2000-10-31T01:30:00.000-05:00". *

This is the default if no annotation value is specified. */ DATE_TIME,