@Generated public class Field90F extends Field implements java.io.Serializable, MonetaryAmountContainer, GenericField
Model and parser for field 90F of a SWIFT MT message.
Subfields (components) Data types
String
String
Currency
BigDecimal
String
BigDecimal
Structure definition
:4!c//4!c/<CUR><AMOUNT>15/4!c/<AMOUNT>15
:S//S/SN/S/N
SSCNSN
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield.
|
static java.lang.Integer |
AMOUNT_TYPE_CODE
Component number for the Amount Type Code subfield.
|
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_90F
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 90F.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield.
|
static java.lang.Integer |
QUANTITY
Component number for the Quantity subfield.
|
static java.lang.Integer |
QUANTITY_TYPE_CODE
Component number for the Quantity Type Code 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 |
---|
Field90F()
Default constructor.
|
Field90F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field90F(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
amount()
Returns the first amounts as BigDecimal
|
java.util.List<java.math.BigDecimal> |
amounts()
Returns the list of all NON-NULL amounts as BigDecimal
|
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 Field90F |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field90F object.
|
static Field90F |
get(SwiftMessage msg)
Gets the first instance of Field90F in the given message.
|
static Field90F |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field90F> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field90F in the given message
an empty list is returned if none found.
|
static java.util.List<Field90F> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field90F from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 4).
|
java.math.BigDecimal |
getAmountAsBigDecimal()
Get the Amount (component 4) as BigDecimal
|
java.lang.Number |
getAmountAsNumber()
Deprecated.
|
java.lang.String |
getAmountTypeCode()
Gets the Amount Type Code (component 2).
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (Amount Type Code).
|
java.lang.String |
getComponent3()
Gets the component 3 (Currency Code).
|
java.util.Currency |
getComponent3AsCurrency()
Get the component 3 as Currency
|
java.lang.String |
getComponent4()
Gets the component 4 (Amount).
|
java.math.BigDecimal |
getComponent4AsBigDecimal()
Get the component 4 as BigDecimal
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
java.lang.String |
getComponent5()
Gets the component 5 (Quantity Type Code).
|
java.lang.String |
getComponent6()
Gets the component 6 (Quantity).
|
java.math.BigDecimal |
getComponent6AsBigDecimal()
Get the component 6 as BigDecimal
|
java.lang.Number |
getComponent6AsNumber()
Deprecated.
|
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 3).
|
java.util.Currency |
getCurrencyCodeAsCurrency()
Get the Currency Code (component 3) 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 |
getQuantity()
Gets the Quantity (component 6).
|
java.math.BigDecimal |
getQuantityAsBigDecimal()
Get the Quantity (component 6) as BigDecimal
|
java.lang.Number |
getQuantityAsNumber()
Deprecated.
|
java.lang.String |
getQuantityTypeCode()
Gets the Quantity Type Code (component 5).
|
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 Field90F |
newInstance(Field90F 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.
|
Field90F |
setAmount(java.math.BigDecimal component4)
Set the Amount (component 4) from a BigDecimal object.
|
Field90F |
setAmount(java.lang.Number component4)
Alternative method setter for field's Amount (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field90F |
setAmount(java.lang.String component4)
Set the Amount (component 4).
|
Field90F |
setAmountTypeCode(java.lang.String component2)
Set the Amount Type Code (component 2).
|
Field90F |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field90F |
setComponent2(java.lang.String component2)
Set the component 2 (Amount Type Code).
|
Field90F |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field90F |
setComponent3(java.lang.String component3)
Set the component 3 (Currency Code).
|
Field90F |
setComponent4(java.math.BigDecimal component4)
Set the component4 from a BigDecimal object.
|
Field90F |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Amount (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field90F |
setComponent4(java.lang.String component4)
Set the component 4 (Amount).
|
Field90F |
setComponent5(java.lang.String component5)
Set the component 5 (Quantity Type Code).
|
Field90F |
setComponent6(java.math.BigDecimal component6)
Set the component6 from a BigDecimal object.
|
Field90F |
setComponent6(java.lang.Number component6)
Alternative method setter for field's Quantity (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field90F |
setComponent6(java.lang.String component6)
Set the component 6 (Quantity).
|
Field90F |
setCurrency(java.util.Currency component3)
Deprecated.
|
Field90F |
setCurrency(java.lang.String component3)
Deprecated.
|
Field90F |
setCurrencyCode(java.util.Currency component3)
Set the Currency Code (component 3) from a Currency object.
|
Field90F |
setCurrencyCode(java.lang.String component3)
Set the Currency Code (component 3).
|
Field90F |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
Field90F |
setQuantity(java.math.BigDecimal component6)
Set the Quantity (component 6) from a BigDecimal object.
|
Field90F |
setQuantity(java.lang.Number component6)
Alternative method setter for field's Quantity (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field90F |
setQuantity(java.lang.String component6)
Set the Quantity (component 6).
|
Field90F |
setQuantityTypeCode(java.lang.String component5)
Set the Quantity Type Code (component 5).
|
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_90F
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer AMOUNT_TYPE_CODE
public static final java.lang.Integer CURRENCY_CODE
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer CURRENCY
CURRENCY_CODE
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer QUANTITY_TYPE_CODE
public static final java.lang.Integer QUANTITY
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field90F()
public Field90F(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field90F(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field90F newInstance(Field90F 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(phase3=SRU2023) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
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.lang.String getAmountTypeCode()
public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getCurrencyCode()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getCurrency()
getCurrencyCode()
public java.util.Currency getCurrencyCodeAsCurrency()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.util.Currency getCurrencyAsCurrency()
getCurrencyCodeAsCurrency()
public java.lang.String getComponent4()
public java.math.BigDecimal getComponent4AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent4AsNumber()
getComponent4AsBigDecimal()
to get the proper value.getComponent4AsBigDecimal()
public java.lang.String getAmount()
public java.math.BigDecimal getAmountAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getAmountAsNumber()
getComponent4AsBigDecimal()
to get the proper value.getAmountAsBigDecimal()
public java.lang.String getComponent5()
public java.lang.String getQuantityTypeCode()
public java.lang.String getComponent6()
public java.math.BigDecimal getComponent6AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent6AsNumber()
getComponent6AsBigDecimal()
to get the proper value.getComponent6AsBigDecimal()
public java.lang.String getQuantity()
public java.math.BigDecimal getQuantityAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getQuantityAsNumber()
getComponent6AsBigDecimal()
to get the proper value.getQuantityAsBigDecimal()
public Field90F setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field90F setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field90F setComponent2(java.lang.String component2)
component2
- the Amount Type Code to setpublic Field90F setAmountTypeCode(java.lang.String component2)
component2
- the Amount Type Code to setpublic Field90F setComponent3(java.lang.String component3)
component3
- the Currency Code to setpublic Field90F setComponent3(java.util.Currency component3)
component3
- the Currency with the Currency Code content to setpublic Field90F setCurrencyCode(java.lang.String component3)
component3
- the Currency Code to setpublic Field90F setCurrencyCode(java.util.Currency component3)
component3
- Currency with the Currency Code content to setsetComponent3(java.util.Currency)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90F setCurrency(java.lang.String component3)
component3
- the Currency Code to setsetCurrencyCode(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90F setCurrency(java.util.Currency component3)
component3
- Currency with the Currency Code content to setsetComponent3(java.util.Currency)
public Field90F setComponent4(java.lang.String component4)
component4
- the Amount to setpublic Field90F setComponent4(java.math.BigDecimal component4)
component4
- the BigDecimal with the Amount content to setpublic Field90F setComponent4(java.lang.Number component4)
component4
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field90F setAmount(java.lang.String component4)
component4
- the Amount to setpublic Field90F setAmount(java.math.BigDecimal component4)
component4
- BigDecimal with the Amount content to setsetComponent4(java.math.BigDecimal)
public Field90F setAmount(java.lang.Number component4)
component4
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field90F setComponent5(java.lang.String component5)
component5
- the Quantity Type Code to setpublic Field90F setQuantityTypeCode(java.lang.String component5)
component5
- the Quantity Type Code to setpublic Field90F setComponent6(java.lang.String component6)
component6
- the Quantity to setpublic Field90F setComponent6(java.math.BigDecimal component6)
component6
- the BigDecimal with the Quantity content to setpublic Field90F setComponent6(java.lang.Number component6)
component6
- the Number with the Quantity content to setsetQuantity(java.math.BigDecimal)
public Field90F setQuantity(java.lang.String component6)
component6
- the Quantity to setpublic Field90F setQuantity(java.math.BigDecimal component6)
component6
- BigDecimal with the Quantity content to setsetComponent6(java.math.BigDecimal)
public Field90F setQuantity(java.lang.Number component6)
component6
- the Number with the Quantity content to setsetQuantity(java.math.BigDecimal)
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.util.List<java.math.BigDecimal> amounts()
MonetaryAmountResolver.amounts(Field)
public java.math.BigDecimal amount()
amount
in interface AmountContainer
MonetaryAmountResolver.amount(Field)
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 Field90F get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field90F get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field90F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field90F> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field90F fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)