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

com.prowidesoftware.swift.model.mt.mt4xx.MT416 Maven / Gradle / Ivy

There is a newer version: SRU2023-10.1.16
Show 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.mt4xx;



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 416 - Advice of Non-Payment/Non-Acceptance.
 *
 * 

* SWIFT MT416 (ISO 15022) message structure: *

  • Sequence A - General Information (M)
    • Field 20 (M)
    • Field 21 (M)
    • Field 23 E (O)
    • Field 51 A (O)
    • Field 53 A,B (O)
    • Field 71 F (O)
    • Field 77 A (O)
  • Sequence B - Non-Payment/Non-Acceptance Details (M) (repetitive)
    • Field 21 A (M)
    • Field 23 E (O)
    • Field 21 C (O)
    • Field 32 A,B,K (M)
    • Field 50 D (O)
    • Field 59 (O)
    • Field 71 F (O)
    • Field 77 A (O)
* *

* This source code is specific to release SRU 2023 *

* For additional resources check https://www.prowidesoftware.com/resources */ @Generated public class MT416 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(MT416.class.getName()); /** * Constant for MT name, this is part of the classname, after MT. */ public static final String NAME = "416"; /** * Creates an MT416 initialized with the parameter SwiftMessage. * @param m swift message with the MT416 content */ public MT416(final SwiftMessage m) { super(m); sanityCheck(m); } /** * Creates an MT416 initialized with the parameter MtSwiftMessage. * @param m swift message with the MT416 content, the parameter can not be null * @see #MT416(String) */ public MT416(final MtSwiftMessage m) { this(m.message()); } /** * Creates an MT416 initialized with the parameter MtSwiftMessage. * * @param m swift message with the MT416 content * @return the created object or null if the parameter is null * @see #MT416(String) * @since 7.7 */ public static MT416 parse(final MtSwiftMessage m) { if (m == null) { return null; } return new MT416(m); } /** * Creates and initializes a new MT416 input message setting TEST BICS as sender and receiver. * All mandatory header attributes are completed with default values. * * @since 7.6 */ public MT416() { this(BIC.TEST8, BIC.TEST8); } /** * Creates and initializes a new MT416 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 MT416(final String sender, final String receiver) { super(416, sender, receiver); } /** * Creates a new MT416 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 MT416(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 MT416 object from FIN content with a Service Message. Check if the MT416 you are intended to read is prepended with and ACK."); } else if (!StringUtils.equals(param.getType(), "416")) { log.warning("Creating an MT416 object from FIN content with message type "+param.getType()); } } /** * Creates a new MT416 by parsing a String with the message content in its swift FIN format. * If the fin parameter cannot be parsed, the returned MT416 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 MT416 or null if fin is null * @since 7.7 */ public static MT416 parse(final String fin) { if (fin == null) { return null; } return new MT416(fin); } /** * Creates a new MT416 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 MT416(final InputStream stream) throws IOException { this(Lib.readStream(stream)); } /** * Creates a new MT416 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 MT416 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 MT416 parse(final InputStream stream) throws IOException { if (stream == null) { return null; } return new MT416(stream); } /** * Creates a new MT416 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 MT416(final File file) throws IOException { this(Lib.readFile(file)); } /** * Creates a new MT416 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 MT416 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 MT416 parse(final File file) throws IOException { if (file == null) { return null; } return new MT416(file); } /** * Returns this MT number. * @return the message type number of this MT * @since 6.4 */ @Override public String getMessageType() { return "416"; } /** * 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 MT416 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 MT416 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 MT416 append(final Field... fields) { super.append(fields); return this; } /** * Creates an MT416 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 MT416 message * @return a new instance of MT416 * @since 7.10.3 */ public static MT416 fromJson(final String json) { return (MT416) 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 MT416 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 MT416 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 51A, * or null if none is found. * The first occurrence of field 51A at MT416 is expected to be the only one. * * @return a Field51A object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field51A getField51A() { final Tag t = tag("51A"); if (t != null) { return new Field51A(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 MT416 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 MT416 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 all occurrences of fields whose names matches 21A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 21A at MT416 are expected at one sequence or across several sequences. * * @return a List of Field21A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField21A() { final List result = new ArrayList<>(); final Tag[] tags = tags("21A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field21A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 23E, * or Collections.emptyList() if none is found. * Multiple occurrences of field 23E at MT416 are expected at one sequence or across several sequences. * * @return a List of Field23E objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField23E() { final List result = new ArrayList<>(); final Tag[] tags = tags("23E"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field23E(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 21C, * or Collections.emptyList() if none is found. * Multiple occurrences of field 21C at MT416 are expected at one sequence or across several sequences. * * @return a List of Field21C objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField21C() { final List result = new ArrayList<>(); final Tag[] tags = tags("21C"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field21C(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 32A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 32A at MT416 are expected at one sequence or across several sequences. * * @return a List of Field32A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField32A() { final List result = new ArrayList<>(); final Tag[] tags = tags("32A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field32A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 32B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 32B at MT416 are expected at one sequence or across several sequences. * * @return a List of Field32B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField32B() { final List result = new ArrayList<>(); final Tag[] tags = tags("32B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field32B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 32K, * or Collections.emptyList() if none is found. * Multiple occurrences of field 32K at MT416 are expected at one sequence or across several sequences. * * @return a List of Field32K objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField32K() { final List result = new ArrayList<>(); final Tag[] tags = tags("32K"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field32K(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 50D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 50D at MT416 are expected at one sequence or across several sequences. * * @return a List of Field50D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField50D() { final List result = new ArrayList<>(); final Tag[] tags = tags("50D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field50D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 59, * or Collections.emptyList() if none is found. * Multiple occurrences of field 59 at MT416 are expected at one sequence or across several sequences. * * @return a List of Field59 objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField59() { final List result = new ArrayList<>(); final Tag[] tags = tags("59"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field59(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 71F, * or Collections.emptyList() if none is found. * Multiple occurrences of field 71F at MT416 are expected at one sequence or across several sequences. * * @return a List of Field71F objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField71F() { final List result = new ArrayList<>(); final Tag[] tags = tags("71F"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field71F(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 77A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 77A at MT416 are expected at one sequence or across several sequences. * * @return a List of Field77A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField77A() { final List result = new ArrayList<>(); final Tag[] tags = tags("77A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field77A(tag.getValue())); } } return result; } /** * Class to model Sequence "A" in MT 416. */ 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: "21" * Array format is for cases when more than one letter options is allowed */ protected static final String[] END = { "21" }; /** * List of optional tags after the last mandatory tag. */ protected static final String[] TAIL = new String[]{ "23E", "51A", "53A", "53B", "71F", "77A" }; /** * 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 416. */ 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: "21A" . * Array format is for cases when more than one letter options is allowed */ public static final String[] START = { "21A" } ; /** * Last mandatory tag name of the sequence: "32A", "32B", "32K" * Array format is for cases when more than one letter options is allowed */ protected static final String[] END = { "32A", "32B", "32K" }; /** * List of optional tags after the last mandatory tag. */ protected static final String[] TAIL = new String[]{ "50D", "59", "71F", "77A" }; /** * 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 list of SequenceB delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur more than once according to the Standard. * If message is empty or no sequences are found an empty list is returned. * * @return the found sequences or an empty list if none is found * @see SwiftTagListBlock#getSubBlocksDelimitedWithOptionalTail(String[], String[], String[]) */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public List getSequenceBList() { return getSequenceBList(super.getSwiftMessageNotNullOrException().getBlock4()); } /** * Get the list of SequenceB delimited by leading tag and end, with an optional tail. * The presence of this method indicates that this sequence can occur more than once according to the Standard. * If message is empty or no sequences are found an empty list is returned. * * @see SwiftTagListBlock#getSubBlocksDelimitedWithOptionalTail(String[], String[], String[]) * @param parentSequence a not null parent sequence to find SequenceB within it * @return the found sequences or an empty list if none is found or parent sequence is null * @since 7.7 */ @SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static List getSequenceBList(final SwiftTagListBlock parentSequence) { if (parentSequence != null) { final List blocks = parentSequence.getSubBlocksDelimitedWithOptionalTail(SequenceB.START, SequenceB.END, SequenceB.TAIL); if (blocks != null && !blocks.isEmpty()) { final List result = new ArrayList<>(blocks.size()); for (final SwiftTagListBlock b : blocks) { result.add(new SequenceB(b)); } return result; } } return Collections.emptyList(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy