Class MT516

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

    @Generated
    public class MT516
    extends AbstractMT
    implements java.io.Serializable
    MT 516 - Securities Loan Confirmation.

    SWIFT MT516 (ISO 15022) message structure:

    • Sequence A (M)
      • Field 20 (M)
      • Field 21 (O)
      • Field 23 (M)
      • Field 31 P (M)
      • Field 83 C (O)
      • Field 35 B (M)
      • Field 35 A (O)
      • Field 31 L (O)
      • Field 31 X (O)
      • Field 30 (M)
      • Field 31 F (O)
      • Field 87 A,D (O)
      • Field 35 N (O)
      • Field 33 T (O)
    • Sequence B (O)
      • Field 37 J (O)
      • Field 26 H (O)
      • Field 33 S (O)
      • Field 32 A,B (O)
      • Field 37 A,B,C,D,E,F (O)
      • Field 57 A,B,D (O)
      • Field 35 S (O)
      • Field 35 B (O)
      • Field 87 A,D (O)
    • Sequence C (O)
      • Field 77 D (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
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MT516.SequenceA
      Class to model Sequence "A" in MT 516.
    • 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
      MT516()
      Creates and initializes a new MT516 input message setting TEST BICS as sender and receiver.
      MT516​(MtSwiftMessage m)
      Creates an MT516 initialized with the parameter MtSwiftMessage.
      MT516​(SwiftMessage m)
      Creates an MT516 initialized with the parameter SwiftMessage.
      MT516​(java.io.File file)
      Creates a new MT516 by parsing a file with the message content in its swift FIN format.
      MT516​(java.io.InputStream stream)
      Creates a new MT516 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.
      MT516​(java.lang.String fin)
      Creates a new MT516 by parsing a String with the message content in its swift FIN format.
      MT516​(java.lang.String sender, java.lang.String receiver)
      Creates and initializes a new MT516 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

      • MT516

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public Field31X getField31X()
        Iterates through block4 fields and return the first one whose name matches 31X, or null if none is found. The first occurrence of field 31X at MT516 is expected to be the only one.
        Returns:
        a Field31X object or null if the field is not found
        Throws:
        java.lang.IllegalStateException - if SwiftMessage object is not initialized
        See Also:
        SwiftTagListBlock.getTagByName(String)
      • 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 MT516 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)
      • getField31F

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public MT516.SequenceA getSequenceA()
        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.
        Returns:
        the found sequence or an empty sequence if none is found
        See Also:
        SwiftTagListBlock.getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
      • getSequenceA

        @SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL)
        public MT516.SequenceA getSequenceA​(SwiftTagListBlock parentSequence)
        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.
        Parameters:
        parentSequence - a not null parent sequence to find SequenceA within it
        Returns:
        the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty
        Since:
        7.7
        See Also:
        SwiftTagListBlock.getSubBlockDelimitedWithOptionalTail(String[], String[], String[])