Class MT920
- java.lang.Object
-
- com.prowidesoftware.swift.model.AbstractMessage
-
- com.prowidesoftware.swift.model.mt.AbstractMT
-
- com.prowidesoftware.swift.model.mt.mt9xx.MT920
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
@Generated public class MT920 extends AbstractMT implements java.io.Serializable
MT 920 - Request Message.SWIFT MT920 (ISO 15022) message structure:
- Field 20 (M)
-
Sequence Loop1 (M) (repetitive)
- Field 12 (M)
- Field 25 (M)
- Field 34 F (O)
- Field 34 F (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
MT920.Loop1
Class to model Sequence "Loop1" in MT 920.
-
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 MT920()
Creates and initializes a new MT920 input message setting TEST BICS as sender and receiver.MT920(MtSwiftMessage m)
Creates an MT920 initialized with the parameter MtSwiftMessage.MT920(SwiftMessage m)
Creates an MT920 initialized with the parameter SwiftMessage.MT920(java.io.File file)
Creates a new MT920 by parsing a file with the message content in its swift FIN format.MT920(java.io.InputStream stream)
Creates a new MT920 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.MT920(java.lang.String fin)
Creates a new MT920 by parsing a String with the message content in its swift FIN format.MT920(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT920 input message from sender to receiver.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MT920
append(Field... fields)
Add all the fields to the end of the block4.MT920
append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.MT920
append(Tag... tags)
Add all tags to the end of the block4.static MT920
fromJson(java.lang.String json)
Creates an MT920 messages from its JSON representation.java.util.List<Field12>
getField12()
Iterates through block4 fields and return all occurrences of fields whose names matches 12, orCollections.emptyList()
if none is found.Field20
getField20()
Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.java.util.List<Field25>
getField25()
Iterates through block4 fields and return all occurrences of fields whose names matches 25, orCollections.emptyList()
if none is found.java.util.List<Field34F>
getField34F()
Iterates through block4 fields and return all occurrences of fields whose names matches 34F, orCollections.emptyList()
if none is found.java.util.List<MT920.Loop1>
getLoop1List()
Get the list of Loop1 delimited by leading tag and end, with an optional tail.static java.util.List<MT920.Loop1>
getLoop1List(SwiftTagListBlock parentSequence)
Get the list of Loop1 delimited by leading tag and end, with an optional tail.java.lang.String
getMessageType()
Returns this MT number.static MT920
parse(MtSwiftMessage m)
Creates an MT920 initialized with the parameter MtSwiftMessage.static MT920
parse(java.io.File file)
Creates a new MT920 by parsing a file with the message content in its swift FIN format.static MT920
parse(java.io.InputStream stream)
Creates a new MT920 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.static MT920
parse(java.lang.String fin)
Creates a new MT920 by parsing a String with the message content in its swift FIN format.-
Methods inherited from class com.prowidesoftware.swift.model.mt.AbstractMT
addField, containsSequence, containsSequenceList, create, create, getApplicationId, getFields, getLogicalTerminal, getMessagePriority, getMtId, getReceiver, getSender, getSequence, getSequence, getSequence, getSequenceList, getSequenceList, getSequenceNumber, getServiceId, getSessionNumber, getSignature, getSwiftMessage, getSwiftMessageNotNullOrException, getVariant, isIncoming, isInput, isOutgoing, isOutput, isType, message, nameFromClass, read, setReceiver, setReceiver, setSender, setSender, setSignature, setSwiftMessage, tag, tags, toJson, toString, write, write, xml
-
Methods inherited from class com.prowidesoftware.swift.model.AbstractMessage
getMessageStandardType, isMT, isMX
-
-
-
-
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
-
MT920
public MT920(SwiftMessage m)
Creates an MT920 initialized with the parameter SwiftMessage.- Parameters:
m
- swift message with the MT920 content
-
MT920
public MT920(MtSwiftMessage m)
Creates an MT920 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT920 content, the parameter can not be null- See Also:
MT920(String)
-
MT920
public MT920()
Creates and initializes a new MT920 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.- Since:
- 7.6
-
MT920
public MT920(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT920 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 charactersreceiver
- the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters- Since:
- 7.7
-
MT920
public MT920(java.lang.String fin)
Creates a new MT920 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
-
MT920
public MT920(java.io.InputStream stream) throws java.io.IOException
Creates a new MT920 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
-
MT920
public MT920(java.io.File file) throws java.io.IOException
Creates a new MT920 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 MT920 parse(MtSwiftMessage m)
Creates an MT920 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT920 content- Returns:
- the created object or null if the parameter is null
- Since:
- 7.7
- See Also:
MT920(String)
-
parse
public static MT920 parse(java.lang.String fin)
Creates a new MT920 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT920 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 MT920 or null if fin is null
- Since:
- 7.7
-
parse
public static MT920 parse(java.io.InputStream stream) throws java.io.IOException
Creates a new MT920 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 MT920 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 MT920 parse(java.io.File file) throws java.io.IOException
Creates a new MT920 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 MT920 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 classAbstractMT
- Returns:
- the message type number of this MT
- Since:
- 6.4
-
append
public MT920 append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
block
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT920 append(Tag... tags)
Add all tags to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
tags
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
append
public MT920 append(Field... fields)
Add all the fields to the end of the block4.- Overrides:
append
in classAbstractMT
- Parameters:
fields
- to append- Returns:
- this object to allow method chaining
- Since:
- 7.6
-
fromJson
public static MT920 fromJson(java.lang.String json)
Creates an MT920 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 MT920 message- Returns:
- a new instance of MT920
- 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 MT920 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)
-
getField12
public java.util.List<Field12> getField12()
Iterates through block4 fields and return all occurrences of fields whose names matches 12, orCollections.emptyList()
if none is found. Multiple occurrences of field 12 at MT920 are expected at one sequence or across several sequences.- Returns:
- a List of Field12 objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField25
public java.util.List<Field25> getField25()
Iterates through block4 fields and return all occurrences of fields whose names matches 25, orCollections.emptyList()
if none is found. Multiple occurrences of field 25 at MT920 are expected at one sequence or across several sequences.- Returns:
- a List of Field25 objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField34F
public java.util.List<Field34F> getField34F()
Iterates through block4 fields and return all occurrences of fields whose names matches 34F, orCollections.emptyList()
if none is found. Multiple occurrences of field 34F at MT920 are expected at one sequence or across several sequences.- Returns:
- a List of Field34F 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<MT920.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<MT920.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[])
-
-