@Generated public class Field23R extends Field implements java.io.Serializable, MultiLineField
Model and parser for field 23R of a SWIFT MT message.
Subfields (components) Data types
String
String
String
String
String
String
String
Structure definition
4!c(**)[$35x]0-6
S[$S]0-6
SSSSSSS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
CODE
Component number for the Code subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.String |
F_23R
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 23R.
|
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.Integer |
TEXT
Component number for the Text subfield.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field23R()
Default constructor.
|
Field23R(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field23R(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 Field23R |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field23R object.
|
static Field23R |
get(SwiftMessage msg)
Gets the first instance of Field23R in the given message.
|
static Field23R |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field23R> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field23R in the given message
an empty list is returned if none found.
|
static java.util.List<Field23R> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field23R from the given block
an empty list is returned if none found.
|
java.lang.String |
getCode()
Gets the Code (component 1).
|
java.lang.String |
getComponent1()
Gets the component 1 (Code).
|
java.lang.String |
getComponent2()
Gets the component 2 (Text).
|
java.lang.String |
getComponent3()
Gets the component 3 (Text 2).
|
java.lang.String |
getComponent4()
Gets the component 4 (Text 3).
|
java.lang.String |
getComponent5()
Gets the component 5 (Text 4).
|
java.lang.String |
getComponent6()
Gets the component 6 (Text 5).
|
java.lang.String |
getComponent7()
Gets the component 7 (Text 6).
|
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 |
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 |
getText()
Gets the Text as a concatenation of component 2 to component 7.
|
java.lang.String |
getText(java.lang.CharSequence deli)
Gets the Text as a concatenation of component 2 to component 7 joined together with a copy of the
specified delimiter.
|
java.lang.String |
getTextLine1()
Gets the Text (component 2).
|
java.lang.String |
getTextLine2()
Gets the Text 2 (component 3).
|
java.lang.String |
getTextLine3()
Gets the Text 3 (component 4).
|
java.lang.String |
getTextLine4()
Gets the Text 4 (component 5).
|
java.lang.String |
getTextLine5()
Gets the Text 5 (component 6).
|
java.lang.String |
getTextLine6()
Gets the Text 6 (component 7).
|
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 Field23R |
newInstance(Field23R 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.
|
Field23R |
setCode(java.lang.String component1)
Set the Code (component 1).
|
Field23R |
setComponent1(java.lang.String component1)
Set the component 1 (Code).
|
Field23R |
setComponent2(java.lang.String component2)
Set the component 2 (Text).
|
Field23R |
setComponent3(java.lang.String component3)
Set the component 3 (Text 2).
|
Field23R |
setComponent4(java.lang.String component4)
Set the component 4 (Text 3).
|
Field23R |
setComponent5(java.lang.String component5)
Set the component 5 (Text 4).
|
Field23R |
setComponent6(java.lang.String component6)
Set the component 6 (Text 5).
|
Field23R |
setComponent7(java.lang.String component7)
Set the component 7 (Text 6).
|
Field23R |
setText(java.lang.String value)
Set the Text splitting the parameter lines into components 2 to 7.
|
Field23R |
setTextLine1(java.lang.String component2)
Set the Text (component 2).
|
Field23R |
setTextLine2(java.lang.String component3)
Set the Text 2 (component 3).
|
Field23R |
setTextLine3(java.lang.String component4)
Set the Text 3 (component 4).
|
Field23R |
setTextLine4(java.lang.String component5)
Set the Text 4 (component 5).
|
Field23R |
setTextLine5(java.lang.String component6)
Set the Text 5 (component 6).
|
Field23R |
setTextLine6(java.lang.String component7)
Set the Text 6 (component 7).
|
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_23R
@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 CODE
public static final java.lang.Integer TEXT
public Field23R()
public Field23R(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field23R(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field23R newInstance(Field23R 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 getCode()
public java.lang.String getComponent2()
public java.lang.String getTextLine1()
public java.lang.String getText()
public java.lang.String getText(java.lang.CharSequence deli)
deli
- the delimiter that separates each componentpublic java.lang.String getComponent3()
public java.lang.String getTextLine2()
public java.lang.String getComponent4()
public java.lang.String getTextLine3()
public java.lang.String getComponent5()
public java.lang.String getTextLine4()
public java.lang.String getComponent6()
public java.lang.String getTextLine5()
public java.lang.String getComponent7()
public java.lang.String getTextLine6()
public Field23R setComponent1(java.lang.String component1)
component1
- the Code to setpublic Field23R setCode(java.lang.String component1)
component1
- the Code to setpublic Field23R setComponent2(java.lang.String component2)
component2
- the Text to setpublic Field23R setTextLine1(java.lang.String component2)
component2
- the Text to setpublic Field23R setText(java.lang.String value)
value
- the Text to set, may contain line ends and each line will be set to its correspondent component attributepublic Field23R setComponent3(java.lang.String component3)
component3
- the Text 2 to setpublic Field23R setTextLine2(java.lang.String component3)
component3
- the Text 2 to setpublic Field23R setComponent4(java.lang.String component4)
component4
- the Text 3 to setpublic Field23R setTextLine3(java.lang.String component4)
component4
- the Text 3 to setpublic Field23R setComponent5(java.lang.String component5)
component5
- the Text 4 to setpublic Field23R setTextLine4(java.lang.String component5)
component5
- the Text 4 to setpublic Field23R setComponent6(java.lang.String component6)
component6
- the Text 5 to setpublic Field23R setTextLine5(java.lang.String component6)
component6
- the Text 5 to setpublic Field23R setComponent7(java.lang.String component7)
component7
- the Text 6 to setpublic Field23R setTextLine6(java.lang.String component7)
component7
- the Text 6 to setpublic java.lang.String getName()
public static Field23R get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field23R get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field23R> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field23R> 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 Field23R fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)