@Generated public class Field92B extends Field implements java.io.Serializable, MonetaryAmountContainer, GenericField
Model and parser for field 92B of a SWIFT MT message.
Subfields (components) Data types
String
Currency
Currency
BigDecimal
Structure definition
:4!c//<CUR>/<CUR>/<AMOUNT>15
:S//S/S/N
SCCN
This class complies with standard release SRU2023
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.String |
F_92B
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
FIRST_CURRENCY_CODE
Component number for the First Currency Code subfield.
|
static java.lang.String |
NAME
Constant with the field name 92B.
|
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 |
RATE
Component number for the Rate subfield.
|
static java.lang.Integer |
SECOND_CURRENCY_CODE
Component number for the Second Currency 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, labelMap
Constructor and Description |
---|
Field92B()
Default constructor.
|
Field92B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field92B(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 Field92B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field92B object.
|
static Field92B |
get(SwiftMessage msg)
Gets the first instance of Field92B in the given message.
|
static Field92B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field92B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field92B in the given message
an empty list is returned if none found.
|
static java.util.List<Field92B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field92B 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 (First Currency Code).
|
java.util.Currency |
getComponent2AsCurrency()
Get the component 2 as Currency
|
java.lang.String |
getComponent3()
Gets the component 3 (Second Currency Code).
|
java.util.Currency |
getComponent3AsCurrency()
Get the component 3 as Currency
|
java.lang.String |
getComponent4()
Gets the component 4 (Rate).
|
java.math.BigDecimal |
getComponent4AsBigDecimal()
Get the component 4 as BigDecimal
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
use #getComponent4AsBigDecimal() instead
|
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 |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getFirstCurrencyCode()
Gets the First Currency Code (component 2).
|
java.util.Currency |
getFirstCurrencyCodeAsCurrency()
Get the First Currency Code (component 2) as Currency
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
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 |
getRate()
Gets the Rate (component 4).
|
java.math.BigDecimal |
getRateAsBigDecimal()
Get the Rate (component 4) as BigDecimal
|
java.lang.Number |
getRateAsNumber()
Deprecated.
use #getRateAsBigDecimal() instead
|
java.lang.String |
getSecondCurrencyCode()
Gets the Second Currency Code (component 3).
|
java.util.Currency |
getSecondCurrencyCodeAsCurrency()
Get the Second Currency Code (component 3) as Currency
|
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 Field92B |
newInstance(Field92B 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.
|
Field92B |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field92B |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field92B |
setComponent2(java.lang.String component2)
Set the component 2 (First Currency Code).
|
Field92B |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field92B |
setComponent3(java.lang.String component3)
Set the component 3 (Second Currency Code).
|
Field92B |
setComponent4(java.math.BigDecimal component4)
Set the component4 from a BigDecimal object.
|
Field92B |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Rate (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field92B |
setComponent4(java.lang.String component4)
Set the component 4 (Rate).
|
Field92B |
setFirstCurrencyCode(java.util.Currency component2)
Set the First Currency Code (component 2) from a Currency object.
|
Field92B |
setFirstCurrencyCode(java.lang.String component2)
Set the First Currency Code (component 2).
|
Field92B |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
Field92B |
setRate(java.math.BigDecimal component4)
Set the Rate (component 4) from a BigDecimal object.
|
Field92B |
setRate(java.lang.Number component4)
Alternative method setter for field's Rate (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field92B |
setRate(java.lang.String component4)
Set the Rate (component 4).
|
Field92B |
setSecondCurrencyCode(java.util.Currency component3)
Set the Second Currency Code (component 3) from a Currency object.
|
Field92B |
setSecondCurrencyCode(java.lang.String component3)
Set the Second Currency Code (component 3).
|
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_92B
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer FIRST_CURRENCY_CODE
public static final java.lang.Integer SECOND_CURRENCY_CODE
public static final java.lang.Integer RATE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field92B()
public Field92B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field92B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field92B newInstance(Field92B 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(phase4=SRU2024) 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
public java.lang.String getFirstCurrencyCode()
public java.util.Currency getFirstCurrencyCodeAsCurrency()
public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getSecondCurrencyCode()
public java.util.Currency getSecondCurrencyCodeAsCurrency()
public java.lang.String getComponent4()
public java.math.BigDecimal getComponent4AsBigDecimal()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent4AsNumber()
public java.lang.String getRate()
public java.math.BigDecimal getRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getRateAsNumber()
public Field92B setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field92B setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field92B setComponent2(java.lang.String component2)
component2
- the First Currency Code to setpublic Field92B setComponent2(java.util.Currency component2)
component2
- the Currency with the First Currency Code content to setpublic Field92B setFirstCurrencyCode(java.lang.String component2)
component2
- the First Currency Code to setpublic Field92B setFirstCurrencyCode(java.util.Currency component2)
component2
- Currency with the First Currency Code content to setsetComponent2(java.util.Currency)
public Field92B setComponent3(java.lang.String component3)
component3
- the Second Currency Code to setpublic Field92B setComponent3(java.util.Currency component3)
component3
- the Currency with the Second Currency Code content to setpublic Field92B setSecondCurrencyCode(java.lang.String component3)
component3
- the Second Currency Code to setpublic Field92B setSecondCurrencyCode(java.util.Currency component3)
component3
- Currency with the Second Currency Code content to setsetComponent3(java.util.Currency)
public Field92B setComponent4(java.lang.String component4)
component4
- the Rate to setpublic Field92B setComponent4(java.math.BigDecimal component4)
component4
- the BigDecimal with the Rate content to setpublic Field92B setComponent4(java.lang.Number component4)
component4
- the Number with the Rate content to setsetRate(java.math.BigDecimal)
public Field92B setRate(java.lang.String component4)
component4
- the Rate to setpublic Field92B setRate(java.math.BigDecimal component4)
component4
- BigDecimal with the Rate content to setsetComponent4(java.math.BigDecimal)
public Field92B setRate(java.lang.Number component4)
component4
- the Number with the Rate content to setsetRate(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 Field92B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field92B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field92B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field92B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field92B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)