Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing

Browse Source
This commit is contained in:
Juergen Hoeller
2014-05-27 18:29:51 +02:00
parent 22a38d4547
commit 8220832c4e
3 changed files with 40 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2014 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.
@@ -25,13 +25,14 @@ import java.lang.annotation.Target;
* Declares that a field should be formatted as a number.
* Supports formatting by style or custom pattern string.
* 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 #, ###.##}.
* <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, it takes precedence over the style attribute.
* When no annotation attributes are specified, the default format applied is style-based with a style of {@link Style#NUMBER}.
*
* <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,
* it takes precedence over the style attribute. When no annotation attributes are specified,
* the default format applied is style-based with a style of {@link Style#NUMBER}.
*
* @author Keith Donald
* @since 3.0
@@ -43,23 +44,23 @@ public @interface NumberFormat {
/**
* The style pattern to use to format the field.
* Defaults to {@link Style#NUMBER} for general-purpose number formatter.
* Set this attribute when you wish to format your field in accordance with a common style other than the default style.
* <p>Defaults to {@link Style#NUMBER} for general-purpose number formatter.
* Set this attribute when you wish to format your field in accordance with a
* common style other than the default style.
*/
Style style() default Style.NUMBER;
/**
* The custom pattern to use to format the field.
* Defaults to empty String, indicating no custom pattern String has been specified.
* Set this attribute when you wish to format your field in accordance with a custom number pattern not represented by a style.
* <p>Defaults to empty String, indicating no custom pattern String has been specified.
* Set this attribute when you wish to format your field in accordance with a
* custom number pattern not represented by a style.
*/
String pattern() default "";
/**
* Common number format styles.
* @author Keith Donald
* @since 3.0
*/
public enum Style {