提交 c3408d86 编写于 作者: S Sam Brannen

@NumberFormat & @DateTimeFormat are now @Documented

上级 9a1b41ff
/* /*
* 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
...@@ -16,6 +16,7 @@ ...@@ -16,6 +16,7 @@
package org.springframework.format.annotation; package org.springframework.format.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
...@@ -28,19 +29,19 @@ import java.lang.annotation.Target; ...@@ -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}, * 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 <code>java.time</code> types too. * Joda-Time value types; and as of Spring 4 and JDK 8, to JSR-310 <code>java.time</code> types too.
* *
* <p>For style-based formatting, set the {@link #style()} attribute to be the style pattern code. * <p>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. * 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. * 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 '-'. * A date or time may be omitted by specifying the style character '-'.
* *
* <p>For ISO-based formatting, set the {@link #iso()} attribute to be the desired {@link ISO} format, * <p>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 * 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}. * DateTime pattern, such as {@code yyyy/MM/dd hh:mm:ss a}.
* *
* <p>Each attribute is mutually exclusive, so only set one attribute per annotation instance * <p>Each attribute is mutually exclusive, so only set one attribute per annotation instance
* (the one most convenient one for your formatting needs). * (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 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, if takes precedence over the style attribute.
* When no annotation attributes are specified, the default format applied is style-based * When no annotation attributes are specified, the default format applied is style-based
* with a style code of 'SS' (short date, short time). * with a style code of 'SS' (short date, short time).
* *
...@@ -49,8 +50,9 @@ import java.lang.annotation.Target; ...@@ -49,8 +50,9 @@ import java.lang.annotation.Target;
* @since 3.0 * @since 3.0
* @see org.joda.time.format.DateTimeFormat * @see org.joda.time.format.DateTimeFormat
*/ */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE}) @Documented
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
public @interface DateTimeFormat { public @interface DateTimeFormat {
/** /**
......
/* /*
* 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
...@@ -16,6 +16,7 @@ ...@@ -16,6 +16,7 @@
package org.springframework.format.annotation; package org.springframework.format.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType; import java.lang.annotation.ElementType;
import java.lang.annotation.Retention; import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
...@@ -26,8 +27,8 @@ import java.lang.annotation.Target; ...@@ -26,8 +27,8 @@ import java.lang.annotation.Target;
* Supports formatting by style or custom pattern string. * Supports formatting by style or custom pattern string.
* Can be applied to any JDK {@code java.lang.Number} type. * Can be applied to any JDK {@code java.lang.Number} type.
* *
* <p>For style-based formatting, set the {@link #style()} attribute to be the desired {@link Style}. * <p>For style-based formatting, set the {@link #style} attribute to be the desired {@link Style}.
* For custom formatting, set the {@link #pattern()} attribute to be the number pattern, such as {@code #, ###.##}. * For custom formatting, set the {@link #pattern} attribute to be the number pattern, such as {@code #, ###.##}.
* *
* <p>Each attribute is mutually exclusive, so only set one attribute per annotation instance * <p>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, * (the one most convenient one for your formatting needs). When the pattern attribute is specified,
...@@ -38,8 +39,9 @@ import java.lang.annotation.Target; ...@@ -38,8 +39,9 @@ import java.lang.annotation.Target;
* @since 3.0 * @since 3.0
* @see java.text.NumberFormat * @see java.text.NumberFormat
*/ */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) @Documented
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
public @interface NumberFormat { public @interface NumberFormat {
/** /**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册