com.prowidesoftware.swift.model.mt.mt5xx.MT516 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.mt5xx;
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 516 - Securities Loan Confirmation.
*
*
* SWIFT MT516 (ISO 15022) message structure:
*
-
Sequence A (M)
- Field 20 (M)
- Field 21 (O)
- Field 23 (M)
- Field 31 P (M)
- Field 83 C (O)
- Field 35 B (M)
- Field 35 A (O)
- Field 31 L (O)
- Field 31 X (O)
- Field 30 (M)
- Field 31 F (O)
- Field 87 A,D (O)
- Field 35 N (O)
- Field 33 T (O)
-
Sequence B (O)
- Field 37 J (O)
- Field 26 H (O)
- Field 33 S (O)
- Field 32 A,B (O)
- Field 37 A,B,C,D,E,F (O)
- Field 57 A,B,D (O)
- Field 35 S (O)
- Field 35 B (O)
- Field 87 A,D (O)
-
Sequence C (O)
- Field 77 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 MT516 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(MT516.class.getName());
/**
* Constant for MT name, this is part of the classname, after MT.
*/
public static final String NAME = "516";
/**
* Creates an MT516 initialized with the parameter SwiftMessage.
* @param m swift message with the MT516 content
*/
public MT516(final SwiftMessage m) {
super(m);
sanityCheck(m);
}
/**
* Creates an MT516 initialized with the parameter MtSwiftMessage.
* @param m swift message with the MT516 content, the parameter can not be null
* @see #MT516(String)
*/
public MT516(final MtSwiftMessage m) {
this(m.message());
}
/**
* Creates an MT516 initialized with the parameter MtSwiftMessage.
*
* @param m swift message with the MT516 content
* @return the created object or null if the parameter is null
* @see #MT516(String)
* @since 7.7
*/
public static MT516 parse(final MtSwiftMessage m) {
if (m == null) {
return null;
}
return new MT516(m);
}
/**
* Creates and initializes a new MT516 input message setting TEST BICS as sender and receiver.
* All mandatory header attributes are completed with default values.
*
* @since 7.6
*/
public MT516() {
this(BIC.TEST8, BIC.TEST8);
}
/**
* Creates and initializes a new MT516 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 MT516(final String sender, final String receiver) {
super(516, sender, receiver);
}
/**
* Creates a new MT516 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 MT516(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 MT516 object from FIN content with a Service Message. Check if the MT516 you are intended to read is prepended with and ACK.");
} else if (!StringUtils.equals(param.getType(), "516")) {
log.warning("Creating an MT516 object from FIN content with message type "+param.getType());
}
}
/**
* Creates a new MT516 by parsing a String with the message content in its swift FIN format.
* If the fin parameter cannot be parsed, the returned MT516 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 MT516 or null if fin is null
* @since 7.7
*/
public static MT516 parse(final String fin) {
if (fin == null) {
return null;
}
return new MT516(fin);
}
/**
* Creates a new MT516 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 MT516(final InputStream stream) throws IOException {
this(Lib.readStream(stream));
}
/**
* Creates a new MT516 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 MT516 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 MT516 parse(final InputStream stream) throws IOException {
if (stream == null) {
return null;
}
return new MT516(stream);
}
/**
* Creates a new MT516 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 MT516(final File file) throws IOException {
this(Lib.readFile(file));
}
/**
* Creates a new MT516 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 MT516 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 MT516 parse(final File file) throws IOException {
if (file == null) {
return null;
}
return new MT516(file);
}
/**
* Returns this MT number.
* @return the message type number of this MT
* @since 6.4
*/
@Override
public String getMessageType() {
return "516";
}
/**
* 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 MT516 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 MT516 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 MT516 append(final Field... fields) {
super.append(fields);
return this;
}
/**
* Creates an MT516 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 MT516 message
* @return a new instance of MT516
* @since 7.10.3
*/
public static MT516 fromJson(final String json) {
return (MT516) 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 MT516 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 MT516 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 23,
* or null if none is found.
* The first occurrence of field 23 at MT516 is expected to be the only one.
*
* @return a Field23 object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field23 getField23() {
final Tag t = tag("23");
if (t != null) {
return new Field23(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 31P,
* or null if none is found.
* The first occurrence of field 31P at MT516 is expected to be the only one.
*
* @return a Field31P object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field31P getField31P() {
final Tag t = tag("31P");
if (t != null) {
return new Field31P(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 83C,
* or null if none is found.
* The first occurrence of field 83C at MT516 is expected to be the only one.
*
* @return a Field83C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field83C getField83C() {
final Tag t = tag("83C");
if (t != null) {
return new Field83C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 35A,
* or null if none is found.
* The first occurrence of field 35A at MT516 is expected to be the only one.
*
* @return a Field35A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field35A getField35A() {
final Tag t = tag("35A");
if (t != null) {
return new Field35A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 31L,
* or null if none is found.
* The first occurrence of field 31L at MT516 is expected to be the only one.
*
* @return a Field31L object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field31L getField31L() {
final Tag t = tag("31L");
if (t != null) {
return new Field31L(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 31X,
* or null if none is found.
* The first occurrence of field 31X at MT516 is expected to be the only one.
*
* @return a Field31X object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field31X getField31X() {
final Tag t = tag("31X");
if (t != null) {
return new Field31X(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 MT516 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 31F,
* or null if none is found.
* The first occurrence of field 31F at MT516 is expected to be the only one.
*
* @return a Field31F object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field31F getField31F() {
final Tag t = tag("31F");
if (t != null) {
return new Field31F(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 35N,
* or null if none is found.
* The first occurrence of field 35N at MT516 is expected to be the only one.
*
* @return a Field35N object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field35N getField35N() {
final Tag t = tag("35N");
if (t != null) {
return new Field35N(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 33T,
* or null if none is found.
* The first occurrence of field 33T at MT516 is expected to be the only one.
*
* @return a Field33T object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field33T getField33T() {
final Tag t = tag("33T");
if (t != null) {
return new Field33T(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37J,
* or null if none is found.
* The first occurrence of field 37J at MT516 is expected to be the only one.
*
* @return a Field37J object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37J getField37J() {
final Tag t = tag("37J");
if (t != null) {
return new Field37J(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 26H,
* or null if none is found.
* The first occurrence of field 26H at MT516 is expected to be the only one.
*
* @return a Field26H object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field26H getField26H() {
final Tag t = tag("26H");
if (t != null) {
return new Field26H(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 33S,
* or null if none is found.
* The first occurrence of field 33S at MT516 is expected to be the only one.
*
* @return a Field33S object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field33S getField33S() {
final Tag t = tag("33S");
if (t != null) {
return new Field33S(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 32A,
* or null if none is found.
* The first occurrence of field 32A at MT516 is expected to be the only one.
*
* @return a Field32A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field32A getField32A() {
final Tag t = tag("32A");
if (t != null) {
return new Field32A(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 MT516 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 37A,
* or null if none is found.
* The first occurrence of field 37A at MT516 is expected to be the only one.
*
* @return a Field37A object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37A getField37A() {
final Tag t = tag("37A");
if (t != null) {
return new Field37A(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37B,
* or null if none is found.
* The first occurrence of field 37B at MT516 is expected to be the only one.
*
* @return a Field37B object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37B getField37B() {
final Tag t = tag("37B");
if (t != null) {
return new Field37B(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37C,
* or null if none is found.
* The first occurrence of field 37C at MT516 is expected to be the only one.
*
* @return a Field37C object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37C getField37C() {
final Tag t = tag("37C");
if (t != null) {
return new Field37C(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37D,
* or null if none is found.
* The first occurrence of field 37D at MT516 is expected to be the only one.
*
* @return a Field37D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37D getField37D() {
final Tag t = tag("37D");
if (t != null) {
return new Field37D(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37E,
* or null if none is found.
* The first occurrence of field 37E at MT516 is expected to be the only one.
*
* @return a Field37E object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37E getField37E() {
final Tag t = tag("37E");
if (t != null) {
return new Field37E(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 37F,
* or null if none is found.
* The first occurrence of field 37F at MT516 is expected to be the only one.
*
* @return a Field37F object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field37F getField37F() {
final Tag t = tag("37F");
if (t != null) {
return new Field37F(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 MT516 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 MT516 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 MT516 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 35S,
* or null if none is found.
* The first occurrence of field 35S at MT516 is expected to be the only one.
*
* @return a Field35S object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field35S getField35S() {
final Tag t = tag("35S");
if (t != null) {
return new Field35S(t.getValue());
} else {
return null;
}
}
/**
* Iterates through block4 fields and return the first one whose name matches 77D,
* or null if none is found.
* The first occurrence of field 77D at MT516 is expected to be the only one.
*
* @return a Field77D object or null if the field is not found
* @see SwiftTagListBlock#getTagByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public Field77D getField77D() {
final Tag t = tag("77D");
if (t != null) {
return new Field77D(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 MT516 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;
}
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 35B,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 35B at MT516 are expected at one sequence or across several sequences.
*
* @return a List of Field35B objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField35B() {
final List result = new ArrayList<>();
final Tag[] tags = tags("35B");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field35B(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 87A,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 87A at MT516 are expected at one sequence or across several sequences.
*
* @return a List of Field87A objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField87A() {
final List result = new ArrayList<>();
final Tag[] tags = tags("87A");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field87A(tag.getValue()));
}
}
return result;
}
/**
* Iterates through block4 fields and return all occurrences of fields whose names matches 87D,
* or Collections.emptyList() if none is found.
* Multiple occurrences of field 87D at MT516 are expected at one sequence or across several sequences.
*
* @return a List of Field87D objects or Collections.emptyList() if none is not found
* @see SwiftTagListBlock#getTagsByName(String)
* @throws IllegalStateException if SwiftMessage object is not initialized
*/
public List getField87D() {
final List result = new ArrayList<>();
final Tag[] tags = tags("87D");
if (tags != null && tags.length > 0) {
for (Tag tag : tags) {
result.add(new Field87D(tag.getValue()));
}
}
return result;
}
/**
* Class to model Sequence "A" in MT 516.
*/
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());
}
/**
* First mandatory tag name of the sequence: "20" .
* Array format is for cases when more than one letter options is allowed
*/
public static final String[] START = { "20" } ;
/**
* Last mandatory tag name of the sequence: "30"
* Array format is for cases when more than one letter options is allowed
*/
protected static final String[] END = { "30" };
/**
* List of optional tags after the last mandatory tag.
*/
protected static final String[] TAIL = new String[]{ "31F", "87A", "87D", "35N", "33T" };
/**
* Same as {@link #newInstance(int, int, Tag...)} using zero for the indexes.
* @param tags the list of tags to set as sequence content
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static SequenceA newInstance(final Tag... tags) {
return newInstance(0, 0, tags);
}
/**
* Creates a sequence with starting and ending tags set to the indicated tags in from the
* {@link #START} and {@link #END} lists of mandatory fields, and with the content between
* the starting and ending tag initialized with the given optional tags.
*
* @param start a zero-based index within the list of mandatory starting tags in the sequence
* @param end a zero-based index within the list of mandatory ending tags in the sequence
* @param tags the list of tags to set as sequence content
* @return a new instance of the sequence, initialized with the parameter tags
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public static SequenceA newInstance(final int start, final int end, final Tag... tags) {
final SequenceA result = new SequenceA();
result.append(new Tag(START[start], ""));
if (tags != null && tags.length > 0) {
for (final Tag t : tags) {
result.append(t);
}
}
result.append(new Tag(END[end], ""));
return result;
}
}
/**
* 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.
*
* @return the found sequence or an empty sequence if none is found
* @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public SequenceA getSequenceA() {
return getSequenceA(super.getSwiftMessageNotNullOrException().getBlock4());
}
/**
* 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.
*
* @see SwiftTagListBlock#getSubBlockDelimitedWithOptionalTail(String[], String[], String[])
* @param parentSequence a not null parent sequence to find SequenceA within it
* @return the found sequence or an empty sequence if none is found, or null if the parent sequence is null or empty
* @since 7.7
*/
@SequenceStyle(Type.GENERATED_FIXED_WITH_OPTIONAL_TAIL)
public SequenceA getSequenceA(SwiftTagListBlock parentSequence) {
if (parentSequence != null && !parentSequence.isEmpty()) {
final SwiftTagListBlock content = parentSequence.getSubBlockDelimitedWithOptionalTail(SequenceA.START, SequenceA.END, SequenceA.TAIL);
if (log.isLoggable(java.util.logging.Level.FINE)) {
if (content == null) {
log.fine("content for sequence SequenceA: is null");
} else {
log.fine("content for sequence SequenceA: "+content.tagNamesList());
}
}
if (content == null) {
return new SequenceA();
} else {
return new SequenceA(content);
}
}
return null;
}
}