@Generated public class Field68A extends Field implements java.io.Serializable, MonetaryAmountContainer
Model and parser for field 68A of a SWIFT MT message.
Subfields (components) Data types
Long
Currency
Long
Long
BigDecimal
String
Structure definition
6n<CUR>6n/2n[/<AMOUNT>15][//10x]
NSN/N[/N][//S]
NCNNNS
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield.
|
static java.lang.Integer |
DENOMINATION
Component number for the Denomination subfield.
|
static java.lang.String |
F_68A
Same as NAME, intended to be clear when using static imports.
|
static java.lang.Integer |
MODE
Component number for the Mode subfield.
|
static java.lang.String |
NAME
Constant with the field name 68A.
|
static java.lang.Integer |
NUMBER
Component number for the Number subfield.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PRODUCT_CODE
Component number for the Product 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
Constructor and Description |
---|
Field68A()
Default constructor.
|
Field68A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field68A(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 Field68A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field68A object.
|
static Field68A |
get(SwiftMessage msg)
Gets the first instance of Field68A in the given message.
|
static Field68A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field68A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field68A in the given message
an empty list is returned if none found.
|
static java.util.List<Field68A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field68A from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 5).
|
java.math.BigDecimal |
getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimal
|
java.lang.Number |
getAmountAsNumber()
Deprecated.
|
java.lang.String |
getComponent1()
Gets the component 1 (Number).
|
java.lang.Long |
getComponent1AsLong()
Get the component 1 as Long
|
java.lang.Number |
getComponent1AsNumber()
Deprecated.
|
java.lang.String |
getComponent2()
Gets the component 2 (Currency).
|
java.util.Currency |
getComponent2AsCurrency()
Get the component 2 as Currency
|
java.lang.String |
getComponent3()
Gets the component 3 (Denomination).
|
java.lang.Long |
getComponent3AsLong()
Get the component 3 as Long
|
java.lang.Number |
getComponent3AsNumber()
Deprecated.
|
java.lang.String |
getComponent4()
Gets the component 4 (Mode).
|
java.lang.Long |
getComponent4AsLong()
Get the component 4 as Long
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
java.lang.String |
getComponent5()
Gets the component 5 (Amount).
|
java.math.BigDecimal |
getComponent5AsBigDecimal()
Get the component 5 as BigDecimal
|
java.lang.Number |
getComponent5AsNumber()
Deprecated.
|
java.lang.String |
getComponent6()
Gets the component 6 (Product Code).
|
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 |
getCurrency()
Gets the Currency (component 2).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component 2) as Currency
|
java.lang.String |
getDenomination()
Gets the Denomination (component 3).
|
java.lang.Long |
getDenominationAsLong()
Get the Denomination (component 3) as Long
|
java.lang.Number |
getDenominationAsNumber()
Deprecated.
|
java.lang.String |
getMode()
Gets the Mode (component 4).
|
java.lang.Long |
getModeAsLong()
Get the Mode (component 4) as Long
|
java.lang.Number |
getModeAsNumber()
Deprecated.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getNumber()
Gets the Number (component 1).
|
java.lang.Long |
getNumberAsLong()
Get the Number (component 1) as Long
|
java.lang.Number |
getNumberAsNumber()
Deprecated.
|
java.lang.String |
getProductCode()
Gets the Product Code (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 |
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 Field68A |
newInstance(Field68A 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.
|
Field68A |
setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.
|
Field68A |
setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setAmount(java.lang.String component5)
Set the Amount (component 5).
|
Field68A |
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
|
Field68A |
setComponent1(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setComponent1(java.lang.String component1)
Set the component 1 (Number).
|
Field68A |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field68A |
setComponent2(java.lang.String component2)
Set the component 2 (Currency).
|
Field68A |
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
|
Field68A |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setComponent3(java.lang.String component3)
Set the component 3 (Denomination).
|
Field68A |
setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
|
Field68A |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setComponent4(java.lang.String component4)
Set the component 4 (Mode).
|
Field68A |
setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.
|
Field68A |
setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field68A |
setComponent5(java.lang.String component5)
Set the component 5 (Amount).
|
Field68A |
setComponent6(java.lang.String component6)
Set the component 6 (Product Code).
|
Field68A |
setCurrency(java.util.Currency component2)
Set the Currency (component 2) from a Currency object.
|
Field68A |
setCurrency(java.lang.String component2)
Set the Currency (component 2).
|
Field68A |
setDenomination(java.lang.Long component3)
Set the Denomination (component 3) from a Long object.
|
Field68A |
setDenomination(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setDenomination(java.lang.String component3)
Set the Denomination (component 3).
|
Field68A |
setMode(java.lang.Long component4)
Set the Mode (component 4) from a Long object.
|
Field68A |
setMode(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setMode(java.lang.String component4)
Set the Mode (component 4).
|
Field68A |
setNumber(java.lang.Long component1)
Set the Number (component 1) from a Long object.
|
Field68A |
setNumber(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field68A |
setNumber(java.lang.String component1)
Set the Number (component 1).
|
Field68A |
setProductCode(java.lang.String component6)
Set the Product Code (component 6).
|
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_68A
@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 NUMBER
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer DENOMINATION
public static final java.lang.Integer MODE
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer PRODUCT_CODE
public Field68A()
public Field68A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field68A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field68A newInstance(Field68A 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.Long getComponent1AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent1AsNumber()
getComponent1AsLong()
to get the proper value.getComponent1AsLong()
public java.lang.String getNumber()
public java.lang.Long getNumberAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getNumberAsNumber()
getComponent1AsLong()
to get the proper value.getNumberAsLong()
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public java.lang.String getComponent3()
public java.lang.Long getComponent3AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent3AsNumber()
getComponent3AsLong()
to get the proper value.getComponent3AsLong()
public java.lang.String getDenomination()
public java.lang.Long getDenominationAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getDenominationAsNumber()
getComponent3AsLong()
to get the proper value.getDenominationAsLong()
public java.lang.String getComponent4()
public java.lang.Long getComponent4AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent4AsNumber()
getComponent4AsLong()
to get the proper value.getComponent4AsLong()
public java.lang.String getMode()
public java.lang.Long getModeAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getModeAsNumber()
getComponent4AsLong()
to get the proper value.getModeAsLong()
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 getAmount()
public java.math.BigDecimal getAmountAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getAmountAsNumber()
getComponent5AsBigDecimal()
to get the proper value.getAmountAsBigDecimal()
public java.lang.String getComponent6()
public java.lang.String getProductCode()
public Field68A setComponent1(java.lang.String component1)
component1
- the Number to setpublic Field68A setComponent1(java.lang.Long component1)
component1
- the Long with the Number content to setsetComponent1(String)
public Field68A setComponent1(java.lang.Number component1)
component1
- the Number with the Number content to setsetNumber(java.lang.Long)
public Field68A setNumber(java.lang.String component1)
component1
- the Number to setpublic Field68A setNumber(java.lang.Long component1)
component1
- Long with the Number content to setsetComponent1(java.lang.Long)
public Field68A setNumber(java.lang.Number component1)
component1
- the Number with the Number content to setsetNumber(java.lang.Long)
public Field68A setComponent2(java.lang.String component2)
component2
- the Currency to setpublic Field68A setComponent2(java.util.Currency component2)
component2
- the Currency with the Currency content to setpublic Field68A setCurrency(java.lang.String component2)
component2
- the Currency to setpublic Field68A setCurrency(java.util.Currency component2)
component2
- Currency with the Currency content to setsetComponent2(java.util.Currency)
public Field68A setComponent3(java.lang.String component3)
component3
- the Denomination to setpublic Field68A setComponent3(java.lang.Long component3)
component3
- the Long with the Denomination content to setsetComponent3(String)
public Field68A setComponent3(java.lang.Number component3)
component3
- the Number with the Denomination content to setsetDenomination(java.lang.Long)
public Field68A setDenomination(java.lang.String component3)
component3
- the Denomination to setpublic Field68A setDenomination(java.lang.Long component3)
component3
- Long with the Denomination content to setsetComponent3(java.lang.Long)
public Field68A setDenomination(java.lang.Number component3)
component3
- the Number with the Denomination content to setsetDenomination(java.lang.Long)
public Field68A setComponent4(java.lang.String component4)
component4
- the Mode to setpublic Field68A setComponent4(java.lang.Long component4)
component4
- the Long with the Mode content to setsetComponent4(String)
public Field68A setComponent4(java.lang.Number component4)
component4
- the Number with the Mode content to setsetMode(java.lang.Long)
public Field68A setMode(java.lang.String component4)
component4
- the Mode to setpublic Field68A setMode(java.lang.Long component4)
component4
- Long with the Mode content to setsetComponent4(java.lang.Long)
public Field68A setMode(java.lang.Number component4)
component4
- the Number with the Mode content to setsetMode(java.lang.Long)
public Field68A setComponent5(java.lang.String component5)
component5
- the Amount to setpublic Field68A setComponent5(java.math.BigDecimal component5)
component5
- the BigDecimal with the Amount content to setpublic Field68A setComponent5(java.lang.Number component5)
component5
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field68A setAmount(java.lang.String component5)
component5
- the Amount to setpublic Field68A setAmount(java.math.BigDecimal component5)
component5
- BigDecimal with the Amount content to setsetComponent5(java.math.BigDecimal)
public Field68A setAmount(java.lang.Number component5)
component5
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field68A setComponent6(java.lang.String component6)
component6
- the Product Code to setpublic Field68A setProductCode(java.lang.String component6)
component6
- the Product Code to setpublic 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 getName()
public static Field68A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field68A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field68A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field68A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field68A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)