Class MT420

  • All Implemented Interfaces:
    JsonSerializable, java.io.Serializable

    @Generated
    public class MT420
    extends AbstractMT
    implements java.io.Serializable
    MT 420 - Tracer.

    SWIFT MT420 (ISO 15022) message structure:

    • Sequence Loop1 (M) (repetitive)
      • Field 20 (M)
      • Field 21 (M)
      • Field 32 A,B,K (M)
    • Field 30 (O)
    • Field 59 (O)
    • Field 72 (O)

    This source code is specific to release SRU 2022

    For additional resources check https://www.prowidesoftware.com/resources

    See Also:
    Serialized Form
    • Field Detail

      • SRU

        public static final int SRU
        Constant identifying the SRU to which this class belongs to.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Constant for MT name, this is part of the classname, after MT.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MT420

        public MT420​(SwiftMessage m)
        Creates an MT420 initialized with the parameter SwiftMessage.
        Parameters:
        m - swift message with the MT420 content
      • MT420

        public MT420​(MtSwiftMessage m)
        Creates an MT420 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT420 content, the parameter can not be null
        See Also:
        MT420(String)
      • MT420

        public MT420()
        Creates and initializes a new MT420 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.
        Since:
        7.6
      • MT420

        public MT420​(java.lang.String sender,
                     java.lang.String receiver)
        Creates and initializes a new MT420 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,
        Parameters:
        sender - the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
        receiver - the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
        Since:
        7.7
      • MT420

        public MT420​(java.lang.String fin)
        Creates a new MT420 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.
        Parameters:
        fin - a string with the MT message in its FIN swift format
        Since:
        7.7
      • MT420

        public MT420​(java.io.InputStream stream)
              throws java.io.IOException
        Creates a new MT420 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.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • MT420

        public MT420​(java.io.File file)
              throws java.io.IOException
        Creates a new MT420 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.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
    • Method Detail

      • parse

        public static MT420 parse​(MtSwiftMessage m)
        Creates an MT420 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT420 content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT420(String)
      • parse

        public static MT420 parse​(java.lang.String fin)
        Creates a new MT420 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT420 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.
        Parameters:
        fin - a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
        Returns:
        a new instance of MT420 or null if fin is null
        Since:
        7.7
      • parse

        public static MT420 parse​(java.io.InputStream stream)
                           throws java.io.IOException
        Creates a new MT420 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.
        Parameters:
        stream - an input stream in UTF-8 encoding with the MT message in its FIN swift format.
        Returns:
        a new instance of MT420 or null if stream is null or the message cannot be parsed
        Throws:
        java.io.IOException - if the stream data cannot be read
        Since:
        7.7
      • parse

        public static MT420 parse​(java.io.File file)
                           throws java.io.IOException
        Creates a new MT420 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.
        Parameters:
        file - a file with the MT message in its FIN swift format.
        Returns:
        a new instance of MT420 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
        Throws:
        java.io.IOException - if the file content cannot be read
        Since:
        7.7
      • getMessageType

        public java.lang.String getMessageType()
        Returns this MT number.
        Specified by:
        getMessageType in class AbstractMT
        Returns:
        the message type number of this MT
        Since:
        6.4
      • append

        public MT420 append​(SwiftTagListBlock block)
        Add all tags from block to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        block - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT420 append​(Tag... tags)
        Add all tags to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        tags - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • append

        public MT420 append​(Field... fields)
        Add all the fields to the end of the block4.
        Overrides:
        append in class AbstractMT
        Parameters:
        fields - to append
        Returns:
        this object to allow method chaining
        Since:
        7.6
      • fromJson

        public static MT420 fromJson​(java.lang.String json)
        Creates an MT420 messages from its JSON representation.

        For generic conversion of JSON into the corresponding MT instance see AbstractMT.fromJson(String)

        Parameters:
        json - a JSON representation of an MT420 message
        Returns:
        a new instance of MT420
        Since:
        7.10.3
      • getField30

        public Field30 getField30()
        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 MT420 is expected to be the only one.
        Returns:
        a Field30 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField59

        public Field59 getField59()
        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 MT420 is expected to be the only one.
        Returns:
        a Field59 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField72

        public Field72 getField72()
        Iterates through block4 fields and return the first one whose name matches 72, or null if none is found. The first occurrence of field 72 at MT420 is expected to be the only one.
        Returns:
        a Field72 object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • getField20

        public java.util.List<Field20> getField20()
        Iterates through block4 fields and return all occurrences of fields whose names matches 20, or Collections.emptyList() if none is found. Multiple occurrences of field 20 at MT420 are expected at one sequence or across several sequences.
        Returns:
        a List of Field20 objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField21

        public java.util.List<Field21> getField21()
        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 MT420 are expected at one sequence or across several sequences.
        Returns:
        a List of Field21 objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField32A

        public java.util.List<Field32A> getField32A()
        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 MT420 are expected at one sequence or across several sequences.
        Returns:
        a List of Field32A objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField32B

        public java.util.List<Field32B> getField32B()
        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 MT420 are expected at one sequence or across several sequences.
        Returns:
        a List of Field32B objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getField32K

        public java.util.List<Field32K> getField32K()
        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 MT420 are expected at one sequence or across several sequences.
        Returns:
        a List of Field32K objects or Collections.emptyList() if none is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagsByName(String)
      • getLoop1List

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public java.util.List<MT420.Loop1> getLoop1List()
        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.
        Returns:
        the found sequences or an empty list if none is found
        See Also:
        SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])
      • getLoop1List

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public static java.util.List<MT420.Loop1> getLoop1List​(SwiftTagListBlock parentSequence)
        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.
        Parameters:
        parentSequence - a not null parent sequence to find Loop1 within it
        Returns:
        the found sequences or an empty list if none is found or parent sequence is null
        Since:
        7.7
        See Also:
        SwiftTagListBlock.getSubBlocksDelimitedWithOptionalTail(String[], String[], String[])