@Generated public class Field33F extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer
Model and parser for field 33F of a SWIFT MT message.
Subfields (components) Data types
Currency
Number
Structure definition
<CUR><AMOUNT>15
SN
CN
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield
|
static java.lang.String |
F_33F
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 33F
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field33F()
Default constructor.
|
Field33F(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33F(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 Field33F |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field33F object.
|
static Field33F |
get(SwiftMessage msg)
Gets the first instance of Field33F in the given message.
|
static Field33F |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field33F> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field33F in the given message
an empty list is returned if none found.
|
static java.util.List<Field33F> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field33F from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 2).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component 2) as Number
|
java.lang.String |
getComponent1()
Gets the component 1 (Currency).
|
java.util.Currency |
getComponent1AsCurrency()
Get the component 1 as Currency
|
java.lang.String |
getComponent2()
Gets the component 2 (Amount).
|
java.lang.Number |
getComponent2AsNumber()
Get the component 2 as Number
|
protected 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 1).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component 1) as Currency
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
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 Field33F |
newInstance(Field33F 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
|
Field33F |
setAmount(java.lang.Number component2)
Set the Amount (component2) from a Number object.
|
Field33F |
setAmount(java.lang.String component2)
Set the Amount (component2).
|
Field33F |
setComponent1(java.util.Currency component1)
Set the component1 from a Currency object.
|
Field33F |
setComponent1(java.lang.String component1)
Set the component1 (Currency).
|
Field33F |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field33F |
setComponent2(java.lang.String component2)
Set the component2 (Amount).
|
Field33F |
setCurrency(java.util.Currency component1)
Set the Currency (component1) from a Currency object.
|
Field33F |
setCurrency(java.lang.String component1)
Set the Currency (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
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isDSSPresent, 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_33F
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public Field33F()
public Field33F(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field33F(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field33F newInstance(Field33F 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
protected 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.util.Currency getComponent1AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
public java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
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 Field33F setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field33F setComponent1(java.util.Currency component1)
component1
- the Currency with the component1 content to setpublic Field33F setCurrency(java.lang.String component1)
component1
- the Currency to setpublic Field33F setCurrency(java.util.Currency component1)
component1
- Currency with the Currency content to setsetComponent1(java.util.Currency)
public Field33F setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field33F setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setpublic Field33F setAmount(java.lang.String component2)
component2
- the Amount to setpublic Field33F setAmount(java.lang.Number component2)
component2
- Number with the Amount content to setsetComponent2(java.lang.Number)
public java.lang.String getName()
public static Field33F get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33F get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field33F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field33F> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field33F fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)