Class MT416
- java.lang.Object
-
- com.prowidesoftware.swift.model.AbstractMessage
-
- com.prowidesoftware.swift.model.mt.AbstractMT
-
- com.prowidesoftware.swift.model.mt.mt4xx.MT416
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
@Generated public class MT416 extends AbstractMT implements java.io.Serializable
MT 416 - Advice of Non-Payment/Non-Acceptance.SWIFT MT416 (ISO 15022) message structure:
-
Sequence A - General Information (M)
- Field 20 (M)
- Field 21 (M)
- Field 23 E (O)
- Field 51 A (O)
- Field 53 A,B (O)
- Field 71 F (O)
- Field 77 A (O)
-
Sequence B - Non-Payment/Non-Acceptance Details (M) (repetitive)
- Field 21 A (M)
- Field 23 E (O)
- Field 21 C (O)
- Field 32 A,B,K (M)
- Field 50 D (O)
- Field 59 (O)
- Field 71 F (O)
- Field 77 A (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
MT416.SequenceA
Class to model Sequence "A" in MT 416.static class
MT416.SequenceB
Class to model Sequence "B" in MT 416.
-
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 MT416()
Creates and initializes a new MT416 input message setting TEST BICS as sender and receiver.MT416(MtSwiftMessage m)
Creates an MT416 initialized with the parameter MtSwiftMessage.MT416(SwiftMessage m)
Creates an MT416 initialized with the parameter SwiftMessage.MT416(java.io.File file)
Creates a new MT416 by parsing a file with the message content in its swift FIN format.MT416(java.io.InputStream stream)
Creates a new MT416 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.MT416(java.lang.String fin)
Creates a new MT416 by parsing a String with the message content in its swift FIN format.MT416(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT416 input message from sender to receiver.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MT416
append(Field... fields)
Add all the fields to the end of the block4.MT416
append(SwiftTagListBlock block)
Add all tags from block to the end of the block4.MT416
append(Tag... tags)
Add all tags to the end of the block4.static MT416
fromJson(java.lang.String json)
Creates an MT416 messages from its JSON representation.Field20
getField20()
Iterates through block4 fields and return the first one whose name matches 20, or null if none is found.Field21
getField21()
Iterates through block4 fields and return the first one whose name matches 21, or null if none is found.java.util.List<Field21A>
getField21A()
Iterates through block4 fields and return all occurrences of fields whose names matches 21A, orCollections.emptyList()
if none is found.java.util.List<Field21C>
getField21C()
Iterates through block4 fields and return all occurrences of fields whose names matches 21C, orCollections.emptyList()
if none is found.java.util.List<Field23E>
getField23E()
Iterates through block4 fields and return all occurrences of fields whose names matches 23E, orCollections.emptyList()
if none is found.java.util.List<Field32A>
getField32A()
Iterates through block4 fields and return all occurrences of fields whose names matches 32A, orCollections.emptyList()
if none is found.java.util.List<Field32B>
getField32B()
Iterates through block4 fields and return all occurrences of fields whose names matches 32B, orCollections.emptyList()
if none is found.java.util.List<Field32K>
getField32K()
Iterates through block4 fields and return all occurrences of fields whose names matches 32K, orCollections.emptyList()
if none is found.java.util.List<Field50D>
getField50D()
Iterates through block4 fields and return all occurrences of fields whose names matches 50D, orCollections.emptyList()
if none is found.Field51A
getField51A()
Iterates through block4 fields and return the first one whose name matches 51A, or null if none is found.Field53A
getField53A()
Iterates through block4 fields and return the first one whose name matches 53A, or null if none is found.Field53B
getField53B()
Iterates through block4 fields and return the first one whose name matches 53B, or null if none is found.java.util.List<Field59>
getField59()
Iterates through block4 fields and return all occurrences of fields whose names matches 59, orCollections.emptyList()
if none is found.java.util.List<Field71F>
getField71F()
Iterates through block4 fields and return all occurrences of fields whose names matches 71F, orCollections.emptyList()
if none is found.java.util.List<Field77A>
getField77A()
Iterates through block4 fields and return all occurrences of fields whose names matches 77A, orCollections.emptyList()
if none is found.java.lang.String
getMessageType()
Returns this MT number.MT416.SequenceA
getSequenceA()
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.MT416.SequenceA
getSequenceA(SwiftTagListBlock parentSequence)
Get the single occurrence of SequenceA delimited by leading tag and end, with an optional tail.java.util.List<MT416.SequenceB>
getSequenceBList()
Get the list of SequenceB delimited by leading tag and end, with an optional tail.static java.util.List<MT416.SequenceB>
getSequenceBList(SwiftTagListBlock parentSequence)
Get the list of SequenceB delimited by leading tag and end, with an optional tail.static MT416
parse(MtSwiftMessage m)
Creates an MT416 initialized with the parameter MtSwiftMessage.static MT416
parse(java.io.File file)
Creates a new MT416 by parsing a file with the message content in its swift FIN format.static MT416
parse(java.io.InputStream stream)
Creates a new MT416 by parsing a input stream with the message content in its swift FIN format, using "UTF-8" as encoding.static MT416
parse(java.lang.String fin)
Creates a new MT416 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
-
MT416
public MT416(SwiftMessage m)
Creates an MT416 initialized with the parameter SwiftMessage.- Parameters:
m
- swift message with the MT416 content
-
MT416
public MT416(MtSwiftMessage m)
Creates an MT416 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT416 content, the parameter can not be null- See Also:
MT416(String)
-
MT416
public MT416()
Creates and initializes a new MT416 input message setting TEST BICS as sender and receiver. All mandatory header attributes are completed with default values.- Since:
- 7.6
-
MT416
public MT416(java.lang.String sender, java.lang.String receiver)
Creates and initializes a new MT416 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
-
MT416
public MT416(java.lang.String fin)
Creates a new MT416 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
-
MT416
public MT416(java.io.InputStream stream) throws java.io.IOException
Creates a new MT416 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
-
MT416
public MT416(java.io.File file) throws java.io.IOException
Creates a new MT416 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 MT416 parse(MtSwiftMessage m)
Creates an MT416 initialized with the parameter MtSwiftMessage.- Parameters:
m
- swift message with the MT416 content- Returns:
- the created object or null if the parameter is null
- Since:
- 7.7
- See Also:
MT416(String)
-
parse
public static MT416 parse(java.lang.String fin)
Creates a new MT416 by parsing a String with the message content in its swift FIN format. If the fin parameter cannot be parsed, the returned MT416 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 MT416 or null if fin is null
- Since:
- 7.7
-
parse
public static MT416 parse(java.io.InputStream stream) throws java.io.IOException
Creates a new MT416 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 MT416 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 MT416 parse(java.io.File file) throws java.io.IOException
Creates a new MT416 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 MT416 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 MT416 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 MT416 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 MT416 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 MT416 fromJson(java.lang.String json)
Creates an MT416 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 MT416 message- Returns:
- a new instance of MT416
- 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 MT416 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 MT416 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)
-
getField51A
public Field51A getField51A()
Iterates through block4 fields and return the first one whose name matches 51A, or null if none is found. The first occurrence of field 51A at MT416 is expected to be the only one.- Returns:
- a Field51A object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField53A
public Field53A getField53A()
Iterates through block4 fields and return the first one whose name matches 53A, or null if none is found. The first occurrence of field 53A at MT416 is expected to be the only one.- Returns:
- a Field53A object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField53B
public Field53B getField53B()
Iterates through block4 fields and return the first one whose name matches 53B, or null if none is found. The first occurrence of field 53B at MT416 is expected to be the only one.- Returns:
- a Field53B object or null if the field is not found
- Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagByName(String)
-
getField21A
public java.util.List<Field21A> getField21A()
Iterates through block4 fields and return all occurrences of fields whose names matches 21A, orCollections.emptyList()
if none is found. Multiple occurrences of field 21A at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field21A objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField23E
public java.util.List<Field23E> getField23E()
Iterates through block4 fields and return all occurrences of fields whose names matches 23E, orCollections.emptyList()
if none is found. Multiple occurrences of field 23E at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field23E objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField21C
public java.util.List<Field21C> getField21C()
Iterates through block4 fields and return all occurrences of fields whose names matches 21C, orCollections.emptyList()
if none is found. Multiple occurrences of field 21C at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field21C 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, orCollections.emptyList()
if none is found. Multiple occurrences of field 32A at MT416 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, orCollections.emptyList()
if none is found. Multiple occurrences of field 32B at MT416 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, orCollections.emptyList()
if none is found. Multiple occurrences of field 32K at MT416 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)
-
getField50D
public java.util.List<Field50D> getField50D()
Iterates through block4 fields and return all occurrences of fields whose names matches 50D, orCollections.emptyList()
if none is found. Multiple occurrences of field 50D at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field50D objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField59
public java.util.List<Field59> getField59()
Iterates through block4 fields and return all occurrences of fields whose names matches 59, orCollections.emptyList()
if none is found. Multiple occurrences of field 59 at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field59 objects or
Collections.emptyList()
if none is not found - Throws:
java.lang.IllegalStateException
- if SwiftMessage object is not initialized- See Also:
SwiftTagListBlock.getTagsByName(String)
-
getField71F
public java.util.List<Field71F> getField71F()
Iterates through block4 fields and return all occurrences of fields whose names matches 71F, orCollections.emptyList()
if none is found. Multiple occurrences of field 71F at MT416 are expected at one sequence or across several sequences.- Returns:
- a List of Field71F 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, orCollections.emptyList()
if none is found. Multiple occurrences of field 77A at MT416 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)
-
getSequenceA
@SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL) public MT416.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 MT416.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[])
-
getSequenceBList
@SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL) public java.util.List<MT416.SequenceB> getSequenceBList()
Get the list of SequenceB 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[])
-
getSequenceBList
@SequenceStyle(GENERATED_FIXED_WITH_OPTIONAL_TAIL) public static java.util.List<MT416.SequenceB> getSequenceBList(SwiftTagListBlock parentSequence)
Get the list of SequenceB 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 SequenceB 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[])
-
-