@Generated public class Field92L extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
Model and parser for field 92L of a SWIFT MT message.
Subfields (components) Data types
String
Currency
Number
Currency
Number
Structure definition
:4!c//<CUR><AMOUNT>15/<CUR><AMOUNT>15
:S//SN/SN
SCNCN
This class complies with standard release SRU2019
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT1
Component number for the Amount1 subfield
|
static java.lang.Integer |
AMOUNT2
Component number for the Amount2 subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.Integer |
CURRENCY1
Component number for the Currency1 subfield
|
static java.lang.Integer |
CURRENCY2
Component number for the Currency2 subfield
|
static java.lang.String |
F_92L
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 92L
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
Constructor and Description |
---|
Field92L()
Default constructor.
|
Field92L(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field92L(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 Field92L |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field92L object.
|
static Field92L |
get(SwiftMessage msg)
Gets the first instance of Field92L in the given message.
|
static Field92L |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field92L> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field92L in the given message
an empty list is returned if none found.
|
static java.util.List<Field92L> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field92L from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount1()
Gets the Amount1 (component3).
|
java.lang.Number |
getAmount1AsNumber()
Get the Amount1 (component3) as Number
|
java.lang.String |
getAmount2()
Gets the Amount2 (component5).
|
java.lang.Number |
getAmount2AsNumber()
Get the Amount2 (component5) as Number
|
java.lang.String |
getComponent1()
Gets the component1 (Qualifier).
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Gets the component2 (Currency1).
|
java.util.Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
java.lang.String |
getComponent3()
Gets the component3 (Amount1).
|
java.lang.Number |
getComponent3AsNumber()
Get the component3 as Number
|
java.lang.String |
getComponent4()
Gets the component4 (Currency2).
|
java.util.Currency |
getComponent4AsCurrency()
Get the component4 as Currency
|
java.lang.String |
getComponent5()
Gets the component5 (Amount2).
|
java.lang.Number |
getComponent5AsNumber()
Get the component5 as Number
|
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 |
getCurrency1()
Gets the Currency1 (component2).
|
java.util.Currency |
getCurrency1AsCurrency()
Get the Currency1 (component2) as Currency
|
java.lang.String |
getCurrency2()
Gets the Currency2 (component4).
|
java.util.Currency |
getCurrency2AsCurrency()
Get the Currency2 (component4) 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 |
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 Field92L |
newInstance(Field92L 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
|
Field92L |
setAmount1(java.lang.Number component3)
Set the Amount1 (component3) from a Number object.
|
Field92L |
setAmount1(java.lang.String component3)
Set the Amount1 (component3).
|
Field92L |
setAmount2(java.lang.Number component5)
Set the Amount2 (component5) from a Number object.
|
Field92L |
setAmount2(java.lang.String component5)
Set the Amount2 (component5).
|
Field92L |
setComponent1(java.lang.String component1)
Set the component1 (Qualifier).
|
Field92L |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field92L |
setComponent2(java.lang.String component2)
Set the component2 (Currency1).
|
Field92L |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field92L |
setComponent3(java.lang.String component3)
Set the component3 (Amount1).
|
Field92L |
setComponent4(java.util.Currency component4)
Set the component4 from a Currency object.
|
Field92L |
setComponent4(java.lang.String component4)
Set the component4 (Currency2).
|
Field92L |
setComponent5(java.lang.Number component5)
Set the component5 from a Number object.
|
Field92L |
setComponent5(java.lang.String component5)
Set the component5 (Amount2).
|
Field92L |
setCurrency1(java.util.Currency component2)
Set the Currency1 (component2) from a Currency object.
|
Field92L |
setCurrency1(java.lang.String component2)
Set the Currency1 (component2).
|
Field92L |
setCurrency2(java.util.Currency component4)
Set the Currency2 (component4) from a Currency object.
|
Field92L |
setCurrency2(java.lang.String component4)
Set the Currency2 (component4).
|
Field92L |
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 validator pattern
|
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_92L
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 CURRENCY1
public static final java.lang.Integer AMOUNT1
public static final java.lang.Integer CURRENCY2
public static final java.lang.Integer AMOUNT2
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field92L()
public Field92L(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field92L(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field92L newInstance(Field92L 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 fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final 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.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase4=SRU2020) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
public java.lang.String getCurrency1()
public java.util.Currency getCurrency1AsCurrency()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getAmount1()
public java.lang.Number getAmount1AsNumber()
public java.lang.String getComponent4()
public java.util.Currency getComponent4AsCurrency()
public java.lang.String getCurrency2()
public java.util.Currency getCurrency2AsCurrency()
public java.lang.String getComponent5()
public java.lang.Number getComponent5AsNumber()
public java.lang.String getAmount2()
public java.lang.Number getAmount2AsNumber()
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 Field92L setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field92L setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field92L setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field92L setComponent2(java.util.Currency component2)
component2
- the Currency with the component2 content to setpublic Field92L setCurrency1(java.lang.String component2)
component2
- the Currency1 to setpublic Field92L setCurrency1(java.util.Currency component2)
component2
- Currency with the Currency1 content to setsetComponent2(java.util.Currency)
public Field92L setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field92L setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setpublic Field92L setAmount1(java.lang.String component3)
component3
- the Amount1 to setpublic Field92L setAmount1(java.lang.Number component3)
component3
- Number with the Amount1 content to setsetComponent3(java.lang.Number)
public Field92L setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field92L setComponent4(java.util.Currency component4)
component4
- the Currency with the component4 content to setpublic Field92L setCurrency2(java.lang.String component4)
component4
- the Currency2 to setpublic Field92L setCurrency2(java.util.Currency component4)
component4
- Currency with the Currency2 content to setsetComponent4(java.util.Currency)
public Field92L setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field92L setComponent5(java.lang.Number component5)
component5
- the Number with the component5 content to setpublic Field92L setAmount2(java.lang.String component5)
component5
- the Amount2 to setpublic Field92L setAmount2(java.lang.Number component5)
component5
- Number with the Amount2 content to setsetComponent5(java.lang.Number)
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 getName()
public static Field92L get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field92L get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field92L> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field92L> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field92L fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)