org.springframework.format.annotation.NumberFormat.java Source code

Introduction

Here is the source code for org.springframework.format.annotation.NumberFormat.java

Source

/*
 * Copyright 2002-2018 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
 *
 *      https://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.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Declares that a field or method parameter should be formatted as a number.
 *
 * <p>Supports formatting by style or custom pattern string. Can be applied
 * to any JDK {@code Number} type such as {@code Double} and {@code Long}.
 *
 * <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 {@link #pattern} attribute is specified, it takes precedence over
 * the {@link #style} attribute. When no annotation attributes are specified,
 * the default format applied is style-based for either number of currency,
 * depending on the annotated field or method parameter type.
 *
 * @author Keith Donald
 * @author Juergen Hoeller
 * @since 3.0
 * @see java.text.NumberFormat
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE })
public @interface NumberFormat {

    /**
     * The style pattern to use to format the field.
     * <p>Defaults to {@link Style#DEFAULT} for general-purpose number formatting
     * for most annotated types, except for money types which default to currency
     * formatting. 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.DEFAULT;

    /**
     * The custom pattern to use to format the field.
     * <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.
     */
    enum Style {

        /**
         * The default format for the annotated type: typically 'number' but possibly
         * 'currency' for a money type (e.g. {@code javax.money.MonetaryAmount)}.
         * @since 4.2
         */
        DEFAULT,

        /**
         * The general-purpose number format for the current locale.
         */
        NUMBER,

        /**
         * The percent format for the current locale.
         */
        PERCENT,

        /**
         * The currency format for the current locale.
         */
        CURRENCY
    }

}