Class MT056

    • 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

      • MT056

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

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

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

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

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

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

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

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

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

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

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

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

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