Field19A (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, CurrencyContainer, GenericField, PatternContainer, Serializable
```
@Generated
public class Field19A
extends Field
implements Serializable, CurrencyContainer, AmountContainer, GenericField
```
SWIFT MT Field 19A
Model and parser for field 19A 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]SN
- components pattern: SSCN
This class complies with standard release SRU2017

NOTE: this source code has been generated from template
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`AMOUNT` Component number for the Amount subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`CONDITIONAL_QUALIFIER` Component number for the conditional qualifier subfield
`static Integer`	`CURRENCY` Component number for the Currency subfield
`static String`	`F_19A` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 19A
`static String`	`PARSER_PATTERN`
`static Integer`	`QUALIFIER` Component number for the Qualifier subfield
`static 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
`Field19A()` Default constructor.
`Field19A(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field19A(Tag tag)` Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Methods
Modifier and Type	Method and Description
`BigDecimal`	`amount()` Get the first amount in this field.
`List<BigDecimal>`	`amounts()`
`String`	`componentsPattern()` Returns the field's components pattern
`int`	`componentsSize()` Returns the defined amount of components. This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
`List<Currency>`	`currencies()` Utility method that creates a Currency for every string returned by `CurrencyContainer.currencyStrings()`
`Currency`	`currency()` Analog to `CurrencyContainer.currencyString()`
`String`	`currencyString()` Get the single currency contained in this field.
`List<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 Field19A`	`get(SwiftMessage msg)` Get the first instance of Field19A in the given message.
`static Field19A`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field19A>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field19A in the given message an empty list is returned if none found.
`static List<Field19A>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field19A from the given block an empty list is returned if none found.
`String`	`getAmount()` Get the Amount (component4).
`Number`	`getAmountAsNumber()` Get the Amount (component4) as Number
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent3()` Get the component3
`Currency`	`getComponent3AsCurrency()` Get the component3 as Currency
`String`	`getComponent4()` Get the component4
`Number`	`getComponent4AsNumber()` Get the component4 as Number
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getConditionalQualifier()` Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
`String`	`getCurrency()` Get the Currency (component3).
`Currency`	`getCurrencyAsCurrency()` Get the Currency (component3) as Currency
`String`	`getDSS()` Returns the issuer code (or Data Source Scheme or DSS).
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getQualifier()` Get the Qualifier (component1).
`String`	`getSign()` Get the Sign (component2).
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`String`	`getValueDisplay(int component, Locale locale)` Returns a localized suitable for showing to humans string of a field component.
`void`	`initializeCurrencies(Currency cur)`
`void`	`initializeCurrencies(String cur)` set the currency of this field.
`boolean`	`isDSSPresent()` Checks if the issuer code (or Data Source Scheme or DSS) is present.
`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 Field19A`	`newInstance(Field19A source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(String value)` Parses the parameter value into the internal components structure.
`String`	`parserPattern()`
`Field19A`	`setAmount(Number component4)` Set the Amount (component4) from a Number object.
`Field19A`	`setAmount(String component4)` Set the Amount (component4).
`Field19A`	`setComponent1(String component1)` Set the component1.
`Field19A`	`setComponent2(String component2)` Set the component2.
`Field19A`	`setComponent3(Currency component3)` Set the component3 from a Currency object.
`Field19A`	`setComponent3(String component3)` Set the component3.
`Field19A`	`setComponent4(Number component4)` Set the component4 from a Number object.
`Field19A`	`setComponent4(String component4)` Set the component4.
`Field19A`	`setCurrency(Currency component3)` Set the Currency (component3) from a Currency object.
`Field19A`	`setCurrency(String component3)` Set the Currency (component3).
`Field19A`	`setQualifier(String component1)` Set the Qualifier (component1).
`Field19A`	`setSign(String component2)` Set the Sign (component2).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.
`String`	`validatorPattern()` Returns the field's validators 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, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, 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 String NAME
```
    Constant with the field name 19A
    
    See Also:
    Constant Field Values
  - F_19A
```
public static final String F_19A
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    See Also:
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    See Also:
    Constant Field Values
  - QUALIFIER
```
public static final Integer QUALIFIER
```
    Component number for the Qualifier subfield
  - SIGN
```
public static final Integer SIGN
```
    Component number for the Sign subfield
  - CURRENCY
```
public static final Integer CURRENCY
```
    Component number for the Currency subfield
  - AMOUNT
```
public static final Integer AMOUNT
```
    Component number for the Amount subfield
  - CONDITIONAL_QUALIFIER
```
public static final Integer CONDITIONAL_QUALIFIER
```
    Component number for the conditional qualifier subfield
- Constructor Detail
  - Field19A
```
public Field19A()
```
    Default constructor. Creates a new field setting all components to null.
  - Field19A
```
public Field19A(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
  - Field19A
```
public Field19A(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    Since:
    
    7.8
- Method Detail
  - parse
```
public void parse(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
  - newInstance
```
public static Field19A newInstance(Field19A 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
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Specified by:
    
    getValue in class Field
    
    Returns:
    SWIFT formatted value
  - tag
```
public static Tag tag(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
  - getComponent1
```
public String getComponent1()
```
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent1AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(1)
  - getQualifier
```
public String getQualifier()
```
    Get the Qualifier (component1).
    
    Returns:
    the Qualifier from component1
  - setComponent1
```
public Field19A setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setQualifier
```
public Field19A setQualifier(String component1)
```
    Set the Qualifier (component1).
    
    Parameters:
    component1 - the Qualifier to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent2AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(2)
  - getSign
```
public String getSign()
```
    Get the Sign (component2).
    
    Returns:
    the Sign from component2
  - setComponent2
```
public Field19A setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setSign
```
public Field19A setSign(String component2)
```
    Set the Sign (component2).
    
    Parameters:
    component2 - the Sign to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsCurrency
```
public Currency getComponent3AsCurrency()
```
    Get the component3 as Currency
    
    Returns:
    the component3 converted to Currency or null if cannot be converted
  - getCurrency
```
public String getCurrency()
```
    Get the Currency (component3).
    
    Returns:
    the Currency from component3
  - getCurrencyAsCurrency
```
public Currency getCurrencyAsCurrency()
```
    Get the Currency (component3) as Currency
    
    Returns:
    the Currency from component3 converted to Currency or null if cannot be converted
  - setComponent3
```
public Field19A setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field19A setComponent3(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 Field19A setCurrency(String component3)
```
    Set the Currency (component3).
    
    Parameters:
    component3 - the Currency to set
  - setCurrency
```
public Field19A setCurrency(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)
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsNumber
```
public Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    the component4 converted to Number or null if cannot be converted
  - getAmount
```
public String getAmount()
```
    Get the Amount (component4).
    
    Returns:
    the Amount from component4
  - getAmountAsNumber
```
public Number getAmountAsNumber()
```
    Get the Amount (component4) as Number
    
    Returns:
    the Amount from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field19A setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field19A setComponent4(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 Field19A setAmount(String component4)
```
    Set the Amount (component4).
    
    Parameters:
    component4 - the Amount to set
  - setAmount
```
public Field19A setAmount(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)
  - currencyStrings
```
public List<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:
    a list, with zero or more currencies in this field.
  - currencies
```
public List<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
  - currency
```
public 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 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(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(Currency cur)
```
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
    
    See Also:
    CurrencyContainer.initializeCurrencies(String)
  - amounts
```
public List<BigDecimal> amounts()
```
    See Also:
    AmountResolver.amounts(Field)
  - amount
```
public 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)
  - 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
  - getDSS
```
public String getDSS()
```
    Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.
    
    Specified by:
    
    getDSS in interface GenericField
    
    Overrides:
    
    getDSS in class Field
    
    Returns:
    DSS component value or null if the DSS is not set or not available for this field.
  - isDSSPresent
```
public boolean isDSSPresent()
```
    Checks if the issuer code (or Data Source Scheme or DSS) is present.
    
    Specified by:
    
    isDSSPresent in interface GenericField
    
    Overrides:
    
    isDSSPresent in class Field
    
    Returns:
    true if DSS is present, false otherwise.
    See Also:
    getDSS()
  - getConditionalQualifier
```
public String getConditionalQualifier()
```
    Gets the conditional qualifier.
    The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
    
    Specified by:
    
    getConditionalQualifier in interface GenericField
    
    Overrides:
    
    getConditionalQualifier in class Field
    
    Returns:
    for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public 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 Field19A.NAME
  - componentsPattern
```
public final String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    the static value of Field19A.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field19A get(SwiftTagListBlock block)
```
    Get 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 Field19A get(SwiftMessage msg)
```
    Get the first instance of Field19A 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 List<Field19A> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field19A 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 List<Field19A> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field19A 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
  - 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
  - getValueDisplay
```
public String getValueDisplay(int component,
                     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:
    
    IllegalArgumentException - if component number is invalid for the field
    Since:
    
    7.8
  - getComponentLabels
```
protected List<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)

Class Field19A

SWIFT MT Field 19A

Subfields (components) Data types

Structure definition

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_19A

PARSER_PATTERN

COMPONENTS_PATTERN

QUALIFIER

SIGN

CURRENCY

AMOUNT

CONDITIONAL_QUALIFIER

Constructor Detail

Field19A

Field19A

Field19A

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getQualifier

setComponent1

setQualifier

getComponent2

getComponent2AsString

getSign

setComponent2

setSign

getComponent3

getComponent3AsCurrency

getCurrency

getCurrencyAsCurrency

setComponent3

setComponent3

setCurrency

setCurrency

getComponent4

getComponent4AsNumber

getAmount

getAmountAsNumber

setComponent4

setComponent4

setAmount

setAmount

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

amounts

amount

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay