Class MT456

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

    @Generated
    public class MT456
    extends AbstractMT
    implements java.io.Serializable
    MT 456 - Advice of Dishonour.

    SWIFT MT456 (ISO 15022) message structure:

    • Field 25 (O)
    • Field 52 A,B,D (O)
    • Field 72 (O)
    • Sequence Loop1 (M) (repetitive)
      • Field 20 (M)
      • Field 21 (M)
      • Field 32 A,B (M)
      • Field 33 D (M)
      • Field 71 B (O)
      • Field 77 A (M)
      • Field 77 D (M)
      • Field 72 (O)

    This source code is specific to release SRU 2023

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

    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MT456.Loop1
      Class to model Sequence "Loop1" in MT 456.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String NAME
      Constant for MT name, this is part of the classname, after MT.
      static int SRU
      Constant identifying the SRU to which this class belongs to.
      • Fields inherited from class com.prowidesoftware.swift.model.mt.AbstractMT

        m
    • Constructor Summary

      Constructors 
      Constructor Description
      MT456()
      Creates and initializes a new MT456 input message setting TEST BICS as sender and receiver.
      MT456​(MtSwiftMessage m)
      Creates an MT456 initialized with the parameter MtSwiftMessage.
      MT456​(SwiftMessage m)
      Creates an MT456 initialized with the parameter SwiftMessage.
      MT456​(java.io.File file)
      Creates a new MT456 by parsing a file with the message content in its swift FIN format.
      MT456​(java.io.InputStream stream)
      Creates a new MT456 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
      MT456​(java.lang.String fin)
      Creates a new MT456 by parsing a String with the message content in its swift FIN format.
      MT456​(java.lang.String sender, java.lang.String receiver)
      Creates and initializes a new MT456 input message from sender to receiver.
    • 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

      • MT456

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

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

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

        public MT456​(java.lang.String sender,
                     java.lang.String receiver)
        Creates and initializes a new MT456 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
      • MT456

        public MT456​(java.lang.String fin)
        Creates a new MT456 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
      • MT456

        public MT456​(java.io.InputStream stream)
              throws java.io.IOException
        Creates a new MT456 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
      • MT456

        public MT456​(java.io.File file)
              throws java.io.IOException
        Creates a new MT456 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 MT456 parse​(MtSwiftMessage m)
        Creates an MT456 initialized with the parameter MtSwiftMessage.
        Parameters:
        m - swift message with the MT456 content
        Returns:
        the created object or null if the parameter is null
        Since:
        7.7
        See Also:
        MT456(String)
      • parse

        public static MT456 parse​(java.lang.String fin)
        Creates a new MT456 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT456 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 MT456 or null if fin is null
        Since:
        7.7
      • parse

        public static MT456 parse​(java.io.InputStream stream)
                           throws java.io.IOException
        Creates a new MT456 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 MT456 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 MT456 parse​(java.io.File file)
                           throws java.io.IOException
        Creates a new MT456 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 MT456 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 MT456 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 MT456 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 MT456 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 MT456 fromJson​(java.lang.String json)
        Creates an MT456 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 MT456 message
        Returns:
        a new instance of MT456
        Since:
        7.10.3
      • getField25

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

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

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

        public Field52D getField52D()
        Iterates through block4 fields and return the first one whose name matches 52D, or null if none is found. The first occurrence of field 52D at MT456 is expected to be the only one.
        Returns:
        a Field52D 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 MT456 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 MT456 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 MT456 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 MT456 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)
      • getField33D

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

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

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

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

        public java.util.List<Field72> getField72()
        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 MT456 are expected at one sequence or across several sequences.
        Returns:
        a List of Field72 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<MT456.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<MT456.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[])