javax.money.format.AmountFormatContextBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of money-api Show documentation
JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency.
There is a newer version: 1.1
Show newest version
/*
 * CREDIT SUISSE IS WILLING TO LICENSE THIS SPECIFICATION TO YOU ONLY UPON THE CONDITION THAT YOU
 * ACCEPT ALL OF THE TERMS CONTAINED IN THIS AGREEMENT. PLEASE READ THE TERMS AND CONDITIONS OF THIS
 * AGREEMENT CAREFULLY. BY DOWNLOADING THIS SPECIFICATION, YOU ACCEPT THE TERMS AND CONDITIONS OF
 * THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY IT, SELECT THE "DECLINE" BUTTON AT THE
 * BOTTOM OF THIS PAGE. Specification: JSR-354 Money and Currency API ("Specification") Copyright
 * (c) 2012-2014, Credit Suisse All rights reserved.
 */
package javax.money.format;

import javax.money.AbstractContextBuilder;
import javax.money.MonetaryAmountFactory;
import java.util.Locale;
import java.util.Objects;

/**
 * Builder class for creating new instances of {@link javax.money.format.AmountFormatContext} adding detailed
 * information
 * about a {@link javax.money.format.MonetaryAmountFormat} instance.
 * 
 * Note this class is NOT thread-safe.
 *
 * @see MonetaryAmountFormat#getContext()
 */
public final class AmountFormatContextBuilder
        extends AbstractContextBuilder {
    /**
     * Map key used for the style identifier attribute.
     */
    private static final String DEFAULT_FORMAT_NAME = "default";

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param formatQuery the base {@link AmountFormatQuery}, not {@code null}.
     */
    private AmountFormatContextBuilder(AmountFormatQuery formatQuery) {
        importContext(formatQuery);
    }

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param context the base {@link AmountFormatContext}, not {@code null}.
     */
    private AmountFormatContextBuilder(AmountFormatContext context) {
        Objects.requireNonNull(context);
        importContext(context);
    }

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param formatName the target formatName {@link String}, not {@code null}.
     */
    private AmountFormatContextBuilder(String formatName) {
        Objects.requireNonNull(formatName, "formatName required.");
        set(AmountFormatContext.KEY_FORMAT_NAME, formatName);
    }

    /**
     * Creates a new default {@link AmountFormatContextBuilder} for a formatter based on the locale specific
     * defaults.
     *
     * @param locale the target {@link java.util.Locale}, not {@code null}.
     */
    private AmountFormatContextBuilder(Locale locale) {
        Objects.requireNonNull(locale, "locale required.");
        setLocale(locale);
        set(AmountFormatContext.KEY_FORMAT_NAME, DEFAULT_FORMAT_NAME);
    }

    /**
     * Sets a format's name.
     *
     * @param formatName the formatName, not null.
     * @return the Builder, for chaining.
     */
    public AmountFormatContextBuilder setFormatName(String formatName) {
        return set(AmountFormatContext.KEY_FORMAT_NAME, formatName);
    }

    /**
     * Sets a Locale to be applied.
     *
     * @param locale the locale, not null.
     * @return the Builder, for chaining.
     */
    public AmountFormatContextBuilder setLocale(Locale locale) {
        return set(locale);
    }

    /**
     * Sets the {@link javax.money.MonetaryContext} to be used, when amount's are parsed.
     *
     * @param monetaryAmountBuilder the monetary amount factory, not {@code null}.
     * @return this builder for chaining.
     */
    public AmountFormatContextBuilder setMonetaryAmountFactory(
            @SuppressWarnings("rawtypes") MonetaryAmountFactory monetaryAmountBuilder) {
        Objects.requireNonNull(monetaryAmountBuilder);
        return set(MonetaryAmountFactory.class, monetaryAmountBuilder);
    }

    /**
     * Creates a new instance of {@link AmountFormatContext} that configures a {@link javax.money.format
     * .MonetaryAmountFormat}.
     *
     * @return a new {@link AmountFormatContext} instance.
     */
    @Override
    public AmountFormatContext build() {
        return new AmountFormatContext(this);
    }

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param formatQuery the base {@link AmountFormatContext}, not {@code null}.
     * @return a new {@link javax.money.format.AmountFormatContextBuilder} instance, never null.
     */
    public static AmountFormatContextBuilder create(AmountFormatQuery formatQuery) {
        return new AmountFormatContextBuilder(formatQuery);
    }

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param context the {@link  AmountFormatContext}
     * @return a new {@link javax.money.format.AmountFormatContextBuilder} instance, never null.
     */
    public static AmountFormatContextBuilder of(AmountFormatContext context) {
        return new AmountFormatContextBuilder(context);
    }

    /**
     * Creates a new {@link AmountFormatContextBuilder}.
     *
     * @param formatName the target formatName {@link String}, not {@code null}.
     * @return a new {@link javax.money.format.AmountFormatContextBuilder} instance, never null.
     */
    public static AmountFormatContextBuilder of(String formatName) {
        return new AmountFormatContextBuilder(formatName);
    }

    /**
     * Creates a new default {@link AmountFormatContextBuilder} for a formatter based on the locale specific
     * defaults.
     *
     * @param locale the target {@link java.util.Locale}, not {@code null}.
     * @return a new {@link javax.money.format.AmountFormatContextBuilder} instance, never null.
     */
    public static AmountFormatContextBuilder of(Locale locale) {
        return new AmountFormatContextBuilder(locale);
    }
}