@Deprecated @ProwideDeprecated(phase2=SRU2023) public class Field29U extends Field implements java.io.Serializable, BICContainer
Model and parser for field 29U of a SWIFT MT message.
Subfields (components) Data types
BIC
Structure definition
<BIC>
S
B
This class complies with standard release SRU2022
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_29U
Deprecated.
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
IDENTIFIERCODE
Deprecated.
Component number for the IdentifierCode subfield.
|
static java.lang.String |
NAME
Deprecated.
Constant with the field name 29U.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static int |
SRU
Deprecated.
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 |
---|
Field29U()
Deprecated.
Default constructor.
|
Field29U(java.lang.String value)
Deprecated.
Creates a new field and initializes its components with content from the parameter value.
|
Field29U(Tag tag)
Deprecated.
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()
Deprecated.
Utility method that creates a BIC for every string returned by
BICContainer.bicStrings() |
java.util.List<java.lang.String> |
bicStrings()
Deprecated.
Get a list of strings of BICs present in this field
|
java.lang.String |
componentsPattern()
Deprecated.
Use
typesPattern() instead. |
int |
componentsSize()
Deprecated.
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()
Deprecated.
Create a Tag with this field name and an empty string as value.
|
static Field29U |
fromJson(java.lang.String json)
Deprecated.
This method deserializes the JSON data into a Field29U object.
|
static Field29U |
get(SwiftMessage msg)
Deprecated.
Gets the first instance of Field29U in the given message.
|
static Field29U |
get(SwiftTagListBlock block)
Deprecated.
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field29U> |
getAll(SwiftMessage msg)
Deprecated.
Gets a list of all occurrences of the field Field29U in the given message
an empty list is returned if none found.
|
static java.util.List<Field29U> |
getAll(SwiftTagListBlock block)
Deprecated.
Gets a list of all occurrences of the field Field29U from the given block
an empty list is returned if none found.
|
java.lang.String |
getBIC()
Deprecated.
|
BIC |
getBICAsBIC()
Deprecated.
|
java.lang.String |
getComponent1()
Deprecated.
Gets the component 1 (IdentifierCode).
|
BIC |
getComponent1AsBIC()
Deprecated.
Get the component 1 as BIC
|
java.util.List<java.lang.String> |
getComponentLabels()
Deprecated.
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Deprecated.
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getIdentifierCode()
Deprecated.
Gets the IdentifierCode (component 1).
|
BIC |
getIdentifierCodeAsBIC()
Deprecated.
Get the IdentifierCode (component 1) as BIC
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Deprecated.
Returns a mapping between component labels and the internal component number.
|
java.lang.String |
getName()
Deprecated.
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getValue()
Deprecated.
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueDisplay(int component,
java.util.Locale locale)
Deprecated.
Returns a localized suitable for showing to humans string of a field component.
|
boolean |
isGeneric()
Deprecated.
Returns true if the field is a GENERIC FIELD as specified by the standard.
|
boolean |
isOptional(int component)
Deprecated.
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 Field29U |
newInstance(Field29U source)
Deprecated.
Copy constructor.
|
void |
parse(java.lang.String value)
Deprecated.
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Deprecated.
Returns the field parser pattern.
|
Field29U |
setBIC(BIC component1)
Deprecated.
|
Field29U |
setBIC(java.lang.String component1)
Deprecated.
|
Field29U |
setComponent1(BIC component1)
Deprecated.
Set the component1 from a BIC object.
|
Field29U |
setComponent1(java.lang.String component1)
Deprecated.
Set the component 1 (IdentifierCode).
|
Field29U |
setIdentifierCode(BIC component1)
Deprecated.
Set the IdentifierCode (component 1) from a BIC object.
|
Field29U |
setIdentifierCode(java.lang.String component1)
Deprecated.
Set the IdentifierCode (component 1).
|
static Tag |
tag(java.lang.String value)
Deprecated.
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Deprecated.
Returns the field component types pattern.
|
java.lang.String |
validatorPattern()
Deprecated.
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_29U
@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 IDENTIFIERCODE
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer BIC
IDENTIFIERCODE
public Field29U()
public Field29U(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field29U(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field29U newInstance(Field29U 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public BIC getComponent1AsBIC()
public java.lang.String getIdentifierCode()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getBIC()
getIdentifierCode()
public BIC getIdentifierCodeAsBIC()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public BIC getBICAsBIC()
getIdentifierCodeAsBIC()
public Field29U setComponent1(java.lang.String component1)
component1
- the IdentifierCode to setpublic Field29U setComponent1(BIC component1)
component1
- the BIC with the IdentifierCode content to setpublic Field29U setIdentifierCode(java.lang.String component1)
component1
- the IdentifierCode to setpublic Field29U setIdentifierCode(BIC component1)
component1
- BIC with the IdentifierCode content to setsetComponent1(com.prowidesoftware.swift.model.BIC)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field29U setBIC(java.lang.String component1)
component1
- the IdentifierCode to setsetIdentifierCode(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field29U setBIC(BIC component1)
component1
- BIC with the IdentifierCode content to setsetComponent1(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 Field29U get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field29U get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field29U> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field29U> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field29U fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)