Field34C (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.field.Field
- - com.prowidesoftware.swift.model.field.Field34C

All Implemented Interfaces:

JsonSerializable, AmountContainer, CurrencyContainer, MonetaryAmountContainer, PatternContainer, java.io.Serializable
```
@Generated
public class Field34C
extends Field
implements java.io.Serializable, MonetaryAmountContainer
```
SWIFT MT Field 34C.
Model and parser for field 34C of a SWIFT MT message.
Subfields (components) Data types
1. String
2. String
3. Currency
4. BigDecimal
Structure definition
- validation pattern: 4!c/[<N>]<CUR><AMOUNT>15
- parser pattern: S/[c]<CUR>N
- components pattern: SSCN
This class complies with standard release SRU2021
See Also:

Serialized Form

Field Summary

Fields
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. Use `typesPattern()` method instead.
`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` Deprecated. Use `parserPattern()` method instead.
`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` Deprecated. Use `typesPattern()` method instead.

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 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.
`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.
`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.
`java.lang.String`	`validatorPattern()` Returns the field validator pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field
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, validName

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SRU
```
public static final int SRU
```
    Constant identifying the SRU to which this class belongs to.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final java.lang.String NAME
```
    Constant with the field name 34C.
    
    See Also:
    
    Constant Field Values
  - F_34C
```
public static final java.lang.String F_34C
```
    Same as NAME, intended to be clear when using static imports.
    
    See Also:
    
    Constant Field Values
  - PARSER_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String PARSER_PATTERN
```
    Deprecated. Use parserPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String COMPONENTS_PATTERN
```
    Deprecated. Use typesPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - TYPES_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String TYPES_PATTERN
```
    Deprecated. Use typesPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - COMMISSION_TYPE
```
public static final java.lang.Integer COMMISSION_TYPE
```
    Component number for the Commission Type subfield.
  - SIGN
```
public static final java.lang.Integer SIGN
```
    Component number for the Sign subfield.
  - CURRENCYPERCENT
```
public static final java.lang.Integer CURRENCYPERCENT
```
    Component number for the Currency/Percent subfield.
  - CURRENCY
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.Integer CURRENCY
```
    Deprecated.
    
    Alternative (DEPRECATED) constant name for field's Currency/Percent Component number.
    
    See Also:
    
    CURRENCYPERCENT
  - AMOUNTRATE
```
public static final java.lang.Integer AMOUNTRATE
```
    Component number for the Amount/Rate subfield.
  - AMOUNT
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.Integer AMOUNT
```
    Deprecated.
    
    Alternative (DEPRECATED) constant name for field's Amount/Rate Component number.
    
    See Also:
    
    AMOUNTRATE
- Constructor Detail
  - Field34C
```
public Field34C()
```
    Default constructor. Creates a new field setting all components to null.
  - Field34C
```
public Field34C(java.lang.String value)
```
    Creates a new field and initializes its components with content from the parameter value.
    
    Parameters:
    
    value - complete field value including separators and CRLF
  - Field34C
```
public Field34C(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    
    Since:
    
    7.8
- Method Detail
  - newInstance
```
public static Field34C newInstance(Field34C source)
```
    Copy constructor. Initializes the components list with a deep copy of the source components list.
    
    Parameters:
    
    source - a field instance to copy
    
    Since:
    
    7.7
  - tag
```
public static Tag tag(java.lang.String value)
```
    Create a Tag with this field name and the given value. Shorthand for new Tag(NAME, value)
    
    Since:
    
    7.5
    
    See Also:
    
    NAME
  - emptyTag
```
public static Tag emptyTag()
```
    Create a Tag with this field name and an empty string as value. Shorthand for new Tag(NAME, "")
    
    Since:
    
    7.5
    
    See Also:
    
    NAME
  - parse
```
public void parse(java.lang.String value)
```
    Parses the parameter value into the internal components structure.
    Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
    
    Specified by:
    
    parse in class Field
    
    Parameters:
    
    value - complete field value including separators and CRLF
    
    Since:
    
    7.8
  - getValue
```
public java.lang.String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Specified by:
    
    getValue in class Field
    
    Returns:
    
    SWIFT formatted value
  - getValueDisplay
```
public java.lang.String getValueDisplay(int component,
                                        java.util.Locale locale)
```
    Returns a localized suitable for showing to humans string of a field component.
    
    Specified by:
    
    getValueDisplay in class Field
    
    Parameters:
    
    component - number of the component to display
    
    locale - optional locale to format date and amounts, if null, the default locale is used
    
    Returns:
    
    formatted component value or null if component number is invalid or not present
    
    Throws:
    
    java.lang.IllegalArgumentException - if component number is invalid for the field
    
    Since:
    
    7.8
  - componentsPattern
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.String componentsPattern()
```
    Deprecated. Use typesPattern() instead.
    
    Description copied from class: Field
    
    Returns the field components pattern This method is DEPRECATED, use typesPattern() instead.
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field${dto.getField()}.COMPONENTS_PATTERN
    
    See Also:
    
    Field.typesPattern()
  - typesPattern
```
public java.lang.String typesPattern()
```
    Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).
    
    Specified by:
    
    typesPattern in interface PatternContainer
    
    Specified by:
    
    typesPattern in class Field
    
    Since:
    
    9.2.7
  - parserPattern
```
public java.lang.String parserPattern()
```
    Returns the field parser pattern.
    
    Specified by:
    
    parserPattern in interface PatternContainer
  - validatorPattern
```
public java.lang.String validatorPattern()
```
    Returns the field validator pattern
    
    Specified by:
    
    validatorPattern in class Field
  - isOptional
```
public 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.
    
    Specified by:
    
    isOptional in class Field
    
    Parameters:
    
    component - component number, first component of a field is referenced as 1
    
    Returns:
    
    true if the component is optional for this field, false otherwise
  - isGeneric
```
public boolean isGeneric()
```
    Returns true if the field is a GENERIC FIELD as specified by the standard.
    
    Specified by:
    
    isGeneric in class Field
    
    Returns:
    
    true if the field is generic, false otherwise
  - componentsSize
```
public 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.
    
    Specified by:
    
    componentsSize in class Field
    
    Since:
    
    7.7
  - getComponentLabels
```
public java.util.List<java.lang.String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Specified by:
    
    getComponentLabels in class Field
    
    Since:
    
    7.8.4
    
    See Also:
    
    Field.getComponentLabel(int)
  - getComponentMap
```
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
```
    Returns a mapping between component numbers and their label in camel case format.
    
    Specified by:
    
    getComponentMap in class Field
    
    Since:
    
    7.10.3
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component 1 (Commission Type).
    
    Returns:
    
    the component 1
  - getCommissionType
```
public java.lang.String getCommissionType()
```
    Gets the Commission Type (component 1).
    
    Returns:
    
    the Commission Type from component 1
  - getComponent2
```
public java.lang.String getComponent2()
```
    Gets the component 2 (Sign).
    
    Returns:
    
    the component 2
  - getSign
```
public java.lang.String getSign()
```
    Gets the Sign (component 2).
    
    Returns:
    
    the Sign from component 2
  - getComponent3
```
public java.lang.String getComponent3()
```
    Gets the component 3 (Currency/Percent).
    
    Returns:
    
    the component 3
  - getComponent3AsCurrency
```
public java.util.Currency getComponent3AsCurrency()
```
    Get the component 3 as Currency
    
    Returns:
    
    the component 3 converted to Currency or null if cannot be converted
  - getCurrencyPercent
```
public java.lang.String getCurrencyPercent()
```
    Gets the Currency/Percent (component 3).
    
    Returns:
    
    the Currency/Percent from component 3
  - getCurrency
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.String getCurrency()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Currency/Percent
    
    Since:
    
    9.2.7
    
    See Also:
    
    getCurrencyPercent()
  - getCurrencyPercentAsCurrency
```
public java.util.Currency getCurrencyPercentAsCurrency()
```
    Get the Currency/Percent (component 3) as Currency
    
    Returns:
    
    the Currency/Percent from component 3 converted to Currency or null if cannot be converted
  - getCurrencyAsCurrency
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.util.Currency getCurrencyAsCurrency()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Currency/Percent as Currency
    
    See Also:
    
    getCurrencyPercentAsCurrency()
  - getComponent4
```
public java.lang.String getComponent4()
```
    Gets the component 4 (Amount/Rate).
    
    Returns:
    
    the component 4
  - getComponent4AsBigDecimal
```
public java.math.BigDecimal getComponent4AsBigDecimal()
```
    Get the component 4 as BigDecimal
    
    Returns:
    
    the component 4 converted to BigDecimal or null if cannot be converted
    
    Since:
    
    9.2.7
  - getComponent4AsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent4AsNumber()
```
    Deprecated.
    
    Get the component 4 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent4AsBigDecimal() to get the proper value.
    
    Returns:
    
    the component 4 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getComponent4AsBigDecimal()
  - getAmountRate
```
public java.lang.String getAmountRate()
```
    Gets the Amount/Rate (component 4).
    
    Returns:
    
    the Amount/Rate from component 4
  - getAmount
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.String getAmount()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Amount/Rate
    
    Since:
    
    9.2.7
    
    See Also:
    
    getAmountRate()
  - getAmountRateAsBigDecimal
```
public java.math.BigDecimal getAmountRateAsBigDecimal()
```
    Get the Amount/Rate (component 4) as BigDecimal
    
    Returns:
    
    the Amount/Rate from component 4 converted to BigDecimal or null if cannot be converted
    
    Since:
    
    9.2.7
  - getAmountRateAsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getAmountRateAsNumber()
```
    Deprecated.
    
    Get the Amount/Rate (component 4) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent4AsBigDecimal() to get the proper value.
    
    Returns:
    
    the component 4 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getAmountRateAsBigDecimal()
  - getAmountAsBigDecimal
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.math.BigDecimal getAmountAsBigDecimal()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Amount/Rate as BigDecimal
    
    See Also:
    
    getAmountRateAsBigDecimal()
  - getAmountAsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getAmountAsNumber()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Amount/Rate (component 4) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent4AsBigDecimal() to get the proper value.
    
    Returns:
    
    the component 4 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getAmountRateAsBigDecimal()
  - setComponent1
```
public Field34C setComponent1(java.lang.String component1)
```
    Set the component 1 (Commission Type).
    
    Parameters:
    
    component1 - the Commission Type to set
    
    Returns:
    
    the field object to enable build pattern
  - setCommissionType
```
public Field34C setCommissionType(java.lang.String component1)
```
    Set the Commission Type (component 1).
    
    Parameters:
    
    component1 - the Commission Type to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent2
```
public Field34C setComponent2(java.lang.String component2)
```
    Set the component 2 (Sign).
    
    Parameters:
    
    component2 - the Sign to set
    
    Returns:
    
    the field object to enable build pattern
  - setSign
```
public Field34C setSign(java.lang.String component2)
```
    Set the Sign (component 2).
    
    Parameters:
    
    component2 - the Sign to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field34C setComponent3(java.lang.String component3)
```
    Set the component 3 (Currency/Percent).
    
    Parameters:
    
    component3 - the Currency/Percent to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field34C setComponent3(java.util.Currency component3)
```
    Set the component3 from a Currency object.
    
    Parameters:
    
    component3 - the Currency with the Currency/Percent content to set
    
    Returns:
    
    the field object to enable build pattern
  - setCurrencyPercent
```
public Field34C setCurrencyPercent(java.lang.String component3)
```
    Set the Currency/Percent (component 3).
    
    Parameters:
    
    component3 - the Currency/Percent to set
    
    Returns:
    
    the field object to enable build pattern
  - setCurrencyPercent
```
public Field34C setCurrencyPercent(java.util.Currency component3)
```
    Set the Currency/Percent (component 3) from a Currency object.
    
    Parameters:
    
    component3 - Currency with the Currency/Percent content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setComponent3(java.util.Currency)
  - setCurrency
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field34C setCurrency(java.lang.String component3)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Currency/Percent
    
    Parameters:
    
    component3 - the Currency/Percent to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setCurrencyPercent(String)
  - setCurrency
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field34C setCurrency(java.util.Currency component3)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Currency/Percent from a Currency object.
    
    Parameters:
    
    component3 - Currency with the Currency/Percent content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setComponent3(java.util.Currency)
  - setComponent4
```
public Field34C setComponent4(java.lang.String component4)
```
    Set the component 4 (Amount/Rate).
    
    Parameters:
    
    component4 - the Amount/Rate to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent4
```
public Field34C setComponent4(java.math.BigDecimal component4)
```
    Set the component4 from a BigDecimal object.
    Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    
    component4 - the BigDecimal with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
  - setComponent4
```
public 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)
    
    Parameters:
    
    component4 - the Number with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setAmountRate(java.math.BigDecimal)
  - setAmountRate
```
public Field34C setAmountRate(java.lang.String component4)
```
    Set the Amount/Rate (component 4).
    
    Parameters:
    
    component4 - the Amount/Rate to set
    
    Returns:
    
    the field object to enable build pattern
  - setAmountRate
```
public Field34C setAmountRate(java.math.BigDecimal component4)
```
    Set the Amount/Rate (component 4) from a BigDecimal object.
    
    Parameters:
    
    component4 - BigDecimal with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
    
    See Also:
    
    setComponent4(java.math.BigDecimal)
  - setAmountRate
```
public 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)
    
    Parameters:
    
    component4 - the Number with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setAmountRate(java.math.BigDecimal)
  - setAmount
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field34C setAmount(java.lang.String component4)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Amount/Rate
    
    Parameters:
    
    component4 - the Amount/Rate to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setAmountRate(String)
  - setAmount
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field34C setAmount(java.math.BigDecimal component4)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Amount/Rate from a BigDecimal object.
    
    Parameters:
    
    component4 - BigDecimal with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
    
    See Also:
    
    setComponent4(java.math.BigDecimal)
  - setAmount
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field34C setAmount(java.lang.Number component4)
```
    Deprecated.
    
    Alternative DEPRECATED 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)
    
    Parameters:
    
    component4 - the Number with the Amount/Rate content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setAmountRate(java.math.BigDecimal)
  - currencyStrings
```
public java.util.List<java.lang.String> currencyStrings()
```
    Description copied from interface: CurrencyContainer
    
    Get a list of strings of currencies present in this field
    
    Specified by:
    
    currencyStrings in interface CurrencyContainer
    
    Returns:
    
    found currency codes or empty list
  - currencies
```
public java.util.List<java.util.Currency> currencies()
```
    Description copied from interface: CurrencyContainer
    
    Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()
    
    Specified by:
    
    currencies in interface CurrencyContainer
    
    Returns:
    
    found currencies or empty list
  - currency
```
public java.util.Currency currency()
```
    Description copied from interface: CurrencyContainer
    
    Analog to CurrencyContainer.currencyString()
    
    Specified by:
    
    currency in interface CurrencyContainer
    
    See Also:
    
    CurrencyContainer.currencyStrings(), CurrencyContainer.currencyString()
  - currencyString
```
public java.lang.String currencyString()
```
    Description copied from interface: CurrencyContainer
    
    Get the single currency contained in this field.
    
    Specified by:
    
    currencyString in interface CurrencyContainer
    
    Returns:
    
    null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.
  - initializeCurrencies
```
public void initializeCurrencies(java.lang.String cur)
```
    Description copied from interface: CurrencyContainer
    
    Set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.
    
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
  - initializeCurrencies
```
public void initializeCurrencies(java.util.Currency cur)
```
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
    
    See Also:
    
    CurrencyContainer.initializeCurrencies(String)
  - amounts
```
public java.util.List<java.math.BigDecimal> amounts()
```
    Returns the list of all NON-NULL amounts as BigDecimal
    
    Returns:
    
    the list of NON-NULL amounts as BigDecimal values
    
    See Also:
    
    MonetaryAmountResolver.amounts(Field)
  - amount
```
public java.math.BigDecimal amount()
```
    Returns the first amounts as BigDecimal
    
    Specified by:
    
    amount in interface AmountContainer
    
    Returns:
    
    the first amount as BigDecimal value. Can be null
    
    See Also:
    
    MonetaryAmountResolver.amount(Field)
  - getName
```
public java.lang.String getName()
```
    Returns the field's name composed by the field number and the letter option (if any).
    
    Specified by:
    
    getName in class Field
    
    Returns:
    
    the static value of Field34C.NAME
  - get
```
public static Field34C get(SwiftTagListBlock block)
```
    Gets the first occurrence form the tag list or null if not found.
    
    Parameters:
    
    block - may be null or empty
    
    Returns:
    
    null if not found o block is null or empty
  - get
```
public static Field34C get(SwiftMessage msg)
```
    Gets the first instance of Field34C in the given message.
    
    Parameters:
    
    msg - may be empty or null
    
    Returns:
    
    null if not found or msg is empty or null
    
    See Also:
    
    get(SwiftTagListBlock)
  - getAll
```
public 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.
    
    Parameters:
    
    msg - may be empty or null in which case an empty list is returned
    
    See Also:
    
    getAll(SwiftTagListBlock)
  - getAll
```
public 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.
    
    Parameters:
    
    block - may be empty or null in which case an empty list is returned
  - fromJson
```
public static Field34C fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field34C object.
    
    Parameters:
    
    json - JSON structure including tuples with label and value for all field components
    
    Returns:
    
    a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
    
    Since:
    
    7.10.3
    
    See Also:
    
    Field.fromJson(String)

Class Field34C

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.field.Field

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.field.Field

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

F_34C

PARSER_PATTERN

COMPONENTS_PATTERN

TYPES_PATTERN

COMMISSION_TYPE

SIGN

CURRENCYPERCENT

CURRENCY

AMOUNTRATE

AMOUNT

Constructor Detail

Field34C

Field34C

Field34C

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getComponent1

getCommissionType

getComponent2

getSign

getComponent3

getComponent3AsCurrency

getCurrencyPercent

getCurrency

getCurrencyPercentAsCurrency

getCurrencyAsCurrency

getComponent4

getComponent4AsBigDecimal

getComponent4AsNumber

getAmountRate

getAmount

getAmountRateAsBigDecimal

getAmountRateAsNumber

getAmountAsBigDecimal

getAmountAsNumber

setComponent1

setCommissionType

setComponent2

setSign

setComponent3

setComponent3

setCurrencyPercent

setCurrencyPercent

setCurrency

setCurrency

setComponent4

setComponent4

setComponent4

setAmountRate

setAmountRate

setAmountRate

setAmount

setAmount

setAmount

currencyStrings

currencies