@Generated public class Field41F extends Field implements java.io.Serializable, BICContainer
Model and parser for field 41F of a SWIFT MT message.
Subfields (components) Data types
BICStructure definition
<BIC>SBThis class complies with standard release SRU2021
| Modifier and Type | Field and Description |
|---|---|
static java.lang.Integer |
BIC
Deprecated.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
use
typesPattern() method instead. |
static java.lang.String |
F_41F
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
IDENTIFIER_CODE
Component number for the Identifier Code subfield.
|
static java.lang.String |
NAME
Constant with the field name 41F.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
use
parserPattern() method instead. |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
use
typesPattern() method instead. |
components| Constructor and Description |
|---|
Field41F()
Default constructor.
|
Field41F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field41F(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<BIC> |
bics()
Utility method that creates a BIC for every string returned by
BICContainer.bicStrings() |
java.util.List<java.lang.String> |
bicStrings()
Get a list of strings of BICs present in this field
|
java.lang.String |
componentsPattern()
Deprecated.
use
typesPattern() instead. |
int |
componentsSize()
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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field41F |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field41F object.
|
static Field41F |
get(SwiftMessage msg)
Gets the first instance of Field41F in the given message.
|
static Field41F |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field41F> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field41F in the given message
an empty list is returned if none found.
|
static java.util.List<Field41F> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field41F from the given block
an empty list is returned if none found.
|
java.lang.String |
getBIC()
Deprecated.
|
BIC |
getBICAsBIC()
Deprecated.
|
java.lang.String |
getComponent1()
Gets the component 1 (Identifier Code).
|
BIC |
getComponent1AsBIC()
Get the component 1 as BIC
|
java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getIdentifierCode()
Gets the Identifier Code (component 1).
|
BIC |
getIdentifierCodeAsBIC()
Get the Identifier Code (component 1) as BIC
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueDisplay(int component,
java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.
|
boolean |
isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
|
boolean |
isOptional(int component)
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. |
static Field41F |
newInstance(Field41F source)
Copy constructor.
|
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern.
|
Field41F |
setBIC(BIC component1)
Deprecated.
|
Field41F |
setBIC(java.lang.String component1)
Deprecated.
|
Field41F |
setComponent1(BIC component1)
Set the component1 from a BIC object.
|
Field41F |
setComponent1(java.lang.String component1)
Set the component 1 (Identifier Code).
|
Field41F |
setIdentifierCode(BIC component1)
Set the Identifier Code (component 1) from a BIC object.
|
Field41F |
setIdentifierCode(java.lang.String component1)
Set the Identifier Code (component 1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Returns the field component types pattern.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_41F
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String PARSER_PATTERN
parserPattern() method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
typesPattern() method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String TYPES_PATTERN
typesPattern() method instead.public static final java.lang.Integer IDENTIFIER_CODE
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer BIC
IDENTIFIER_CODEpublic Field41F()
public Field41F(java.lang.String value)
value - complete field value including separators and CRLFpublic Field41F(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic static Field41F newInstance(Field41F source)
source - a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component,
java.util.Locale locale)
getValueDisplay in class Fieldcomponent - number of the component to displaylocale - optional locale to format date and amounts, if null, the default locale is usedjava.lang.IllegalArgumentException - if component number is invalid for the field@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String componentsPattern()
typesPattern() instead.FieldtypesPattern() instead.componentsPattern in class FieldField.typesPattern()public java.lang.String typesPattern()
typesPattern in interface PatternContainertypesPattern in class Fieldpublic java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic java.lang.String validatorPattern()
validatorPattern in class Fieldpublic boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize in class Fieldpublic java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap in class Fieldpublic java.lang.String getComponent1()
public BIC getComponent1AsBIC()
public java.lang.String getIdentifierCode()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getBIC()
getIdentifierCode()public BIC getIdentifierCodeAsBIC()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public BIC getBICAsBIC()
getIdentifierCodeAsBIC()public Field41F setComponent1(java.lang.String component1)
component1 - the Identifier Code to setpublic Field41F setComponent1(BIC component1)
component1 - the BIC with the Identifier Code content to setpublic Field41F setIdentifierCode(java.lang.String component1)
component1 - the Identifier Code to setpublic Field41F setIdentifierCode(BIC component1)
component1 - BIC with the Identifier Code content to setsetComponent1(com.prowidesoftware.swift.model.BIC)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field41F setBIC(java.lang.String component1)
component1 - the Identifier Code to setsetIdentifierCode(String)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field41F setBIC(BIC component1)
component1 - BIC with the Identifier Code content to setsetComponent1(com.prowidesoftware.swift.model.BIC)public java.util.List<BIC> bics()
BICContainerBICContainer.bicStrings()bics in interface BICContainerpublic java.util.List<java.lang.String> bicStrings()
BICContainerbicStrings in interface BICContainerpublic java.lang.String getName()
public static Field41F get(SwiftTagListBlock block)
block - may be null or emptypublic static Field41F get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field41F> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field41F> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic static Field41F fromJson(java.lang.String json)
json - JSON structure including tuples with label and value for all field componentsField.fromJson(String)