@Generated public class Field90J extends Field implements java.io.Serializable, MonetaryAmountContainer, GenericField
Model and parser for field 90J of a SWIFT MT message.
Subfields (components) Data types
String
String
Currency
BigDecimal
Currency
BigDecimal
Structure definition
:4!c//4!c/<CUR><AMOUNT>15/<CUR><AMOUNT>15
:S//S/SN/SN
SSCNCN
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT1
Component number for the Amount1 subfield.
|
static java.lang.Integer |
AMOUNT2
Component number for the Amount2 subfield.
|
static java.lang.Integer |
AMOUNTTYPECODE
Component number for the AmountTypeCode subfield.
|
static java.lang.Integer |
CODE
Deprecated.
|
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_CODE1
Component number for the Currency Code1 subfield.
|
static java.lang.Integer |
CURRENCY_CODE2
Component number for the Currency Code2 subfield.
|
static java.lang.Integer |
CURRENCY1
Deprecated.
|
static java.lang.Integer |
CURRENCY2
Deprecated.
|
static java.lang.String |
F_90J
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 90J.
|
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 |
---|
Field90J()
Default constructor.
|
Field90J(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field90J(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 Field90J |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field90J object.
|
static Field90J |
get(SwiftMessage msg)
Gets the first instance of Field90J in the given message.
|
static Field90J |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field90J> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field90J in the given message
an empty list is returned if none found.
|
static java.util.List<Field90J> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field90J from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount1()
Gets the Amount1 (component 4).
|
java.math.BigDecimal |
getAmount1AsBigDecimal()
Get the Amount1 (component 4) as BigDecimal
|
java.lang.Number |
getAmount1AsNumber()
Deprecated.
|
java.lang.String |
getAmount2()
Gets the Amount2 (component 6).
|
java.math.BigDecimal |
getAmount2AsBigDecimal()
Get the Amount2 (component 6) as BigDecimal
|
java.lang.Number |
getAmount2AsNumber()
Deprecated.
|
java.lang.String |
getAmountTypeCode()
Gets the AmountTypeCode (component 2).
|
java.lang.String |
getCode()
Deprecated.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (AmountTypeCode).
|
java.lang.String |
getComponent3()
Gets the component 3 (Currency Code1).
|
java.util.Currency |
getComponent3AsCurrency()
Get the component 3 as Currency
|
java.lang.String |
getComponent4()
Gets the component 4 (Amount1).
|
java.math.BigDecimal |
getComponent4AsBigDecimal()
Get the component 4 as BigDecimal
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
java.lang.String |
getComponent5()
Gets the component 5 (Currency Code2).
|
java.util.Currency |
getComponent5AsCurrency()
Get the component 5 as Currency
|
java.lang.String |
getComponent6()
Gets the component 6 (Amount2).
|
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 |
getCurrency1()
Deprecated.
|
java.util.Currency |
getCurrency1AsCurrency()
Deprecated.
|
java.lang.String |
getCurrency2()
Deprecated.
|
java.util.Currency |
getCurrency2AsCurrency()
Deprecated.
|
java.lang.String |
getCurrencyCode1()
Gets the Currency Code1 (component 3).
|
java.util.Currency |
getCurrencyCode1AsCurrency()
Get the Currency Code1 (component 3) as Currency
|
java.lang.String |
getCurrencyCode2()
Gets the Currency Code2 (component 5).
|
java.util.Currency |
getCurrencyCode2AsCurrency()
Get the Currency Code2 (component 5) 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 Field90J |
newInstance(Field90J 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.
|
Field90J |
setAmount1(java.math.BigDecimal component4)
Set the Amount1 (component 4) from a BigDecimal object.
|
Field90J |
setAmount1(java.lang.Number component4)
Alternative method setter for field's Amount1 (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field90J |
setAmount1(java.lang.String component4)
Set the Amount1 (component 4).
|
Field90J |
setAmount2(java.math.BigDecimal component6)
Set the Amount2 (component 6) from a BigDecimal object.
|
Field90J |
setAmount2(java.lang.Number component6)
Alternative method setter for field's Amount2 (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field90J |
setAmount2(java.lang.String component6)
Set the Amount2 (component 6).
|
Field90J |
setAmountTypeCode(java.lang.String component2)
Set the AmountTypeCode (component 2).
|
Field90J |
setCode(java.lang.String component2)
Deprecated.
|
Field90J |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field90J |
setComponent2(java.lang.String component2)
Set the component 2 (AmountTypeCode).
|
Field90J |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field90J |
setComponent3(java.lang.String component3)
Set the component 3 (Currency Code1).
|
Field90J |
setComponent4(java.math.BigDecimal component4)
Set the component4 from a BigDecimal object.
|
Field90J |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Amount1 (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field90J |
setComponent4(java.lang.String component4)
Set the component 4 (Amount1).
|
Field90J |
setComponent5(java.util.Currency component5)
Set the component5 from a Currency object.
|
Field90J |
setComponent5(java.lang.String component5)
Set the component 5 (Currency Code2).
|
Field90J |
setComponent6(java.math.BigDecimal component6)
Set the component6 from a BigDecimal object.
|
Field90J |
setComponent6(java.lang.Number component6)
Alternative method setter for field's Amount2 (component 6) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field90J |
setComponent6(java.lang.String component6)
Set the component 6 (Amount2).
|
Field90J |
setCurrency1(java.util.Currency component3)
Deprecated.
|
Field90J |
setCurrency1(java.lang.String component3)
Deprecated.
|
Field90J |
setCurrency2(java.util.Currency component5)
Deprecated.
|
Field90J |
setCurrency2(java.lang.String component5)
Deprecated.
|
Field90J |
setCurrencyCode1(java.util.Currency component3)
Set the Currency Code1 (component 3) from a Currency object.
|
Field90J |
setCurrencyCode1(java.lang.String component3)
Set the Currency Code1 (component 3).
|
Field90J |
setCurrencyCode2(java.util.Currency component5)
Set the Currency Code2 (component 5) from a Currency object.
|
Field90J |
setCurrencyCode2(java.lang.String component5)
Set the Currency Code2 (component 5).
|
Field90J |
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_90J
@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 AMOUNTTYPECODE
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer CODE
AMOUNTTYPECODE
public static final java.lang.Integer CURRENCY_CODE1
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer CURRENCY1
CURRENCY_CODE1
public static final java.lang.Integer AMOUNT1
public static final java.lang.Integer CURRENCY_CODE2
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.Integer CURRENCY2
CURRENCY_CODE2
public static final java.lang.Integer AMOUNT2
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field90J()
public Field90J(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field90J(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field90J newInstance(Field90J 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()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getCode()
getAmountTypeCode()
public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getCurrencyCode1()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getCurrency1()
getCurrencyCode1()
public java.util.Currency getCurrencyCode1AsCurrency()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.util.Currency getCurrency1AsCurrency()
getCurrencyCode1AsCurrency()
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 getAmount1()
public java.math.BigDecimal getAmount1AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getAmount1AsNumber()
getComponent4AsBigDecimal()
to get the proper value.getAmount1AsBigDecimal()
public java.lang.String getComponent5()
public java.util.Currency getComponent5AsCurrency()
public java.lang.String getCurrencyCode2()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String getCurrency2()
getCurrencyCode2()
public java.util.Currency getCurrencyCode2AsCurrency()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.util.Currency getCurrency2AsCurrency()
getCurrencyCode2AsCurrency()
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 getAmount2()
public java.math.BigDecimal getAmount2AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getAmount2AsNumber()
getComponent6AsBigDecimal()
to get the proper value.getAmount2AsBigDecimal()
public Field90J setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field90J setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field90J setComponent2(java.lang.String component2)
component2
- the AmountTypeCode to setpublic Field90J setAmountTypeCode(java.lang.String component2)
component2
- the AmountTypeCode to set@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90J setCode(java.lang.String component2)
component2
- the AmountTypeCode to setsetAmountTypeCode(String)
public Field90J setComponent3(java.lang.String component3)
component3
- the Currency Code1 to setpublic Field90J setComponent3(java.util.Currency component3)
component3
- the Currency with the Currency Code1 content to setpublic Field90J setCurrencyCode1(java.lang.String component3)
component3
- the Currency Code1 to setpublic Field90J setCurrencyCode1(java.util.Currency component3)
component3
- Currency with the Currency Code1 content to setsetComponent3(java.util.Currency)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90J setCurrency1(java.lang.String component3)
component3
- the Currency Code1 to setsetCurrencyCode1(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90J setCurrency1(java.util.Currency component3)
component3
- Currency with the Currency Code1 content to setsetComponent3(java.util.Currency)
public Field90J setComponent4(java.lang.String component4)
component4
- the Amount1 to setpublic Field90J setComponent4(java.math.BigDecimal component4)
component4
- the BigDecimal with the Amount1 content to setpublic Field90J setComponent4(java.lang.Number component4)
component4
- the Number with the Amount1 content to setsetAmount1(java.math.BigDecimal)
public Field90J setAmount1(java.lang.String component4)
component4
- the Amount1 to setpublic Field90J setAmount1(java.math.BigDecimal component4)
component4
- BigDecimal with the Amount1 content to setsetComponent4(java.math.BigDecimal)
public Field90J setAmount1(java.lang.Number component4)
component4
- the Number with the Amount1 content to setsetAmount1(java.math.BigDecimal)
public Field90J setComponent5(java.lang.String component5)
component5
- the Currency Code2 to setpublic Field90J setComponent5(java.util.Currency component5)
component5
- the Currency with the Currency Code2 content to setpublic Field90J setCurrencyCode2(java.lang.String component5)
component5
- the Currency Code2 to setpublic Field90J setCurrencyCode2(java.util.Currency component5)
component5
- Currency with the Currency Code2 content to setsetComponent5(java.util.Currency)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90J setCurrency2(java.lang.String component5)
component5
- the Currency Code2 to setsetCurrencyCode2(String)
@Deprecated @ProwideDeprecated(phase3=SRU2023) public Field90J setCurrency2(java.util.Currency component5)
component5
- Currency with the Currency Code2 content to setsetComponent5(java.util.Currency)
public Field90J setComponent6(java.lang.String component6)
component6
- the Amount2 to setpublic Field90J setComponent6(java.math.BigDecimal component6)
component6
- the BigDecimal with the Amount2 content to setpublic Field90J setComponent6(java.lang.Number component6)
component6
- the Number with the Amount2 content to setsetAmount2(java.math.BigDecimal)
public Field90J setAmount2(java.lang.String component6)
component6
- the Amount2 to setpublic Field90J setAmount2(java.math.BigDecimal component6)
component6
- BigDecimal with the Amount2 content to setsetComponent6(java.math.BigDecimal)
public Field90J setAmount2(java.lang.Number component6)
component6
- the Number with the Amount2 content to setsetAmount2(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 Field90J get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field90J get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field90J> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field90J> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field90J fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)