@Generated public class Field90F extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
StringStringCurrencyNumberStringNumber:4!c//4!c/<CUR><AMOUNT>15/4!c/<AMOUNT>15:S//S/SN/S/NSSCNSNThis class complies with standard release SRU2017
NOTE: this source code has been generated from template
| Modifier and Type | Field and Description |
|---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield
|
static java.lang.Integer |
AMOUNT_TYPE_CODE
Component number for the Amount Type Code subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield
|
static java.lang.String |
F_90F
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 90F
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static java.lang.Integer |
QUANTITY
Component number for the Quantity subfield
|
static java.lang.Integer |
QUANTITY_TYPE_CODE
Component number for the Quantity Type Code subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components| Constructor and Description |
|---|
Field90F()
Default constructor.
|
Field90F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field90F(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's 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 Field90F |
get(SwiftMessage msg)
Get the first instance of Field90F in the given message.
|
static Field90F |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field90F> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field90F in the given message
an empty list is returned if none found.
|
static java.util.List<Field90F> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field90F from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Get the Amount (component4).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component4) as Number
|
java.lang.String |
getAmountTypeCode()
Get the Amount Type Code (component2).
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
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 |
getComponent5()
Get the component5
|
java.lang.String |
getComponent5AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent6()
Get the component6
|
java.lang.Number |
getComponent6AsNumber()
Get the component6 as Number
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
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 |
getCurrency()
Get the Currency (component3).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component3) 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()
Get the Qualifier (component1).
|
java.lang.String |
getQuantity()
Get the Quantity (component6).
|
java.lang.Number |
getQuantityAsNumber()
Get the Quantity (component6) as Number
|
java.lang.String |
getQuantityTypeCode()
Get the Quantity Type Code (component5).
|
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 Field90F |
newInstance(Field90F 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() |
Field90F |
setAmount(java.lang.Number component4)
Set the Amount (component4) from a Number object.
|
Field90F |
setAmount(java.lang.String component4)
Set the Amount (component4).
|
Field90F |
setAmountTypeCode(java.lang.String component2)
Set the Amount Type Code (component2).
|
Field90F |
setComponent1(java.lang.String component1)
Set the component1.
|
Field90F |
setComponent2(java.lang.String component2)
Set the component2.
|
Field90F |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field90F |
setComponent3(java.lang.String component3)
Set the component3.
|
Field90F |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field90F |
setComponent4(java.lang.String component4)
Set the component4.
|
Field90F |
setComponent5(java.lang.String component5)
Set the component5.
|
Field90F |
setComponent6(java.lang.Number component6)
Set the component6 from a Number object.
|
Field90F |
setComponent6(java.lang.String component6)
Set the component6.
|
Field90F |
setCurrency(java.util.Currency component3)
Set the Currency (component3) from a Currency object.
|
Field90F |
setCurrency(java.lang.String component3)
Set the Currency (component3).
|
Field90F |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field90F |
setQuantity(java.lang.Number component6)
Set the Quantity (component6) from a Number object.
|
Field90F |
setQuantity(java.lang.String component6)
Set the Quantity (component6).
|
Field90F |
setQuantityTypeCode(java.lang.String component5)
Set the Quantity Type Code (component5).
|
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's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_90F
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 AMOUNT_TYPE_CODE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer QUANTITY_TYPE_CODE
public static final java.lang.Integer QUANTITY
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field90F()
public Field90F(java.lang.String value)
value - complete field value including separators and CRLFpublic Field90F(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field90F newInstance(Field90F source)
source - a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent1AsString()
Field.getComponent(int) insteadpublic java.lang.String getQualifier()
public Field90F setComponent1(java.lang.String component1)
component1 - the component1 to setpublic Field90F setQualifier(java.lang.String component1)
component1 - the Qualifier to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent2AsString()
Field.getComponent(int) insteadpublic java.lang.String getAmountTypeCode()
public Field90F setComponent2(java.lang.String component2)
component2 - the component2 to setpublic Field90F setAmountTypeCode(java.lang.String component2)
component2 - the Amount Type Code to setpublic java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
null if cannot be convertedpublic java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
null if cannot be convertedpublic Field90F setComponent3(java.lang.String component3)
component3 - the component3 to setpublic Field90F setComponent3(java.util.Currency component3)
component3 - the Currency with the component3 content to setpublic Field90F setCurrency(java.lang.String component3)
component3 - the Currency to setpublic Field90F setCurrency(java.util.Currency component3)
component3 - Currency with the Currency content to setsetComponent3(java.util.Currency)public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
null if cannot be convertedpublic java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
null if cannot be convertedpublic Field90F setComponent4(java.lang.String component4)
component4 - the component4 to setpublic Field90F setComponent4(java.lang.Number component4)
component4 - the Number with the component4 content to setpublic Field90F setAmount(java.lang.String component4)
component4 - the Amount to setpublic Field90F setAmount(java.lang.Number component4)
component4 - Number with the Amount content to setsetComponent4(java.lang.Number)public java.lang.String getComponent5()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent5AsString()
Field.getComponent(int) insteadpublic java.lang.String getQuantityTypeCode()
public Field90F setComponent5(java.lang.String component5)
component5 - the component5 to setpublic Field90F setQuantityTypeCode(java.lang.String component5)
component5 - the Quantity Type Code to setpublic java.lang.String getComponent6()
public java.lang.Number getComponent6AsNumber()
null if cannot be convertedpublic java.lang.String getQuantity()
public java.lang.Number getQuantityAsNumber()
null if cannot be convertedpublic Field90F setComponent6(java.lang.String component6)
component6 - the component6 to setpublic Field90F setComponent6(java.lang.Number component6)
component6 - the Number with the component6 content to setpublic Field90F setQuantity(java.lang.String component6)
component6 - the Quantity to setpublic Field90F setQuantity(java.lang.Number component6)
component6 - Number with the Quantity content to setsetComponent6(java.lang.Number)public java.util.List<java.lang.String> currencyStrings()
CurrencyContainercurrencyStrings in interface CurrencyContainerpublic java.util.List<java.util.Currency> currencies()
CurrencyContainerCurrencyContainer.currencyStrings()currencies in interface CurrencyContainerpublic java.util.Currency currency()
CurrencyContainerCurrencyContainer.currencyString()currency in interface CurrencyContainerCurrencyContainer.currencyStrings(),
CurrencyContainer.currencyString()public java.lang.String currencyString()
CurrencyContainercurrencyString in interface CurrencyContainerpublic void initializeCurrencies(java.lang.String cur)
CurrencyContainerinitializeCurrencies in interface CurrencyContainerpublic void initializeCurrencies(java.util.Currency cur)
initializeCurrencies in interface CurrencyContainerCurrencyContainer.initializeCurrencies(String)public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)public java.math.BigDecimal amount()
AmountContaineramount in interface AmountContainerAmountResolver.amount(Field)public boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String getDSS()
getDSS in interface GenericFieldgetDSS in class Fieldnull if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent in interface GenericFieldisDSSPresent in class FieldgetDSS()public java.lang.String getConditionalQualifier()
getConditionalQualifier in interface GenericFieldgetConditionalQualifier in class Fieldnull if not set or not applicable for this kind of field.public java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern in interface PatternContainercomponentsPattern in class Fieldpublic final java.lang.String validatorPattern()
validatorPattern in class Fieldpublic static Field90F get(SwiftTagListBlock block)
block - may be null or emptypublic static Field90F get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field90F> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field90F> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize in class Fieldpublic java.lang.String getValueDisplay(int component,
java.util.Locale locale)
getValueDisplay in class Fieldcomponent - 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 fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)