@Generated public class Field90B extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
Model and parser for field 90B of a SWIFT MT message.
Subfields (components) Data types
String
String
Currency
Number
Structure definition
:4!c//4!c/<CUR><AMOUNT>15
:S//S/SN
SSCN
This class complies with standard release SRU2018
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT_TYPE_CODE
Component number for the Amount Type 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.String |
F_90B
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 90B
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PRICE
Component number for the Price subfield
|
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field90B()
Default constructor.
|
Field90B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field90B(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's 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 Field90B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field90B object.
|
static Field90B |
get(SwiftMessage msg)
Gets the first instance of Field90B in the given message.
|
static Field90B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field90B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field90B in the given message
an empty list is returned if none found.
|
static java.util.List<Field90B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field90B from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmountTypeCode()
Gets the Amount Type Code (component2).
|
java.lang.String |
getComponent1()
Gets the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Gets the component3
|
java.util.Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
java.lang.String |
getComponent4()
Gets the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 as Number
|
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 conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition. |
java.lang.String |
getCurrency()
Gets the Currency (component3).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component3) 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 |
getPrice()
Gets the Price (component4).
|
java.lang.Number |
getPriceAsNumber()
Get the Price (component4) as Number
|
java.lang.String |
getQualifier()
Gets the Qualifier (component1).
|
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 Field90B |
newInstance(Field90B 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() |
Field90B |
setAmountTypeCode(java.lang.String component2)
Set the Amount Type Code (component2).
|
Field90B |
setComponent1(java.lang.String component1)
Set the component1.
|
Field90B |
setComponent2(java.lang.String component2)
Set the component2.
|
Field90B |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field90B |
setComponent3(java.lang.String component3)
Set the component3.
|
Field90B |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field90B |
setComponent4(java.lang.String component4)
Set the component4.
|
Field90B |
setCurrency(java.util.Currency component3)
Set the Currency (component3) from a Currency object.
|
Field90B |
setCurrency(java.lang.String component3)
Set the Currency (component3).
|
Field90B |
setPrice(java.lang.Number component4)
Set the Price (component4) from a Number object.
|
Field90B |
setPrice(java.lang.String component4)
Set the Price (component4).
|
Field90B |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
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's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, 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_90B
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 AMOUNT_TYPE_CODE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer PRICE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field90B()
public Field90B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field90B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field90B newInstance(Field90B source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getQualifier()
public Field90B setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field90B setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase3=_2019) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getAmountTypeCode()
public Field90B setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field90B setAmountTypeCode(java.lang.String component2)
component2
- the Amount Type Code to setpublic java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public Field90B setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field90B setComponent3(java.util.Currency component3)
component3
- the Currency with the component3 content to setpublic Field90B setCurrency(java.lang.String component3)
component3
- the Currency to setpublic Field90B setCurrency(java.util.Currency component3)
component3
- Currency with the Currency content to setsetComponent3(java.util.Currency)
public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
public java.lang.String getPrice()
public java.lang.Number getPriceAsNumber()
public Field90B setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field90B setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setpublic Field90B setPrice(java.lang.String component4)
component4
- the Price to setpublic Field90B setPrice(java.lang.Number component4)
component4
- Number with the Price content to setsetComponent4(java.lang.Number)
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()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
AmountResolver.amount(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 java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field90B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field90B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field90B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field90B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected 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 static Field90B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)