Java tutorial
/******************************************************************************* * Copyright (c) 2016 Prowide Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * Check the LGPL at <http://www.gnu.org/licenses/> for more details. *******************************************************************************/ package com.prowidesoftware.swift.model.field; import com.prowidesoftware.swift.model.Tag; import com.prowidesoftware.Generated; import java.io.Serializable; import java.util.ArrayList; import java.util.Locale; import java.util.List; import com.prowidesoftware.swift.model.BIC; import com.prowidesoftware.swift.model.field.BICContainer; import org.apache.commons.lang.StringUtils; import com.prowidesoftware.swift.model.field.SwiftParseUtils; import com.prowidesoftware.swift.model.field.CurrencyResolver; import com.prowidesoftware.swift.model.field.AmountResolver; import com.prowidesoftware.swift.model.field.Field; import com.prowidesoftware.swift.model.*; import com.prowidesoftware.swift.utils.SwiftFormatUtils; /** * Field 134<br /><br /> * * validation pattern: <BIC>$65x$65x<br /> * parser pattern: S$S$S<br /> * components pattern: BSS<br /> * * <h1>Components Data types</h1> * <ul> * <li>component1: <code>BIC</code></li> * <li>component2: <code>String</code></li> * <li>component3: <code>String</code></li> * </ul> * * <em>NOTE: this source code has been generated from template</em> * * <em>This class complies with standard release SRU2016</em> * */ @SuppressWarnings("unused") @Generated public class Field134 extends Field implements Serializable, BICContainer, com.prowidesoftware.swift.model.field.MultiLineField { /** * Constant identifying the SRU to which this class belongs to. */ public static final int SRU = 2016; private static final long serialVersionUID = 1L; /** * Constant with the field name 134 */ public static final String NAME = "134"; /** * same as NAME, intended to be clear when using static imports */ public static final String F_134 = "134"; public static final String PARSER_PATTERN = "S$S$S"; public static final String COMPONENTS_PATTERN = "BSS"; /** * Component number for the BIC subfield */ public static final Integer BIC = 1; /** * Component number for the Broadcast Requester Name subfield */ public static final Integer BROADCAST_REQUESTER_NAME = 2; /** * Component number for the Broadcast Requester City subfield */ public static final Integer BROADCAST_REQUESTER_CITY = 3; /** * Default constructor. Creates a new field setting all components to null. */ public Field134() { super(3); } /** * Creates a new field and initializes its components with content from the parameter value. * @param value complete field value including separators and CRLF */ public Field134(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 Field134(final Tag tag) { this(); if (tag == null) { throw new IllegalArgumentException("tag cannot be null."); } if (!StringUtils.equals(tag.getName(), "134")) { throw new IllegalArgumentException("cannot create field 134 from tag " + tag.getName() + ", tagname must match the name of the field."); } parse(tag.getValue()); } /** * 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 components value is overwritten. * @param value complete field value including separators and CRLF * @since 7.8 */ @Override public void parse(final String value) { init(3); java.util.List<String> lines = SwiftParseUtils.getLines(value); if (lines.size() > 0) { setComponent1(lines.get(0)); } if (lines.size() > 1) { setComponent2(lines.get(1)); } if (lines.size() > 2) { setComponent3(lines.get(2)); } } /** * 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 Field134 newInstance(Field134 source) { Field134 cp = new Field134(); cp.setComponents(new ArrayList<String>(source.getComponents())); return cp; } /** * Serializes the fields' components into the single string value (SWIFT format) */ @Override public String getValue() { final StringBuilder result = new StringBuilder(); result.append(StringUtils.trimToEmpty(getComponent1())); result.append(com.prowidesoftware.swift.io.writer.FINWriterVisitor.SWIFT_EOL); result.append(StringUtils.trimToEmpty(getComponent2())); result.append(com.prowidesoftware.swift.io.writer.FINWriterVisitor.SWIFT_EOL); result.append(StringUtils.trimToEmpty(getComponent3())); return result.toString(); } /** * 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, ""); } /** * Get the component1 * @return the component1 */ public String getComponent1() { return getComponent(1); } /** * Get the component1 as BIC * @return the component1 converted to BIC or <code>null</code> if cannot be converted */ public com.prowidesoftware.swift.model.BIC getComponent1AsBIC() { return SwiftFormatUtils.getBIC(getComponent(1)); } /** * Get the BIC (component1). * @return the BIC from component1 */ public String getBIC() { return getComponent(1); } /** * Get the BIC (component1) as BIC * @return the BIC from component1 converted to BIC or <code>null</code> if cannot be converted */ public com.prowidesoftware.swift.model.BIC getBICAsBIC() { return SwiftFormatUtils.getBIC(getComponent(1)); } /** * Set the component1. * @param component1 the component1 to set */ public Field134 setComponent1(String component1) { setComponent(1, component1); return this; } /** * Set the component1 from a BIC object. * @param component1 the BIC with the component1 content to set */ public Field134 setComponent1(com.prowidesoftware.swift.model.BIC component1) { setComponent(1, SwiftFormatUtils.getBIC(component1)); return this; } /** * Set the BIC (component1). * @param component1 the BIC to set */ public Field134 setBIC(String component1) { setComponent(1, component1); return this; } /** * Set the BIC (component1) from a BIC object. * @see #setComponent1(com.prowidesoftware.swift.model.BIC) * @param component1 BIC with the BIC content to set */ public Field134 setBIC(com.prowidesoftware.swift.model.BIC component1) { setComponent1(component1); return this; } /** * Get the component2 * @return the component2 */ public String getComponent2() { return getComponent(2); } /** * Same as getComponent(2) */ @Deprecated public java.lang.String getComponent2AsString() { return getComponent(2); } /** * Get the Broadcast Requester Name (component2). * @return the Broadcast Requester Name from component2 */ public String getBroadcastRequesterName() { return getComponent(2); } /** * Set the component2. * @param component2 the component2 to set */ public Field134 setComponent2(String component2) { setComponent(2, component2); return this; } /** * Set the Broadcast Requester Name (component2). * @param component2 the Broadcast Requester Name to set */ public Field134 setBroadcastRequesterName(String component2) { setComponent(2, component2); return this; } /** * Get the component3 * @return the component3 */ public String getComponent3() { return getComponent(3); } /** * Same as getComponent(3) */ @Deprecated public java.lang.String getComponent3AsString() { return getComponent(3); } /** * Get the Broadcast Requester City (component3). * @return the Broadcast Requester City from component3 */ public String getBroadcastRequesterCity() { return getComponent(3); } /** * Set the component3. * @param component3 the component3 to set */ public Field134 setComponent3(String component3) { setComponent(3, component3); return this; } /** * Set the Broadcast Requester City (component3). * @param component3 the Broadcast Requester City to set */ public Field134 setBroadcastRequesterCity(String component3) { setComponent(3, component3); return this; } public List<BIC> bics() { final List<BIC> result = new ArrayList<BIC>(); result.add(SwiftFormatUtils.getBIC(getComponent(1))); return result; } public List<String> bicStrings() { final List<String> result = new ArrayList<String>(); result.add(getComponent(1)); return result; } /** * 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; } public String parserPattern() { return PARSER_PATTERN; } /** * Returns the field's name composed by the field number and the letter option (if any) * @return the static value of Field134.NAME */ @Override public String getName() { return NAME; } /** * Returns the field's components pattern * @return the static value of Field134.COMPONENTS_PATTERN */ @Override public final String componentsPattern() { return COMPONENTS_PATTERN; } /** * Returns the field's validators pattern */ @Override public final String validatorPattern() { return "<BIC>$65x$65x"; } /** * Get 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 Field134 get(final SwiftTagListBlock block) { if (block == null || block.isEmpty()) { return null; } final Tag t = block.getTagByName(NAME); if (t == null) { return null; } return new Field134(t); } /** * Get the first instance of Field134 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 Field134 get(final SwiftMessage msg) { if (msg == null || msg.getBlock4() == null || msg.getBlock4().isEmpty()) return null; return get(msg.getBlock4()); } /** * Get a list of all occurrences of the field Field134 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 java.util.List<Field134> getAll(final SwiftMessage msg) { if (msg == null || msg.getBlock4() == null || msg.getBlock4().isEmpty()) return java.util.Collections.emptyList(); return getAll(msg.getBlock4()); } /** * Get a list of all occurrences of the field Field134 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 java.util.List<Field134> 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 java.util.ArrayList<Field134> result = new java.util.ArrayList<Field134>(arr.length); for (final Tag f : arr) { result.add(new Field134(f)); } return result; } return java.util.Collections.emptyList(); } /** * 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 3; } /** * 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) { Field134 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) { Field134 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) { Field134 cp = newInstance(this); return SwiftParseUtils.getLines(getLine(cp, start, end, offset)); } /** * 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 > 3) { throw new IllegalArgumentException("invalid component number " + component + " for field 134"); } if (locale == null) { locale = Locale.getDefault(); } 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); } return null; } /** * 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<String>(); result.add("BIC"); result.add("Broadcast Requester Name"); result.add("Broadcast Requester City"); return result; } }