org.javamoney.moneta.format.MonetaryAmountDecimalFormatBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of moneta-bp Show documentation
JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency. This module implements JSR 354.
There is a newer version: 1.4.1
Show newest version
/*
  Copyright (c) 2012, 2014, Credit Suisse (Anatole Tresch), Werner Keil and others by the @author tag.

  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.javamoney.moneta.format;

import org.javamoney.moneta.function.MonetaryAmountProducer;
import org.javamoney.moneta.function.MoneyProducer;

import javax.money.CurrencyUnit;
import javax.money.Monetary;
import javax.money.format.MonetaryAmountFormat;
import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.text.NumberFormat;
import java.util.Currency;
import java.util.Locale;

/**
 * Builder to {@link MonetaryAmountFormat}.
 * @see  MonetaryAmountDecimalFormatBuilder#newInstance
 * @see  MonetaryAmountDecimalFormatBuilder#of
 * @since 1.0.1
 */
public class MonetaryAmountDecimalFormatBuilder {

    private DecimalFormat decimalFormat;

    private CurrencyUnit currencyUnit;

    private Locale locale;

    private MonetaryAmountProducer producer;

    private MonetaryAmountDecimalFormatBuilder() {
    }

    /**
     * Creates a new instance of {@link MonetaryAmountDecimalFormatBuilder} with default {@link Locale}.
     * @see NumberFormat#getCurrencyInstance()
     * @return a new instance of {@link MonetaryAmountDecimalFormatBuilder}
     */
    public static MonetaryAmountDecimalFormatBuilder newInstance() {
        MonetaryAmountDecimalFormatBuilder builder = new MonetaryAmountDecimalFormatBuilder();
        builder.decimalFormat = (DecimalFormat) NumberFormat.getCurrencyInstance();
        return builder;
    }

    /**
     * Creates a new instance of {@link MonetaryAmountDecimalFormatBuilder} with {@link Locale} set from parameter.
     * @param locale the target locale
     * @see NumberFormat#getCurrencyInstance(Locale)
     * @return a new instance of {@link MonetaryAmountDecimalFormatBuilder}
     */
    public static MonetaryAmountDecimalFormatBuilder of(Locale locale) {
        MonetaryAmountDecimalFormatBuilder builder = new MonetaryAmountDecimalFormatBuilder();
        builder.decimalFormat = (DecimalFormat) NumberFormat.getCurrencyInstance(locale);
        builder.locale = locale;
        return builder;
    }

    /**
     * Creates a new instance of {@link MonetaryAmountDecimalFormatBuilder} with default {@link Locale} and pattern to format the {@link javax.money.MonetaryAmount}.
     * @param  pattern the pattern to be used.
     * @see DecimalFormat
     * @see DecimalFormat#DecimalFormat(String)
     * @return a new instance of {@link MonetaryAmountDecimalFormatBuilder}
     */
    public static MonetaryAmountDecimalFormatBuilder of(String pattern) {
        MonetaryAmountDecimalFormatBuilder builder = new MonetaryAmountDecimalFormatBuilder();
        builder.decimalFormat = new DecimalFormat(pattern);
        return builder;
    }

    /**
     * Creates a new instance of {@link MonetaryAmountDecimalFormatBuilder} with {@link Locale} set from parameter and pattern to format the {@link javax.money.MonetaryAmount}.
     * @param  pattern the pattern to be used.
     * @param  locale the target locale
     * @see DecimalFormat
     * @see DecimalFormat#DecimalFormat(String)
     * @return a new instance of {@link MonetaryAmountDecimalFormatBuilder}
     */
    public static MonetaryAmountDecimalFormatBuilder of(String pattern, Locale locale) {
        MonetaryAmountDecimalFormatBuilder builder = new MonetaryAmountDecimalFormatBuilder();
        builder.decimalFormat = new DecimalFormat(pattern, DecimalFormatSymbols.getInstance(locale));
        builder.locale = locale;
        return builder;
    }

    /**
     * Sets the {@link CurrencyUnit}
     * @param currencyUnit the target currency
     * @return the {@link MonetaryAmountDecimalFormatBuilder}
     */
    public MonetaryAmountDecimalFormatBuilder withCurrencyUnit(CurrencyUnit currencyUnit) {
        this.currencyUnit = currencyUnit;
        return this;
    }

    /**
     * Sets the {@link MonetaryAmountProducer}
     * @param producer the producer
     * @return the {@link MonetaryAmountDecimalFormatBuilder}
     */
    public MonetaryAmountDecimalFormatBuilder withProducer(MonetaryAmountProducer producer) {
        this.producer = producer;
        return this;
    }

    /**
     * Creates the {@link MonetaryAmountFormat}
     * If @{link Locale} didn't set the default value is {@link Locale#getDefault()}
     * If @{link MonetaryAmountProducer} didn't set the default value is {@link MoneyProducer}
     * If @{link CurrencyUnit} didn't set the default value is a currency from {@link Locale}
     * @return {@link MonetaryAmountFormat}
     */
    public MonetaryAmountFormat build() {
        if (locale == null) {
            locale = Locale.getDefault();
        }
        if (decimalFormat == null) {
            decimalFormat = (DecimalFormat) NumberFormat.getCurrencyInstance(locale);
        }
        if (currencyUnit == null) {
            currencyUnit = Monetary.getCurrency(locale);
        }
        if (producer == null) {
            producer = new MoneyProducer();
        }
        decimalFormat.setCurrency(Currency.getInstance(currencyUnit.getCurrencyCode()));
        return new MonetaryAmountDecimalFormat(decimalFormat, producer, currencyUnit);
    }

}