/* * Copyright 2006-2021 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.google.gson.JsonObject; import com.google.gson.JsonParser; import com.prowidesoftware.Generated; import com.prowidesoftware.swift.model.Tag; import org.apache.commons.lang3.StringUtils; import java.io.Serializable; import java.util.*; import com.prowidesoftware.swift.model.SwiftMessage; import com.prowidesoftware.swift.model.SwiftTagListBlock; /** * <strong>SWIFT MT Field 47A</strong> * <p> * Model and parser for field 47A of a SWIFT MT message. * * <p>Subfields (components) Data types * <ol> * <li><code>String</code></li> * </ol> * * <p>Structure definition * <ul> * <li>validation pattern: <code>65z[$65z]0-99</code></li> * <li>parser pattern: <code>S</code></li> * <li>components pattern: <code>S</code></li> * </ul> * * <p> * This class complies with standard release <strong>SRU2020</strong> */ @SuppressWarnings("unused") @Generated public class Field47A extends Field implements Serializable, MultiLineField { /** * Constant identifying the SRU to which this class belongs to. */ public static final int SRU = 2020; private static final long serialVersionUID = 1L; /** * Constant with the field name 47A */ public static final String NAME = "47A"; /** * same as NAME, intended to be clear when using static imports */ public static final String F_47A = "47A"; public static final String PARSER_PATTERN ="S"; public static final String COMPONENTS_PATTERN = "S"; /** * Component number for the Narrative subfield */ public static final Integer NARRATIVE = 1; /** * Default constructor. Creates a new field setting all components to null. */ public Field47A() { super(1); } /** * Creates a new field and initializes its components with content from the parameter value. * @param value complete field value including separators and CRLF */ public Field47A(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 Field47A(final Tag tag) { this(); if (tag == null) { throw new IllegalArgumentException("tag cannot be null."); } if (!StringUtils.equals(tag.getName(), "47A")) { throw new IllegalArgumentException("cannot create field 47A from tag "+tag.getName()+", tagname must match the name of the field."); } parse(tag.getValue()); } /** * Copy constructor.<br> * 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 Field47A newInstance(Field47A source) { Field47A cp = new Field47A(); cp.setComponents(new ArrayList<>(source.getComponents())); return cp; } /** * Create a Tag with this field name and the given value. * Shorthand for <code>new Tag(NAME, value)</code> * @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 <code>new Tag(NAME, "")</code> * @see #NAME * @since 7.5 */ public static Tag emptyTag() { return new Tag(NAME, ""); } /** * Parses the parameter value into the internal components structure. * * <p>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(1); setComponent1(value); } /** * Serializes the fields' components into the single string value (SWIFT format) */ @Override public String getValue() { final StringBuilder result = new StringBuilder(); append(result, 1); return result.toString(); } /** * Returns a localized suitable for showing to humans string of a field component.<br> * * @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 > 1) { throw new IllegalArgumentException("invalid component number "+component+" for field 47A"); } if (component == 1) { //default format (as is) return getComponent(1); } return null; } /** * Returns the field components pattern * @return the static value of Field47A.COMPONENTS_PATTERN */ @Override public final String componentsPattern() { return COMPONENTS_PATTERN; } /** * Returns the field parser pattern * @return the static value of Field47A.PARSER_PATTERN */ @Override public final String parserPattern() { return PARSER_PATTERN; } /** * Returns the field validator pattern */ @Override public final String validatorPattern() { return "65z[$65z]0-99"; } /** * Given a component number it returns true if the component is optional, * regardless of the field being mandatory in a particular message.<br> * 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.<br> * 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 1; } /** * Returns english label for components. * <br> * The index in the list is in sync with specific field component structure. * @see #getComponentLabel(int) * @since 7.8.4 */ @Override protected List<String> getComponentLabels() { List<String> result = new ArrayList<>(); result.add("Narrative"); return result; } /** * Returns a mapping between component numbers and their label in camel case format. * @since 7.10.3 */ @Override protected Map<Integer, String> getComponentMap() { Map<Integer, String> result = new HashMap<>(); result.put(1, "narrative"); return result; } /** * Gets the component 1 (Narrative). * @return the component 1 */ public String getComponent1() { return getComponent(1); } /** * Gets the Narrative (component 1). * @return the Narrative from component 1 */ public String getNarrative() { return getComponent(1); } /** * Set the component1 (Narrative). * @param component1 the component1 to set */ public Field47A setComponent1(String component1) { setComponent(1, component1); return this; } /** * Set the Narrative (component1). * @param component1 the Narrative to set */ public Field47A setNarrative(String component1) { setComponent(1, component1); return this; } /** * Returns the field's name composed by the field number and the letter option (if any) * @return the static value of Field47A.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 Field47A get(final SwiftTagListBlock block) { if (block == null || block.isEmpty()) { return null; } final Tag t = block.getTagByName(NAME); if (t == null) { return null; } return new Field47A(t) ; } /** * Gets the first instance of Field47A 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 Field47A 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 Field47A 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<Field47A> 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 Field47A 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<Field47A> getAll(final SwiftTagListBlock block) { if (block == null || block.isEmpty()) { return java.util.Collections.emptyList(); } final Tag[] arr = block.getTagsByName(NAME); if (arr != null && arr.length > 0) { final List<Field47A> result = new ArrayList<>(arr.length); for (final Tag f : arr) { result.add( new Field47A(f)); } return result; } return java.util.Collections.emptyList(); } /** * Returns a specific line from the field's value.<br> * * @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.<br> * * @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) { Field47A cp = newInstance(this); return getLine(cp, line, null, offset); } /** * Returns the field value split into lines.<br> * * @see MultiLineField#getLines() * @return lines content or empty list if field's value is empty * @since 7.7 */ public List<String> getLines() { return SwiftParseUtils.getLines(getValue()); } /** * Returns the field value starting at the offset component, split into lines.<br> * * @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<String> getLines(int offset) { Field47A 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.<br> * * @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<String> 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.<br> * * @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<String> getLinesBetween(int start, int end, int offset) { Field47A cp = newInstance(this); return SwiftParseUtils.getLines(getLine(cp, start, end, offset)); } /** * This method deserializes the JSON data into a Field47A 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 Field47A fromJson(final String json) { Field47A field = new Field47A(); JsonParser parser = new JsonParser(); JsonObject jsonObject = (JsonObject) parser.parse(json); if (jsonObject.get("narrative") != null) { field.setComponent1(jsonObject.get("narrative").getAsString()); } return field; } }