@Generated public class Field93F extends Field implements java.io.Serializable, AmountContainer, GenericField
Model and parser for field 93F of a SWIFT MT message.
Subfields (components) Data types
String
String
String
String
BigDecimal
Structure definition
:4!c/[8c]/4!c/[<N>]<AMOUNT>30
:S/[S]/S/[S]N
SSSSN
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
BALANCE_OF_DIGITAL_TOKENS
Component number for the Balance of Digital Tokens 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 |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield.
|
static java.lang.String |
F_93F
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 93F.
|
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_TYPE_CODE
Component number for the Quantity Type Code subfield.
|
static java.lang.Integer |
SIGN
Component number for the Sign 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 |
---|
Field93F()
Default constructor.
|
Field93F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field93F(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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field93F |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field93F object.
|
static Field93F |
get(SwiftMessage msg)
Gets the first instance of Field93F in the given message.
|
static Field93F |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field93F> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field93F in the given message
an empty list is returned if none found.
|
static java.util.List<Field93F> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field93F from the given block
an empty list is returned if none found.
|
java.lang.String |
getBalanceofDigitalTokens()
Gets the Balance of Digital Tokens (component 5).
|
java.math.BigDecimal |
getBalanceofDigitalTokensAsBigDecimal()
Get the Balance of Digital Tokens (component 5) as BigDecimal
|
java.lang.Number |
getBalanceofDigitalTokensAsNumber()
Deprecated.
|
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 (Quantity Type Code).
|
java.lang.String |
getComponent4()
Gets the component 4 (Sign).
|
java.lang.String |
getComponent5()
Gets the component 5 (Balance of Digital Tokens).
|
java.math.BigDecimal |
getComponent5AsBigDecimal()
Get the component 5 as BigDecimal
|
java.lang.Number |
getComponent5AsNumber()
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 |
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 |
getQualifier()
Gets the Qualifier (component 1).
|
java.lang.String |
getQuantityTypeCode()
Gets the Quantity Type Code (component 3).
|
java.lang.String |
getSign()
Gets the Sign (component 4).
|
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.
|
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 Field93F |
newInstance(Field93F 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.
|
Field93F |
setBalanceofDigitalTokens(java.math.BigDecimal component5)
Set the Balance of Digital Tokens (component 5) from a BigDecimal object.
|
Field93F |
setBalanceofDigitalTokens(java.lang.Number component5)
Alternative method setter for field's Balance of Digital Tokens (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field93F |
setBalanceofDigitalTokens(java.lang.String component5)
Set the Balance of Digital Tokens (component 5).
|
Field93F |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field93F |
setComponent2(java.lang.String component2)
Set the component 2 (Data Source Scheme).
|
Field93F |
setComponent3(java.lang.String component3)
Set the component 3 (Quantity Type Code).
|
Field93F |
setComponent4(java.lang.String component4)
Set the component 4 (Sign).
|
Field93F |
setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.
|
Field93F |
setComponent5(java.lang.Number component5)
Alternative method setter for field's Balance of Digital Tokens (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field93F |
setComponent5(java.lang.String component5)
Set the component 5 (Balance of Digital Tokens).
|
Field93F |
setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component 2).
|
Field93F |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
Field93F |
setQuantityTypeCode(java.lang.String component3)
Set the Quantity Type Code (component 3).
|
Field93F |
setSign(java.lang.String component4)
Set the Sign (component 4).
|
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_93F
@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 DATA_SOURCE_SCHEME
public static final java.lang.Integer QUANTITY_TYPE_CODE
public static final java.lang.Integer SIGN
public static final java.lang.Integer BALANCE_OF_DIGITAL_TOKENS
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field93F()
public Field93F(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field93F(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field93F newInstance(Field93F 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 getDataSourceScheme()
public java.lang.String getComponent3()
public java.lang.String getQuantityTypeCode()
public java.lang.String getComponent4()
public java.lang.String getSign()
public java.lang.String getComponent5()
public java.math.BigDecimal getComponent5AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent5AsNumber()
getComponent5AsBigDecimal()
to get the proper value.getComponent5AsBigDecimal()
public java.lang.String getBalanceofDigitalTokens()
public java.math.BigDecimal getBalanceofDigitalTokensAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getBalanceofDigitalTokensAsNumber()
getComponent5AsBigDecimal()
to get the proper value.getBalanceofDigitalTokensAsBigDecimal()
public Field93F setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field93F setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field93F setComponent2(java.lang.String component2)
component2
- the Data Source Scheme to setpublic Field93F setDataSourceScheme(java.lang.String component2)
component2
- the Data Source Scheme to setpublic Field93F setComponent3(java.lang.String component3)
component3
- the Quantity Type Code to setpublic Field93F setQuantityTypeCode(java.lang.String component3)
component3
- the Quantity Type Code to setpublic Field93F setComponent4(java.lang.String component4)
component4
- the Sign to setpublic Field93F setSign(java.lang.String component4)
component4
- the Sign to setpublic Field93F setComponent5(java.lang.String component5)
component5
- the Balance of Digital Tokens to setpublic Field93F setComponent5(java.math.BigDecimal component5)
component5
- the BigDecimal with the Balance of Digital Tokens content to setpublic Field93F setComponent5(java.lang.Number component5)
component5
- the Number with the Balance of Digital Tokens content to setsetBalanceofDigitalTokens(java.math.BigDecimal)
public Field93F setBalanceofDigitalTokens(java.lang.String component5)
component5
- the Balance of Digital Tokens to setpublic Field93F setBalanceofDigitalTokens(java.math.BigDecimal component5)
component5
- BigDecimal with the Balance of Digital Tokens content to setsetComponent5(java.math.BigDecimal)
public Field93F setBalanceofDigitalTokens(java.lang.Number component5)
component5
- the Number with the Balance of Digital Tokens content to setsetBalanceofDigitalTokens(java.math.BigDecimal)
public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
amount
in interface AmountContainer
AmountResolver.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 Field93F get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field93F get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field93F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field93F> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field93F fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)