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 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 137<br /><br /> * * validation pattern: 1a3!x2!a4!n<br /> * parser pattern: c3!SSN<br /> * components pattern: cSSN<br /> * * <h1>Components Data types</h1> * <ul> * <li>component1: <code>Character</code></li> * <li>component2: <code>String</code></li> * <li>component3: <code>String</code></li> * <li>component4: <code>Number</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 Field137 extends Field implements Serializable { /** * 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 137 */ public static final String NAME = "137"; /** * same as NAME, intended to be clear when using static imports */ public static final String F_137 = "137"; public static final String PARSER_PATTERN = "c3!SSN"; public static final String COMPONENTS_PATTERN = "cSSN"; /** * Component number for the Broadcast Initiator subfield */ public static final Integer BROADCAST_INITIATOR = 1; /** * Component number for the Unsequenced Broadcast subfield */ public static final Integer UNSEQUENCED_BROADCAST = 2; /** * Component number for the Broadcast Issuer subfield */ public static final Integer BROADCAST_ISSUER = 3; /** * Component number for the Broadcast Number subfield */ public static final Integer BROADCAST_NUMBER = 4; /** * Default constructor. Creates a new field setting all components to null. */ public Field137() { 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 Field137(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 Field137(final Tag tag) { this(); if (tag == null) { throw new IllegalArgumentException("tag cannot be null."); } if (!StringUtils.equals(tag.getName(), "137")) { throw new IllegalArgumentException("cannot create field 137 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(4); if (value != null) { if (value.length() >= 1) { setComponent1(org.apache.commons.lang.StringUtils.substring(value, 0, 1)); } if (value.length() >= 4) { setComponent2(org.apache.commons.lang.StringUtils.substring(value, 1, 4)); } if (value.length() > 4) { String toparse = org.apache.commons.lang.StringUtils.substring(value, 4); setComponent3(SwiftParseUtils.getAlphaPrefix(toparse)); setComponent4(SwiftParseUtils.getNumericSuffix(toparse)); } } } /** * 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 Field137 newInstance(Field137 source) { Field137 cp = new Field137(); 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(joinComponents()); 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 Broadcast Initiator (component1). * @return the Broadcast Initiator from component1 */ public String getBroadcastInitiator() { return getComponent(1); } /** * Set the component1. * @param component1 the component1 to set */ public Field137 setComponent1(String component1) { setComponent(1, component1); return this; } /** * Set the Broadcast Initiator (component1). * @param component1 the Broadcast Initiator to set */ public Field137 setBroadcastInitiator(String component1) { setComponent(1, 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 Unsequenced Broadcast (component2). * @return the Unsequenced Broadcast from component2 */ public String getUnsequencedBroadcast() { return getComponent(2); } /** * Set the component2. * @param component2 the component2 to set */ public Field137 setComponent2(String component2) { setComponent(2, component2); return this; } /** * Set the Unsequenced Broadcast (component2). * @param component2 the Unsequenced Broadcast to set */ public Field137 setUnsequencedBroadcast(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 Issuer (component3). * @return the Broadcast Issuer from component3 */ public String getBroadcastIssuer() { return getComponent(3); } /** * Set the component3. * @param component3 the component3 to set */ public Field137 setComponent3(String component3) { setComponent(3, component3); return this; } /** * Set the Broadcast Issuer (component3). * @param component3 the Broadcast Issuer to set */ public Field137 setBroadcastIssuer(String component3) { setComponent(3, component3); return this; } /** * Get the component4 * @return the component4 */ public String getComponent4() { return getComponent(4); } /** * Get the component4 as Number * @return the component4 converted to Number or <code>null</code> if cannot be converted */ public java.lang.Number getComponent4AsNumber() { return SwiftFormatUtils.getNumber(getComponent(4)); } /** * Get the Broadcast Number (component4). * @return the Broadcast Number from component4 */ public String getBroadcastNumber() { return getComponent(4); } /** * Get the Broadcast Number (component4) as Number * @return the Broadcast Number from component4 converted to Number or <code>null</code> if cannot be converted */ public java.lang.Number getBroadcastNumberAsNumber() { return SwiftFormatUtils.getNumber(getComponent(4)); } /** * Set the component4. * @param component4 the component4 to set */ public Field137 setComponent4(String component4) { setComponent(4, component4); return this; } /** * Set the component4 from a Number object. * <br /> * <em>If the component being set is a fixed length number, the argument will not be * padded.</em> It is recommended for these cases to use the setComponent4(String) * method. * * @see #setComponent4(String) * * @param component4 the Number with the component4 content to set */ public Field137 setComponent4(java.lang.Number component4) { if (component4 != null) { setComponent(4, "" + component4.intValue()); } return this; } /** * Set the Broadcast Number (component4). * @param component4 the Broadcast Number to set */ public Field137 setBroadcastNumber(String component4) { setComponent(4, component4); return this; } /** * Set the Broadcast Number (component4) from a Number object. * @see #setComponent4(java.lang.Number) * @param component4 Number with the Broadcast Number content to set */ public Field137 setBroadcastNumber(java.lang.Number component4) { setComponent4(component4); return this; } /** * 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 Field137.NAME */ @Override public String getName() { return NAME; } /** * Returns the field's components pattern * @return the static value of Field137.COMPONENTS_PATTERN */ @Override public final String componentsPattern() { return COMPONENTS_PATTERN; } /** * Returns the field's validators pattern */ @Override public final String validatorPattern() { return "1a3!x2!a4!n"; } /** * 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 Field137 get(final SwiftTagListBlock block) { if (block == null || block.isEmpty()) { return null; } final Tag t = block.getTagByName(NAME); if (t == null) { return null; } return new Field137(t); } /** * Get the first instance of Field137 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 Field137 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 Field137 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<Field137> 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 Field137 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<Field137> 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<Field137> result = new java.util.ArrayList<Field137>(arr.length); for (final Tag f : arr) { result.add(new Field137(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 4; } /** * 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 137"); } 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); } if (component == 4) { //number or amount java.text.NumberFormat f = java.text.NumberFormat.getNumberInstance(locale); Number n = getComponent4AsNumber(); if (n != null) { return f.format(n); } } 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("Broadcast Initiator"); result.add("Unsequenced Broadcast"); result.add("Broadcast Issuer"); result.add("Broadcast Number"); return result; } }