@Generated public class Field34C extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer
Model and parser for field 34C of a SWIFT MT message.
Subfields (components) Data types
StringStringCurrencyBigDecimalStructure definition
4!c/[<N>]<CUR><AMOUNT>15S/[c]<CUR>NSSCNThis class complies with standard release SRU2021
| Modifier and Type | Field and Description |
|---|---|
static java.lang.Integer |
AMOUNT
Deprecated.
|
static java.lang.Integer |
AMOUNTRATE
Component number for the Amount/Rate subfield
|
static java.lang.Integer |
COMMISSION_TYPE
Component number for the Commission Type subfield
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.Integer |
CURRENCY
Deprecated.
|
static java.lang.Integer |
CURRENCYPERCENT
Component number for the Currency/Percent subfield
|
static java.lang.String |
F_34C
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 34C
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
SIGN
Component number for the Sign subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.
|
components| Constructor and Description |
|---|
Field34C()
Default constructor.
|
Field34C(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field34C(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.
|
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 Field34C |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field34C object.
|
static Field34C |
get(SwiftMessage msg)
Gets the first instance of Field34C in the given message.
|
static Field34C |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field34C> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field34C in the given message
an empty list is returned if none found.
|
static java.util.List<Field34C> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field34C from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Deprecated.
|
java.math.BigDecimal |
getAmountAsBigDecimal()
Deprecated.
|
java.lang.Number |
getAmountAsNumber()
Deprecated.
|
java.lang.String |
getAmountRate()
Gets the Amount/Rate (component 4).
|
java.math.BigDecimal |
getAmountRateAsBigDecimal()
Get the Amount/Rate (component 4) as BigDecimal
|
java.lang.Number |
getAmountRateAsNumber()
Deprecated.
|
java.lang.String |
getCommissionType()
Gets the Commission Type (component 1).
|
java.lang.String |
getComponent1()
Gets the component 1 (Commission Type).
|
java.lang.String |
getComponent2()
Gets the component 2 (Sign).
|
java.lang.String |
getComponent3()
Gets the component 3 (Currency/Percent).
|
java.util.Currency |
getComponent3AsCurrency()
Get the component 3 as Currency
|
java.lang.String |
getComponent4()
Gets the component 4 (Amount/Rate).
|
java.math.BigDecimal |
getComponent4AsBigDecimal()
Get the component 4 as BigDecimal
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
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()
Deprecated.
|
java.util.Currency |
getCurrencyAsCurrency()
Deprecated.
|
java.lang.String |
getCurrencyPercent()
Gets the Currency/Percent (component 3).
|
java.util.Currency |
getCurrencyPercentAsCurrency()
Get the Currency/Percent (component 3) 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 |
getSign()
Gets the Sign (component 2).
|
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 Field34C |
newInstance(Field34C 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
|
Field34C |
setAmount(java.math.BigDecimal component4)
Deprecated.
|
Field34C |
setAmount(java.lang.Number component4)
Deprecated.
|
Field34C |
setAmount(java.lang.String component4)
Deprecated.
|
Field34C |
setAmountRate(java.math.BigDecimal component4)
Set the Amount/Rate (component 4) from a BigDecimal object.
|
Field34C |
setAmountRate(java.lang.Number component4)
Alternative method setter for field's Amount/Rate (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field34C |
setAmountRate(java.lang.String component4)
Set the Amount/Rate (component 4).
|
Field34C |
setCommissionType(java.lang.String component1)
Set the Commission Type (component 1).
|
Field34C |
setComponent1(java.lang.String component1)
Set the component 1 (Commission Type).
|
Field34C |
setComponent2(java.lang.String component2)
Set the component 2 (Sign).
|
Field34C |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field34C |
setComponent3(java.lang.String component3)
Set the component 3 (Currency/Percent).
|
Field34C |
setComponent4(java.math.BigDecimal component4)
Set the component4 from a BigDecimal object.
|
Field34C |
setComponent4(java.lang.Number component4)
Alternative method setter for field's Amount/Rate (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field34C |
setComponent4(java.lang.String component4)
Set the component 4 (Amount/Rate).
|
Field34C |
setCurrency(java.util.Currency component3)
Deprecated.
|
Field34C |
setCurrency(java.lang.String component3)
Deprecated.
|
Field34C |
setCurrencyPercent(java.util.Currency component3)
Set the Currency/Percent (component 3) from a Currency object.
|
Field34C |
setCurrencyPercent(java.lang.String component3)
Set the Currency/Percent (component 3).
|
Field34C |
setSign(java.lang.String component2)
Set the Sign (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
This method returns a letter representing the type for each component in the Field.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_34C
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer COMMISSION_TYPE
public static final java.lang.Integer SIGN
public static final java.lang.Integer CURRENCYPERCENT
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer CURRENCY
CURRENCYPERCENTpublic static final java.lang.Integer AMOUNTRATE
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer AMOUNT
AMOUNTRATEpublic Field34C()
public Field34C(java.lang.String value)
value - complete field value including separators and CRLFpublic Field34C(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic static Field34C newInstance(Field34C source)
source - a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic 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 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 field@Deprecated @ProwideDeprecated(phase2=SRU2022) public final java.lang.String componentsPattern()
typesPattern() instead.componentsPattern in class FieldtypesPattern()public final java.lang.String typesPattern()
typesPattern in interface PatternContainertypesPattern in class FieldTYPES_PATTERNpublic final java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic final java.lang.String validatorPattern()
validatorPattern in class Fieldpublic boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize in class Fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap in class Fieldpublic java.lang.String getComponent1()
public java.lang.String getCommissionType()
public java.lang.String getComponent2()
public java.lang.String getSign()
public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
public java.lang.String getCurrencyPercent()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getCurrency()
getCurrencyPercent()public java.util.Currency getCurrencyPercentAsCurrency()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.util.Currency getCurrencyAsCurrency()
getCurrencyPercentAsCurrency()public java.lang.String getComponent4()
public java.math.BigDecimal getComponent4AsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent4AsNumber()
getComponent4AsBigDecimal() to get the proper value.getComponent4AsBigDecimal()public java.lang.String getAmountRate()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getAmount()
getAmountRate()public java.math.BigDecimal getAmountRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getAmountRateAsNumber()
getComponent4AsBigDecimal() to get the proper value.getAmountRateAsBigDecimal()@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.math.BigDecimal getAmountAsBigDecimal()
getAmountRateAsBigDecimal()@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getAmountAsNumber()
getComponent4AsBigDecimal() to get the proper value.getAmountRateAsBigDecimal()public Field34C setComponent1(java.lang.String component1)
component1 - the Commission Type to setpublic Field34C setCommissionType(java.lang.String component1)
component1 - the Commission Type to setpublic Field34C setComponent2(java.lang.String component2)
component2 - the Sign to setpublic Field34C setSign(java.lang.String component2)
component2 - the Sign to setpublic Field34C setComponent3(java.lang.String component3)
component3 - the Currency/Percent to setpublic Field34C setComponent3(java.util.Currency component3)
component3 - the Currency with the Currency/Percent content to setpublic Field34C setCurrencyPercent(java.lang.String component3)
component3 - the Currency/Percent to setpublic Field34C setCurrencyPercent(java.util.Currency component3)
component3 - Currency with the Currency/Percent content to setsetComponent3(java.util.Currency)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field34C setCurrency(java.lang.String component3)
component3 - the Currency/Percent to setsetCurrencyPercent(String)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field34C setCurrency(java.util.Currency component3)
component3 - Currency with the Currency/Percent content to setsetComponent3(java.util.Currency)public Field34C setComponent4(java.lang.String component4)
component4 - the Amount/Rate to setpublic Field34C setComponent4(java.math.BigDecimal component4)
component4 - the BigDecimal with the Amount/Rate content to setpublic Field34C setComponent4(java.lang.Number component4)
component4 - the Number with the Amount/Rate content to setsetAmountRate(java.math.BigDecimal)public Field34C setAmountRate(java.lang.String component4)
component4 - the Amount/Rate to setpublic Field34C setAmountRate(java.math.BigDecimal component4)
component4 - BigDecimal with the Amount/Rate content to setsetComponent4(java.math.BigDecimal)public Field34C setAmountRate(java.lang.Number component4)
component4 - the Number with the Amount/Rate content to setsetAmountRate(java.math.BigDecimal)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field34C setAmount(java.lang.String component4)
component4 - the Amount/Rate to setsetAmountRate(String)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field34C setAmount(java.math.BigDecimal component4)
component4 - BigDecimal with the Amount/Rate content to setsetComponent4(java.math.BigDecimal)@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field34C setAmount(java.lang.Number component4)
component4 - the Number with the Amount/Rate content to setsetAmountRate(java.math.BigDecimal)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()
amount in interface AmountContainerAmountResolver.amount(Field)public java.lang.String getName()
public static Field34C get(SwiftTagListBlock block)
block - may be null or emptypublic static Field34C get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field34C> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field34C> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic static Field34C fromJson(java.lang.String json)
json - JSON structure including tuples with label and value for all field componentsField.fromJson(String)