@Generated public class Field59A extends Field implements java.io.Serializable, BICContainer, MultiLineField
Model and parser for field 59A of a SWIFT MT message.
Subfields (components) Data types
String
BIC
Structure definition
[/34x$]<BIC>
[/S$]S
SB
This class complies with standard release SRU2023
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACCOUNT
Component number for the Account subfield.
|
static java.lang.Integer |
BIC
Deprecated.
use #IDENTIFIER_CODE instead
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_59A
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 59A.
|
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, labelMap
Constructor and Description |
---|
Field59A()
Default constructor.
|
Field59A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field59A(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 Field59A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field59A object.
|
static Field59A |
get(SwiftMessage msg)
Gets the first instance of Field59A in the given message.
|
static Field59A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
java.lang.String |
getAccount()
Gets the Account (component 1) removing its starting slashes if any.
|
static java.util.List<Field59A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field59A in the given message
an empty list is returned if none found.
|
static java.util.List<Field59A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field59A from the given block
an empty list is returned if none found.
|
java.lang.String |
getBIC()
Deprecated.
use #getIdentifierCode() instead
|
BIC |
getBICAsBIC()
Deprecated.
use #getIdentifierCodeAsBIC() instead
|
java.lang.String |
getComponent1()
Gets the component 1 (Account).
|
java.lang.String |
getComponent2()
Gets the component 2 (Identifier Code).
|
BIC |
getComponent2AsBIC()
Get the component 2 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 2).
|
BIC |
getIdentifierCodeAsBIC()
Get the Identifier Code (component 2) as BIC
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
java.lang.String |
getLine(int line)
Returns a specific line from the field's value.
|
java.lang.String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
java.util.List<java.lang.String> |
getLines()
Returns the field value split into lines.
|
java.util.List<java.lang.String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
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 Field59A |
newInstance(Field59A 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.
|
Field59A |
setAccount(java.lang.String component1)
Set the Account (component 1).
|
Field59A |
setBIC(BIC component2)
Deprecated.
use #setComponent2(com.prowidesoftware.swift.model.BIC) instead
|
Field59A |
setBIC(java.lang.String component2)
Deprecated.
use #setIdentifierCode(String) instead
|
Field59A |
setComponent1(java.lang.String component1)
Set the component 1 (Account).
|
Field59A |
setComponent2(BIC component2)
Set the component2 from a BIC object.
|
Field59A |
setComponent2(java.lang.String component2)
Set the component 2 (Identifier Code).
|
Field59A |
setIdentifierCode(BIC component2)
Set the Identifier Code (component 2) from a BIC object.
|
Field59A |
setIdentifierCode(java.lang.String component2)
Set the Identifier Code (component 2).
|
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_59A
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer ACCOUNT
public static final java.lang.Integer IDENTIFIER_CODE
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer BIC
public Field59A()
public Field59A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field59A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field59A newInstance(Field59A source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public 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 Field
component
- 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(phase4=SRU2024) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
public java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getAccount()
public java.lang.String getComponent2()
public BIC getComponent2AsBIC()
public java.lang.String getIdentifierCode()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getBIC()
public BIC getIdentifierCodeAsBIC()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public BIC getBICAsBIC()
public Field59A setComponent1(java.lang.String component1)
component1
- the Account to setpublic Field59A setAccount(java.lang.String component1)
component1
- the Account to setpublic Field59A setComponent2(java.lang.String component2)
component2
- the Identifier Code to setpublic Field59A setComponent2(BIC component2)
component2
- the BIC with the Identifier Code content to setpublic Field59A setIdentifierCode(java.lang.String component2)
component2
- the Identifier Code to setpublic Field59A setIdentifierCode(BIC component2)
component2
- BIC with the Identifier Code content to setsetComponent2(com.prowidesoftware.swift.model.BIC)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field59A setBIC(java.lang.String component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field59A setBIC(BIC component2)
public java.util.List<BIC> bics()
BICContainer
BICContainer.bicStrings()
bics
in interface BICContainer
public java.util.List<java.lang.String> bicStrings()
BICContainer
bicStrings
in interface BICContainer
public java.lang.String getName()
public static Field59A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field59A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field59A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field59A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getLine(int line)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1MultiLineField.getLine(int)
public java.lang.String getLine(int line, int offset)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting linesMultiLineField.getLine(int, int)
public java.util.List<java.lang.String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public java.util.List<java.lang.String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public java.util.List<java.lang.String> getLinesBetween(int start, int end)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startMultiLineField.getLinesBetween(int, int )
public java.util.List<java.lang.String> getLinesBetween(int start, int end, int offset)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startoffset
- an optional component number used as offset when counting linesMultiLineField.getLinesBetween(int start, int end, int offset)
public static Field59A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)