@Generated public class Field12C extends Field implements java.io.Serializable, GenericField
Model and parser for field 12C of a SWIFT MT message.
Subfields (components) Data types
String
String
Structure definition
:4!c//6!c
:S//S
SS
This class complies with standard release SRU2019
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
CFI_CODE
Component number for the CFI Code subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.String |
F_12C
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 12C
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
Constructor and Description |
---|
Field12C()
Default constructor.
|
Field12C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field12C(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 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 Field12C |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field12C object.
|
static Field12C |
get(SwiftMessage msg)
Gets the first instance of Field12C in the given message.
|
static Field12C |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field12C> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field12C in the given message
an empty list is returned if none found.
|
static java.util.List<Field12C> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field12C from the given block
an empty list is returned if none found.
|
java.lang.String |
getCFICode()
Gets the CFI Code (component2).
|
java.lang.String |
getComponent1()
Gets the component1 (Qualifier).
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2 (CFI Code).
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getConditionalQualifier()
Gets the conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition. |
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getQualifier()
Gets the Qualifier (component1).
|
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 |
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.
|
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 Field12C |
newInstance(Field12C 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
|
Field12C |
setCFICode(java.lang.String component2)
Set the CFI Code (component2).
|
Field12C |
setComponent1(java.lang.String component1)
Set the component1 (Qualifier).
|
Field12C |
setComponent2(java.lang.String component2)
Set the component2 (CFI Code).
|
Field12C |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
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 validator pattern
|
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_12C
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer CFI_CODE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field12C()
public Field12C(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field12C(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field12C newInstance(Field12C 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 fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
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
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getQualifier()
public java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getCFICode()
public Field12C setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field12C setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field12C setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field12C setCFICode(java.lang.String component2)
component2
- the CFI Code to setpublic java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
public java.lang.String getName()
public static Field12C get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field12C get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field12C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field12C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field12C fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)