com.prowidesoftware.swift.model.field.Field59 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 com.prowidesoftware.swift.model.field.MultiLineField;
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 59.
*
* Model and parser for field 59 of a SWIFT MT message.
*
*
Subfields (components) Data types
*
* - Component 1: Account:
String
* - Component 2: NameAndAddress:
String
* - Component 3: NameAndAddress2:
String
* - Component 4: NameAndAddress3:
String
* - Component 5: NameAndAddress4:
String
*
*
* Structure definition
*
* - validation pattern:
[/34x$]35x[$35x]0-3
* - parser pattern:
[/S$]S[$S]0-3
* - components pattern:
SSSSS
*
*
*
* This class complies with standard release SRU2023
*/
@SuppressWarnings("unused")
@Generated
public class Field59 extends Field implements Serializable, MultiLineField {
/**
* 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 59.
*/
public static final String NAME = "59";
/**
* Same as NAME, intended to be clear when using static imports.
*/
public static final String F_59 = "59";
/**
* @deprecated Use {@link #parserPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String PARSER_PATTERN = "[/S$]S[$S]0-3";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String COMPONENTS_PATTERN = "SSSSS";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String TYPES_PATTERN = "SSSSS";
/**
* Component number for the Account subfield.
*/
public static final Integer ACCOUNT = 1;
/**
* Component number for the Name And Address subfield.
*/
public static final Integer NAME_AND_ADDRESS = 2;
/**
* Default constructor. Creates a new field setting all components to null.
*/
public Field59() {
super(5);
}
/**
* Creates a new field and initializes its components with content from the parameter value.
* @param value complete field value including separators and CRLF
*/
public Field59(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 Field59(final Tag tag) {
this();
if (tag == null) {
throw new IllegalArgumentException("tag cannot be null.");
}
if (!StringUtils.equals(tag.getName(), "59")) {
throw new IllegalArgumentException("cannot create field 59 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 Field59 newInstance(Field59 source) {
Field59 cp = new Field59();
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(5);
List lines = SwiftParseUtils.getLines(value);
if (!lines.isEmpty()) {
if (lines.get(0).startsWith("/")) {
setComponent1(StringUtils.substring(lines.get(0), 1));
SwiftParseUtils.setComponentsFromLines(this, 2, null, 1, lines);
} else {
SwiftParseUtils.setComponentsFromLines(this, 2, null, 0, lines);
}
}
}
/**
* Serializes the fields' components into the single string value (SWIFT format)
*/
@Override
public String getValue() {
final StringBuilder result = new StringBuilder();
if (getComponent1() != null) {
result.append("/").append(getComponent1());
}
appendInLines(result, 2, 5);
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 > 5) {
throw new IllegalArgumentException("invalid component number " + component + " for field 59");
}
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);
}
return null;
}
/**
* @deprecated Use {@link #typesPattern()} instead.
*/
@Override
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public String componentsPattern() {
return "SSSSS";
}
/**
* 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 "SSSSS";
}
/**
* Returns the field parser pattern.
*/
@Override
public String parserPattern() {
return "[/S$]S[$S]0-3";
}
/**
* Returns the field validator pattern
*/
@Override
public String validatorPattern() {
return "[/34x$]35x[$35x]0-3";
}
/**
* 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) {
if (component == 1) {
return true;
}
if (component == 3) {
return true;
}
if (component == 4) {
return true;
}
if (component == 5) {
return true;
}
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 5;
}
/**
* 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("Account");
result.add("Name And Address");
result.add("Name And Address 2");
result.add("Name And Address 3");
result.add("Name And Address 4");
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, "account");
result.put(2, "nameAndAddress");
result.put(3, "nameAndAddress2");
result.put(4, "nameAndAddress3");
result.put(5, "nameAndAddress4");
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("account", 1);
super.labelMap.put("nameandaddress", 2);
super.labelMap.put("nameandaddress2", 3);
super.labelMap.put("nameandaddress3", 4);
super.labelMap.put("nameandaddress4", 5);
return super.labelMap;
}
/**
* Gets the component 1 (Account).
* @return the component 1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Gets the Account (component 1) removing its starting slashes if any.
* @return the Account from component 1
*/
public String getAccount() {
String account = getComponent(1);
if (account != null) {
for(int i = 0; i < account.length(); i++) {
if (account.charAt(i) != '/') {
return account.substring(i);
}
}
return "";
}
return null;
}
/**
* Gets the component 2 (Name And Address).
* @return the component 2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Gets the Name And Address (component 2).
* @return the Name And Address from component 2
*/
public String getNameAndAddressLine1() {
return getComponent2();
}
/**
* Gets the Name And Address as a concatenation of component 2 to component 5.
* @return the Name And Address from components
*/
public String getNameAndAddress() {
return getNameAndAddress(null);
}
/**
* Gets the Name And Address as a concatenation of component 2 to component 5 joined together with a copy of the
* specified delimiter.
* @param deli the delimiter that separates each component
* @return the Name And Address from components
* @since 9.1.4
*/
public String getNameAndAddress(CharSequence deli) {
StringBuilder result = new StringBuilder();
for (int i = 2; i < 6; i++) {
if (getComponent(i) != null) {
if (deli != null && result.length() > 0) {
result.append(deli);
}
result.append(getComponent(i));
}
}
return result.toString();
}
/**
* Gets the component 3 (Name And Address 2).
* @return the component 3
*/
public String getComponent3() {
return getComponent(3);
}
/**
* Gets the Name And Address 2 (component 3).
* @return the Name And Address 2 from component 3
*/
public String getNameAndAddressLine2() {
return getComponent3();
}
/**
* Gets the component 4 (Name And Address 3).
* @return the component 4
*/
public String getComponent4() {
return getComponent(4);
}
/**
* Gets the Name And Address 3 (component 4).
* @return the Name And Address 3 from component 4
*/
public String getNameAndAddressLine3() {
return getComponent4();
}
/**
* Gets the component 5 (Name And Address 4).
* @return the component 5
*/
public String getComponent5() {
return getComponent(5);
}
/**
* Gets the Name And Address 4 (component 5).
* @return the Name And Address 4 from component 5
*/
public String getNameAndAddressLine4() {
return getComponent5();
}
/**
* Set the component 1 (Account).
*
* @param component1 the Account to set
* @return the field object to enable build pattern
*/
public Field59 setComponent1(String component1) {
setComponent(1, component1);
return this;
}
/**
* Set the Account (component 1).
*
* @param component1 the Account to set
* @return the field object to enable build pattern
*/
public Field59 setAccount(String component1) {
return setComponent1(component1);
}
/**
* Set the component 2 (Name And Address).
*
* @param component2 the Name And Address to set
* @return the field object to enable build pattern
*/
public Field59 setComponent2(String component2) {
setComponent(2, component2);
return this;
}
/**
* Set the Name And Address (component 2).
*
* @param component2 the Name And Address to set
* @return the field object to enable build pattern
*/
public Field59 setNameAndAddressLine1(String component2) {
return setComponent2(component2);
}
/**
* Set the Name And Address splitting the parameter lines into components 2 to 5.
*
* @param value the Name And Address to set, may contain line ends and each line will be set to its correspondent component attribute
* @return the field object to enable build pattern
*/
public Field59 setNameAndAddress(String value) {
List lines = SwiftParseUtils.getLines(value);
SwiftParseUtils.setComponentsFromLines(this, 2, 4, 0, lines);
return this;
}
/**
* Set the component 3 (Name And Address 2).
*
* @param component3 the Name And Address 2 to set
* @return the field object to enable build pattern
*/
public Field59 setComponent3(String component3) {
setComponent(3, component3);
return this;
}
/**
* Set the Name And Address 2 (component 3).
*
* @param component3 the Name And Address 2 to set
* @return the field object to enable build pattern
*/
public Field59 setNameAndAddressLine2(String component3) {
return setComponent3(component3);
}
/**
* Set the component 4 (Name And Address 3).
*
* @param component4 the Name And Address 3 to set
* @return the field object to enable build pattern
*/
public Field59 setComponent4(String component4) {
setComponent(4, component4);
return this;
}
/**
* Set the Name And Address 3 (component 4).
*
* @param component4 the Name And Address 3 to set
* @return the field object to enable build pattern
*/
public Field59 setNameAndAddressLine3(String component4) {
return setComponent4(component4);
}
/**
* Set the component 5 (Name And Address 4).
*
* @param component5 the Name And Address 4 to set
* @return the field object to enable build pattern
*/
public Field59 setComponent5(String component5) {
setComponent(5, component5);
return this;
}
/**
* Set the Name And Address 4 (component 5).
*
* @param component5 the Name And Address 4 to set
* @return the field object to enable build pattern
*/
public Field59 setNameAndAddressLine4(String component5) {
return setComponent5(component5);
}
/**
* Returns the field's name composed by the field number and the letter option (if any).
* @return the static value of Field59.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 Field59 get(final SwiftTagListBlock block) {
if (block == null || block.isEmpty()) {
return null;
}
final Tag t = block.getTagByName(NAME);
if (t == null) {
return null;
}
return new Field59(t);
}
/**
* Gets the first instance of Field59 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 Field59 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 Field59 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 Field59 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 Field59(f));
}
}
return result;
}
/**
* Returns a specific line from the field's value.
*
* @see MultiLineField#getLine(int)
* @param line a reference to a specific line in the field, first line being 1
* @return line content or null if not present or if line number is above the expected
* @since 7.7
*/
public String getLine(int line) {
return getLine(line, 0);
}
/**
* Returns a specific line from the field's value.
*
* @see MultiLineField#getLine(int, int)
* @param line a reference to a specific line in the field, first line being 1
* @param offset an optional component number used as offset when counting lines
* @return line content or null if not present or if line number is above the expected
* @since 7.7
*/
public String getLine(int line, int offset) {
Field59 cp = newInstance(this);
return getLine(cp, line, null, offset);
}
/**
* Returns the field value split into lines.
*
* @see MultiLineField#getLines()
* @return lines content or empty list if field's value is empty
* @since 7.7
*/
public List getLines() {
return SwiftParseUtils.getLines(getValue());
}
/**
* Returns the field value starting at the offset component, split into lines.
*
* @see MultiLineField#getLines(int)
* @param offset an optional component number used as offset when counting lines
* @return found lines or empty list if lines are not present or the offset is invalid
* @since 7.7
*/
public List getLines(int offset) {
Field59 cp = newInstance(this);
return SwiftParseUtils.getLines(getLine(cp, null, null, offset));
}
/**
* Returns a specific subset of lines from the field's value, given a range.
*
* @see MultiLineField#getLinesBetween(int, int )
* @param start a reference to a specific line in the field, first line being 1
* @param end a reference to a specific line in the field, must be greater than start
* @return found lines or empty list if value is empty
* @since 7.7
*/
public List getLinesBetween(int start, int end) {
return getLinesBetween(start, end, 0);
}
/**
* Returns a specific subset of lines from the field's value, starting at the offset component.
*
* @see MultiLineField#getLinesBetween(int start, int end, int offset)
* @param start a reference to a specific line in the field, first line being 1
* @param end a reference to a specific line in the field, must be greater than start
* @param offset an optional component number used as offset when counting lines
* @return found lines or empty list if lines are not present or the offset is invalid
* @since 7.7
*/
public List getLinesBetween(int start, int end, int offset) {
Field59 cp = newInstance(this);
return SwiftParseUtils.getLines(getLine(cp, start, end, offset));
}
/**
* This method deserializes the JSON data into a Field59 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 Field59 fromJson(final String json) {
final Field59 field = new Field59();
final JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
// **** COMPONENT 1 - Account
if (jsonObject.get("account") != null) {
field.setComponent1(jsonObject.get("account").getAsString());
}
// **** COMPONENT 2 - Name And Address
if (jsonObject.get("nameAndAddress") != null) {
field.setComponent2(jsonObject.get("nameAndAddress").getAsString());
}
// **** COMPONENT 3 - Name And Address 2
if (jsonObject.get("nameAndAddress2") != null) {
field.setComponent3(jsonObject.get("nameAndAddress2").getAsString());
}
// **** COMPONENT 4 - Name And Address 3
if (jsonObject.get("nameAndAddress3") != null) {
field.setComponent4(jsonObject.get("nameAndAddress3").getAsString());
}
// **** COMPONENT 5 - Name And Address 4
if (jsonObject.get("nameAndAddress4") != null) {
field.setComponent5(jsonObject.get("nameAndAddress4").getAsString());
}
return field;
}
}