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, PatternContainer, java.io.Serializable
```
@Generated
public class Field34C
extends Field
implements java.io.Serializable, CurrencyContainer, AmountContainer
```
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. Number
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 SRU2020
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`AMOUNT` Component number for the Amount subfield
`static java.lang.Integer`	`COMMISSION_TYPE` Component number for the Commission Type subfield
`static java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.Integer`	`CURRENCY` Component number for the Currency 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.

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
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 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()` Gets the Amount (component 4).
`java.lang.Number`	`getAmountAsNumber()` Get the Amount (component 4) as Number
`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).
`java.util.Currency`	`getComponent3AsCurrency()` Get the component 3 as Currency
`java.lang.String`	`getComponent4()` Gets the component 4 (Amount).
`java.lang.Number`	`getComponent4AsNumber()` Get the component 4 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 3).
`java.util.Currency`	`getCurrencyAsCurrency()` Get the Currency (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.lang.Number component4)` Set the Amount (component4) from a Number object.
`Field34C`	`setAmount(java.lang.String component4)` Set the Amount (component4).
`Field34C`	`setCommissionType(java.lang.String component1)` Set the Commission Type (component1).
`Field34C`	`setComponent1(java.lang.String component1)` Set the component1 (Commission Type).
`Field34C`	`setComponent2(java.lang.String component2)` Set the component2 (Sign).
`Field34C`	`setComponent3(java.util.Currency component3)` Set the component3 from a Currency object.
`Field34C`	`setComponent3(java.lang.String component3)` Set the component3 (Currency).
`Field34C`	`setComponent4(java.lang.Number component4)` Set the component4 from a Number object.
`Field34C`	`setComponent4(java.lang.String component4)` Set the component4 (Amount).
`Field34C`	`setCurrency(java.util.Currency component3)` Set the Currency (component3) from a Currency object.
`Field34C`	`setCurrency(java.lang.String component3)` Set the Currency (component3).
`Field34C`	`setSign(java.lang.String component2)` Set the Sign (component2).
`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

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, 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

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
```
public static final java.lang.String PARSER_PATTERN
```
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final java.lang.String COMPONENTS_PATTERN
```
    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
  - CURRENCY
```
public static final java.lang.Integer CURRENCY
```
    Component number for the Currency subfield
  - AMOUNT
```
public static final java.lang.Integer AMOUNT
```
    Component number for the Amount subfield
- 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
```
public final java.lang.String componentsPattern()
```
    Returns the field components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field34C.COMPONENTS_PATTERN
  - parserPattern
```
public final java.lang.String parserPattern()
```
    Returns the field parser pattern
    
    Specified by:
    
    parserPattern in interface PatternContainer
    
    Returns:
    
    the static value of Field34C.PARSER_PATTERN
  - validatorPattern
```
public final 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
```
protected 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).
    
    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
  - getCurrency
```
public java.lang.String getCurrency()
```
    Gets the Currency (component 3).
    
    Returns:
    
    the Currency from component 3
  - getCurrencyAsCurrency
```
public java.util.Currency getCurrencyAsCurrency()
```
    Get the Currency (component 3) as Currency
    
    Returns:
    
    the Currency from component 3 converted to Currency or null if cannot be converted
  - getComponent4
```
public java.lang.String getComponent4()
```
    Gets the component 4 (Amount).
    
    Returns:
    
    the component 4
  - getComponent4AsNumber
```
public java.lang.Number getComponent4AsNumber()
```
    Get the component 4 as Number
    
    Returns:
    
    the component 4 converted to Number or null if cannot be converted
  - getAmount
```
public java.lang.String getAmount()
```
    Gets the Amount (component 4).
    
    Returns:
    
    the Amount from component 4
  - getAmountAsNumber
```
public java.lang.Number getAmountAsNumber()
```
    Get the Amount (component 4) as Number
    
    Returns:
    
    the Amount from component 4 converted to Number or null if cannot be converted
  - 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()
```
    See Also:
    
    AmountResolver.amounts(Field)
  - amount
```
public java.math.BigDecimal amount()
```
    Description copied from interface: AmountContainer
    
    Get the first amount in this field.
    
    Specified by:
    
    amount in interface AmountContainer
    
    See Also:
    
    AmountResolver.amount(Field)
  - setComponent1
```
public Field34C setComponent1(java.lang.String component1)
```
    Set the component1 (Commission Type).
    
    Parameters:
    
    component1 - the component1 to set
  - setCommissionType
```
public Field34C setCommissionType(java.lang.String component1)
```
    Set the Commission Type (component1).
    
    Parameters:
    
    component1 - the Commission Type to set
  - setComponent2
```
public Field34C setComponent2(java.lang.String component2)
```
    Set the component2 (Sign).
    
    Parameters:
    
    component2 - the component2 to set
  - setSign
```
public Field34C setSign(java.lang.String component2)
```
    Set the Sign (component2).
    
    Parameters:
    
    component2 - the Sign to set
  - setComponent3
```
public Field34C setComponent3(java.lang.String component3)
```
    Set the component3 (Currency).
    
    Parameters:
    
    component3 - the component3 to set
  - setComponent3
```
public Field34C setComponent3(java.util.Currency component3)
```
    Set the component3 from a Currency object.
    Parses the Number 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:
    
    component3 - the Currency with the component3 content to set
  - setCurrency
```
public Field34C setCurrency(java.lang.String component3)
```
    Set the Currency (component3).
    
    Parameters:
    
    component3 - the Currency to set
  - setCurrency
```
public Field34C setCurrency(java.util.Currency component3)
```
    Set the Currency (component3) from a Currency object.
    
    Parameters:
    
    component3 - Currency with the Currency content to set
    
    See Also:
    
    setComponent3(java.util.Currency)
  - setComponent4
```
public Field34C setComponent4(java.lang.String component4)
```
    Set the component4 (Amount).
    
    Parameters:
    
    component4 - the component4 to set
  - setComponent4
```
public Field34C setComponent4(java.lang.Number component4)
```
    Set the component4 from a Number object.
    Parses the Number 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 Number with the component4 content to set
  - setAmount
```
public Field34C setAmount(java.lang.String component4)
```
    Set the Amount (component4).
    
    Parameters:
    
    component4 - the Amount to set
  - setAmount
```
public Field34C setAmount(java.lang.Number component4)
```
    Set the Amount (component4) from a Number object.
    
    Parameters:
    
    component4 - Number with the Amount content to set
    
    See Also:
    
    setComponent4(java.lang.Number)
  - 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

COMMISSION_TYPE

SIGN

CURRENCY

AMOUNT

Constructor Detail

Field34C

Field34C

Field34C

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getComponent1

getCommissionType

getComponent2

getSign

getComponent3

getComponent3AsCurrency

getCurrency

getCurrencyAsCurrency

getComponent4

getComponent4AsNumber

getAmount

getAmountAsNumber

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

amounts

amount

setComponent1

setCommissionType

setComponent2

setSign

setComponent3

setComponent3

setCurrency

setCurrency

setComponent4

setComponent4

setAmount

setAmount

getName

get

get

getAll

getAll

fromJson