com.prowidesoftware.swift.model.mt.mt4xx.MT491 Maven / Gradle / Ivy
Show all versions of pw-swift-core Show documentation
/*
* Copyright 2006-2023 Prowide
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.prowidesoftware.swift.model.mt.mt4xx;
import com.prowidesoftware.Generated;
import java.io.Serializable;
import org.apache.commons.lang3.StringUtils;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.model.field.*;
import com.prowidesoftware.swift.model.mt.AbstractMT;
import com.prowidesoftware.swift.utils.Lib;
import java.io.File;
import java.io.InputStream;
import java.io.IOException;
/**
* MT 491 - Request for Payment of Charges, Interest and Other Expenses.
*
*
* SWIFT MT491 (ISO 15022) message structure:
*
- Field 20 (M)
- Field 21 (M)
- Field 32 B (M)
- Field 52 A,D (O)
- Field 57 A,B,D (O)
- Field 71 B (M)
- Field 72 (O)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT491 extends AbstractMT implements Serializable {
/**
* Constant identifying the SRU to which this class belongs to.
*/
public static final int SRU = 2023;
private static final long serialVersionUID = 1L;
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(MT491.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "491";
/**
* Creates an MT491 initialized with the parameter SwiftMessage.
* @param m swift message with the MT491 content
*/
public MT491(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT491 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT491 content, the parameter can not be null
* @see #MT491(String)
*/
public MT491(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT491 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT491 content
* @return the created object or null if the parameter is null
* @see #MT491(String)
* @since 7.7
*/
public static MT491 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT491(m);
}
/**
* Creates and initializes a new MT491 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT491() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT491 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,
*
* @param sender the sender address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @param receiver the receiver address as a bic8, bic11 or full logical terminal consisting of 12 characters
* @since 7.7
*/
public MT491(final String sender, final String receiver) {
super(491, sender, receiver);
}
/**
* Creates a new MT491 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.
*
* @param fin a string with the MT message in its FIN swift format
* @since 7.7
*/
public MT491(final String fin) {
super();
if (fin != null) {
final SwiftMessage parsed = read(fin);
if (parsed != null) {
super.m = parsed;
sanityCheck(parsed);
}
}
}
private void sanityCheck(final SwiftMessage param) {
if (param.isServiceMessage()) {
log.warning("Creating an MT491 object from FIN content with a Service Message. Check if the MT491 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "491")) {
log.warning("Creating an MT491 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT491 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT491 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.
*
* @param fin a string with the MT message in its FIN swift format. fin may be null in which case this method returns null
* @return a new instance of MT491 or null if fin is null
* @since 7.7
*/
public static MT491 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT491(fin);
}
/**
* Creates a new MT491 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.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public MT491(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT491 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.
*
* @param stream an input stream in UTF-8 encoding with the MT message in its FIN swift format.
* @return a new instance of MT491 or null if stream is null or the message cannot be parsed
* @throws IOException if the stream data cannot be read
* @since 7.7
*/
public static MT491 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT491(stream);
}
/**
* Creates a new MT491 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.
*
* @param file a file with the MT message in its FIN swift format.
* @throws IOException if the file content cannot be read
* @since 7.7
*/
public MT491(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT491 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.
*
* @param file a file with the MT message in its FIN swift format.
* @return a new instance of MT491 or null if; file is null, does not exist, can't be read, is not a file or the message cannot be parsed
* @throws IOException if the file content cannot be read
* @since 7.7
*/
public static MT491 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT491(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "491";
}
/**
* Add all tags from block to the end of the block4.
*
* @param block to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT491 append(final SwiftTagListBlock block) {
super.append(block);
return this;
}
/**
* Add all tags to the end of the block4.
*
* @param tags to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT491 append(final Tag... tags) {
super.append(tags);
return this;
}
/**
* Add all the fields to the end of the block4.
*
* @param fields to append
* @return this object to allow method chaining
* @since 7.6
*/
@Override
public MT491 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT491 messages from its JSON representation.
*
* For generic conversion of JSON into the corresponding MT instance
* see {@link AbstractMT#fromJson(String)}
*
* @param json a JSON representation of an MT491 message
* @return a new instance of MT491
* @since 7.10.3
*/
public static MT491 fromJson(final String json) {
return (MT491) AbstractMT.fromJson(json);
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field20 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field20 getField20() {
final Tag t = tag("20");
if (t != null) {
return new Field20(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field21 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field21 getField21() {
final Tag t = tag("21");
if (t != null) {
return new Field21(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field32B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field32B getField32B() {
final Tag t = tag("32B");
if (t != null) {
return new Field32B(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field52A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field52A getField52A() {
final Tag t = tag("52A");
if (t != null) {
return new Field52A(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field52D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field52D getField52D() {
final Tag t = tag("52D");
if (t != null) {
return new Field52D(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field57A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field57A getField57A() {
final Tag t = tag("57A");
if (t != null) {
return new Field57A(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field57B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field57B getField57B() {
final Tag t = tag("57B");
if (t != null) {
return new Field57B(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field57D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field57D getField57D() {
final Tag t = tag("57D");
if (t != null) {
return new Field57D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 71B,
* or null if none is found.
* The first occurrence of field 71B at MT491 is expected to be the only one.
*
* @return a Field71B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field71B getField71B() {
final Tag t = tag("71B");
if (t != null) {
return new Field71B(t.getValue());
} else {
return null;
}
}
/**
* 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 MT491 is expected to be the only one.
*
* @return a Field72 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field72 getField72() {
final Tag t = tag("72");
if (t != null) {
return new Field72(t.getValue());
} else {
return null;
}
}
}