root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Polish JavaDoc for date-time and number format annotations

This commit is contained in:
Sam Brannen 2017-04-03 16:48:05 +02:00
parent 279c56a385
commit 51f23cb424
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2016 the original author or authors. * Copyright 2002-2017 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.
@ -23,7 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* Declares that a field should be formatted as a date time. * Declares that a field or method parameter should be formatted as a date or time.
* *
* <p>Supports formatting by style pattern, ISO date time pattern, or custom format pattern string. * <p>Supports formatting by style pattern, ISO date time pattern, or custom format pattern string.
* Can be applied to {@code java.util.Date}, {@code java.util.Calendar}, {@code java.lang.Long}, * Can be applied to {@code java.util.Date}, {@code java.util.Calendar}, {@code java.lang.Long},
@ -35,7 +35,7 @@ import java.lang.annotation.Target;
* 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
@ -64,7 +64,7 @@ public @interface DateTimeFormat {
/** /**
* The ISO pattern to use to format the field. * The ISO pattern to use to format the field.
* The possible ISO patterns are defined in the {@link ISO} enum. * <p>The possible ISO patterns are defined in the {@link ISO} enum.
* <p>Defaults to {@link ISO#NONE}, indicating this attribute should be ignored. * <p>Defaults to {@link ISO#NONE}, indicating this attribute should be ignored.
* Set this attribute when you wish to format your field in accordance with an ISO format. * Set this attribute when you wish to format your field in accordance with an ISO format.
*/ */

6
spring-context/src/main/java/org/springframework/format/annotation/NumberFormat.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2015 the original author or authors. * Copyright 2002-2017 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.
@ -23,7 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* Declares that a field should be formatted as a number. * Declares that a field or method parameter should be formatted as a number.
* *
* <p>Supports formatting by style or custom pattern string. * <p>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.
@ -37,7 +37,7 @@ import java.lang.annotation.Target;
* When the {@link #pattern} attribute is specified, it takes precedence over * When the {@link #pattern} attribute is specified, it takes precedence over
* the {@link #style} attribute. When no annotation attributes are specified, * the {@link #style} attribute. When no annotation attributes are specified,
* the default format applied is style-based for either number of currency, * the default format applied is style-based for either number of currency,
* depending on the annotated field type. * depending on the annotated field or method parameter type.
* *
* @author Keith Donald * @author Keith Donald
* @author Juergen Hoeller * @author Juergen Hoeller