com.prowidesoftware.swift.model.field.BICContainer 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 com.prowidesoftware.swift.model.BIC;
import java.util.List;

/**
 * Fields with a BIC component.
 *
 * Note that if a field has a BIC and it is optional, and the actual field has not set the optional BIC/s then the
 * call bics() will return an empty list
 *
 * @since 6.1
 */
public interface BICContainer extends PatternContainer {

    /**
     * Get a list of strings of BICs present in this field
     *
     * @return a list, with zero or more BICs in this field.
     */
    List bicStrings();

    /**
     * Utility method that creates a BIC for every string returned by {@link #bicStrings()}
     *
     * @return list of BIC objects
     */
    List bics();
}