public class Field92B extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
String
Currency
Currency
Number
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_92B
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 92B
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field92B()
Default constructor
|
Field92B(java.lang.String value)
Creates the field parsing the parameter value into fields' components
|
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() |
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 Field92B |
get(SwiftMessage msg)
Get the first instance of Field92B in the given message.
|
static Field92B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field92B> |
getAll(SwiftMessage msg)
Get 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)
Get 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()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
|
java.lang.String |
getComponent2()
Get the component2
|
java.util.Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
java.lang.String |
getComponent3()
Get the component3
|
java.util.Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
java.lang.String |
getComponent4()
Get the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 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 |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getFirstCurrencyCode()
Get the First Currency Code (component2).
|
java.util.Currency |
getFirstCurrencyCodeAsCurrency()
Get the First Currency Code (component2) as Currency
|
java.lang.String |
getQualifier()
Get the Qualifier (component1).
|
java.lang.String |
getRate()
Get the Rate (component4).
|
java.lang.Number |
getRateAsNumber()
Get the Rate (component4) as Number
|
java.lang.String |
getSecondCurrencyCode()
Get the Second Currency Code (component3).
|
java.util.Currency |
getSecondCurrencyCodeAsCurrency()
Get the Second Currency Code (component3) as Currency
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
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. |
java.lang.String |
parserPattern() |
Field92B |
setComponent1(java.lang.String component1)
Set the component1.
|
Field92B |
setComponent2(java.util.Currency component2)
Set the component2.
|
Field92B |
setComponent2(java.lang.String component2)
Set the component2.
|
Field92B |
setComponent3(java.util.Currency component3)
Set the component3.
|
Field92B |
setComponent3(java.lang.String component3)
Set the component3.
|
Field92B |
setComponent4(java.lang.Number component4)
Set the component4.
|
Field92B |
setComponent4(java.lang.String component4)
Set the component4.
|
Field92B |
setFirstCurrencyCode(java.util.Currency component2)
Set the First Currency Code (component2) as Currency
|
Field92B |
setFirstCurrencyCode(java.lang.String component2)
Set the First Currency Code (component2).
|
Field92B |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field92B |
setRate(java.lang.Number component4)
Set the Rate (component4) as Number
|
Field92B |
setRate(java.lang.String component4)
Set the Rate (component4).
|
Field92B |
setSecondCurrencyCode(java.util.Currency component3)
Set the Second Currency Code (component3) as Currency
|
Field92B |
setSecondCurrencyCode(java.lang.String component3)
Set the Second Currency Code (component3).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.String F_92B
public static final java.lang.String NAME
public static final java.lang.String PARSER_PATTERN
public Field92B()
public Field92B(java.lang.String value)
value
- public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
public java.util.List<java.math.BigDecimal> amounts()
public java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
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 java.util.List<java.lang.String> currencyStrings()
CurrencyContainer
currencyStrings
in interface CurrencyContainer
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public static Field92B get(SwiftMessage msg)
msg
- may be empty or null
public static Field92B get(SwiftTagListBlock block)
block
- may be null or emptypublic static java.util.List<Field92B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returned
public static java.util.List<Field92B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getComponent1()
@Deprecated public java.lang.String getComponent1AsString()
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
null
if cannot be convertedpublic java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
null
if cannot be convertedpublic java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
null
if cannot be convertedpublic java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.public java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public java.lang.String getFirstCurrencyCode()
public java.util.Currency getFirstCurrencyCodeAsCurrency()
null
if cannot be convertedpublic java.lang.String getQualifier()
public java.lang.String getRate()
public java.lang.Number getRateAsNumber()
null
if cannot be convertedpublic java.lang.String getSecondCurrencyCode()
public java.util.Currency getSecondCurrencyCodeAsCurrency()
null
if cannot be convertedpublic java.lang.String getValue()
public void initializeCurrencies(java.util.Currency cur)
initializeCurrencies
in interface CurrencyContainer
CurrencyContainer.initializeCurrencies(String)
public void initializeCurrencies(java.lang.String cur)
CurrencyContainer
initializeCurrencies
in interface CurrencyContainer
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public boolean isGeneric()
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public Field92B setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field92B setComponent2(java.util.Currency component2)
component2
- the Currency with the component2 content to setpublic Field92B setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field92B setComponent3(java.util.Currency component3)
component3
- the Currency with the component3 content to setpublic Field92B setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field92B setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setpublic Field92B setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field92B setFirstCurrencyCode(java.util.Currency component2)
component2
- Currency with the First Currency Code content to setpublic Field92B setFirstCurrencyCode(java.lang.String component2)
component2
- the First Currency Code to setpublic Field92B setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field92B setRate(java.lang.Number component4)
component4
- Number with the Rate content to setpublic Field92B setRate(java.lang.String component4)
component4
- the Rate to setpublic Field92B setSecondCurrencyCode(java.util.Currency component3)
component3
- Currency with the Second Currency Code content to setpublic Field92B setSecondCurrencyCode(java.lang.String component3)
component3
- the Second Currency Code to set