@Generated public class Field23 extends Field implements java.io.Serializable
Model and parser for field 23 of a SWIFT MT message.
Subfields (components) Data types
String
String
String
Currency
Structure definition
CUSTOM
S[/S/S[/S]]
SSSC
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
CODE_1
Component number for the Code 1 subfield
|
static java.lang.Integer |
CODE_2
Component number for the Code 2 subfield
|
static java.lang.Integer |
CODE_3
Component number for the Code 3 subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield
|
static java.lang.String |
F_23
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 23
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field23()
Default constructor.
|
Field23(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field23(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()
Returns the field's components pattern
|
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
Shorthand for
new Tag(NAME, "") |
static Field23 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field23 object.
|
static Field23 |
get(SwiftMessage msg)
Gets the first instance of Field23 in the given message.
|
static Field23 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field23> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field23 in the given message
an empty list is returned if none found.
|
static java.util.List<Field23> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field23 from the given block
an empty list is returned if none found.
|
java.lang.String |
getCode1()
Gets the Code 1 (component1).
|
java.lang.String |
getCode2()
Gets the Code 2 (component2).
|
java.lang.String |
getCode3()
Gets the Code 3 (component3).
|
java.lang.String |
getComponent1()
Gets the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Gets the component3
|
java.lang.String |
getComponent3AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent4()
Gets the component4
|
java.util.Currency |
getComponent4AsCurrency()
Get the component4 as Currency
|
protected 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 |
getCurrency()
Gets the Currency (component4).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component4) as Currency
|
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 Field23 |
newInstance(Field23 source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern() |
Field23 |
setCode1(java.lang.String component1)
Set the Code 1 (component1).
|
Field23 |
setCode2(java.lang.String component2)
Set the Code 2 (component2).
|
Field23 |
setCode3(java.lang.String component3)
Set the Code 3 (component3).
|
Field23 |
setComponent1(java.lang.String component1)
Set the component1.
|
Field23 |
setComponent2(java.lang.String component2)
Set the component2.
|
Field23 |
setComponent3(java.lang.String component3)
Set the component3.
|
Field23 |
setComponent4(java.util.Currency component4)
Set the component4 from a Currency object.
|
Field23 |
setComponent4(java.lang.String component4)
Set the component4.
|
Field23 |
setCurrency(java.util.Currency component4)
Set the Currency (component4) from a Currency object.
|
Field23 |
setCurrency(java.lang.String component4)
Set the Currency (component4).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isDSSPresent, 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_23
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer CODE_1
public static final java.lang.Integer CODE_2
public static final java.lang.Integer CODE_3
public static final java.lang.Integer CURRENCY
public Field23()
public Field23(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field23(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field23 newInstance(Field23 source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCode1()
public Field23 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field23 setCode1(java.lang.String component1)
component1
- the Code 1 to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCode2()
public Field23 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field23 setCode2(java.lang.String component2)
component2
- the Code 2 to setpublic java.lang.String getComponent3()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent3AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCode3()
public Field23 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field23 setCode3(java.lang.String component3)
component3
- the Code 3 to setpublic java.lang.String getComponent4()
public java.util.Currency getComponent4AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public Field23 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field23 setComponent4(java.util.Currency component4)
component4
- the Currency with the component4 content to setpublic Field23 setCurrency(java.lang.String component4)
component4
- the Currency to setpublic Field23 setCurrency(java.util.Currency component4)
component4
- Currency with the Currency content to setsetComponent4(java.util.Currency)
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field23 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field23 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field23> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field23> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected 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 static Field23 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)