com.prowidesoftware.swift.model.field.Field26C 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 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 26C.
*
* Model and parser for field 26C of a SWIFT MT message.
*
*
Subfields (components) Data types
*
* - Component 1: DeliveryDetails:
String
* - Component 2: DeliveryLocation:
String
* - Component 3: Allocation:
String
* - Component 4: Type:
String
* - Component 5: Denomination:
String
* - Component 6: Form:
String
*
*
* Structure definition
*
* - validation pattern:
[3!a]/15x/5!a4!a<VAR-SEQU-4>
* - parser pattern:
[S]/S/5!a4!aS[//S]
* - components pattern:
SSSSSS
*
*
*
* This class complies with standard release SRU2023
*/
@SuppressWarnings("unused")
@Generated
public class Field26C 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 26C.
*/
public static final String NAME = "26C";
/**
* Same as NAME, intended to be clear when using static imports.
*/
public static final String F_26C = "26C";
/**
* @deprecated Use {@link #parserPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String PARSER_PATTERN = "[S]/S/5!a4!aS[//S]";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String COMPONENTS_PATTERN = "SSSSSS";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String TYPES_PATTERN = "SSSSSS";
/**
* Component number for the Delivery Details subfield.
*/
public static final Integer DELIVERY_DETAILS = 1;
/**
* Component number for the Delivery Location subfield.
*/
public static final Integer DELIVERY_LOCATION = 2;
/**
* Component number for the Allocation subfield.
*/
public static final Integer ALLOCATION = 3;
/**
* Component number for the Type subfield.
*/
public static final Integer TYPE = 4;
/**
* Component number for the Denomination subfield.
*/
public static final Integer DENOMINATION = 5;
/**
* Component number for the Form subfield.
*/
public static final Integer FORM = 6;
/**
* Default constructor. Creates a new field setting all components to null.
*/
public Field26C() {
super(6);
}
/**
* Creates a new field and initializes its components with content from the parameter value.
* @param value complete field value including separators and CRLF
*/
public Field26C(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 Field26C(final Tag tag) {
this();
if (tag == null) {
throw new IllegalArgumentException("tag cannot be null.");
}
if (!StringUtils.equals(tag.getName(), "26C")) {
throw new IllegalArgumentException("cannot create field 26C 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 Field26C newInstance(Field26C source) {
Field26C cp = new Field26C();
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(6);
setComponent1(SwiftParseUtils.getTokenFirst(value, null, "/"));
setComponent2(SwiftParseUtils.getTokenSecond(value, "/"));
String toparse = SwiftParseUtils.getTokenThirdLast(value, "/");
// if a double slash ("//") => separate component 6
if (StringUtils.indexOf(toparse, "//") != -1) {
setComponent6(SwiftParseUtils.getTokenSecond(toparse, "//"));
toparse = SwiftParseUtils.getTokenFirst(toparse, "//");
}
if (toparse != null) {
if (toparse.length() < 5) {
setComponent3(toparse);
}
if (toparse.length() >= 5) {
setComponent3(StringUtils.substring(toparse, 0, 5));
}
if (toparse.length() > 5 && toparse.length() < 9) {
setComponent4(StringUtils.substring(toparse, 5));
}
if (toparse.length() >= 9) {
setComponent4(StringUtils.substring(toparse, 5, 9));
}
if (toparse.length() > 9) {
setComponent5(StringUtils.substring(toparse, 9));
}
}
}
/**
* Serializes the fields' components into the single string value (SWIFT format)
*/
@Override
public String getValue() {
final StringBuilder result = new StringBuilder();
append(result, 1);
result.append("/");
append(result, 2);
result.append("/");
append(result, 3);
append(result, 4);
append(result, 5);
if (getComponent6() != null) {
result.append("//").append(getComponent6());
}
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 > 6) {
throw new IllegalArgumentException("invalid component number " + component + " for field 26C");
}
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);
}
return null;
}
/**
* @deprecated Use {@link #typesPattern()} instead.
*/
@Override
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public String componentsPattern() {
return "SSSSSS";
}
/**
* 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 "SSSSSS";
}
/**
* Returns the field parser pattern.
*/
@Override
public String parserPattern() {
return "[S]/S/5!a4!aS[//S]";
}
/**
* Returns the field validator pattern
*/
@Override
public String validatorPattern() {
return "[3!a]/15x/5!a4!a";
}
/**
* 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 == 5) {
return true;
}
if (component == 6) {
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 6;
}
/**
* 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("Delivery Details");
result.add("Delivery Location");
result.add("Allocation");
result.add("Type");
result.add("Denomination");
result.add("Form");
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, "deliveryDetails");
result.put(2, "deliveryLocation");
result.put(3, "allocation");
result.put(4, "type");
result.put(5, "denomination");
result.put(6, "form");
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("deliverydetails", 1);
super.labelMap.put("deliverylocation", 2);
super.labelMap.put("allocation", 3);
super.labelMap.put("type", 4);
super.labelMap.put("denomination", 5);
super.labelMap.put("form", 6);
return super.labelMap;
}
/**
* Gets the component 1 (Delivery Details).
* @return the component 1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Gets the Delivery Details (component 1).
* @return the Delivery Details from component 1
*/
public String getDeliveryDetails() {
return getComponent1();
}
/**
* Gets the component 2 (Delivery Location).
* @return the component 2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Gets the Delivery Location (component 2).
* @return the Delivery Location from component 2
*/
public String getDeliveryLocation() {
return getComponent2();
}
/**
* Gets the component 3 (Allocation).
* @return the component 3
*/
public String getComponent3() {
return getComponent(3);
}
/**
* Gets the Allocation (component 3).
* @return the Allocation from component 3
*/
public String getAllocation() {
return getComponent3();
}
/**
* Gets the component 4 (Type).
* @return the component 4
*/
public String getComponent4() {
return getComponent(4);
}
/**
* Gets the Type (component 4).
* @return the Type from component 4
*/
public String getType() {
return getComponent4();
}
/**
* Gets the component 5 (Denomination).
* @return the component 5
*/
public String getComponent5() {
return getComponent(5);
}
/**
* Gets the Denomination (component 5).
* @return the Denomination from component 5
*/
public String getDenomination() {
return getComponent5();
}
/**
* Gets the component 6 (Form).
* @return the component 6
*/
public String getComponent6() {
return getComponent(6);
}
/**
* Gets the Form (component 6).
* @return the Form from component 6
*/
public String getForm() {
return getComponent6();
}
/**
* Set the component 1 (Delivery Details).
*
* @param component1 the Delivery Details to set
* @return the field object to enable build pattern
*/
public Field26C setComponent1(String component1) {
setComponent(1, component1);
return this;
}
/**
* Set the Delivery Details (component 1).
*
* @param component1 the Delivery Details to set
* @return the field object to enable build pattern
*/
public Field26C setDeliveryDetails(String component1) {
return setComponent1(component1);
}
/**
* Set the component 2 (Delivery Location).
*
* @param component2 the Delivery Location to set
* @return the field object to enable build pattern
*/
public Field26C setComponent2(String component2) {
setComponent(2, component2);
return this;
}
/**
* Set the Delivery Location (component 2).
*
* @param component2 the Delivery Location to set
* @return the field object to enable build pattern
*/
public Field26C setDeliveryLocation(String component2) {
return setComponent2(component2);
}
/**
* Set the component 3 (Allocation).
*
* @param component3 the Allocation to set
* @return the field object to enable build pattern
*/
public Field26C setComponent3(String component3) {
setComponent(3, component3);
return this;
}
/**
* Set the Allocation (component 3).
*
* @param component3 the Allocation to set
* @return the field object to enable build pattern
*/
public Field26C setAllocation(String component3) {
return setComponent3(component3);
}
/**
* Set the component 4 (Type).
*
* @param component4 the Type to set
* @return the field object to enable build pattern
*/
public Field26C setComponent4(String component4) {
setComponent(4, component4);
return this;
}
/**
* Set the Type (component 4).
*
* @param component4 the Type to set
* @return the field object to enable build pattern
*/
public Field26C setType(String component4) {
return setComponent4(component4);
}
/**
* Set the component 5 (Denomination).
*
* @param component5 the Denomination to set
* @return the field object to enable build pattern
*/
public Field26C setComponent5(String component5) {
setComponent(5, component5);
return this;
}
/**
* Set the Denomination (component 5).
*
* @param component5 the Denomination to set
* @return the field object to enable build pattern
*/
public Field26C setDenomination(String component5) {
return setComponent5(component5);
}
/**
* Set the component 6 (Form).
*
* @param component6 the Form to set
* @return the field object to enable build pattern
*/
public Field26C setComponent6(String component6) {
setComponent(6, component6);
return this;
}
/**
* Set the Form (component 6).
*
* @param component6 the Form to set
* @return the field object to enable build pattern
*/
public Field26C setForm(String component6) {
return setComponent6(component6);
}
/**
* Returns the field's name composed by the field number and the letter option (if any).
* @return the static value of Field26C.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 Field26C get(final SwiftTagListBlock block) {
if (block == null || block.isEmpty()) {
return null;
}
final Tag t = block.getTagByName(NAME);
if (t == null) {
return null;
}
return new Field26C(t);
}
/**
* Gets the first instance of Field26C 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 Field26C 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 Field26C 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 Field26C 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 Field26C(f));
}
}
return result;
}
/**
* This method deserializes the JSON data into a Field26C 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 Field26C fromJson(final String json) {
final Field26C field = new Field26C();
final JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
// **** COMPONENT 1 - Delivery Details
if (jsonObject.get("deliveryDetails") != null) {
field.setComponent1(jsonObject.get("deliveryDetails").getAsString());
}
// **** COMPONENT 2 - Delivery Location
if (jsonObject.get("deliveryLocation") != null) {
field.setComponent2(jsonObject.get("deliveryLocation").getAsString());
}
// **** COMPONENT 3 - Allocation
if (jsonObject.get("allocation") != null) {
field.setComponent3(jsonObject.get("allocation").getAsString());
}
// **** COMPONENT 4 - Type
if (jsonObject.get("type") != null) {
field.setComponent4(jsonObject.get("type").getAsString());
}
// **** COMPONENT 5 - Denomination
if (jsonObject.get("denomination") != null) {
field.setComponent5(jsonObject.get("denomination").getAsString());
}
// **** COMPONENT 6 - Form
if (jsonObject.get("form") != null) {
field.setComponent6(jsonObject.get("form").getAsString());
}
return field;
}
@Deprecated
@com.prowidesoftware.deprecation.ProwideDeprecated(phase4=com.prowidesoftware.deprecation.TargetYear.SRU2024)
public static final Integer DENOMINATION_FORM = 5;
/**
* @deprecated Use getComponent5/getDenomination and/or getComponent6 instead
*/
@Deprecated
@com.prowidesoftware.deprecation.ProwideDeprecated(phase4=com.prowidesoftware.deprecation.TargetYear.SRU2024)
public String getDenominationForm() {
// build the field
final StringBuilder result = new StringBuilder();
append(result, 5);
if (getComponent6() != null) {
result.append("//").append(getComponent6());
}
return StringUtils.trimToNull(result.toString());
}
/**
* @deprecated Use setComponent5/setDenomination and/or setComponent6 instead
*/
@Deprecated
@com.prowidesoftware.deprecation.ProwideDeprecated(phase4=com.prowidesoftware.deprecation.TargetYear.SRU2024)
public Field26C setDenominationForm(final String denominationForm) {
setComponent5(SwiftParseUtils.getTokenFirst(denominationForm, "//"));
setComponent6(SwiftParseUtils.getTokenSecond(denominationForm, "//"));
return this;
}
}