/* * 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 com.prowidesoftware.swift.utils.SwiftFormatUtils; 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 98F</strong> * <p> * Model and parser for field 98F of a SWIFT MT message. * * <p>Subfields (components) Data types * <ol> * <li><code>String</code></li> * <li><code>String</code></li> * <li><code>String</code></li> * <li><code>Calendar</code></li> * </ol> * * <p>Structure definition * <ul> * <li>validation pattern: <code>:4!c/[8c]/4!c<TIME2></code></li> * <li>parser pattern: <code>:S/[S]/S<TIME2></code></li> * <li>components pattern: <code>SSST</code></li> * </ul> * * <p> * This class complies with standard release <strong>SRU2020</strong> */ @SuppressWarnings("unused") @Generated public class Field98F extends Field implements Serializable, GenericField { /** * 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 98F */ public static final String NAME = "98F"; /** * same as NAME, intended to be clear when using static imports */ public static final String F_98F = "98F"; public static final String PARSER_PATTERN =":S/[S]/S<TIME2>"; public static final String COMPONENTS_PATTERN = "SSST"; /** * Component number for the Qualifier subfield */ public static final Integer QUALIFIER = 1; /** * Component number for the Data Source Scheme subfield */ public static final Integer DATA_SOURCE_SCHEME = 2; /** * Component number for the Code subfield */ public static final Integer CODE = 3; /** * Component number for the Time subfield */ public static final Integer TIME = 4; /** * Default constructor. Creates a new field setting all components to null. */ public Field98F() { super(4); } /** * Creates a new field and initializes its components with content from the parameter value. * @param value complete field value including separators and CRLF */ public Field98F(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 Field98F(final Tag tag) { this(); if (tag == null) { throw new IllegalArgumentException("tag cannot be null."); } if (!StringUtils.equals(tag.getName(), "98F")) { throw new IllegalArgumentException("cannot create field 98F 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 Field98F newInstance(Field98F source) { Field98F cp = new Field98F(); 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(4); setComponent1(SwiftParseUtils.getTokenFirst(value, ":", "/")); String toparse = SwiftParseUtils.getTokenSecondLast(value, "/"); setComponent2(SwiftParseUtils.getTokenFirst(toparse, "/")); String toparse2 = SwiftParseUtils.getTokenSecondLast(toparse, "/"); if (toparse2 != null) { if (toparse2.length() >= 6) { setComponent3(StringUtils.substring(toparse2, 0, toparse2.length()-6)); setComponent4(StringUtils.substring(toparse2, toparse2.length()-6)); } else { setComponent3(toparse2); } } } /** * Serializes the fields' components into the single string value (SWIFT format) */ @Override public String getValue() { final StringBuilder result = new StringBuilder(); result.append(":"); append(result, 1); result.append("/"); append(result, 2); result.append("/"); append(result, 3); append(result, 4); 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 > 4) { throw new IllegalArgumentException("invalid component number "+component+" for field 98F"); } 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) { //time with seconds java.text.DateFormat f = new java.text.SimpleDateFormat("HH:mm:ss", notNull(locale)); java.util.Calendar cal = getComponent4AsCalendar(); if (cal != null) { return f.format(cal.getTime()); } } return null; } /** * Returns the field components pattern * @return the static value of Field98F.COMPONENTS_PATTERN */ @Override public final String componentsPattern() { return COMPONENTS_PATTERN; } /** * Returns the field parser pattern * @return the static value of Field98F.PARSER_PATTERN */ @Override public final String parserPattern() { return PARSER_PATTERN; } /** * Returns the field validator pattern */ @Override public final String validatorPattern() { return ":4!c/[8c]/4!c<TIME2>"; } /** * 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) { if (component == 2) { 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 true; } /** * 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 4; } /** * 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("Qualifier"); result.add("Data Source Scheme"); result.add("Code"); result.add("Time"); 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, "qualifier"); result.put(2, "dataSourceScheme"); result.put(3, "code"); result.put(4, "time"); return result; } /** * Gets the component 1 (Qualifier). * @return the component 1 */ public String getComponent1() { return getComponent(1); } /** * Gets the Qualifier (component 1). * @return the Qualifier from component 1 */ public String getQualifier() { return getComponent(1); } /** * Gets the component 2 (Data Source Scheme). * @return the component 2 */ public String getComponent2() { return getComponent(2); } /** * Gets the Data Source Scheme (component 2). * @return the Data Source Scheme from component 2 */ public String getDataSourceScheme() { return getComponent(2); } /** * Gets the component 3 (Code). * @return the component 3 */ public String getComponent3() { return getComponent(3); } /** * Gets the Code (component 3). * @return the Code from component 3 */ public String getCode() { return getComponent(3); } /** * Gets the component 4 (Time). * @return the component 4 */ public String getComponent4() { return getComponent(4); } /** * Get the component 4 as Calendar * @return the component 4 converted to Calendar or null if cannot be converted */ public java.util.Calendar getComponent4AsCalendar() { return SwiftFormatUtils.getTime2(getComponent(4)); } /** * Gets the Time (component 4). * @return the Time from component 4 */ public String getTime() { return getComponent(4); } /** * Get the Time (component 4) as Calendar * @return the Time from component 4 converted to Calendar or null if cannot be converted */ public java.util.Calendar getTimeAsCalendar() { return SwiftFormatUtils.getTime2(getComponent(4)); } /** * Set the component1 (Qualifier). * @param component1 the component1 to set */ public Field98F setComponent1(String component1) { setComponent(1, component1); return this; } /** * Set the Qualifier (component1). * @param component1 the Qualifier to set */ public Field98F setQualifier(String component1) { setComponent(1, component1); return this; } /** * Set the component2 (Data Source Scheme). * @param component2 the component2 to set */ public Field98F setComponent2(String component2) { setComponent(2, component2); return this; } /** * Set the Data Source Scheme (component2). * @param component2 the Data Source Scheme to set */ public Field98F setDataSourceScheme(String component2) { setComponent(2, component2); return this; } /** * Set the component3 (Code). * @param component3 the component3 to set */ public Field98F setComponent3(String component3) { setComponent(3, component3); return this; } /** * Set the Code (component3). * @param component3 the Code to set */ public Field98F setCode(String component3) { setComponent(3, component3); return this; } /** * Set the component4 (Time). * @param component4 the component4 to set */ public Field98F setComponent4(String component4) { setComponent(4, component4); return this; } /** * Set the component4 from a Calendar object. * @param component4 the Calendar with the component4 content to set */ public Field98F setComponent4(java.util.Calendar component4) { setComponent(4, SwiftFormatUtils.getTime2(component4)); return this; } /** * Set the Time (component4). * @param component4 the Time to set */ public Field98F setTime(String component4) { setComponent(4, component4); return this; } /** * Set the Time (component4) from a Calendar object. * @see #setComponent4(java.util.Calendar) * @param component4 Calendar with the Time content to set */ public Field98F setTime(java.util.Calendar component4) { setComponent4(component4); return this; } /** * Returns the issuer code (or Data Source Scheme or DSS). * The DSS is only present in some generic fields, when present, is equals to component two. * * @return DSS component value or null if the DSS is not set or not available for this field. */ public String getDSS() { return getComponent2(); } /** * Checks if the issuer code (or Data Source Scheme or DSS) is present. * * @see #getDSS() * @return true if DSS is present, false otherwise. */ public boolean isDSSPresent() { return getDSS() != null; } /** * Component number for the conditional qualifier subfield */ public static final Integer CONDITIONAL_QUALIFIER = 3; /** * Gets the component with the conditional (secondary) qualifier. * * @return for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this field. */ public String getConditionalQualifier() { return getComponent(CONDITIONAL_QUALIFIER); } /** * Returns the field's name composed by the field number and the letter option (if any) * @return the static value of Field98F.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 Field98F get(final SwiftTagListBlock block) { if (block == null || block.isEmpty()) { return null; } final Tag t = block.getTagByName(NAME); if (t == null) { return null; } return new Field98F(t) ; } /** * Gets the first instance of Field98F 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 Field98F 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 Field98F 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<Field98F> 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 Field98F 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<Field98F> 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<Field98F> result = new ArrayList<>(arr.length); for (final Tag f : arr) { result.add( new Field98F(f)); } return result; } return java.util.Collections.emptyList(); } /** * This method deserializes the JSON data into a Field98F 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 Field98F fromJson(final String json) { Field98F field = new Field98F(); JsonParser parser = new JsonParser(); JsonObject jsonObject = (JsonObject) parser.parse(json); if (jsonObject.get("qualifier") != null) { field.setComponent1(jsonObject.get("qualifier").getAsString()); } if (jsonObject.get("dataSourceScheme") != null) { field.setComponent2(jsonObject.get("dataSourceScheme").getAsString()); } if (jsonObject.get("code") != null) { field.setComponent3(jsonObject.get("code").getAsString()); } if (jsonObject.get("time") != null) { field.setComponent4(jsonObject.get("time").getAsString()); } return field; } }