javax.money.CurrencyQuery Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of money-api-bp Show documentation

JSR 354 provides an API for representing, transporting, and performing comprehensive calculations with Money and Currency. This module provides a forward compatible backport of the API.

There is a newer version: 1.0.4

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-2013, Credit Suisse All rights reserved.
 */
package javax.money;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.Locale;

/**
 * This class models a query for accessing instances of {@link CurrencyUnit}. It
 * provides information such as
 * 
 * the providers that may provide {@link CurrencyUnit} instances
 * 
a target timestamp / temporal unit, when the {@link CurrencyUnit} instances should be valid
 * 
any other attributes, identified by the attribute type, e.g. regions, tenants etc.
 * 
 * The effective attributes supported are only determined by the implementations of {@link javax.money.spi
 * .CurrencyProviderSpi}.
 * 
 * This class is immutable, serializable and thread-safe.
 *
 * @author Anatole Tresch
 */
public final class CurrencyQuery extends AbstractQuery implements Serializable {

    /**
     * Key for storing a countries to be queried.
     */
    static final String KEY_QUERY_COUNTRIES = "Query.countries";

    /**
     * Key for storing a target literal currency codes to be queried.
     */
    static final String KEY_QUERY_CURRENCY_CODES = "Query.currencyCodes";

    /**
     * Key for storing a target numeric currency codes to be queried.
     */
    static final String KEY_QUERY_NUMERIC_CODES = "Query.numericCodes";

    /**
     * Constructor, used from the Builder.
     *
     * @param builder the corresponding {@link CurrencyQueryBuilder}, not null.
     */
    CurrencyQuery(CurrencyQueryBuilder builder) {
        super(builder);
    }

    /**
     * Returns the target locales.
     *
     * @return the otarget locales, never null.
     */
    @SuppressWarnings("unchecked")
    public Collection getCountries() {
        Collection result = get(KEY_QUERY_COUNTRIES, Collection.class);
        if (result == null) {
            return Collections.emptySet();
        }
        return result;
    }

    /**
     * Gets the currency codes, or the regular expression to select codes.
     *
     * @return the query for chaining.
     */
    @SuppressWarnings("unchecked")
    public Collection getCurrencyCodes() {
        Collection result = get(KEY_QUERY_CURRENCY_CODES, Collection.class);
        if (result == null) {
            return Collections.emptySet();
        }
        return result;
    }

    /**
     * Gets the numeric codes. Setting it to -1 search for currencies that have no numeric code.
     *
     * @return the query for chaining.
     */
    @SuppressWarnings("unchecked")
    public Collection getNumericCodes() {
        Collection result = get(KEY_QUERY_NUMERIC_CODES, Collection.class);
        if (result == null) {
            return Collections.emptySet();
        }
        return result;
    }

    /**
     * Creates a new builder instances, initialized with the data from this one.
     *
     * @return a new {@link MonetaryAmountFactoryQueryBuilder} instance, never null.
     */
    public CurrencyQueryBuilder toBuilder() {
        return CurrencyQueryBuilder.of(this);
    }

}