annotation driven number formatting with default number formatting rules
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
/*
|
||||
* Copyright 2002-2009 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.springframework.format.annotation;
|
||||
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
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</code> type.
|
||||
* <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>#,###.##</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}.
|
||||
*
|
||||
* @author Keith Donald
|
||||
* @since 3.0
|
||||
* @see org.joda.time.format.DateTimeFormat
|
||||
*/
|
||||
@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
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.
|
||||
*/
|
||||
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.
|
||||
*/
|
||||
String pattern() default "";
|
||||
|
||||
/**
|
||||
* Common number format styles.
|
||||
* @author Keith Donald
|
||||
* @since 3.0
|
||||
*/
|
||||
public enum Style {
|
||||
|
||||
/**
|
||||
* General-purpose number format for the current locale.
|
||||
*/
|
||||
NUMBER,
|
||||
|
||||
/**
|
||||
* A currency format for the current locale.
|
||||
*/
|
||||
CURRENCY,
|
||||
|
||||
/**
|
||||
* A percent format for the current locale.
|
||||
*/
|
||||
PERCENT
|
||||
|
||||
}
|
||||
}
|
||||
@@ -35,7 +35,6 @@ public abstract class AbstractNumberFormatter implements Formatter<Number> {
|
||||
|
||||
private boolean lenient = false;
|
||||
|
||||
|
||||
/**
|
||||
* Specify whether or not parsing is to be lenient. Default is false.
|
||||
* <p>With lenient parsing, the parser may allow inputs that do not precisely match the format.
|
||||
@@ -45,7 +44,6 @@ public abstract class AbstractNumberFormatter implements Formatter<Number> {
|
||||
this.lenient = lenient;
|
||||
}
|
||||
|
||||
|
||||
public String print(Number integer, Locale locale) {
|
||||
return getNumberFormat(locale).format(integer);
|
||||
}
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
/*
|
||||
* Copyright 2002-2009 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.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.format.number;
|
||||
|
||||
import java.text.NumberFormat;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* A Number formatter for whole integer values.
|
||||
*
|
||||
* <p>Delegates to {@link NumberFormat#getIntegerInstance(Locale)}.
|
||||
* The {@link #parse(String, Locale)} routine always returns a Long.
|
||||
*
|
||||
* @author Keith Donald
|
||||
* @author Juergen Hoeller
|
||||
* @since 3.0
|
||||
* @see #setLenient
|
||||
*/
|
||||
public final class IntegerFormatter extends AbstractNumberFormatter {
|
||||
|
||||
protected NumberFormat getNumberFormat(Locale locale) {
|
||||
return NumberFormat.getIntegerInstance(locale);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -21,7 +21,7 @@ import java.text.NumberFormat;
|
||||
import java.util.Locale;
|
||||
|
||||
/**
|
||||
* A Number formatter for decimal values.
|
||||
* A general-purpose Number formatter.
|
||||
*
|
||||
* <p>Delegates to {@link NumberFormat#getInstance(Locale)}.
|
||||
* Configures BigDecimal parsing so there is no loss in precision.
|
||||
@@ -34,10 +34,17 @@ import java.util.Locale;
|
||||
* @see #setPattern
|
||||
* @see #setLenient
|
||||
*/
|
||||
public final class DecimalFormatter extends AbstractNumberFormatter {
|
||||
public final class NumberFormatter extends AbstractNumberFormatter {
|
||||
|
||||
private String pattern;
|
||||
|
||||
public NumberFormatter() {
|
||||
|
||||
}
|
||||
|
||||
public NumberFormatter(String pattern) {
|
||||
this.pattern = pattern;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the pattern to use to format number values.
|
||||
@@ -19,6 +19,8 @@ import org.springframework.beans.factory.FactoryBean;
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
import org.springframework.core.convert.ConversionService;
|
||||
import org.springframework.format.datetime.joda.JodaTimeFormattingConfigurer;
|
||||
import org.springframework.format.number.NumberFormatAnnotationFormatterFactory;
|
||||
import org.springframework.format.number.NumberFormatter;
|
||||
import org.springframework.util.ClassUtils;
|
||||
|
||||
/**
|
||||
@@ -40,6 +42,7 @@ public class FormattingConversionServiceFactoryBean implements FactoryBean<Conve
|
||||
|
||||
public void afterPropertiesSet() {
|
||||
initConversionService();
|
||||
installNumberFormatting();
|
||||
installJodaTimeFormattingIfPresent();
|
||||
}
|
||||
|
||||
@@ -67,6 +70,11 @@ public class FormattingConversionServiceFactoryBean implements FactoryBean<Conve
|
||||
}
|
||||
}
|
||||
|
||||
private void installNumberFormatting() {
|
||||
this.conversionService.addFormatterForFieldType(Number.class, new NumberFormatter());
|
||||
this.conversionService.addFormatterForFieldAnnotation(new NumberFormatAnnotationFormatterFactory());
|
||||
}
|
||||
|
||||
private void installJodaTimeFormattingIfPresent() {
|
||||
if (ClassUtils.isPresent("org.joda.time.DateTime", FormattingConversionService.class.getClassLoader())) {
|
||||
new JodaTimeFormattingConfigurer().installJodaTimeFormatting(this.conversionService);
|
||||
|
||||
Reference in New Issue
Block a user