com.prowidesoftware.swift.model.field.Field28E 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 28E.
*
* Model and parser for field 28E of a SWIFT MT message.
*
*
Subfields (components) Data types
*
* - Component 1: PageNumber:
Long
* - Component 2: ContinuationIndicator:
String
*
*
* Structure definition
*
* - validation pattern:
5n/4!c
* - parser pattern:
S/S
* - components pattern:
NS
*
*
*
* This class complies with standard release SRU2023
*/
@SuppressWarnings("unused")
@Generated
public class Field28E 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 28E.
*/
public static final String NAME = "28E";
/**
* Same as NAME, intended to be clear when using static imports.
*/
public static final String F_28E = "28E";
/**
* @deprecated Use {@link #parserPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String PARSER_PATTERN = "S/S";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String COMPONENTS_PATTERN = "NS";
/**
* @deprecated Use {@link #typesPattern()} method instead.
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public static final String TYPES_PATTERN = "NS";
/**
* Component number for the Page Number subfield.
*/
public static final Integer PAGE_NUMBER = 1;
/**
* Component number for the Continuation Indicator subfield.
*/
public static final Integer CONTINUATION_INDICATOR = 2;
/**
* Default constructor. Creates a new field setting all components to null.
*/
public Field28E() {
super(2);
}
/**
* Creates a new field and initializes its components with content from the parameter value.
* @param value complete field value including separators and CRLF
*/
public Field28E(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 Field28E(final Tag tag) {
this();
if (tag == null) {
throw new IllegalArgumentException("tag cannot be null.");
}
if (!StringUtils.equals(tag.getName(), "28E")) {
throw new IllegalArgumentException("cannot create field 28E 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 Field28E newInstance(Field28E source) {
Field28E cp = new Field28E();
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(2);
setComponent1(SwiftParseUtils.getTokenFirst(value, "/"));
setComponent2(SwiftParseUtils.getTokenSecondLast(value, "/"));
}
/**
* 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);
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 > 2) {
throw new IllegalArgumentException("invalid component number " + component + " for field 28E");
}
if (component == 1) {
//default format (as is)
return getComponent(1);
}
if (component == 2) {
//default format (as is)
return getComponent(2);
}
return null;
}
/**
* @deprecated Use {@link #typesPattern()} instead.
*/
@Override
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public String componentsPattern() {
return "NS";
}
/**
* 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 "NS";
}
/**
* Returns the field parser pattern.
*/
@Override
public String parserPattern() {
return "S/S";
}
/**
* Returns the field validator pattern
*/
@Override
public String validatorPattern() {
return "5n/4!c";
}
/**
* 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 2;
}
/**
* 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("Page Number");
result.add("Continuation Indicator");
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, "pageNumber");
result.put(2, "continuationIndicator");
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("pagenumber", 1);
super.labelMap.put("continuationindicator", 2);
return super.labelMap;
}
/**
* Gets the component 1 (Page Number).
* @return the component 1
*/
public String getComponent1() {
return getComponent(1);
}
/**
* Get the component 1 as Long
*
* @return the component 1 converted to Long or null if cannot be converted
* @since 9.2.7
*/
public java.lang.Long getComponent1AsLong() {
return SwiftFormatUtils.getLong(getComponent(1));
}
/**
* @deprecated use #getComponent1AsLong() instead
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public java.lang.Number getComponent1AsNumber() {
Long l = getComponent1AsLong();
return l != null ? new BigDecimal(l) : null;
}
/**
* Gets the Page Number (component 1).
* @return the Page Number from component 1
*/
public String getPageNumber() {
return getComponent1();
}
/**
* Get the Page Number (component 1) as Long
* @return the Page Number from component 1 converted to Long or null if cannot be converted
* @since 9.2.7
*/
public java.lang.Long getPageNumberAsLong() {
return getComponent1AsLong();
}
/**
* @deprecated use #getPageNumberAsLong() instead
*/
@Deprecated
@ProwideDeprecated(phase4 = TargetYear.SRU2024)
public java.lang.Number getPageNumberAsNumber() {
return getComponent1AsNumber();
}
/**
* Gets the component 2 (Continuation Indicator).
* @return the component 2
*/
public String getComponent2() {
return getComponent(2);
}
/**
* Gets the Continuation Indicator (component 2).
* @return the Continuation Indicator from component 2
*/
public String getContinuationIndicator() {
return getComponent2();
}
/**
* Set the component 1 (Page Number).
*
* @param component1 the Page Number to set
* @return the field object to enable build pattern
*/
public Field28E setComponent1(String component1) {
setComponent(1, component1);
return this;
}
/**
* Set the component1 from a Long object.
*
* If the component being set is a fixed length number, the argument will not be
* padded. It is recommended for these cases to use the setComponent1(String)
* method.
*
* @see #setComponent1(String)
* @since 9.2.7
*
* @param component1 the Long with the Page Number content to set
* @return the field object to enable build pattern
*/
public Field28E setComponent1(java.lang.Long component1) {
setComponent(1, SwiftFormatUtils.getLong(component1));
return this;
}
/**
* Alternative method setter for field's Page Number (component 1) as Number
*
* This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
*
* @param component1 the Number with the Page Number content to set
* @return the field object to enable build pattern
* @see #setPageNumber(java.lang.Long)
*/
public Field28E setComponent1(java.lang.Number component1) {
// NOTE: remember instanceof implicitly checks for non-null
if (component1 instanceof Long) {
setComponent(1, SwiftFormatUtils.getLong((Long) component1));
} else if (component1 instanceof BigInteger || component1 instanceof Integer) {
setComponent(1, SwiftFormatUtils.getLong(component1.longValue()));
} else if (component1 != null) {
// it's another non-null Number (Float, Double, BigDecimal, etc...)
setComponent(1, SwiftFormatUtils.getLong(component1.longValue()));
} else {
// explicitly set component as null
setComponent(1, null);
}
return this;
}
/**
* Set the Page Number (component 1).
*
* @param component1 the Page Number to set
* @return the field object to enable build pattern
*/
public Field28E setPageNumber(String component1) {
return setComponent1(component1);
}
/**
* Set the Page Number (component 1) from a Long object.
*
* @see #setComponent1(java.lang.Long)
*
* @param component1 Long with the Page Number content to set
* @return the field object to enable build pattern
* @since 9.2.7
*/
public Field28E setPageNumber(java.lang.Long component1) {
return setComponent1(component1);
}
/**
* Alternative method setter for field's Page Number (component 1) as Number
*
* This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
*
* @param component1 the Number with the Page Number content to set
* @return the field object to enable build pattern
* @see #setPageNumber(java.lang.Long)
*/
public Field28E setPageNumber(java.lang.Number component1) {
return setComponent1(component1);
}
/**
* Set the component 2 (Continuation Indicator).
*
* @param component2 the Continuation Indicator to set
* @return the field object to enable build pattern
*/
public Field28E setComponent2(String component2) {
setComponent(2, component2);
return this;
}
/**
* Set the Continuation Indicator (component 2).
*
* @param component2 the Continuation Indicator to set
* @return the field object to enable build pattern
*/
public Field28E setContinuationIndicator(String component2) {
return setComponent2(component2);
}
/**
* Returns the field's name composed by the field number and the letter option (if any).
* @return the static value of Field28E.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 Field28E get(final SwiftTagListBlock block) {
if (block == null || block.isEmpty()) {
return null;
}
final Tag t = block.getTagByName(NAME);
if (t == null) {
return null;
}
return new Field28E(t);
}
/**
* Gets the first instance of Field28E 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 Field28E 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 Field28E 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 Field28E 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 Field28E(f));
}
}
return result;
}
/**
* This method deserializes the JSON data into a Field28E 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 Field28E fromJson(final String json) {
final Field28E field = new Field28E();
final JsonObject jsonObject = JsonParser.parseString(json).getAsJsonObject();
// **** COMPONENT 1 - Page Number
if (jsonObject.get("pageNumber") != null) {
field.setComponent1(jsonObject.get("pageNumber").getAsString());
}
// **** COMPONENT 2 - Continuation Indicator
if (jsonObject.get("continuationIndicator") != null) {
field.setComponent2(jsonObject.get("continuationIndicator").getAsString());
}
return field;
}
}