@Generated public class Field92J extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
Model and parser for field 92J of a SWIFT MT message.
Subfields (components) Data types
StringStringStringCurrencyNumberStringStructure definition
:4!c/[8c]/4!c/<CUR><AMOUNT>15[/4!c]:S/[S]/S/SN[/S]SSSCNSThis class complies with standard release SRU2020
| Modifier and Type | Field and Description |
|---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield
|
static java.lang.Integer |
CODE
Component number for the Code subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield
|
static java.lang.Integer |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield
|
static java.lang.String |
F_92J
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 92J
|
static java.lang.Integer |
NARRATIVE
Deprecated.
use RATE_STATUS instead
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static java.lang.Integer |
RATE_STATUS
Component number for the Rate Status subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components| Constructor and Description |
|---|
Field92J()
Default constructor.
|
Field92J(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field92J(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()
Get the first amount in this field.
|
java.util.List<java.math.BigDecimal> |
amounts() |
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. |
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
Shorthand for
new Tag(NAME, "") |
static Field92J |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field92J object.
|
static Field92J |
get(SwiftMessage msg)
Gets the first instance of Field92J in the given message.
|
static Field92J |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field92J> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field92J in the given message
an empty list is returned if none found.
|
static java.util.List<Field92J> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field92J from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 5).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component 5) as Number
|
java.lang.String |
getCode()
Gets the Code (component 3).
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (Data Source Scheme).
|
java.lang.String |
getComponent3()
Gets the component 3 (Code).
|
java.lang.String |
getComponent4()
Gets the component 4 (Currency).
|
java.util.Currency |
getComponent4AsCurrency()
Get the component 4 as Currency
|
java.lang.String |
getComponent5()
Gets the component 5 (Amount).
|
java.lang.Number |
getComponent5AsNumber()
Get the component 5 as Number
|
java.lang.String |
getComponent6()
Gets the component 6 (Rate Status).
|
protected 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()
Gets the Currency (component 4).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component 4) as Currency
|
java.lang.String |
getDataSourceScheme()
Gets the Data Source Scheme (component 2).
|
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 |
getNarrative()
Deprecated.
use getRateStatus instead
|
java.lang.String |
getQualifier()
Gets the Qualifier (component 1).
|
java.lang.String |
getRateStatus()
Gets the Rate Status (component 6).
|
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 Field92J |
newInstance(Field92J 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
|
Field92J |
setAmount(java.lang.Number component5)
Set the Amount (component5) from a Number object.
|
Field92J |
setAmount(java.lang.String component5)
Set the Amount (component5).
|
Field92J |
setCode(java.lang.String component3)
Set the Code (component3).
|
Field92J |
setComponent1(java.lang.String component1)
Set the component1 (Qualifier).
|
Field92J |
setComponent2(java.lang.String component2)
Set the component2 (Data Source Scheme).
|
Field92J |
setComponent3(java.lang.String component3)
Set the component3 (Code).
|
Field92J |
setComponent4(java.util.Currency component4)
Set the component4 from a Currency object.
|
Field92J |
setComponent4(java.lang.String component4)
Set the component4 (Currency).
|
Field92J |
setComponent5(java.lang.Number component5)
Set the component5 from a Number object.
|
Field92J |
setComponent5(java.lang.String component5)
Set the component5 (Amount).
|
Field92J |
setComponent6(java.lang.String component6)
Set the component6 (Rate Status).
|
Field92J |
setCurrency(java.util.Currency component4)
Set the Currency (component4) from a Currency object.
|
Field92J |
setCurrency(java.lang.String component4)
Set the Currency (component4).
|
Field92J |
setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component2).
|
Field92J |
setNarrative(java.lang.String narrative)
Deprecated.
use setRateStatus instead
|
Field92J |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field92J |
setRateStatus(java.lang.String component6)
Set the Rate Status (component6).
|
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
|
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, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_92J
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 DATA_SOURCE_SCHEME
public static final java.lang.Integer CODE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer RATE_STATUS
public static final java.lang.Integer CONDITIONAL_QUALIFIER
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer NARRATIVE
public Field92J()
public Field92J(java.lang.String value)
value - complete field value including separators and CRLFpublic Field92J(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic static Field92J newInstance(Field92J source)
source - a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic 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 Fieldcomponent - 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 PatternContainercomponentsPattern in class Fieldpublic final java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic final java.lang.String validatorPattern()
validatorPattern in class Fieldpublic boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize in class Fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap in class Fieldpublic java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.lang.String getDataSourceScheme()
public java.lang.String getComponent3()
public java.lang.String getCode()
public java.lang.String getComponent4()
public java.util.Currency getComponent4AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public java.lang.String getComponent5()
public java.lang.Number getComponent5AsNumber()
public java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
public java.lang.String getComponent6()
public java.lang.String getRateStatus()
public java.util.List<java.lang.String> currencyStrings()
CurrencyContainercurrencyStrings in interface CurrencyContainerpublic java.util.List<java.util.Currency> currencies()
CurrencyContainerCurrencyContainer.currencyStrings()currencies in interface CurrencyContainerpublic java.util.Currency currency()
CurrencyContainerCurrencyContainer.currencyString()currency in interface CurrencyContainerCurrencyContainer.currencyStrings(),
CurrencyContainer.currencyString()public java.lang.String currencyString()
CurrencyContainercurrencyString in interface CurrencyContainerpublic void initializeCurrencies(java.lang.String cur)
CurrencyContainerinitializeCurrencies in interface CurrencyContainerpublic void initializeCurrencies(java.util.Currency cur)
initializeCurrencies in interface CurrencyContainerCurrencyContainer.initializeCurrencies(String)public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)public java.math.BigDecimal amount()
AmountContaineramount in interface AmountContainerAmountResolver.amount(Field)public Field92J setComponent1(java.lang.String component1)
component1 - the component1 to setpublic Field92J setQualifier(java.lang.String component1)
component1 - the Qualifier to setpublic Field92J setComponent2(java.lang.String component2)
component2 - the component2 to setpublic Field92J setDataSourceScheme(java.lang.String component2)
component2 - the Data Source Scheme to setpublic Field92J setComponent3(java.lang.String component3)
component3 - the component3 to setpublic Field92J setCode(java.lang.String component3)
component3 - the Code to setpublic Field92J setComponent4(java.lang.String component4)
component4 - the component4 to setpublic Field92J setComponent4(java.util.Currency component4)
component4 - the Currency with the component4 content to setpublic Field92J setCurrency(java.lang.String component4)
component4 - the Currency to setpublic Field92J setCurrency(java.util.Currency component4)
component4 - Currency with the Currency content to setsetComponent4(java.util.Currency)public Field92J setComponent5(java.lang.String component5)
component5 - the component5 to setpublic Field92J setComponent5(java.lang.Number component5)
component5 - the Number with the component5 content to setpublic Field92J setAmount(java.lang.String component5)
component5 - the Amount to setpublic Field92J setAmount(java.lang.Number component5)
component5 - Number with the Amount content to setsetComponent5(java.lang.Number)public Field92J setComponent6(java.lang.String component6)
component6 - the component6 to setpublic Field92J setRateStatus(java.lang.String component6)
component6 - the Rate Status to setpublic java.lang.String getDSS()
getDSS in interface GenericFieldgetDSS in class Fieldpublic boolean isDSSPresent()
isDSSPresent in interface GenericFieldisDSSPresent in class FieldgetDSS()public java.lang.String getConditionalQualifier()
getConditionalQualifier in interface GenericFieldgetConditionalQualifier in class Fieldpublic java.lang.String getName()
public static Field92J get(SwiftTagListBlock block)
block - may be null or emptypublic static Field92J get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field92J> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field92J> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic static Field92J fromJson(java.lang.String json)
json - JSON structure including tuples with label and value for all field componentsField.fromJson(String)@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getNarrative()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field92J setNarrative(java.lang.String narrative)