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

com.prowidesoftware.swift.model.mt.mt6xx.MT605 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.mt6xx;



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 605 - Commodity Notice to Receive.
 *
 * 

* SWIFT MT605 (ISO 15022) message structure: *

  • Field 20 (M)
  • Field 26 C (M)
  • Field 25 (O)
  • Field 30 (M)
  • Field 72 (O)
  • Sequence Loop1 (M) (repetitive)
    • Field 21 (M)
    • Field 23 (M)
    • Field 26 D (O)
    • Field 32 F (M)
    • Field 82 A,B,D (O)
    • Field 86 A,B,D (O)
    • Field 87 A,B,D (M)
    • Field 88 A,B,D (O)
    • Field 72 (O)
* *

* This source code is specific to release SRU 2023 *

* For additional resources check https://www.prowidesoftware.com/resources */ @Generated public class MT605 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(MT605.class.getName()); /** * Constant for MT name, this is part of the classname, after MT. */ public static final String NAME = "605"; /** * Creates an MT605 initialized with the parameter SwiftMessage. * @param m swift message with the MT605 content */ public MT605(final SwiftMessage m) { super(m); sanityCheck(m); } /** * Creates an MT605 initialized with the parameter MtSwiftMessage. * @param m swift message with the MT605 content, the parameter can not be null * @see #MT605(String) */ public MT605(final MtSwiftMessage m) { this(m.message()); } /** * Creates an MT605 initialized with the parameter MtSwiftMessage. * * @param m swift message with the MT605 content * @return the created object or null if the parameter is null * @see #MT605(String) * @since 7.7 */ public static MT605 parse(final MtSwiftMessage m) { if (m == null) { return null; } return new MT605(m); } /** * Creates and initializes a new MT605 input message setting TEST BICS as sender and receiver. * All mandatory header attributes are completed with default values. * * @since 7.6 */ public MT605() { this(BIC.TEST8, BIC.TEST8); } /** * Creates and initializes a new MT605 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 MT605(final String sender, final String receiver) { super(605, sender, receiver); } /** * Creates a new MT605 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 MT605(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 MT605 object from FIN content with a Service Message. Check if the MT605 you are intended to read is prepended with and ACK."); } else if (!StringUtils.equals(param.getType(), "605")) { log.warning("Creating an MT605 object from FIN content with message type "+param.getType()); } } /** * Creates a new MT605 by parsing a String with the message content in its swift FIN format. * If the fin parameter cannot be parsed, the returned MT605 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 MT605 or null if fin is null * @since 7.7 */ public static MT605 parse(final String fin) { if (fin == null) { return null; } return new MT605(fin); } /** * Creates a new MT605 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 MT605(final InputStream stream) throws IOException { this(Lib.readStream(stream)); } /** * Creates a new MT605 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 MT605 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 MT605 parse(final InputStream stream) throws IOException { if (stream == null) { return null; } return new MT605(stream); } /** * Creates a new MT605 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 MT605(final File file) throws IOException { this(Lib.readFile(file)); } /** * Creates a new MT605 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 MT605 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 MT605 parse(final File file) throws IOException { if (file == null) { return null; } return new MT605(file); } /** * Returns this MT number. * @return the message type number of this MT * @since 6.4 */ @Override public String getMessageType() { return "605"; } /** * 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 MT605 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 MT605 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 MT605 append(final Field... fields) { super.append(fields); return this; } /** * Creates an MT605 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 MT605 message * @return a new instance of MT605 * @since 7.10.3 */ public static MT605 fromJson(final String json) { return (MT605) 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 MT605 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 26C, * or null if none is found. * The first occurrence of field 26C at MT605 is expected to be the only one. * * @return a Field26C object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field26C getField26C() { final Tag t = tag("26C"); if (t != null) { return new Field26C(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 25, * or null if none is found. * The first occurrence of field 25 at MT605 is expected to be the only one. * * @return a Field25 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field25 getField25() { final Tag t = tag("25"); if (t != null) { return new Field25(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return the first one whose name matches 30, * or null if none is found. * The first occurrence of field 30 at MT605 is expected to be the only one. * * @return a Field30 object or null if the field is not found * @see SwiftTagListBlock#getTagByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public Field30 getField30() { final Tag t = tag("30"); if (t != null) { return new Field30(t.getValue()); } else { return null; } } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 21, * or Collections.emptyList() if none is found. * Multiple occurrences of field 21 at MT605 are expected at one sequence or across several sequences. * * @return a List of Field21 objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField21() { final List result = new ArrayList<>(); final Tag[] tags = tags("21"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field21(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 23, * or Collections.emptyList() if none is found. * Multiple occurrences of field 23 at MT605 are expected at one sequence or across several sequences. * * @return a List of Field23 objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField23() { final List result = new ArrayList<>(); final Tag[] tags = tags("23"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field23(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 26D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 26D at MT605 are expected at one sequence or across several sequences. * * @return a List of Field26D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField26D() { final List result = new ArrayList<>(); final Tag[] tags = tags("26D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field26D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 32F, * or Collections.emptyList() if none is found. * Multiple occurrences of field 32F at MT605 are expected at one sequence or across several sequences. * * @return a List of Field32F objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField32F() { final List result = new ArrayList<>(); final Tag[] tags = tags("32F"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field32F(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 82A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 82A at MT605 are expected at one sequence or across several sequences. * * @return a List of Field82A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField82A() { final List result = new ArrayList<>(); final Tag[] tags = tags("82A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field82A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 82B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 82B at MT605 are expected at one sequence or across several sequences. * * @return a List of Field82B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField82B() { final List result = new ArrayList<>(); final Tag[] tags = tags("82B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field82B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 82D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 82D at MT605 are expected at one sequence or across several sequences. * * @return a List of Field82D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField82D() { final List result = new ArrayList<>(); final Tag[] tags = tags("82D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field82D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 86A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 86A at MT605 are expected at one sequence or across several sequences. * * @return a List of Field86A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField86A() { final List result = new ArrayList<>(); final Tag[] tags = tags("86A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field86A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 86B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 86B at MT605 are expected at one sequence or across several sequences. * * @return a List of Field86B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField86B() { final List result = new ArrayList<>(); final Tag[] tags = tags("86B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field86B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 86D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 86D at MT605 are expected at one sequence or across several sequences. * * @return a List of Field86D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField86D() { final List result = new ArrayList<>(); final Tag[] tags = tags("86D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field86D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 87A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 87A at MT605 are expected at one sequence or across several sequences. * * @return a List of Field87A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField87A() { final List result = new ArrayList<>(); final Tag[] tags = tags("87A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field87A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 87B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 87B at MT605 are expected at one sequence or across several sequences. * * @return a List of Field87B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField87B() { final List result = new ArrayList<>(); final Tag[] tags = tags("87B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field87B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 87D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 87D at MT605 are expected at one sequence or across several sequences. * * @return a List of Field87D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField87D() { final List result = new ArrayList<>(); final Tag[] tags = tags("87D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field87D(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 88A, * or Collections.emptyList() if none is found. * Multiple occurrences of field 88A at MT605 are expected at one sequence or across several sequences. * * @return a List of Field88A objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField88A() { final List result = new ArrayList<>(); final Tag[] tags = tags("88A"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field88A(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 88B, * or Collections.emptyList() if none is found. * Multiple occurrences of field 88B at MT605 are expected at one sequence or across several sequences. * * @return a List of Field88B objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField88B() { final List result = new ArrayList<>(); final Tag[] tags = tags("88B"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field88B(tag.getValue())); } } return result; } /** * Iterates through block4 fields and return all occurrences of fields whose names matches 88D, * or Collections.emptyList() if none is found. * Multiple occurrences of field 88D at MT605 are expected at one sequence or across several sequences. * * @return a List of Field88D objects or Collections.emptyList() if none is not found * @see SwiftTagListBlock#getTagsByName(String) * @throws IllegalStateException if SwiftMessage object is not initialized */ public List getField88D() { final List result = new ArrayList<>(); final Tag[] tags = tags("88D"); if (tags != null && tags.length > 0) { for (Tag tag : tags) { result.add(new Field88D(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 MT605 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 "Loop1" in MT 605. */ public static class Loop1 extends SwiftTagListBlock { private static final long serialVersionUID = 1L; /** * Constructs an empty sequence. */ private Loop1() { super(new ArrayList<>()); } /** * Creates a sequence with the given content. * @see SwiftTagListBlock */ private Loop1(final SwiftTagListBlock content) { super(content.getTags()); } /** * First mandatory tag name of the sequence: "21" . * Array format is for cases when more than one letter options is allowed */ public static final String[] START = { "21" } ; /** * Last mandatory tag name of the sequence: "87A", "87B", "87D" * Array format is for cases when more than one letter options is allowed */ protected static final String[] END = { "87A", "87B", "87D" }; /** * List of optional tags after the last mandatory tag. */ protected static final String[] TAIL = new String[]{ "88A", "88B", "88D", "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 Loop1 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 Loop1 newInstance(final int start, final int end, final Tag... tags) { final Loop1 result = new Loop1(); 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 Loop1 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 getLoop1List() { return getLoop1List(super.getSwiftMessageNotNullOrException().getBlock4()); } /** * Get the list of Loop1 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 Loop1 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 getLoop1List(final SwiftTagListBlock parentSequence) { if (parentSequence != null) { final List blocks = parentSequence.getSubBlocksDelimitedWithOptionalTail(Loop1.START, Loop1.END, Loop1.TAIL); if (blocks != null && !blocks.isEmpty()) { final List result = new ArrayList<>(blocks.size()); for (final SwiftTagListBlock b : blocks) { result.add(new Loop1(b)); } return result; } } return Collections.emptyList(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy