@Generated public class Field128 extends Field implements java.io.Serializable, BICContainer
Model and parser for field 128 of a SWIFT MT message.
Subfields (components) Data types
Character
BIC
Structure definition
1a/<BIC>
S/S
cB
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
BIC
Component number for the BIC subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_128
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 128.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PRIORITY
Component number for the Priority subfield.
|
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 |
---|
Field128()
Default constructor.
|
Field128(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field128(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 Field128 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field128 object.
|
static Field128 |
get(SwiftMessage msg)
Gets the first instance of Field128 in the given message.
|
static Field128 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field128> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field128 in the given message
an empty list is returned if none found.
|
static java.util.List<Field128> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field128 from the given block
an empty list is returned if none found.
|
java.lang.String |
getBIC()
Gets the BIC (component 2).
|
BIC |
getBICAsBIC()
Get the BIC (component 2) as BIC
|
java.lang.String |
getComponent1()
Gets the component 1 (Priority).
|
java.lang.String |
getComponent2()
Gets the component 2 (BIC).
|
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 |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getPriority()
Gets the Priority (component 1).
|
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 Field128 |
newInstance(Field128 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.
|
Field128 |
setBIC(BIC component2)
Set the BIC (component 2) from a BIC object.
|
Field128 |
setBIC(java.lang.String component2)
Set the BIC (component 2).
|
Field128 |
setComponent1(java.lang.String component1)
Set the component 1 (Priority).
|
Field128 |
setComponent2(BIC component2)
Set the component2 from a BIC object.
|
Field128 |
setComponent2(java.lang.String component2)
Set the component 2 (BIC).
|
Field128 |
setPriority(java.lang.String component1)
Set the Priority (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, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_128
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer PRIORITY
public static final java.lang.Integer BIC
public Field128()
public Field128(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field128(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field128 newInstance(Field128 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(phase3=SRU2023) 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
public java.lang.String getComponent1()
public java.lang.String getPriority()
public java.lang.String getComponent2()
public BIC getComponent2AsBIC()
public java.lang.String getBIC()
public BIC getBICAsBIC()
public Field128 setComponent1(java.lang.String component1)
component1
- the Priority to setpublic Field128 setPriority(java.lang.String component1)
component1
- the Priority to setpublic Field128 setComponent2(java.lang.String component2)
component2
- the BIC to setpublic Field128 setComponent2(BIC component2)
component2
- the BIC with the BIC content to setpublic Field128 setBIC(java.lang.String component2)
component2
- the BIC to setpublic Field128 setBIC(BIC component2)
component2
- BIC with the BIC content to setsetComponent2(com.prowidesoftware.swift.model.BIC)
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 Field128 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field128 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field128> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field128> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field128 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)