com.prowidesoftware.swift.model.mt.mt6xx.MT606 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.mt6xx;
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 606 - Commodity Debit Advice.
*
*
* SWIFT MT606 (ISO 15022) message structure:
*
- Field 20 (M)
- Field 21 (M)
- Field 26 C (M)
- Field 25 (O)
- Field 26 D (O)
- Field 30 (M)
- Field 32 F (M)
- Field 82 A,D (O)
- Field 86 A,B,D (O)
- Field 87 A,D (O)
- Field 88 A,D (O)
- Field 72 (O)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT606 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(MT606.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "606";
/**
* Creates an MT606 initialized with the parameter SwiftMessage.
* @param m swift message with the MT606 content
*/
public MT606(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT606 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT606 content, the parameter can not be null
* @see #MT606(String)
*/
public MT606(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT606 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT606 content
* @return the created object or null if the parameter is null
* @see #MT606(String)
* @since 7.7
*/
public static MT606 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT606(m);
}
/**
* Creates and initializes a new MT606 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT606() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT606 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 MT606(final String sender, final String receiver) {
super(606, sender, receiver);
}
/**
* Creates a new MT606 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 MT606(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 MT606 object from FIN content with a Service Message. Check if the MT606 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "606")) {
log.warning("Creating an MT606 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT606 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT606 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 MT606 or null if fin is null
* @since 7.7
*/
public static MT606 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT606(fin);
}
/**
* Creates a new MT606 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 MT606(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT606 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 MT606 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 MT606 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT606(stream);
}
/**
* Creates a new MT606 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 MT606(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT606 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 MT606 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 MT606 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT606(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "606";
}
/**
* 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 MT606 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 MT606 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 MT606 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT606 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 MT606 message
* @return a new instance of MT606
* @since 7.10.3
*/
public static MT606 fromJson(final String json) {
return (MT606) 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 MT606 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 MT606 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 26C,
* or null if none is found.
* The first occurrence of field 26C at MT606 is expected to be the only one.
*
* @return a Field26C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field26C getField26C() {
final Tag t = tag("26C");
if (t != null) {
return new Field26C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 25,
* or null if none is found.
* The first occurrence of field 25 at MT606 is expected to be the only one.
*
* @return a Field25 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field25 getField25() {
final Tag t = tag("25");
if (t != null) {
return new Field25(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 26D,
* or null if none is found.
* The first occurrence of field 26D at MT606 is expected to be the only one.
*
* @return a Field26D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field26D getField26D() {
final Tag t = tag("26D");
if (t != null) {
return new Field26D(t.getValue());
} else {
return null;
}
}
/**
* 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 MT606 is expected to be the only one.
*
* @return a Field30 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field30 getField30() {
final Tag t = tag("30");
if (t != null) {
return new Field30(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 32F,
* or null if none is found.
* The first occurrence of field 32F at MT606 is expected to be the only one.
*
* @return a Field32F object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field32F getField32F() {
final Tag t = tag("32F");
if (t != null) {
return new Field32F(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 82A,
* or null if none is found.
* The first occurrence of field 82A at MT606 is expected to be the only one.
*
* @return a Field82A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field82A getField82A() {
final Tag t = tag("82A");
if (t != null) {
return new Field82A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 82D,
* or null if none is found.
* The first occurrence of field 82D at MT606 is expected to be the only one.
*
* @return a Field82D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field82D getField82D() {
final Tag t = tag("82D");
if (t != null) {
return new Field82D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 86A,
* or null if none is found.
* The first occurrence of field 86A at MT606 is expected to be the only one.
*
* @return a Field86A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field86A getField86A() {
final Tag t = tag("86A");
if (t != null) {
return new Field86A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 86B,
* or null if none is found.
* The first occurrence of field 86B at MT606 is expected to be the only one.
*
* @return a Field86B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field86B getField86B() {
final Tag t = tag("86B");
if (t != null) {
return new Field86B(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 86D,
* or null if none is found.
* The first occurrence of field 86D at MT606 is expected to be the only one.
*
* @return a Field86D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field86D getField86D() {
final Tag t = tag("86D");
if (t != null) {
return new Field86D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 87A,
* or null if none is found.
* The first occurrence of field 87A at MT606 is expected to be the only one.
*
* @return a Field87A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field87A getField87A() {
final Tag t = tag("87A");
if (t != null) {
return new Field87A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 87D,
* or null if none is found.
* The first occurrence of field 87D at MT606 is expected to be the only one.
*
* @return a Field87D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field87D getField87D() {
final Tag t = tag("87D");
if (t != null) {
return new Field87D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 88A,
* or null if none is found.
* The first occurrence of field 88A at MT606 is expected to be the only one.
*
* @return a Field88A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field88A getField88A() {
final Tag t = tag("88A");
if (t != null) {
return new Field88A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 88D,
* or null if none is found.
* The first occurrence of field 88D at MT606 is expected to be the only one.
*
* @return a Field88D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field88D getField88D() {
final Tag t = tag("88D");
if (t != null) {
return new Field88D(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 MT606 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;
}
}
}