@Generated public class Field11A extends Field implements java.io.Serializable, CurrencyContainer, GenericField
Model and parser for field 11A of a SWIFT MT message.
Subfields (components) Data types
String
Currency
Structure definition
:4!c//<CUR>
:S//S
SC
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.
|
static java.lang.Integer |
CURRENCY
Deprecated.
|
static java.lang.Integer |
CURRENCY_CODE
Component number for the Currency Code subfield.
|
static java.lang.String |
F_11A
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 11A.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field11A()
Default constructor.
|
Field11A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field11A(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. |
java.util.List<java.util.Currency> |
currencies()
Utility method that creates a Currency for every string returned by
CurrencyContainer.currencyStrings() |
java.util.Currency |
currency()
Analog to
CurrencyContainer.currencyString() |
java.lang.String |
currencyString()
Get the single currency contained in this field.
|
java.util.List<java.lang.String> |
currencyStrings()
Get a list of strings of currencies present in this field
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field11A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field11A object.
|
static Field11A |
get(SwiftMessage msg)
Gets the first instance of Field11A in the given message.
|
static Field11A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field11A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field11A in the given message
an empty list is returned if none found.
|
static java.util.List<Field11A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field11A from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (Currency Code).
|
java.util.Currency |
getComponent2AsCurrency()
Get the component 2 as Currency
|
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 |
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.
|
java.lang.String |
getCurrency()
Deprecated.
|
java.util.Currency |
getCurrencyAsCurrency()
Deprecated.
|
java.lang.String |
getCurrencyCode()
Gets the Currency Code (component 2).
|
java.util.Currency |
getCurrencyCodeAsCurrency()
Get the Currency Code (component 2) as Currency
|
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 (component 1).
|
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.
|
void |
initializeCurrencies(java.util.Currency cur) |
void |
initializeCurrencies(java.lang.String cur)
Set the currency of this field.
|
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 Field11A |
newInstance(Field11A 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.
|
Field11A |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field11A |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field11A |
setComponent2(java.lang.String component2)
Set the component 2 (Currency Code).
|
Field11A |
setCurrency(java.util.Currency component2)
Deprecated.
|
Field11A |
setCurrency(java.lang.String component2)
Deprecated.
|
Field11A |
setCurrencyCode(java.util.Currency component2)
Set the Currency Code (component 2) from a Currency object.
|
Field11A |
setCurrencyCode(java.lang.String component2)
Set the Currency Code (component 2).
|
Field11A |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
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_11A
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer CURRENCY_CODE
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer CURRENCY
CURRENCY_CODE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field11A()
public Field11A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field11A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field11A newInstance(Field11A 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 java.lang.String componentsPattern()
typesPattern()
instead.Field
typesPattern()
instead.componentsPattern
in class Field
Field.typesPattern()
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 getQualifier()
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
public java.lang.String getCurrencyCode()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getCurrency()
getCurrencyCode()
public java.util.Currency getCurrencyCodeAsCurrency()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.util.Currency getCurrencyAsCurrency()
getCurrencyCodeAsCurrency()
public Field11A setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field11A setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field11A setComponent2(java.lang.String component2)
component2
- the Currency Code to setpublic Field11A setComponent2(java.util.Currency component2)
component2
- the Currency with the Currency Code content to setpublic Field11A setCurrencyCode(java.lang.String component2)
component2
- the Currency Code to setpublic Field11A setCurrencyCode(java.util.Currency component2)
component2
- Currency with the Currency Code content to setsetComponent2(java.util.Currency)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field11A setCurrency(java.lang.String component2)
component2
- the Currency Code to setsetCurrencyCode(String)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field11A setCurrency(java.util.Currency component2)
component2
- Currency with the Currency Code content to setsetComponent2(java.util.Currency)
public java.util.List<java.lang.String> currencyStrings()
CurrencyContainer
currencyStrings
in interface CurrencyContainer
public java.util.List<java.util.Currency> currencies()
CurrencyContainer
CurrencyContainer.currencyStrings()
currencies
in interface CurrencyContainer
public java.util.Currency currency()
CurrencyContainer
CurrencyContainer.currencyString()
currency
in interface CurrencyContainer
CurrencyContainer.currencyStrings()
,
CurrencyContainer.currencyString()
public java.lang.String currencyString()
CurrencyContainer
currencyString
in interface CurrencyContainer
public void initializeCurrencies(java.lang.String cur)
CurrencyContainer
initializeCurrencies
in interface CurrencyContainer
public void initializeCurrencies(java.util.Currency cur)
initializeCurrencies
in interface CurrencyContainer
CurrencyContainer.initializeCurrencies(String)
public java.lang.String getDSS()
getDSS
in interface GenericField
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
public java.lang.String getName()
public static Field11A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field11A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field11A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field11A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field11A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)