@Generated public class Field22C extends Field implements Serializable
String
String
Number
String
String
CUSTOM
4!S2!S4!S4!S2!S
SSNSS
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static String |
F_22C
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 22C
|
static String |
PARSER_PATTERN |
static Integer |
PARTY_PREFIX_1
Component number for the Party Prefix 1 subfield
|
static Integer |
PARTY_PREFIX_2
Component number for the Party Prefix 2 subfield
|
static Integer |
PARTY_SUFFIX_1
Component number for the Party Suffix 1 subfield
|
static Integer |
PARTY_SUFFIX_2
Component number for the Party Suffix 2 subfield
|
static Integer |
REFERENCE_CODE
Component number for the Reference Code subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field22C()
Default constructor.
|
Field22C(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 |
---|---|
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 Field22C |
get(SwiftMessage msg)
Get the first instance of Field22C in the given message.
|
static Field22C |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field22C> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field22C in the given message
an empty list is returned if none found.
|
static List<Field22C> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field22C from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
String |
getComponent4()
Get the component4
|
String |
getComponent4AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getPartyPrefix1()
Get the Party Prefix 1 (component1).
|
String |
getPartyPrefix2()
Get the Party Prefix 2 (component4).
|
String |
getPartySuffix1()
Get the Party Suffix 1 (component2).
|
String |
getPartySuffix2()
Get the Party Suffix 2 (component5).
|
String |
getReferenceCode()
Get the Reference Code (component3).
|
Number |
getReferenceCodeAsNumber()
Get the Reference Code (component3) as Number
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field22C |
setComponent1(String component1)
Set the component1.
|
Field22C |
setComponent2(String component2)
Set the component2.
|
Field22C |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field22C |
setComponent3(String component3)
Set the component3.
|
Field22C |
setComponent4(String component4)
Set the component4.
|
Field22C |
setComponent5(String component5)
Set the component5.
|
Field22C |
setPartyPrefix1(String component1)
Set the Party Prefix 1 (component1).
|
Field22C |
setPartyPrefix2(String component4)
Set the Party Prefix 2 (component4).
|
Field22C |
setPartySuffix1(String component2)
Set the Party Suffix 1 (component2).
|
Field22C |
setPartySuffix2(String component5)
Set the Party Suffix 2 (component5).
|
Field22C |
setReferenceCode(Number component3)
Set the Reference Code (component3) from a Number object.
|
Field22C |
setReferenceCode(String component3)
Set the Reference Code (component3).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
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, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_22C
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer PARTY_PREFIX_1
public static final Integer PARTY_SUFFIX_1
public static final Integer REFERENCE_CODE
public static final Integer PARTY_PREFIX_2
public static final Integer PARTY_SUFFIX_2
public Field22C()
public Field22C(String value)
value
- complete field value including separators and CRLFpublic Field22C(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field22C newInstance(Field22C source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent1AsString()
Field.getComponent(int)
insteadpublic String getPartyPrefix1()
public Field22C setComponent1(String component1)
component1
- the component1 to setpublic Field22C setPartyPrefix1(String component1)
component1
- the Party Prefix 1 to setpublic String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent2AsString()
Field.getComponent(int)
insteadpublic String getPartySuffix1()
public Field22C setComponent2(String component2)
component2
- the component2 to setpublic Field22C setPartySuffix1(String component2)
component2
- the Party Suffix 1 to setpublic String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getReferenceCode()
public Number getReferenceCodeAsNumber()
null
if cannot be convertedpublic Field22C setComponent3(String component3)
component3
- the component3 to setpublic Field22C setComponent3(Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field22C setReferenceCode(String component3)
component3
- the Reference Code to setpublic Field22C setReferenceCode(Number component3)
component3
- Number with the Reference Code content to setsetComponent3(java.lang.Number)
public String getComponent4()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent4AsString()
Field.getComponent(int)
insteadpublic String getPartyPrefix2()
public Field22C setComponent4(String component4)
component4
- the component4 to setpublic Field22C setPartyPrefix2(String component4)
component4
- the Party Prefix 2 to setpublic String getComponent5()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent5AsString()
Field.getComponent(int)
insteadpublic String getPartySuffix2()
public Field22C setComponent5(String component5)
component5
- the component5 to setpublic Field22C setPartySuffix2(String component5)
component5
- the Party Suffix 2 to setpublic boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
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 List<Field22C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field22C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)