001package ezvcard.util;
002
003import java.text.NumberFormat;
004import java.util.Locale;
005
006/*
007 Copyright (c) 2012-2023, Michael Angstadt
008 All rights reserved.
009
010 Redistribution and use in source and binary forms, with or without
011 modification, are permitted provided that the following conditions are met: 
012
013 1. Redistributions of source code must retain the above copyright notice, this
014 list of conditions and the following disclaimer. 
015 2. Redistributions in binary form must reproduce the above copyright notice,
016 this list of conditions and the following disclaimer in the documentation
017 and/or other materials provided with the distribution. 
018
019 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
026 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030
031/**
032 * <p>
033 * Formats floating-point values for vCards. This ensures that numbers are
034 * rendered the same, no matter the default locale.
035 * </p>
036 * <ul>
037 * <li>Decimal separator can differ by locale (e.g. Germany uses ",")</li>
038 * <li>Number characters can differ by locale (e.g. "1.0" is "۱٫۰" in Iran)</li>
039 * </ul>
040 * @author Michael Angstadt
041 */
042public class VCardFloatFormatter {
043        private final NumberFormat nf = NumberFormat.getNumberInstance(Locale.ROOT);
044
045        /**
046         * Creates a new formatter with a max of 6 decimals.
047         */
048        public VCardFloatFormatter() {
049                this(6);
050        }
051
052        /**
053         * Creates a new formatter.
054         * @param decimals the max number of decimal places
055         */
056        public VCardFloatFormatter(int decimals) {
057                nf.setMaximumFractionDigits(decimals);
058                if (decimals > 0) {
059                        nf.setMinimumFractionDigits(1);
060                }
061        }
062
063        /**
064         * Formats a number for inclusion in a vCard.
065         * @param number the number
066         * @return the formatted number
067         */
068        public String format(double number) {
069                return nf.format(number);
070        }
071}