com.prowidesoftware.swift.model.mt.mt6xx.MT671 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 java.util.ArrayList;
import java.util.List;
import java.util.Collections;
import org.apache.commons.lang3.StringUtils;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.internal.*;
import com.prowidesoftware.swift.internal.SequenceStyle.Type;
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 671 - Standing Settlement Instruction Update Notification.
*
*
* SWIFT MT671 (ISO 15022) message structure:
*
-
Sequence A - General Information (M)
- Field 16 R (M)
- Field 20 C (M)
- Field 23 G (M)
-
Sequence A1 - Linkages (O) (repetitive)
- Field 16 R (M)
- Field 20 C (M)
- Field 16 S (M)
-
Fieldset 95
(M) (repetitive)
- FieldsetItem 95 P (M)
- FieldsetItem 95 Q (O) (repetitive)
- FieldsetItem 95 P,Q (O) (repetitive)
- Field 22 F (M)
- Field 97 A (O)
- Field 16 S (M)
-
Sequence B - Standing Settlement Instruction Details (M) (repetitive)
- Field 16 R (M)
- Field 22 H (M)
- Field 20 C (O)
- Field 11 A (M)
- Field 98 A (M)
-
Fieldset 22
(M) (repetitive)
- FieldsetItem 22 F (O) (repetitive)
- FieldsetItem 22 F (M) (repetitive)
-
Sequence B1 - Cash Parties (M) (repetitive)
- Field 16 R (M)
-
Fieldset 95
(M) (repetitive)
- FieldsetItem 95 P,Q,R (M) (repetitive)
- FieldsetItem 95 S (O) (repetitive)
- Field 97 A (O)
- Field 16 S (M)
-
Sequence B2 - Other Details (O)
- Field 16 R (M)
- Field 70 E (O) (repetitive)
- Field 22 F (O)
- Field 22 H (O)
- Field 16 S (M)
- Field 16 S (M)
-
Sequence C - Other Details (O)
- Field 16 R (M)
- Field 70 E (O) (repetitive)
- Field 22 F (O)
- Field 22 H (O)
- Field 16 S (M)
*
*
* This source code is specific to release SRU 2023
*
* For additional resources check https://www.prowidesoftware.com/resources
*/
@Generated
public class MT671 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(MT671.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "671";
/**
* Creates an MT671 initialized with the parameter SwiftMessage.
* @param m swift message with the MT671 content
*/
public MT671(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT671 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT671 content, the parameter can not be null
* @see #MT671(String)
*/
public MT671(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT671 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT671 content
* @return the created object or null if the parameter is null
* @see #MT671(String)
* @since 7.7
*/
public static MT671 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT671(m);
}
/**
* Creates and initializes a new MT671 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT671() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT671 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 MT671(final String sender, final String receiver) {
super(671, sender, receiver);
}
/**
* Creates a new MT671 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 MT671(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 MT671 object from FIN content with a Service Message. Check if the MT671 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "671")) {
log.warning("Creating an MT671 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT671 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT671 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 MT671 or null if fin is null
* @since 7.7
*/
public static MT671 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT671(fin);
}
/**
* Creates a new MT671 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 MT671(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT671 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 MT671 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 MT671 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT671(stream);
}
/**
* Creates a new MT671 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 MT671(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT671 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 MT671 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 MT671 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT671(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "671";
}
/**
* 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 MT671 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 MT671 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 MT671 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT671 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 MT671 message
* @return a new instance of MT671
* @since 7.10.3
*/
public static MT671 fromJson(final String json) {
return (MT671) AbstractMT.fromJson(json);
}
/**
* Iterates through block4 fields and return the first one whose name matches 23G,
* or null if none is found.
* The first occurrence of field 23G at MT671 is expected to be the only one.
*
* @return a Field23G object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field23G getField23G() {
final Tag t = tag("23G");
if (t != null) {
return new Field23G(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 16R,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 16R at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field16R objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField16R() {
final List result = new ArrayList<>();
final Tag[] tags = tags("16R");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field16R(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 20C,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 20C at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field20C objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField20C() {
final List result = new ArrayList<>();
final Tag[] tags = tags("20C");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field20C(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 16S,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 16S at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field16S objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField16S() {
final List result = new ArrayList<>();
final Tag[] tags = tags("16S");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field16S(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 95P,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 95P at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field95P objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField95P() {
final List result = new ArrayList<>();
final Tag[] tags = tags("95P");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field95P(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 95Q,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 95Q at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field95Q objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField95Q() {
final List result = new ArrayList<>();
final Tag[] tags = tags("95Q");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field95Q(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 22H,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 22H at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field22H objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField22H() {
final List result = new ArrayList<>();
final Tag[] tags = tags("22H");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field22H(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 11A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 11A at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field11A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField11A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("11A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field11A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 98A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 98A at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field98A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField98A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("98A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field98A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 22F,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 22F at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field22F objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField22F() {
final List result = new ArrayList<>();
final Tag[] tags = tags("22F");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field22F(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 95R,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 95R at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field95R objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField95R() {
final List result = new ArrayList<>();
final Tag[] tags = tags("95R");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field95R(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 95S,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 95S at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field95S objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField95S() {
final List result = new ArrayList<>();
final Tag[] tags = tags("95S");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field95S(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 97A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 97A at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field97A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField97A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("97A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field97A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 70E,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 70E at MT671 are expected at one sequence or across several sequences.
*
* @return a List of Field70E objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField70E() {
final List result = new ArrayList<>();
final Tag[] tags = tags("70E");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field70E(tag.getValue()));
}
}
return result;
}
/**
* Class to model Sequence "A" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
public static class SequenceA extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceA() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceA(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence GENL.
*/
public static final String START_END_16RS = "GENL";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceA newInstance(final Tag... tags) {
final SequenceA result = new SequenceA();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceA newInstance() {
final SequenceA result = new SequenceA();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceA newInstance(final SwiftTagListBlock... sequences) {
final SequenceA result = new SequenceA();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceA(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the single occurrence of SequenceA delimited by 16R/16S the value of SequenceA#START_END_16RS.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* @return the found sequence or an empty sequence if none is found
* @see SequenceA#START_END_16RS
*/
@SequenceStyle(Type.GENERATED_16RS)
public SequenceA getSequenceA() {
return new SequenceA(super.getSwiftMessageNotNullOrException());
}
/**
* Same as getSequenceA using the sequence delimiter field qualifier
* @see SequenceA#getSequenceA()
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 9.2.18
*/
public SequenceA getSequenceGENL() {
return getSequenceA();
}
/**
* Get the single occurrence of SequenceA delimited by 16R/16S the value of SequenceA#START_END_16RS.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* @see SequenceA#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceA within it
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceA getSequenceA(SwiftTagListBlock parentSequence) {
final SequenceA s = new SequenceA();
if (parentSequence != null) {
s.setTags(parentSequence.getSubBlock(SequenceA.START_END_16RS).getTags());
}
return s;
}
/**
* Same as getSequenceA using the sequence delimiter field qualifier
* @see SequenceA#getSequenceA(SwiftTagListBlock)
* @param parentSequence a not null parent sequence to find SequenceA within it
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 9.2.18
*/
public static SequenceA getSequenceGENL(SwiftTagListBlock parentSequence) {
return getSequenceA(parentSequence);
}
/**
* Class to model Sequence "A1" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
public static class SequenceA1 extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceA1() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceA1(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence LINK.
*/
public static final String START_END_16RS = "LINK";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceA1 newInstance(final Tag... tags) {
final SequenceA1 result = new SequenceA1();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceA1 newInstance() {
final SequenceA1 result = new SequenceA1();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceA1 newInstance(final SwiftTagListBlock... sequences) {
final SequenceA1 result = new SequenceA1();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceA1(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the list of SequenceA1 delimited by 16R/16S with value specified in {@link SequenceA1#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @return the found sequences or an empty list if none is found
* @see SequenceA1#START_END_16RS
*/
@SequenceStyle(Type.GENERATED_16RS)
public List getSequenceA1List() {
return getSequenceA1List(super.getSwiftMessageNotNullOrException().getBlock4());
}
/**
* Same as getSequenceA1List using the sequence delimiter field qualifier
* @see SequenceA1#getSequenceA1List()
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public List getSequenceLINKList() {
return getSequenceA1List();
}
/**
* Get the list of SequenceA1 delimited by 16R/16S with value specified in {@link SequenceA1#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @see SequenceA1#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceA1 within it
* @return the found sequences or an empty list if none is found or parent sequence is null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static List getSequenceA1List(final SwiftTagListBlock parentSequence) {
if (parentSequence != null) {
final List blocks = parentSequence.getSubBlocks(SequenceA1.START_END_16RS);
if (blocks != null && !blocks.isEmpty()) {
final List result = new ArrayList<>(blocks.size());
for (final SwiftTagListBlock b : blocks) {
final SequenceA1 s = new SequenceA1();
s.setTags(b.getSubBlock(SequenceA1.START_END_16RS).getTags());
result.add(s);
}
return result;
}
}
return Collections.emptyList();
}
/**
* Same as getSequenceA1List using the sequence delimiter field qualifier
* @see SequenceA1#getSequenceA1List(SwiftTagListBlock)
* @param parentSequence a not null parent sequence to find SequenceA1 within it
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public static List getSequenceLINKList(final SwiftTagListBlock parentSequence) {
return getSequenceA1List(parentSequence);
}
/**
* Class to model Sequence "B" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
public static class SequenceB extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceB() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceB(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence SSIDET.
*/
public static final String START_END_16RS = "SSIDET";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceB newInstance(final Tag... tags) {
final SequenceB result = new SequenceB();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceB newInstance() {
final SequenceB result = new SequenceB();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceB newInstance(final SwiftTagListBlock... sequences) {
final SequenceB result = new SequenceB();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceB(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the list of SequenceB delimited by 16R/16S with value specified in {@link SequenceB#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @return the found sequences or an empty list if none is found
* @see SequenceB#START_END_16RS
*/
@SequenceStyle(Type.GENERATED_16RS)
public List getSequenceBList() {
return getSequenceBList(super.getSwiftMessageNotNullOrException().getBlock4());
}
/**
* Same as getSequenceBList using the sequence delimiter field qualifier
* @see SequenceB#getSequenceBList()
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public List getSequenceSSIDETList() {
return getSequenceBList();
}
/**
* Get the list of SequenceB delimited by 16R/16S with value specified in {@link SequenceB#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @see SequenceB#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceB within it
* @return the found sequences or an empty list if none is found or parent sequence is null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static List getSequenceBList(final SwiftTagListBlock parentSequence) {
if (parentSequence != null) {
final List blocks = parentSequence.getSubBlocks(SequenceB.START_END_16RS);
if (blocks != null && !blocks.isEmpty()) {
final List result = new ArrayList<>(blocks.size());
for (final SwiftTagListBlock b : blocks) {
final SequenceB s = new SequenceB();
s.setTags(b.getSubBlock(SequenceB.START_END_16RS).getTags());
result.add(s);
}
return result;
}
}
return Collections.emptyList();
}
/**
* Same as getSequenceBList using the sequence delimiter field qualifier
* @see SequenceB#getSequenceBList(SwiftTagListBlock)
* @param parentSequence a not null parent sequence to find SequenceB within it
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public static List getSequenceSSIDETList(final SwiftTagListBlock parentSequence) {
return getSequenceBList(parentSequence);
}
/**
* Class to model Sequence "B1" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
public static class SequenceB1 extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceB1() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceB1(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence CSHPRTY.
*/
public static final String START_END_16RS = "CSHPRTY";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceB1 newInstance(final Tag... tags) {
final SequenceB1 result = new SequenceB1();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceB1 newInstance() {
final SequenceB1 result = new SequenceB1();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceB1 newInstance(final SwiftTagListBlock... sequences) {
final SequenceB1 result = new SequenceB1();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceB1(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the list of SequenceB1 delimited by 16R/16S with value specified in {@link SequenceB1#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @return the found sequences or an empty list if none is found
* @see SequenceB1#START_END_16RS
*/
@SequenceStyle(Type.GENERATED_16RS)
public List getSequenceB1List() {
return getSequenceB1List(super.getSwiftMessageNotNullOrException().getBlock4());
}
/**
* Same as getSequenceB1List using the sequence delimiter field qualifier
* @see SequenceB1#getSequenceB1List()
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public List getSequenceCSHPRTYList() {
return getSequenceB1List();
}
/**
* Get the list of SequenceB1 delimited by 16R/16S with value specified in {@link SequenceB1#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
* @see SequenceB1#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceB1 within it
* @return the found sequences or an empty list if none is found or parent sequence is null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static List getSequenceB1List(final SwiftTagListBlock parentSequence) {
if (parentSequence != null) {
final List blocks = parentSequence.getSubBlocks(SequenceB1.START_END_16RS);
if (blocks != null && !blocks.isEmpty()) {
final List result = new ArrayList<>(blocks.size());
for (final SwiftTagListBlock b : blocks) {
final SequenceB1 s = new SequenceB1();
s.setTags(b.getSubBlock(SequenceB1.START_END_16RS).getTags());
result.add(s);
}
return result;
}
}
return Collections.emptyList();
}
/**
* Same as getSequenceB1List using the sequence delimiter field qualifier
* @see SequenceB1#getSequenceB1List(SwiftTagListBlock)
* @param parentSequence a not null parent sequence to find SequenceB1 within it
* @return the found sequences or an empty list if none is found
* @since 9.2.18
*/
public static List getSequenceCSHPRTYList(final SwiftTagListBlock parentSequence) {
return getSequenceB1List(parentSequence);
}
/**
* Class to model Sequence "B2" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
@NonUniqueSeparator
public static class SequenceB2 extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceB2() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceB2(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence OTHRDET.
*/
public static final String START_END_16RS = "OTHRDET";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@NonUniqueSeparator
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceB2 newInstance(final Tag... tags) {
final SequenceB2 result = new SequenceB2();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceB2 newInstance() {
final SequenceB2 result = new SequenceB2();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceB2 newInstance(final SwiftTagListBlock... sequences) {
final SequenceB2 result = new SequenceB2();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceB2(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the list of SequenceB2 delimited by 16R/16S with value specified in {@link SequenceB2#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
*
*
This sequence does not have a unique 16R/S delimiter. In order to be uniquely identified it must be
* present inside its parent sequences.
* @see com.prowidesoftware.swift.model.mt.SequenceUtils
*
* @return the found sequences or an empty list if none is found
* @see SequenceB2#START_END_16RS
*/
@NonUniqueSeparator
@SequenceStyle(Type.GENERATED_16RS)
public List getSequenceB2List() {
/*
* The delimiter OTHRDET is not unique across all sequences, in this MT.
* The usual generated API for accessing this can not be used for sequence B2.
* So we call a special method to resolve this situation until we find a better approach.
*/
if (this.getSwiftMessage() == null) {
return null;
}
return com.prowidesoftware.swift.model.mt.SequenceUtils.resolveMT671GetSequenceB2List_sru2023(this);
}
/**
* Get the list of SequenceB2 delimited by 16R/16S with value specified in {@link SequenceB2#START_END_16RS}.
*
* The presence of this method indicates that this sequence can occur more than once according to the Standard.
*
*
This sequence does not have a unique 16R/S delimiter. In order to be uniquely identified it must be
* present inside its parent sequences.
* @see com.prowidesoftware.swift.model.mt.SequenceUtils
*
* @see SequenceB2#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceB2 within it
* @return the found sequences or an empty list if none is found or parent sequence is null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static List getSequenceB2List(final SwiftTagListBlock parentSequence) {
if (parentSequence != null) {
final List blocks = parentSequence.getSubBlocks(SequenceB2.START_END_16RS);
if (blocks != null && !blocks.isEmpty()) {
final List result = new ArrayList<>(blocks.size());
for (final SwiftTagListBlock b : blocks) {
final SequenceB2 s = new SequenceB2();
s.setTags(b.getSubBlock(SequenceB2.START_END_16RS).getTags());
result.add(s);
}
return result;
}
}
return Collections.emptyList();
}
/**
* Class to model Sequence "C" in MT 671.
*/
@SequenceStyle(Type.GENERATED_16RS)
@NonUniqueSeparator
public static class SequenceC extends SwiftTagListBlock {
private static final long serialVersionUID = 1L;
/**
* Constructs an empty sequence.
*/
private SequenceC() {
super(new ArrayList<>());
}
/**
* Creates a sequence with the given content.
* @see SwiftTagListBlock
*/
private SequenceC(final SwiftTagListBlock content) {
super(content.getTags());
}
/**
* Value for the qualifier of the 16R / 16S tag that indicates start and end of this sequence OTHRDET.
*/
public static final String START_END_16RS = "OTHRDET";
public static final Tag START_TAG = new Tag(Field16R.NAME, START_END_16RS);
public static final Tag END_TAG = new Tag(Field16S.NAME, START_END_16RS);
/**
* Creates a new instance of this sequence with the given tags inside.
* @param tags may be null, an empty sequence containing only start and end sequence tags will be returned
* @return a new instance of the sequence, initialized with the parameter tags
*/
@NonUniqueSeparator
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceC newInstance(final Tag... tags) {
final SequenceC result = new SequenceC();
result.append(START_TAG);
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(END_TAG);
return result;
}
/**
* Create an empty $sequenceClassname.
* This method is intended to avoid disambiguation for the newInstance() with variable list of blocks or tags
* @return a new instance of the sequence
* @since 7.6
*/
public static SequenceC newInstance() {
final SequenceC result = new SequenceC();
result.append(START_TAG);
result.append(END_TAG);
return result;
}
/**
* Create a new instance of $sequenceClassname and add the contents of all sequences given inside.
* Mainly intended to create a sequence by adding subsequences
* @param sequences a list of blocks to set as the new sequence content
* @return a new instance of the sequence, initialized with the parameter sequences content
* @since 7.6
*/
public static SequenceC newInstance(final SwiftTagListBlock... sequences) {
final SequenceC result = new SequenceC();
result.append(START_TAG);
if (sequences != null && sequences.length > 0) {
for (final SwiftTagListBlock s : sequences) {
result.addTags(s.getTags());
}
}
result.append(END_TAG);
return result;
}
@SequenceStyle(Type.GENERATED_16RS)
private SequenceC(final SwiftMessage m) {
super();
if (m.getBlock4() != null) {
setTags(m.getBlock4().getSubBlock(START_END_16RS).getTags());
}
}
}
/**
* Get the single occurrence of SequenceC delimited by 16R/16S the value of SequenceC#START_END_16RS.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* @return the found sequence or an empty sequence if none is found
*
* This sequence does not have a unique 16R/S delimiter. In order to be uniquely identified it must be
* present inside its parent sequences.
* @see com.prowidesoftware.swift.model.mt.SequenceUtils
*
* @see SequenceC#START_END_16RS
*/
@NonUniqueSeparator
@SequenceStyle(Type.GENERATED_16RS)
public SequenceC getSequenceC() {
/*
* The delimiter OTHRDET is not unique across all sequences, this api can not be resolved without considering nested sequences
* In Sequence C
*/
if (this.getSwiftMessage() == null) {
return null;
}
return com.prowidesoftware.swift.model.mt.SequenceUtils.resolveMT671GetSequenceC_sru2023(this);
}
/**
* Same as getSequenceC using the sequence delimiter field qualifier
* @see SequenceC#getSequenceC()
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 9.2.18
*/
public SequenceC getSequenceOTHRDET() {
return getSequenceC();
}
/**
* Get the single occurrence of SequenceC delimited by 16R/16S the value of SequenceC#START_END_16RS.
* The presence of this method indicates that this sequence can occur only once according to the Standard.
* @see SequenceC#START_END_16RS
* @param parentSequence a not null parent sequence to find SequenceC within it
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_16RS)
public static SequenceC getSequenceC(SwiftTagListBlock parentSequence) {
final SequenceC s = new SequenceC();
if (parentSequence != null) {
s.setTags(parentSequence.getSubBlock(SequenceC.START_END_16RS).getTags());
}
return s;
}
/**
* Same as getSequenceC using the sequence delimiter field qualifier
* @see SequenceC#getSequenceC(SwiftTagListBlock)
* @param parentSequence a not null parent sequence to find SequenceC within it
* @return the found sequence or an empty sequence if none is found, never returns null
* @since 9.2.18
*/
public static SequenceC getSequenceOTHRDET(SwiftTagListBlock parentSequence) {
return getSequenceC(parentSequence);
}
}