@Generated public class Field22C extends Field implements java.io.Serializable
Model and parser for field 22C of a SWIFT MT message.
Subfields (components) Data types
String
String
Long
String
String
Structure definition
CUSTOM
4!S2!S4!S4!S2!S
SSNSS
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.String |
F_22C
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 22C
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PARTY_PREFIX_1
Component number for the Party Prefix 1 subfield
|
static java.lang.Integer |
PARTY_PREFIX_2
Component number for the Party Prefix 2 subfield
|
static java.lang.Integer |
PARTY_SUFFIX_1
Component number for the Party Suffix 1 subfield
|
static java.lang.Integer |
PARTY_SUFFIX_2
Component number for the Party Suffix 2 subfield
|
static java.lang.Integer |
REFERENCE_CODE
Component number for the Reference Code subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.
|
components
Constructor and Description |
---|
Field22C()
Default constructor.
|
Field22C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field22C(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.
|
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 Field22C |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field22C object.
|
static Field22C |
get(SwiftMessage msg)
Gets the first instance of Field22C in the given message.
|
static Field22C |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field22C> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field22C in the given message
an empty list is returned if none found.
|
static java.util.List<Field22C> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field22C from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Party Prefix 1).
|
java.lang.String |
getComponent2()
Gets the component 2 (Party Suffix 1).
|
java.lang.String |
getComponent3()
Gets the component 3 (Reference Code).
|
java.lang.Long |
getComponent3AsLong()
Get the component 3 as Long
|
java.lang.Number |
getComponent3AsNumber()
Deprecated.
|
java.lang.String |
getComponent4()
Gets the component 4 (Party Prefix 2).
|
java.lang.String |
getComponent5()
Gets the component 5 (Party Suffix 2).
|
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 |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getPartyPrefix1()
Gets the Party Prefix 1 (component 1).
|
java.lang.String |
getPartyPrefix2()
Gets the Party Prefix 2 (component 4).
|
java.lang.String |
getPartySuffix1()
Gets the Party Suffix 1 (component 2).
|
java.lang.String |
getPartySuffix2()
Gets the Party Suffix 2 (component 5).
|
java.lang.String |
getReferenceCode()
Gets the Reference Code (component 3).
|
java.lang.Long |
getReferenceCodeAsLong()
Get the Reference Code (component 3) as Long
|
java.lang.Number |
getReferenceCodeAsNumber()
Deprecated.
|
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 Field22C |
newInstance(Field22C 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()
Returns the field parser pattern
|
Field22C |
setComponent1(java.lang.String component1)
Set the component 1 (Party Prefix 1).
|
Field22C |
setComponent2(java.lang.String component2)
Set the component 2 (Party Suffix 1).
|
Field22C |
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
|
Field22C |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Reference Code (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field22C |
setComponent3(java.lang.String component3)
Set the component 3 (Reference Code).
|
Field22C |
setComponent4(java.lang.String component4)
Set the component 4 (Party Prefix 2).
|
Field22C |
setComponent5(java.lang.String component5)
Set the component 5 (Party Suffix 2).
|
Field22C |
setPartyPrefix1(java.lang.String component1)
Set the Party Prefix 1 (component 1).
|
Field22C |
setPartyPrefix2(java.lang.String component4)
Set the Party Prefix 2 (component 4).
|
Field22C |
setPartySuffix1(java.lang.String component2)
Set the Party Suffix 1 (component 2).
|
Field22C |
setPartySuffix2(java.lang.String component5)
Set the Party Suffix 2 (component 5).
|
Field22C |
setReferenceCode(java.lang.Long component3)
Set the Reference Code (component 3) from a Long object.
|
Field22C |
setReferenceCode(java.lang.Number component3)
Alternative method setter for field's Reference Code (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field22C |
setReferenceCode(java.lang.String component3)
Set the Reference Code (component 3).
|
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
This method returns a letter representing the type for each component in the Field.
|
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_22C
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN
,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer PARTY_PREFIX_1
public static final java.lang.Integer PARTY_SUFFIX_1
public static final java.lang.Integer REFERENCE_CODE
public static final java.lang.Integer PARTY_PREFIX_2
public static final java.lang.Integer PARTY_SUFFIX_2
public Field22C()
public Field22C(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field22C(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field22C newInstance(Field22C 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(phase2=SRU2022) public final java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
typesPattern()
public final java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
TYPES_PATTERN
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final 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
protected 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 getPartyPrefix1()
public java.lang.String getComponent2()
public java.lang.String getPartySuffix1()
public java.lang.String getComponent3()
public java.lang.Long getComponent3AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent3AsNumber()
getComponent3AsLong()
to get the proper value.getComponent3AsLong()
public java.lang.String getReferenceCode()
public java.lang.Long getReferenceCodeAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getReferenceCodeAsNumber()
getComponent3AsLong()
to get the proper value.getReferenceCodeAsLong()
public java.lang.String getComponent4()
public java.lang.String getPartyPrefix2()
public java.lang.String getComponent5()
public java.lang.String getPartySuffix2()
public Field22C setComponent1(java.lang.String component1)
component1
- the Party Prefix 1 to setpublic Field22C setPartyPrefix1(java.lang.String component1)
component1
- the Party Prefix 1 to setpublic Field22C setComponent2(java.lang.String component2)
component2
- the Party Suffix 1 to setpublic Field22C setPartySuffix1(java.lang.String component2)
component2
- the Party Suffix 1 to setpublic Field22C setComponent3(java.lang.String component3)
component3
- the Reference Code to setpublic Field22C setComponent3(java.lang.Long component3)
component3
- the Long with the Reference Code content to setsetComponent3(String)
public Field22C setComponent3(java.lang.Number component3)
component3
- the Number with the Reference Code content to setsetReferenceCode(java.lang.Long)
public Field22C setReferenceCode(java.lang.String component3)
component3
- the Reference Code to setpublic Field22C setReferenceCode(java.lang.Long component3)
component3
- Long with the Reference Code content to setsetComponent3(java.lang.Long)
public Field22C setReferenceCode(java.lang.Number component3)
component3
- the Number with the Reference Code content to setsetReferenceCode(java.lang.Long)
public Field22C setComponent4(java.lang.String component4)
component4
- the Party Prefix 2 to setpublic Field22C setPartyPrefix2(java.lang.String component4)
component4
- the Party Prefix 2 to setpublic Field22C setComponent5(java.lang.String component5)
component5
- the Party Suffix 2 to setpublic Field22C setPartySuffix2(java.lang.String component5)
component5
- the Party Suffix 2 to setpublic java.lang.String getName()
public static Field22C get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field22C get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field22C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field22C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field22C fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)