public class Field92J extends Field implements Serializable, CurrencyContainer, AmountContainer, GenericField
String
String
String
Currency
Number
String
Modifier and Type | Field and Description |
---|---|
static Integer |
AMOUNT
Component number for the Amount subfield
|
static Integer |
CODE
Component number for the Code subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CURRENCY
Component number for the Currency subfield
|
static Integer |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield
|
static String |
F_92J
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 92J
|
static Integer |
NARRATIVE
Component number for the Narrative subfield
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
components
Constructor and Description |
---|
Field92J()
Default constructor
|
Field92J(String value)
Creates the field parsing the parameter value into fields' components
|
Modifier and Type | Method and Description |
---|---|
BigDecimal |
amount()
Get the first amount in this field.
|
List<BigDecimal> |
amounts() |
String |
componentsPattern() |
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. |
List<Currency> |
currencies()
Utility method that creates a Currency for every string returned by
CurrencyContainer.currencyStrings() |
Currency |
currency()
Analog to
CurrencyContainer.currencyString() |
String |
currencyString()
Get the single currency contained in this field.
|
List<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 Field92J |
get(SwiftMessage msg)
Get the first instance of Field92J in the given message.
|
static Field92J |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field92J> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field92J in the given message
an empty list is returned if none found.
|
static List<Field92J> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field92J from the given block
an empty list is returned if none found.
|
String |
getAmount()
Get the Amount (component5).
|
Number |
getAmountAsNumber()
Get the Amount (component5) as Number
|
String |
getCode()
Get the Code (component3).
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
Currency |
getComponent4AsCurrency()
Get the component4 as Currency
|
String |
getComponent5()
Get the component5
|
Number |
getComponent5AsNumber()
Get the component5 as Number
|
String |
getComponent6()
Get the component6
|
String |
getComponent6AsString()
Deprecated.
|
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. |
String |
getCurrency()
Get the Currency (component4).
|
Currency |
getCurrencyAsCurrency()
Get the Currency (component4) as Currency
|
String |
getDataSourceScheme()
Get the Data Source Scheme (component2).
|
String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
String |
getName()
Deprecated.
use constant Field92J
|
String |
getNarrative()
Get the Narrative (component6).
|
String |
getQualifier()
Get the Qualifier (component1).
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
void |
initializeCurrencies(Currency cur) |
void |
initializeCurrencies(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 Field92J |
newInstance(Field92J source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
String |
parserPattern() |
Field92J |
setAmount(Number component5)
Set the Amount (component5) as Number
|
Field92J |
setAmount(String component5)
Set the Amount (component5).
|
Field92J |
setCode(String component3)
Set the Code (component3).
|
Field92J |
setComponent1(String component1)
Set the component1.
|
Field92J |
setComponent2(String component2)
Set the component2.
|
Field92J |
setComponent3(String component3)
Set the component3.
|
Field92J |
setComponent4(Currency component4)
Set the component4.
|
Field92J |
setComponent4(String component4)
Set the component4.
|
Field92J |
setComponent5(Number component5)
Set the component5.
|
Field92J |
setComponent5(String component5)
Set the component5.
|
Field92J |
setComponent6(String component6)
Set the component6.
|
Field92J |
setCurrency(Currency component4)
Set the Currency (component4) as Currency
|
Field92J |
setCurrency(String component4)
Set the Currency (component4).
|
Field92J |
setDataSourceScheme(String component2)
Set the Data Source Scheme (component2).
|
Field92J |
setNarrative(String component6)
Set the Narrative (component6).
|
Field92J |
setQualifier(String component1)
Set the Qualifier (component1).
|
static Tag |
tag(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, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final String NAME
public static final String F_92J
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer DATA_SOURCE_SCHEME
public static final Integer CODE
public static final Integer CURRENCY
public static final Integer AMOUNT
public static final Integer NARRATIVE
public Field92J()
public Field92J(String value)
value
- public static Field92J newInstance(Field92J source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
@Deprecated public String getComponent1AsString()
public String getQualifier()
public Field92J setComponent1(String component1)
component1
- the component1 to setpublic Field92J setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getDataSourceScheme()
public Field92J setComponent2(String component2)
component2
- the component2 to setpublic Field92J setDataSourceScheme(String component2)
component2
- the Data Source Scheme to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getCode()
public Field92J setComponent3(String component3)
component3
- the component3 to setpublic Field92J setCode(String component3)
component3
- the Code to setpublic String getComponent4()
public Currency getComponent4AsCurrency()
null
if cannot be convertedpublic String getCurrency()
public Currency getCurrencyAsCurrency()
null
if cannot be convertedpublic Field92J setComponent4(String component4)
component4
- the component4 to setpublic Field92J setComponent4(Currency component4)
component4
- the Currency with the component4 content to setpublic Field92J setCurrency(String component4)
component4
- the Currency to setpublic Field92J setCurrency(Currency component4)
component4
- Currency with the Currency content to setpublic String getComponent5()
public Number getComponent5AsNumber()
null
if cannot be convertedpublic String getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field92J setComponent5(String component5)
component5
- the component5 to setpublic Field92J setComponent5(Number component5)
component5
- the Number with the component5 content to setpublic Field92J setAmount(String component5)
component5
- the Amount to setpublic Field92J setAmount(Number component5)
component5
- Number with the Amount content to setpublic String getComponent6()
@Deprecated public String getComponent6AsString()
public String getNarrative()
public Field92J setComponent6(String component6)
component6
- the component6 to setpublic Field92J setNarrative(String component6)
component6
- the Narrative to setpublic List<String> currencyStrings()
CurrencyContainer
currencyStrings
in interface CurrencyContainer
public List<Currency> currencies()
CurrencyContainer
CurrencyContainer.currencyStrings()
currencies
in interface CurrencyContainer
public Currency currency()
CurrencyContainer
CurrencyContainer.currencyString()
currency
in interface CurrencyContainer
CurrencyContainer.currencyStrings()
,
CurrencyContainer.currencyString()
public String currencyString()
CurrencyContainer
currencyString
in interface CurrencyContainer
public void initializeCurrencies(String cur)
CurrencyContainer
initializeCurrencies
in interface CurrencyContainer
public void initializeCurrencies(Currency cur)
initializeCurrencies
in interface CurrencyContainer
CurrencyContainer.initializeCurrencies(String)
public List<BigDecimal> amounts()
public BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.public String componentsPattern()
componentsPattern
in interface PatternContainer
public String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
Field
public static Field92J get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field92J get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field92J> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field92J> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field