com.prowidesoftware.swift.model.field.CurrencyContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation

Prowide Library for SWIFT messages

There is a newer version: SRU2024-10.2.3

/*
 * Copyright 2006-2023 Prowide
 *
 * 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 com.prowidesoftware.swift.model.field;

import java.util.Currency;
import java.util.List;

/**
 * Field with a currency component.
 *
 * Note that if a field has a currency and it is optional, and the actual field has not set the optional currency/ies
 * then the call currencies() will return an empty list
 *
 * @since 6.0
 */
public interface CurrencyContainer extends PatternContainer {

    /**
     * Get a list of strings of currencies present in this field
     *
     * @return found currency codes or empty list
     */
    List currencyStrings();

    /**
     * Get the single currency contained in this field.
     *
     * @return null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.
     */
    String currencyString();

    /**
     * Utility method that creates a Currency for every string returned by {@link #currencyStrings()}
     *
     * @return found currencies or empty list
     */
    List currencies();

    /**
     * Analog to {@link #currencyString()}
     *
     * @see #currencyStrings()
     * @see #currencyString()
     */
    Currency currency();

    /**
     * Set the currency of this field.
     * If this field contains more than one currency then all currency components will be set.
     * Individual setComponentNN should be used to set only one component of the field.
     */
    void initializeCurrencies(String cur);

    /**
     * @see #initializeCurrencies(String)
     */
    void initializeCurrencies(Currency cur);
}