/*
 * 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 CurrencyUnit. It provides information such as 

the providers that may provide CurrencyUnit instances 
a target timestamp / temporal unit, when the 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 CurrencyProviderSpi. 

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

	private static final long serialVersionUID = -5117949582074719190L;

	
Key for storing a countries to be queried.
/**
     * 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.
/**
     * 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.
/**
     * 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.
Params:
builder – the corresponding CurrencyQueryBuilder, not null./**
     * Constructor, used from the Builder.
     *
     * @param builder the corresponding {@link javax.money.CurrencyQueryBuilder}, not null.
     */
    CurrencyQuery(CurrencyQueryBuilder builder) {
        super(builder);
    }

    
Returns the target locales.
Returns:
the target locales, never null./**
     * Returns the target locales.
     *
     * @return the target locales, never null.
     */
    public Collection<Locale> getCountries() {
        Collection<Locale> 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.
Returns:
the query for chaining./**
     * Gets the currency codes, or the regular expression to select codes.
     *
     * @return the query for chaining.
     */
    public Collection<String> getCurrencyCodes() {
        Collection<String> 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.
Returns:
the query for chaining./**
     * Gets the numeric codes. Setting it to -1 search for currencies that have no numeric code.
     *
     * @return the query for chaining.
     */
    public Collection<Integer> getNumericCodes() {
        Collection<Integer> 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.
Returns:
a new MonetaryAmountFactoryQueryBuilder instance, never null./**
     * 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);
    }

}