com.prowidesoftware.swift.model.field.Field345 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.field;
import com.prowidesoftware.swift.model.Tag;
import com.prowidesoftware.Generated;
import com.prowidesoftware.deprecation.ProwideDeprecated;
import com.prowidesoftware.deprecation.TargetYear;
import java.io.Serializable;
import java.util.Locale;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;
import java.math.BigDecimal;
import java.math.BigInteger;
import org.apache.commons.lang3.StringUtils;
import com.prowidesoftware.swift.model.field.SwiftParseUtils;
import com.prowidesoftware.swift.model.field.Field;
import com.prowidesoftware.swift.model.*;
import com.prowidesoftware.swift.utils.SwiftFormatUtils;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
/**
* SWIFT MT Field 345.
*
* Model and parser for field 345 of a SWIFT MT message.
*
*
Subfields (components) Data types
*
* - Component 1: MT1:
Long
* - Component 2: MT2:
Long
* - Component 3: MT3:
Long
* - Component 4: MT4:
Long
* - Component 5: MT5:
Long
* - Component 6: MT6:
Long
* - Component 7: MT7:
Long
* - Component 8: MT8:
Long
* - Component 9: MT9:
Long
* - Component 10: MT10:
Long
*
*
* Structure definition
*
* - validation pattern:
[3!c]*10
* - parser pattern:
3!S*10
* - components pattern:
MMMMMMMMMM
*
*
*
* This class complies with standard release SRU2023
*/
@SuppressWarnings("unused")
@Generated
public class Field345 extends Field implements Serializable {
/**
* Constant identifying the SRU to which this class belongs to.
*/
public static final int SRU = 2023;
private static final long serialVersionUID = 1L;
/**
* Constant with the field name 345.
*/
public static final String NAME = "345";
/**
* Same as NAME, intended to be clear when using static imports.
*/
public static final String F_345 = "345";
/**
* @deprecated Use {@link #parserPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String PARSER_PATTERN = "3!S*10";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String COMPONENTS_PATTERN = "MMMMMMMMMM";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String TYPES_PATTERN = "MMMMMMMMMM";
/**
* Component number for the MT1 subfield.
*/
public static final Integer MT1 = 1;
/**
* Component number for the MT2 subfield.
*/
public static final Integer MT2 = 2;
/**
* Component number for the MT3 subfield.
*/
public static final Integer MT3 = 3;
/**
* Component number for the MT4 subfield.
*/
public static final Integer MT4 = 4;
/**
* Component number for the MT5 subfield.
*/
public static final Integer MT5 = 5;
/**
* Component number for the MT6 subfield.
*/
public static final Integer MT6 = 6;
/**
* Component number for the MT7 subfield.
*/
public static final Integer MT7 = 7;
/**
* Component number for the MT8 subfield.
*/
public static final Integer MT8 = 8;
/**
* Component number for the MT9 subfield.
*/
public static final Integer MT9 = 9;
/**
* Component number for the MT10 subfield.
*/
public static final Integer MT10 = 10;
/**
* Default constructor. Creates a new field setting all components to null.
*/
public Field345() {
super(10);
}
/**
* Creates a new field and initializes its components with content from the parameter value.
* @param value complete field value including separators and CRLF
*/
public Field345(final String value) {
super(value);
}
/**
* Creates a new field and initializes its components with content from the parameter tag.
* The value is parsed with {@link #parse(String)}
* @throws IllegalArgumentException if the parameter tag is null or its tagname does not match the field name
* @since 7.8
*/
public Field345(final Tag tag) {
this();
if (tag == null) {
throw new IllegalArgumentException("tag cannot be null.");
}
if (!StringUtils.equals(tag.getName(), "345")) {
throw new IllegalArgumentException("cannot create field 345 from tag "+tag.getName()+", tagname must match the name of the field.");
}
parse(tag.getValue());
}
/**
* Copy constructor.
* Initializes the components list with a deep copy of the source components list.
* @param source a field instance to copy
* @since 7.7
*/
public static Field345 newInstance(Field345 source) {
Field345 cp = new Field345();
cp.setComponents(new ArrayList<>(source.getComponents()));
return cp;
}
/**
* Create a Tag with this field name and the given value.
* Shorthand for new Tag(NAME, value)
* @see #NAME
* @since 7.5
*/
public static Tag tag(final String value) {
return new Tag(NAME, value);
}
/**
* Create a Tag with this field name and an empty string as value.
* Shorthand for new Tag(NAME, "")
* @see #NAME
* @since 7.5
*/
public static Tag emptyTag() {
return new Tag(NAME, "");
}
/**
* Parses the parameter value into the internal components structure.
*
*
Used to update all components from a full new value, as an alternative
* to setting individual components. Previous component values are overwritten.
*
* @param value complete field value including separators and CRLF
* @since 7.8
*/
@Override
public void parse(final String value) {
init(10);
if (value != null) {
SwiftParseUtils.setComponentsFromTokens(this, 1, 10, 3, value);
}
}
/**
* Serializes the fields' components into the single string value (SWIFT format)
*/
@Override
public String getValue() {
final StringBuilder result = new StringBuilder();
result.append(joinComponents());
return result.toString();
}
/**
* Returns a localized suitable for showing to humans string of a field component.
*
* @param component number of the component to display
* @param locale optional locale to format date and amounts, if null, the default locale is used
* @return formatted component value or null if component number is invalid or not present
* @throws IllegalArgumentException if component number is invalid for the field
* @since 7.8
*/
@Override
public String getValueDisplay(int component, Locale locale) {
if (component < 1 || component > 10) {
throw new IllegalArgumentException("invalid component number " + component + " for field 345");
}
if (component == 1) {
//default format (as is)
return getComponent(1);
}
if (component == 2) {
//default format (as is)
return getComponent(2);
}
if (component == 3) {
//default format (as is)
return getComponent(3);
}
if (component == 4) {
//default format (as is)
return getComponent(4);
}
if (component == 5) {
//default format (as is)
return getComponent(5);
}
if (component == 6) {
//default format (as is)
return getComponent(6);
}
if (component == 7) {
//default format (as is)
return getComponent(7);
}
if (component == 8) {
//default format (as is)
return getComponent(8);
}
if (component == 9) {
//default format (as is)
return getComponent(9);
}
if (component == 10) {
//default format (as is)
return getComponent(10);
}
return null;
}
/**
* @deprecated Use {@link #typesPattern()} instead.
*/
@Override
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public String componentsPattern() {
return "MMMMMMMMMM";
}
/**
* Returns the field component types pattern.
*
* This method returns a letter representing the type for each component in the Field. It supersedes
* the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).
* @since 9.2.7
*/
@Override
public String typesPattern() {
return "MMMMMMMMMM";
}
/**
* Returns the field parser pattern.
*/
@Override
public String parserPattern() {
return "3!S*10";
}
/**
* Returns the field validator pattern
*/
@Override
public String validatorPattern() {
return "[3!c]*10";
}
/**
* Given a component number it returns true if the component is optional,
* regardless of the field being mandatory in a particular message.
* Being the field's value conformed by a composition of one or several
* internal component values, the field may be present in a message with
* a proper value but with some of its internal components not set.
*
* @param component component number, first component of a field is referenced as 1
* @return true if the component is optional for this field, false otherwise
*/
@Override
public boolean isOptional(int component) {
return false;
}
/**
* Returns true if the field is a GENERIC FIELD as specified by the standard.
* @return true if the field is generic, false otherwise
*/
@Override
public boolean isGeneric() {
return false;
}
/**
* Returns the defined amount of components.
* This is not the amount of components present in the field instance, but the total amount of components
* that this field accepts as defined.
* @since 7.7
*/
@Override
public int componentsSize() {
return 10;
}
/**
* Returns english label for components.
*
* The index in the list is in sync with specific field component structure.
* @see #getComponentLabel(int)
* @since 7.8.4
*/
@Override
public List getComponentLabels() {
List result = new ArrayList<>();
result.add("MT1");
result.add("MT2");
result.add("MT3");
result.add("MT4");
result.add("MT5");
result.add("MT6");
result.add("MT7");
result.add("MT8");
result.add("MT9");
result.add("MT10");
return result;
}
/**
* Returns a mapping between component numbers and their label in camel case format.
* @since 7.10.3
*/
@Override
protected Map getComponentMap() {
Map result = new HashMap<>();
result.put(1, "mT1");
result.put(2, "mT2");
result.put(3, "mT3");
result.put(4, "mT4");
result.put(5, "mT5");
result.put(6, "mT6");
result.put(7, "mT7");
result.put(8, "mT8");
result.put(9, "mT9");
result.put(10, "mT10");
return result;
}
/**
* @see Field#getLabelMap()
* @since 9.3.12
*/
@Override
protected Map getLabelMap() {
if (super.labelMap != null && !super.labelMap.isEmpty()) {
// return cached map
return super.labelMap;
}
super.labelMap = new HashMap<>();
super.labelMap.put("mt1", 1);
super.labelMap.put("mt2", 2);
super.labelMap.put("mt3", 3);
super.labelMap.put("mt4", 4);
super.labelMap.put("mt5", 5);
super.labelMap.put("mt6", 6);
super.labelMap.put("mt7", 7);
super.labelMap.put("mt8", 8);
super.labelMap.put("mt9", 9);
super.labelMap.put("mt10", 10);
return super.labelMap;
}
/**
* Gets the component 1 (MT1).
* @return the component 1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Gets the MT1 (component 1).
* @return the MT1 from component 1
*/
public String getMT1() {
return getComponent1();
}
/**
* Gets the component 2 (MT2).
* @return the component 2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Gets the MT2 (component 2).
* @return the MT2 from component 2
*/
public String getMT2() {
return getComponent2();
}
/**
* Gets the component 3 (MT3).
* @return the component 3
*/
public String getComponent3() {
return getComponent(3);
}
/**
* Gets the MT3 (component 3).
* @return the MT3 from component 3
*/
public String getMT3() {
return getComponent3();
}
/**
* Gets the component 4 (MT4).
* @return the component 4
*/
public String getComponent4() {
return getComponent(4);
}
/**
* Gets the MT4 (component 4).
* @return the MT4 from component 4
*/
public String getMT4() {
return getComponent4();
}
/**
* Gets the component 5 (MT5).
* @return the component 5
*/
public String getComponent5() {
return getComponent(5);
}
/**
* Gets the MT5 (component 5).
* @return the MT5 from component 5
*/
public String getMT5() {
return getComponent5();
}
/**
* Gets the component 6 (MT6).
* @return the component 6
*/
public String getComponent6() {
return getComponent(6);
}
/**
* Gets the MT6 (component 6).
* @return the MT6 from component 6
*/
public String getMT6() {
return getComponent6();
}
/**
* Gets the component 7 (MT7).
* @return the component 7
*/
public String getComponent7() {
return getComponent(7);
}
/**
* Gets the MT7 (component 7).
* @return the MT7 from component 7
*/
public String getMT7() {
return getComponent7();
}
/**
* Gets the component 8 (MT8).
* @return the component 8
*/
public String getComponent8() {
return getComponent(8);
}
/**
* Gets the MT8 (component 8).
* @return the MT8 from component 8
*/
public String getMT8() {
return getComponent8();
}
/**
* Gets the component 9 (MT9).
* @return the component 9
*/
public String getComponent9() {
return getComponent(9);
}
/**
* Gets the MT9 (component 9).
* @return the MT9 from component 9
*/
public String getMT9() {
return getComponent9();
}
/**
* Gets the component 10 (MT10).
* @return the component 10
*/
public String getComponent10() {
return getComponent(10);
}
/**
* Gets the MT10 (component 10).
* @return the MT10 from component 10
*/
public String getMT10() {
return getComponent10();
}
/**
* Set the component 1 (MT1).
*
* @param component1 the MT1 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent1(String component1) {
setComponent(1, component1);
return this;
}
/**
* Set the MT1 (component 1).
*
* @param component1 the MT1 to set
* @return the field object to enable build pattern
*/
public Field345 setMT1(String component1) {
return setComponent1(component1);
}
/**
* Set the component 2 (MT2).
*
* @param component2 the MT2 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent2(String component2) {
setComponent(2, component2);
return this;
}
/**
* Set the MT2 (component 2).
*
* @param component2 the MT2 to set
* @return the field object to enable build pattern
*/
public Field345 setMT2(String component2) {
return setComponent2(component2);
}
/**
* Set the component 3 (MT3).
*
* @param component3 the MT3 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent3(String component3) {
setComponent(3, component3);
return this;
}
/**
* Set the MT3 (component 3).
*
* @param component3 the MT3 to set
* @return the field object to enable build pattern
*/
public Field345 setMT3(String component3) {
return setComponent3(component3);
}
/**
* Set the component 4 (MT4).
*
* @param component4 the MT4 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent4(String component4) {
setComponent(4, component4);
return this;
}
/**
* Set the MT4 (component 4).
*
* @param component4 the MT4 to set
* @return the field object to enable build pattern
*/
public Field345 setMT4(String component4) {
return setComponent4(component4);
}
/**
* Set the component 5 (MT5).
*
* @param component5 the MT5 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent5(String component5) {
setComponent(5, component5);
return this;
}
/**
* Set the MT5 (component 5).
*
* @param component5 the MT5 to set
* @return the field object to enable build pattern
*/
public Field345 setMT5(String component5) {
return setComponent5(component5);
}
/**
* Set the component 6 (MT6).
*
* @param component6 the MT6 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent6(String component6) {
setComponent(6, component6);
return this;
}
/**
* Set the MT6 (component 6).
*
* @param component6 the MT6 to set
* @return the field object to enable build pattern
*/
public Field345 setMT6(String component6) {
return setComponent6(component6);
}
/**
* Set the component 7 (MT7).
*
* @param component7 the MT7 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent7(String component7) {
setComponent(7, component7);
return this;
}
/**
* Set the MT7 (component 7).
*
* @param component7 the MT7 to set
* @return the field object to enable build pattern
*/
public Field345 setMT7(String component7) {
return setComponent7(component7);
}
/**
* Set the component 8 (MT8).
*
* @param component8 the MT8 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent8(String component8) {
setComponent(8, component8);
return this;
}
/**
* Set the MT8 (component 8).
*
* @param component8 the MT8 to set
* @return the field object to enable build pattern
*/
public Field345 setMT8(String component8) {
return setComponent8(component8);
}
/**
* Set the component 9 (MT9).
*
* @param component9 the MT9 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent9(String component9) {
setComponent(9, component9);
return this;
}
/**
* Set the MT9 (component 9).
*
* @param component9 the MT9 to set
* @return the field object to enable build pattern
*/
public Field345 setMT9(String component9) {
return setComponent9(component9);
}
/**
* Set the component 10 (MT10).
*
* @param component10 the MT10 to set
* @return the field object to enable build pattern
*/
public Field345 setComponent10(String component10) {
setComponent(10, component10);
return this;
}
/**
* Set the MT10 (component 10).
*
* @param component10 the MT10 to set
* @return the field object to enable build pattern
*/
public Field345 setMT10(String component10) {
return setComponent10(component10);
}
/**
* Returns the field's name composed by the field number and the letter option (if any).
* @return the static value of Field345.NAME
*/
@Override
public String getName() {
return NAME;
}
/**
* Gets the first occurrence form the tag list or null if not found.
* @return null if not found o block is null or empty
* @param block may be null or empty
*/
public static Field345 get(final SwiftTagListBlock block) {
if (block == null || block.isEmpty()) {
return null;
}
final Tag t = block.getTagByName(NAME);
if (t == null) {
return null;
}
return new Field345(t);
}
/**
* Gets the first instance of Field345 in the given message.
* @param msg may be empty or null
* @return null if not found or msg is empty or null
* @see #get(SwiftTagListBlock)
*/
public static Field345 get(final SwiftMessage msg) {
if (msg == null || msg.getBlock4() == null || msg.getBlock4().isEmpty()) {
return null;
}
return get(msg.getBlock4());
}
/**
* Gets a list of all occurrences of the field Field345 in the given message
* an empty list is returned if none found.
* @param msg may be empty or null in which case an empty list is returned
* @see #getAll(SwiftTagListBlock)
*/
public static List getAll(final SwiftMessage msg) {
if (msg == null || msg.getBlock4() == null || msg.getBlock4().isEmpty()) {
return java.util.Collections.emptyList();
}
return getAll(msg.getBlock4());
}
/**
* Gets a list of all occurrences of the field Field345 from the given block
* an empty list is returned if none found.
*
* @param block may be empty or null in which case an empty list is returned
*/
public static List getAll(final SwiftTagListBlock block) {
final List result = new ArrayList<>();
if (block == null || block.isEmpty()) {
return result;
}
final Tag[] arr = block.getTagsByName(NAME);
if (arr != null && arr.length > 0) {
for (final Tag f : arr) {
result.add(new Field345(f));
}
}
return result;
}
/**
* This method deserializes the JSON data into a Field345 object.
* @param json JSON structure including tuples with label and value for all field components
* @return a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
* @since 7.10.3
* @see Field#fromJson(String)
*/
public static Field345 fromJson(final String json) {
final Field345 field = new Field345();
final JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
// **** COMPONENT 1 - MT1
if (jsonObject.get("mT1") != null) {
field.setComponent1(jsonObject.get("mT1").getAsString());
}
// **** COMPONENT 2 - MT2
if (jsonObject.get("mT2") != null) {
field.setComponent2(jsonObject.get("mT2").getAsString());
}
// **** COMPONENT 3 - MT3
if (jsonObject.get("mT3") != null) {
field.setComponent3(jsonObject.get("mT3").getAsString());
}
// **** COMPONENT 4 - MT4
if (jsonObject.get("mT4") != null) {
field.setComponent4(jsonObject.get("mT4").getAsString());
}
// **** COMPONENT 5 - MT5
if (jsonObject.get("mT5") != null) {
field.setComponent5(jsonObject.get("mT5").getAsString());
}
// **** COMPONENT 6 - MT6
if (jsonObject.get("mT6") != null) {
field.setComponent6(jsonObject.get("mT6").getAsString());
}
// **** COMPONENT 7 - MT7
if (jsonObject.get("mT7") != null) {
field.setComponent7(jsonObject.get("mT7").getAsString());
}
// **** COMPONENT 8 - MT8
if (jsonObject.get("mT8") != null) {
field.setComponent8(jsonObject.get("mT8").getAsString());
}
// **** COMPONENT 9 - MT9
if (jsonObject.get("mT9") != null) {
field.setComponent9(jsonObject.get("mT9").getAsString());
}
// **** COMPONENT 10 - MT10
if (jsonObject.get("mT10") != null) {
field.setComponent10(jsonObject.get("mT10").getAsString());
}
return field;
}
}