All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.prowidesoftware.swift.model.mt.mt2xx.MT202COV Maven / Gradle / Ivy

The newest version!
/*
 * 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.mt.mt2xx;



import com.prowidesoftware.Generated;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Collections;

import org.apache.commons.lang3.StringUtils;

import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.internal.*;
import com.prowidesoftware.swift.internal.SequenceStyle.Type;
import com.prowidesoftware.swift.model.field.*;
import com.prowidesoftware.swift.model.mt.AbstractMT;
import com.prowidesoftware.swift.utils.Lib;
import java.io.File;
import java.io.InputStream;
import java.io.IOException;

/**
 * MT 202COV - General Financial Institution Transfer.
 *
 * 

* SWIFT MT202COV (ISO 15022) message structure: *

  • Sequence A (M)
    • Field 20 (M)
    • Field 21 (M)
    • Field 13 C (O) (repetitive)
    • Field 32 A (M)
    • Field 52 A,D (O)
    • Field 53 A,B,D (O)
    • Field 54 A,B,D (O)
    • Field 56 A,D (O)
    • Field 57 A,B,D (O)
    • Field 58 A,D (M)
    • Field 72 (O)
  • Sequence B (M)
    • Field 50 A,F,K (M)
    • Field 52 A,D (O)
    • Field 56 A,C,D (O)
    • Field 57 A,B,C,D (O)
    • Field 59 A,F,NONE (M)
    • Field 70 (O)
    • Field 72 (O)
    • Field 33 B (O)
* *

* This source code is specific to release SRU 2023 *

* For additional resources check https://www.prowidesoftware.com/resources */ @Generated public class MT202COV extends AbstractMT implements Serializable { /** * Constant identifying the SRU to which this class belongs to. */ public static final int SRU = 2023; private static final long serialVersionUID = 1L; private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(MT202COV.class.getName()); /** * Constant for MT name, this is part of the classname, after MT. */ public static final String NAME = "202COV"; /** * Creates an MT202COV initialized with the parameter SwiftMessage. * @param m swift message with the MT202COV content */ public MT202COV(final SwiftMessage m) { super(m); sanityCheck(m); } /** * Creates an MT202COV initialized with the parameter MtSwiftMessage. * @param m swift message with the MT202COV content, the parameter can not be null * @see #MT202COV(String) */ public MT202COV(final MtSwiftMessage m) { this(m.message()); } /** * Creates an MT202COV initialized with the parameter MtSwiftMessage. * * @param m swift message with the MT202COV content * @return the created object or null if the parameter is null * @see #MT202COV(String) * @since 7.7 */ public static MT202COV parse(final MtSwiftMessage m) { if (m == null) { return null; } return new MT202COV(m); } /** * Creates and initializes a new MT202COV input message setting TEST BICS as sender and receiver. * All mandatory header attributes are completed with default values. * * @since 7.6 */ public MT202COV() { this(BIC.TEST8, BIC.TEST8); } /** * Creates and initializes a new MT202COV input message from sender to receiver. * All mandatory header attributes are completed with default values. * In particular the sender and receiver addresses will be filled with proper default LT identifier * and branch codes if not provided, * * @param sender the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters * @param receiver the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters * @since 7.7 */ public MT202COV(final String sender, final String receiver) { super(202, sender, receiver); m.setVariant(com.prowidesoftware.swift.model.mt.MTVariant.COV); // initialize the SWIFT gpi service unique end to end transaction reference m.setUETR(); } /** * Creates a new MT202COV by parsing a String with the message content in its swift FIN format. * If the fin parameter is null or the message cannot be parsed, the internal message object * will be initialized (blocks will be created) but empty. * If the string contains multiple messages, only the first one will be parsed. * * @param fin a string with the MT message in its FIN swift format * @since 7.7 */ public MT202COV(final String fin) { super(); if (fin != null) { final SwiftMessage parsed = read(fin); if (parsed != null) { super.m = parsed; sanityCheck(parsed); } } } private void sanityCheck(final SwiftMessage param) { if (param.isServiceMessage()) { log.warning("Creating an MT202COV object from FIN content with a Service Message. Check if the MT202COV you are intended to read is prepended with and ACK."); } else if (!StringUtils.equals(param.getType(), "202")) { log.warning("Creating an MT202COV object from FIN content with message type "+param.getType()); } } /** * Creates a new MT202COV by parsing a String with the message content in its swift FIN format. * If the fin parameter cannot be parsed, the returned MT202COV will have its internal message object * initialized (blocks will be created) but empty. * If the string contains multiple messages, only the first one will be parsed. * * @param fin a string with the MT message in its FIN swift format. fin may be null in which case this method returns null * @return a new instance of MT202COV or null if fin is null * @since 7.7 */ public static MT202COV parse(final String fin) { if (fin == null) { return null; } return new MT202COV(fin); } /** * Creates a new MT202COV by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. * If the message content is null or cannot be parsed, the internal message object * will be initialized (blocks will be created) but empty. * If the stream contains multiple messages, only the first one will be parsed. * * @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format. * @throws IOException if the stream data cannot be read * @since 7.7 */ public MT202COV(final InputStream stream) throws IOException { this(Lib.readStream(stream)); } /** * Creates a new MT202COV by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding. * If the stream contains multiple messages, only the first one will be parsed. * * @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format. * @return a new instance of MT202COV or null if stream is null or the message cannot be parsed * @throws IOException if the stream data cannot be read * @since 7.7 */ public static MT202COV parse(final InputStream stream) throws IOException { if (stream == null) { return null; } return new MT202COV(stream); } /** * Creates a new MT202COV by parsing a file with the message content in its swift FIN format. * If the file content is null or cannot be parsed as a message, the internal message object * will be initialized (blocks will be created) but empty. * If the file contains multiple messages, only the first one will be parsed. * * @param file a file with the MT message in its FIN swift format. * @throws IOException if the file content cannot be read * @since 7.7 */ public MT202COV(final File file) throws IOException { this(Lib.readFile(file)); } /** * Creates a new MT202COV by parsing a file with the message content in its swift FIN format. * If the file contains multiple messages, only the first one will be parsed. * * @param file a file with the MT message in its FIN swift format. * @return a new instance of MT202COV or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed * @throws IOException if the file content cannot be read * @since 7.7 */ public static MT202COV parse(final File file) throws IOException { if (file == null) { return null; } return new MT202COV(file); } /** * Returns this MT number. * @return the message type number of this MT * @since 6.4 */ @Override public String getMessageType() { return "202"; } /** * Gets the Unique End to End Transaction Reference (field 121 from block 3). *

* This field is used by the SWIFT gpi service to track payments messages. * * @return the UETR value or null if block3 or field 121 in block3 are not present * @since 7.10.0 */ public String getUETR() { if (this.getSwiftMessage() == null) { return null; } else { return this.getSwiftMessage().getUETR(); } } /** * Add all tags from block to the end of the block4. * * @param block to append * @return this object to allow method chaining * @since 7.6 */ @Override public MT202COV append(final SwiftTagListBlock block) { super.append(block); return this; } /** * Add all tags to the end of the block4. * * @param tags to append * @return this object to allow method chaining * @since 7.6 */ @Override public MT202COV append(final Tag... tags) { super.append(tags); return this; } /** * Add all the fields to the end of the block4. * * @param fields to append * @return this object to allow method chaining * @since 7.6 */ @Override public MT202COV append(final Field... fields) { super.append(fields); return this; } /** * Creates an MT202COV messages from its JSON representation. *

* For generic conversion of JSON into the corresponding MT instance * see {@link AbstractMT#fromJson(String)} * * @param json a JSON representation of an MT202COV message * @return a new instance of MT202COV * @since 7.10.3 */ public static MT202COV fromJson(final String json) { return (MT202COV) AbstractMT.fromJson(json); } /** * Iterates through block4 fields and return the first one whose name matches 20, * or null if none is found. * The first occurrence of field 20 at MT202COV is expected to be the only one. * * @return a Field20 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field20 getField20() { final Tag t = tag("20"); if (t != null) { return new Field20(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 21, * or null if none is found. * The first occurrence of field 21 at MT202COV is expected to be the only one. * * @return a Field21 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field21 getField21() { final Tag t = tag("21"); if (t != null) { return new Field21(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 32A, * or null if none is found. * The first occurrence of field 32A at MT202COV is expected to be the only one. * * @return a Field32A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field32A getField32A() { final Tag t = tag("32A"); if (t != null) { return new Field32A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 53A, * or null if none is found. * The first occurrence of field 53A at MT202COV is expected to be the only one. * * @return a Field53A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field53A getField53A() { final Tag t = tag("53A"); if (t != null) { return new Field53A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 53B, * or null if none is found. * The first occurrence of field 53B at MT202COV is expected to be the only one. * * @return a Field53B object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field53B getField53B() { final Tag t = tag("53B"); if (t != null) { return new Field53B(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 53D, * or null if none is found. * The first occurrence of field 53D at MT202COV is expected to be the only one. * * @return a Field53D object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field53D getField53D() { final Tag t = tag("53D"); if (t != null) { return new Field53D(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 54A, * or null if none is found. * The first occurrence of field 54A at MT202COV is expected to be the only one. * * @return a Field54A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field54A getField54A() { final Tag t = tag("54A"); if (t != null) { return new Field54A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 54B, * or null if none is found. * The first occurrence of field 54B at MT202COV is expected to be the only one. * * @return a Field54B object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field54B getField54B() { final Tag t = tag("54B"); if (t != null) { return new Field54B(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 54D, * or null if none is found. * The first occurrence of field 54D at MT202COV is expected to be the only one. * * @return a Field54D object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field54D getField54D() { final Tag t = tag("54D"); if (t != null) { return new Field54D(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 58A, * or null if none is found. * The first occurrence of field 58A at MT202COV is expected to be the only one. * * @return a Field58A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field58A getField58A() { final Tag t = tag("58A"); if (t != null) { return new Field58A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 58D, * or null if none is found. * The first occurrence of field 58D at MT202COV is expected to be the only one. * * @return a Field58D object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field58D getField58D() { final Tag t = tag("58D"); if (t != null) { return new Field58D(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 50A, * or null if none is found. * The first occurrence of field 50A at MT202COV is expected to be the only one. * * @return a Field50A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field50A getField50A() { final Tag t = tag("50A"); if (t != null) { return new Field50A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 50F, * or null if none is found. * The first occurrence of field 50F at MT202COV is expected to be the only one. * * @return a Field50F object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field50F getField50F() { final Tag t = tag("50F"); if (t != null) { return new Field50F(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 50K, * or null if none is found. * The first occurrence of field 50K at MT202COV is expected to be the only one. * * @return a Field50K object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field50K getField50K() { final Tag t = tag("50K"); if (t != null) { return new Field50K(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 56C, * or null if none is found. * The first occurrence of field 56C at MT202COV is expected to be the only one. * * @return a Field56C object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field56C getField56C() { final Tag t = tag("56C"); if (t != null) { return new Field56C(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 57C, * or null if none is found. * The first occurrence of field 57C at MT202COV is expected to be the only one. * * @return a Field57C object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field57C getField57C() { final Tag t = tag("57C"); if (t != null) { return new Field57C(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 59A, * or null if none is found. * The first occurrence of field 59A at MT202COV is expected to be the only one. * * @return a Field59A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field59A getField59A() { final Tag t = tag("59A"); if (t != null) { return new Field59A(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 59F, * or null if none is found. * The first occurrence of field 59F at MT202COV is expected to be the only one. * * @return a Field59F object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field59F getField59F() { final Tag t = tag("59F"); if (t != null) { return new Field59F(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 59, * or null if none is found. * The first occurrence of field 59 at MT202COV is expected to be the only one. * * @return a Field59 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field59 getField59() { final Tag t = tag("59"); if (t != null) { return new Field59(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 70, * or null if none is found. * The first occurrence of field 70 at MT202COV is expected to be the only one. * * @return a Field70 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field70 getField70() { final Tag t = tag("70"); if (t != null) { return new Field70(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 33B, * or null if none is found. * The first occurrence of field 33B at MT202COV is expected to be the only one. * * @return a Field33B object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field33B getField33B() { final Tag t = tag("33B"); if (t != null) { return new Field33B(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 13C, * or Collections.emptyList() if none is found. * Multiple occurrences of field 13C at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field13C objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField13C() { final List result = new ArrayList<>(); final Tag[] tags = tags("13C"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field13C(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 52A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 52A at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field52A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField52A() { final List result = new ArrayList<>(); final Tag[] tags = tags("52A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field52A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 52D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 52D at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field52D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField52D() { final List result = new ArrayList<>(); final Tag[] tags = tags("52D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field52D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 56A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 56A at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field56A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField56A() { final List result = new ArrayList<>(); final Tag[] tags = tags("56A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field56A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 56D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 56D at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field56D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField56D() { final List result = new ArrayList<>(); final Tag[] tags = tags("56D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field56D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 57A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 57A at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field57A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField57A() { final List result = new ArrayList<>(); final Tag[] tags = tags("57A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field57A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 57B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 57B at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field57B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField57B() { final List result = new ArrayList<>(); final Tag[] tags = tags("57B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field57B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 57D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 57D at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field57D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField57D() { final List result = new ArrayList<>(); final Tag[] tags = tags("57D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field57D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 72, * or Collections.emptyList() if none is found. * Multiple occurrences of field 72 at MT202COV are expected at one sequence or across several sequences. * * @return a List of Field72 objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField72() { final List result = new ArrayList<>(); final Tag[] tags = tags("72"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field72(tag.getValue())); } } return result; } /** * Class to model Sequence "A" in MT 202COV. */ public static class SequenceA extends SwiftTagListBlock { private static final long serialVersionUID = 1L; /** * Constructs an empty sequence. */ private SequenceA() { super(new ArrayList<>()); } /** * Creates a sequence with the given content. * @see SwiftTagListBlock */ private SequenceA(final SwiftTagListBlock content) { super(content.getTags()); } /** * First mandatory tag name of the sequence: "20" . * Array format is for cases when more than one letter options is allowed */ public static final String[] START = { "20" } ; /** * Last mandatory tag name of the sequence: "58A", "58D" * Array format is for cases when more than one letter options is allowed */ protected static final String[] END = { "58A", "58D" }; /** * List of optional tags after the last mandatory tag. */ protected static final String[] TAIL = new String[]{ "72" }; /** * Same as {@link #newInstance(int, int, Tag...)} using zero for the indexes. * @param tags the list of tags to set as sequence content * @return a new instance of the sequence, initialized with the parameter tags */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static SequenceA newInstance(final Tag... tags) { return newInstance(0, 0, tags); } /** * Creates a sequence with starting and ending tags set to the indicated tags in from the * {@link #START} and {@link #END} lists of mandatory fields, and with the content between * the starting and ending tag initialized with the given optional tags. * * @param start a zero-based index within the list of mandatory starting tags in the sequence * @param end a zero-based index within the list of mandatory ending tags in the sequence * @param tags the list of tags to set as sequence content * @return a new instance of the sequence, initialized with the parameter tags */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static SequenceA newInstance(final int start, final int end, final Tag... tags) { final SequenceA result = new SequenceA(); result.append(new Tag(START[start], "")); if (tags != null && tags.length > 0) { for (final Tag t : tags) { result.append(t); } } result.append(new Tag(END[end], "")); return result; } } /** * Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur only once according to the Standard. * If block 4 is empty this method returns null. * * @return the found sequence or an empty sequence if none is found * @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[]) */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public SequenceA getSequenceA() { return getSequenceA(super.getSwiftMessageNotNullOrException().getBlock4()); } /** * Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur only once according to the Standard. * If block 4 is empty this method returns null. * * @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[]) * @param parentSequence a not null parent sequence to find SequenceA within it * @return the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty * @since 7.7 */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public SequenceA getSequenceA(SwiftTagListBlock parentSequence) { if (parentSequence != null && !parentSequence.isEmpty()) { final SwiftTagListBlock content = parentSequence.getSubBlockDelimitedWithOptionalTail(SequenceA.START, SequenceA.END, SequenceA.TAIL); if (log.isLoggable(java.util.logging.Level.FINE)) { if (content == null) { log.fine("content for sequence SequenceA: is null"); } else { log.fine("content for sequence SequenceA: "+content.tagNamesList()); } } if (content == null) { return new SequenceA(); } else { return new SequenceA(content); } } return null; } /** * Class to model Sequence "B" in MT 202COV. */ public static class SequenceB extends SwiftTagListBlock { private static final long serialVersionUID = 1L; /** * Constructs an empty sequence. */ private SequenceB() { super(new ArrayList<>()); } /** * Creates a sequence with the given content. * @see SwiftTagListBlock */ private SequenceB(final SwiftTagListBlock content) { super(content.getTags()); } /** * First mandatory tag name of the sequence: "50A", "50F", "50K" . * Array format is for cases when more than one letter options is allowed */ public static final String[] START = { "50A", "50F", "50K" } ; /** * Last mandatory tag name of the sequence: "59A", "59F", "59" * Array format is for cases when more than one letter options is allowed */ protected static final String[] END = { "59A", "59F", "59" }; /** * List of optional tags after the last mandatory tag. */ protected static final String[] TAIL = new String[]{ "70", "72", "33B" }; /** * Same as {@link #newInstance(int, int, Tag...)} using zero for the indexes. * @param tags the list of tags to set as sequence content * @return a new instance of the sequence, initialized with the parameter tags */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static SequenceB newInstance(final Tag... tags) { return newInstance(0, 0, tags); } /** * Creates a sequence with starting and ending tags set to the indicated tags in from the * {@link #START} and {@link #END} lists of mandatory fields, and with the content between * the starting and ending tag initialized with the given optional tags. * * @param start a zero-based index within the list of mandatory starting tags in the sequence * @param end a zero-based index within the list of mandatory ending tags in the sequence * @param tags the list of tags to set as sequence content * @return a new instance of the sequence, initialized with the parameter tags */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static SequenceB newInstance(final int start, final int end, final Tag... tags) { final SequenceB result = new SequenceB(); result.append(new Tag(START[start], "")); if (tags != null && tags.length > 0) { for (final Tag t : tags) { result.append(t); } } result.append(new Tag(END[end], "")); return result; } } /** * Get the single occurrence of SequenceB delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur only once according to the Standard. * If block 4 is empty this method returns null. * * @return the found sequence or an empty sequence if none is found * @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[]) */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public SequenceB getSequenceB() { return getSequenceB(super.getSwiftMessageNotNullOrException().getBlock4()); } /** * Get the single occurrence of SequenceB delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur only once according to the Standard. * If block 4 is empty this method returns null. * * @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[]) * @param parentSequence a not null parent sequence to find SequenceB within it * @return the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty * @since 7.7 */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public SequenceB getSequenceB(SwiftTagListBlock parentSequence) { if (parentSequence != null && !parentSequence.isEmpty()) { final SwiftTagListBlock content = parentSequence.getSubBlockDelimitedWithOptionalTail(SequenceB.START, SequenceB.END, SequenceB.TAIL); if (log.isLoggable(java.util.logging.Level.FINE)) { if (content == null) { log.fine("content for sequence SequenceB: is null"); } else { log.fine("content for sequence SequenceB: "+content.tagNamesList()); } } if (content == null) { return new SequenceB(); } else { return new SequenceB(content); } } return null; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy