@Generated public class Field33A extends Field implements java.io.Serializable, CurrencyContainer, DateContainer, AmountContainer
Model and parser for field 33A of a SWIFT MT message.
Subfields (components) Data types
Calendar
Currency
Number
Structure definition
<DATE2><CUR><AMOUNT>15
<DATE2>SN
ECN
This class complies with standard release SRU2018
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.Integer |
DATE
Component number for the Date subfield
|
static java.lang.String |
F_33A
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 33A
|
static java.lang.String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field33A()
Default constructor.
|
Field33A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33A(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
|
java.util.List<java.util.Calendar> |
dates()
Get a calendar for every date found
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field33A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field33A object.
|
static Field33A |
get(SwiftMessage msg)
Gets the first instance of Field33A in the given message.
|
static Field33A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field33A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field33A in the given message
an empty list is returned if none found.
|
static java.util.List<Field33A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field33A from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component3).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component3) as Number
|
java.lang.String |
getComponent1()
Gets the component1
|
java.util.Calendar |
getComponent1AsCalendar()
Get the component1 as Calendar
|
java.lang.String |
getComponent2()
Gets the component2
|
java.util.Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
java.lang.String |
getComponent3()
Gets the component3
|
java.lang.Number |
getComponent3AsNumber()
Get the component3 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 (component2).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component2) as Currency
|
java.lang.String |
getDate()
Gets the Date (component1).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component1) as Calendar
|
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 Field33A |
newInstance(Field33A 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() |
Field33A |
setAmount(java.lang.Number component3)
Set the Amount (component3) from a Number object.
|
Field33A |
setAmount(java.lang.String component3)
Set the Amount (component3).
|
Field33A |
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.
|
Field33A |
setComponent1(java.lang.String component1)
Set the component1.
|
Field33A |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field33A |
setComponent2(java.lang.String component2)
Set the component2.
|
Field33A |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field33A |
setComponent3(java.lang.String component3)
Set the component3.
|
Field33A |
setCurrency(java.util.Currency component2)
Set the Currency (component2) from a Currency object.
|
Field33A |
setCurrency(java.lang.String component2)
Set the Currency (component2).
|
Field33A |
setDate(java.util.Calendar component1)
Set the Date (component1) from a Calendar object.
|
Field33A |
setDate(java.lang.String component1)
Set the Date (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's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, 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_33A
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DATE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public Field33A()
public Field33A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field33A(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 Field33A newInstance(Field33A source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
public java.util.Calendar getComponent1AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public Field33A setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field33A setComponent1(java.util.Calendar component1)
component1
- the Calendar with the component1 content to setpublic Field33A setDate(java.lang.String component1)
component1
- the Date to setpublic Field33A setDate(java.util.Calendar component1)
component1
- Calendar with the Date content to setsetComponent1(java.util.Calendar)
public java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public Field33A setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field33A setComponent2(java.util.Currency component2)
component2
- the Currency with the component2 content to setpublic Field33A setCurrency(java.lang.String component2)
component2
- the Currency to setpublic Field33A setCurrency(java.util.Currency component2)
component2
- Currency with the Currency content to setsetComponent2(java.util.Currency)
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
public Field33A setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field33A setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setpublic Field33A setAmount(java.lang.String component3)
component3
- the Amount to setpublic Field33A setAmount(java.lang.Number component3)
component3
- Number with the Amount content to setsetComponent3(java.lang.Number)
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.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
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 boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field33A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field33A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field33A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected 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 static Field33A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)