@Generated public class Field33K extends Field implements java.io.Serializable, MonetaryAmountContainer
Model and parser for field 33K of a SWIFT MT message.
Subfields (components) Data types
String
Long
String
Currency
BigDecimal
Structure definition
<DM>3!n2!a<CUR><AMOUNT>15
cNS<CUR>N
SNSCN
This class complies with standard release SRU2023
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield.
|
static java.lang.Integer |
CODE
Component number for the Code subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield.
|
static java.lang.Integer |
DAYMONTH
Component number for the DayMonth subfield.
|
static java.lang.Integer |
DM_MARK
Deprecated.
use #DAYMONTH instead
|
static java.lang.String |
F_33K
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 33K.
|
static java.lang.Integer |
NUMBER_OF_DAYSMONTHS
Component number for the Number Of Days/Months subfield.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components, labelMap
Constructor and Description |
---|
Field33K()
Default constructor.
|
Field33K(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33K(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()
Returns the first amounts as BigDecimal
|
java.util.List<java.math.BigDecimal> |
amounts()
Returns the list of all NON-NULL amounts as BigDecimal
|
java.lang.String |
componentsPattern()
Deprecated.
Use
typesPattern() instead. |
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.
|
static Field33K |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field33K object.
|
static Field33K |
get(SwiftMessage msg)
Gets the first instance of Field33K in the given message.
|
static Field33K |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field33K> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field33K in the given message
an empty list is returned if none found.
|
static java.util.List<Field33K> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field33K from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 5).
|
java.math.BigDecimal |
getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimal
|
java.lang.Number |
getAmountAsNumber()
Deprecated.
use #getAmountAsBigDecimal() instead
|
java.lang.String |
getCode()
Gets the Code (component 3).
|
java.lang.String |
getComponent1()
Gets the component 1 (DayMonth).
|
java.lang.String |
getComponent2()
Gets the component 2 (Number Of Days/Months).
|
java.lang.Long |
getComponent2AsLong()
Get the component 2 as Long
|
java.lang.Number |
getComponent2AsNumber()
Deprecated.
use #getComponent2AsLong() instead
|
java.lang.String |
getComponent3()
Gets the component 3 (Code).
|
java.lang.String |
getComponent4()
Gets the component 4 (Currency).
|
java.util.Currency |
getComponent4AsCurrency()
Get the component 4 as Currency
|
java.lang.String |
getComponent5()
Gets the component 5 (Amount).
|
java.math.BigDecimal |
getComponent5AsBigDecimal()
Get the component 5 as BigDecimal
|
java.lang.Number |
getComponent5AsNumber()
Deprecated.
use #getComponent5AsBigDecimal() instead
|
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 4).
|
java.util.Currency |
getCurrencyAsCurrency()
Get the Currency (component 4) as Currency
|
java.lang.String |
getDayMonth()
Gets the DayMonth (component 1).
|
java.lang.String |
getDMMark()
Deprecated.
use #getDayMonth() instead
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getNumberofDaysMonths()
Deprecated.
use #getNumberOfDaysMonths() instead
|
java.lang.String |
getNumberOfDaysMonths()
Gets the Number Of Days/Months (component 2).
|
java.lang.Long |
getNumberofDaysMonthsAsLong()
Deprecated.
use #getNumberOfDaysMonthsAsLong() instead
|
java.lang.Long |
getNumberOfDaysMonthsAsLong()
Get the Number Of Days/Months (component 2) as Long
|
java.lang.Number |
getNumberofDaysMonthsAsNumber()
Deprecated.
use #getNumberOfDaysMonthsAsLong() instead
|
java.lang.Number |
getNumberOfDaysMonthsAsNumber()
Deprecated.
use #getNumberOfDaysMonthsAsLong() instead
|
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 Field33K |
newInstance(Field33K source)
Copy constructor.
|
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern.
|
Field33K |
setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.
|
Field33K |
setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field33K |
setAmount(java.lang.String component5)
Set the Amount (component 5).
|
Field33K |
setCode(java.lang.String component3)
Set the Code (component 3).
|
Field33K |
setComponent1(java.lang.String component1)
Set the component 1 (DayMonth).
|
Field33K |
setComponent2(java.lang.Long component2)
Set the component2 from a Long object.
|
Field33K |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Number Of Days/Months (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field33K |
setComponent2(java.lang.String component2)
Set the component 2 (Number Of Days/Months).
|
Field33K |
setComponent3(java.lang.String component3)
Set the component 3 (Code).
|
Field33K |
setComponent4(java.util.Currency component4)
Set the component4 from a Currency object.
|
Field33K |
setComponent4(java.lang.String component4)
Set the component 4 (Currency).
|
Field33K |
setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.
|
Field33K |
setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field33K |
setComponent5(java.lang.String component5)
Set the component 5 (Amount).
|
Field33K |
setCurrency(java.util.Currency component4)
Set the Currency (component 4) from a Currency object.
|
Field33K |
setCurrency(java.lang.String component4)
Set the Currency (component 4).
|
Field33K |
setDayMonth(java.lang.String component1)
Set the DayMonth (component 1).
|
Field33K |
setDMMark(java.lang.String component1)
Deprecated.
use #setDayMonth(String) instead
|
Field33K |
setNumberofDaysMonths(java.lang.Long component2)
Deprecated.
use #setComponent2(java.lang.Long) instead
|
Field33K |
setNumberOfDaysMonths(java.lang.Long component2)
Set the Number Of Days/Months (component 2) from a Long object.
|
Field33K |
setNumberofDaysMonths(java.lang.Number component2)
Deprecated.
use #setNumberOfDaysMonths(java.lang.Long) instead
|
Field33K |
setNumberOfDaysMonths(java.lang.Number component2)
Alternative method setter for field's Number Of Days/Months (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field33K |
setNumberofDaysMonths(java.lang.String component2)
Deprecated.
use #setNumberOfDaysMonths(String) instead
|
Field33K |
setNumberOfDaysMonths(java.lang.String component2)
Set the Number Of Days/Months (component 2).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
typesPattern()
Returns the field component types pattern.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_33K
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer DAYMONTH
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer DM_MARK
public static final java.lang.Integer NUMBER_OF_DAYSMONTHS
public static final java.lang.Integer CODE
public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public Field33K()
public Field33K(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field33K(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field33K newInstance(Field33K 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 field@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public 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
public 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getDayMonth()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getDMMark()
public java.lang.String getComponent2()
public java.lang.Long getComponent2AsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent2AsNumber()
public java.lang.String getNumberOfDaysMonths()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getNumberofDaysMonths()
public java.lang.Long getNumberOfDaysMonthsAsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberOfDaysMonthsAsNumber()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Long getNumberofDaysMonthsAsLong()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberofDaysMonthsAsNumber()
public java.lang.String getComponent3()
public java.lang.String getCode()
public java.lang.String getComponent4()
public java.util.Currency getComponent4AsCurrency()
public java.lang.String getCurrency()
public java.util.Currency getCurrencyAsCurrency()
public java.lang.String getComponent5()
public java.math.BigDecimal getComponent5AsBigDecimal()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent5AsNumber()
public java.lang.String getAmount()
public java.math.BigDecimal getAmountAsBigDecimal()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getAmountAsNumber()
public Field33K setComponent1(java.lang.String component1)
component1
- the DayMonth to setpublic Field33K setDayMonth(java.lang.String component1)
component1
- the DayMonth to set@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field33K setDMMark(java.lang.String component1)
public Field33K setComponent2(java.lang.String component2)
component2
- the Number Of Days/Months to setpublic Field33K setComponent2(java.lang.Long component2)
component2
- the Long with the Number Of Days/Months content to setsetComponent2(String)
public Field33K setComponent2(java.lang.Number component2)
component2
- the Number with the Number Of Days/Months content to setsetNumberOfDaysMonths(java.lang.Long)
public Field33K setNumberOfDaysMonths(java.lang.String component2)
component2
- the Number Of Days/Months to setpublic Field33K setNumberOfDaysMonths(java.lang.Long component2)
component2
- Long with the Number Of Days/Months content to setsetComponent2(java.lang.Long)
public Field33K setNumberOfDaysMonths(java.lang.Number component2)
component2
- the Number with the Number Of Days/Months content to setsetNumberOfDaysMonths(java.lang.Long)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field33K setNumberofDaysMonths(java.lang.String component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field33K setNumberofDaysMonths(java.lang.Long component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field33K setNumberofDaysMonths(java.lang.Number component2)
public Field33K setComponent3(java.lang.String component3)
component3
- the Code to setpublic Field33K setCode(java.lang.String component3)
component3
- the Code to setpublic Field33K setComponent4(java.lang.String component4)
component4
- the Currency to setpublic Field33K setComponent4(java.util.Currency component4)
component4
- the Currency with the Currency content to setpublic Field33K setCurrency(java.lang.String component4)
component4
- the Currency to setpublic Field33K setCurrency(java.util.Currency component4)
component4
- Currency with the Currency content to setsetComponent4(java.util.Currency)
public Field33K setComponent5(java.lang.String component5)
component5
- the Amount to setpublic Field33K setComponent5(java.math.BigDecimal component5)
component5
- the BigDecimal with the Amount content to setpublic Field33K setComponent5(java.lang.Number component5)
component5
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field33K setAmount(java.lang.String component5)
component5
- the Amount to setpublic Field33K setAmount(java.math.BigDecimal component5)
component5
- BigDecimal with the Amount content to setsetComponent5(java.math.BigDecimal)
public Field33K setAmount(java.lang.Number component5)
component5
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
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()
MonetaryAmountResolver.amounts(Field)
public java.math.BigDecimal amount()
amount
in interface AmountContainer
MonetaryAmountResolver.amount(Field)
public java.lang.String getName()
public static Field33K get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33K get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field33K> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field33K> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field33K fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)