@Generated public class Field26A extends Field implements java.io.Serializable
Model and parser for field 26A of a SWIFT MT message.
Subfields (components) Data types
String
String
Structure definition
<VAR-SEQU-2>
S[/S]
SS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_26A
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 26A.
|
static java.lang.Integer |
NUMBER
Deprecated.
|
static java.lang.Integer |
NUMBER1
Component number for the Number1 subfield.
|
static java.lang.Integer |
NUMBER2
Component number for the Number2 subfield.
|
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 |
---|
Field26A()
Default constructor.
|
Field26A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field26A(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
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 Field26A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field26A object.
|
static Field26A |
get(SwiftMessage msg)
Gets the first instance of Field26A in the given message.
|
static Field26A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field26A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field26A in the given message
an empty list is returned if none found.
|
static java.util.List<Field26A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field26A from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Number1).
|
java.lang.String |
getComponent2()
Gets the component 2 (Number2).
|
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 |
getNumber()
Deprecated.
|
java.lang.String |
getNumber1()
Gets the Number1 (component 1).
|
java.lang.String |
getNumber2()
Gets the Number2 (component 2).
|
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 Field26A |
newInstance(Field26A 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.
|
Field26A |
setComponent1(java.lang.String component1)
Set the component 1 (Number1).
|
Field26A |
setComponent2(java.lang.String component2)
Set the component 2 (Number2).
|
Field26A |
setNumber(java.lang.String number)
Deprecated.
|
Field26A |
setNumber1(java.lang.String component1)
Set the Number1 (component 1).
|
Field26A |
setNumber2(java.lang.String component2)
Set the Number2 (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, 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_26A
@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 NUMBER1
public static final java.lang.Integer NUMBER2
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer NUMBER
public Field26A()
public Field26A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field26A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field26A newInstance(Field26A 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 getNumber1()
public java.lang.String getComponent2()
public java.lang.String getNumber2()
public Field26A setComponent1(java.lang.String component1)
component1
- the Number1 to setpublic Field26A setNumber1(java.lang.String component1)
component1
- the Number1 to setpublic Field26A setComponent2(java.lang.String component2)
component2
- the Number2 to setpublic Field26A setNumber2(java.lang.String component2)
component2
- the Number2 to setpublic java.lang.String getName()
public static Field26A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field26A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field26A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field26A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field26A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getNumber()
getValue
.
Note that in previous versions, this field had only one component and now has two
because it's what the SWIFT specification indicates.getValue()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field26A setNumber(java.lang.String number)
parse
.
Note that in previous versions, this field had only one component and now has two
because it's what the SWIFT specification indicates.number
- the new expected value for components 1 and 2 concatenatedparse(String)