Field37A (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, DateContainer, PatternContainer, Serializable
```
@Generated
public class Field37A
extends Field
implements Serializable, DateContainer, AmountContainer
```
SWIFT MT Field 37A
Model and parser for field 37A of a SWIFT MT message.
Subfields (components) Data types
1. Number
2. Calendar
3. String
4. Number
5. String
Structure definition
- validation pattern: <AMOUNT>12[//<DATE2><DM>3n][/16x]
- parser pattern: N[//<DATE2>cS][/S]
- components pattern: NESNS
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 String`	`COMPONENTS_PATTERN`
`static Integer`	`DATE` Component number for the Date subfield
`static Integer`	`DM_MARK` Component number for the D/M Mark subfield
`static String`	`F_37A` same as NAME, intended to be clear when using static imports
`static Integer`	`INFORMATION` Component number for the Information subfield
`static String`	`NAME` Constant with the field name 37A
`static Integer`	`NUMBER_OF_DAYSMONTHS` Component number for the Number of Days/Months subfield
`static String`	`PARSER_PATTERN`
`static Integer`	`RATE` Component number for the Rate 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
`Field37A()` Default constructor.
`Field37A(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field37A(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<Calendar>`	`dates()` Get a calendar for every date found
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field37A`	`get(SwiftMessage msg)` Get the first instance of Field37A in the given message.
`static Field37A`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field37A>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field37A in the given message an empty list is returned if none found.
`static List<Field37A>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field37A from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`Number`	`getComponent1AsNumber()` Get the component1 as Number
`String`	`getComponent2()` Get the component2
`Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`String`	`getComponent3()` Get the component3
`String`	`getComponent3AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent4()` Get the component4
`Number`	`getComponent4AsNumber()` Get the component4 as Number
`String`	`getComponent5()` Get the component5
`String`	`getComponent5AsString()` Deprecated. use `Field.getComponent(int)` instead
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getDate()` Get the Date (component2).
`Calendar`	`getDateAsCalendar()` Get the Date (component2) as Calendar
`String`	`getDMMark()` Get the D/M Mark (component3).
`String`	`getInformation()` Get the Information (component5).
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getNumberofDaysMonths()` Get the Number of Days/Months (component4).
`Number`	`getNumberofDaysMonthsAsNumber()` Get the Number of Days/Months (component4) as Number
`String`	`getRate()` Get the Rate (component1).
`Number`	`getRateAsNumber()` Get the Rate (component1) as Number
`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.
`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 Field37A`	`newInstance(Field37A 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()`
`Field37A`	`setComponent1(Number component1)` Set the component1 from a Number object.
`Field37A`	`setComponent1(String component1)` Set the component1.
`Field37A`	`setComponent2(Calendar component2)` Set the component2 from a Calendar object.
`Field37A`	`setComponent2(String component2)` Set the component2.
`Field37A`	`setComponent3(String component3)` Set the component3.
`Field37A`	`setComponent4(Number component4)` Set the component4 from a Number object.
`Field37A`	`setComponent4(String component4)` Set the component4.
`Field37A`	`setComponent5(String component5)` Set the component5.
`Field37A`	`setDate(Calendar component2)` Set the Date (component2) from a Calendar object.
`Field37A`	`setDate(String component2)` Set the Date (component2).
`Field37A`	`setDMMark(String component3)` Set the D/M Mark (component3).
`Field37A`	`setInformation(String component5)` Set the Information (component5).
`Field37A`	`setNumberofDaysMonths(Number component4)` Set the Number of Days/Months (component4) from a Number object.
`Field37A`	`setNumberofDaysMonths(String component4)` Set the Number of Days/Months (component4).
`Field37A`	`setRate(Number component1)` Set the Rate (component1) from a Number object.
`Field37A`	`setRate(String component1)` Set the Rate (component1).
`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, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, 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 37A
    
    See Also:
    Constant Field Values
  - F_37A
```
public static final String F_37A
```
    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
  - RATE
```
public static final Integer RATE
```
    Component number for the Rate subfield
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - DM_MARK
```
public static final Integer DM_MARK
```
    Component number for the D/M Mark subfield
  - NUMBER_OF_DAYSMONTHS
```
public static final Integer NUMBER_OF_DAYSMONTHS
```
    Component number for the Number of Days/Months subfield
  - INFORMATION
```
public static final Integer INFORMATION
```
    Component number for the Information subfield
- Constructor Detail
  - Field37A
```
public Field37A()
```
    Default constructor. Creates a new field setting all components to null.
  - Field37A
```
public Field37A(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
  - Field37A
```
public Field37A(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 Field37A newInstance(Field37A 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
  - getComponent1AsNumber
```
public Number getComponent1AsNumber()
```
    Get the component1 as Number
    
    Returns:
    the component1 converted to Number or null if cannot be converted
  - getRate
```
public String getRate()
```
    Get the Rate (component1).
    
    Returns:
    the Rate from component1
  - getRateAsNumber
```
public Number getRateAsNumber()
```
    Get the Rate (component1) as Number
    
    Returns:
    the Rate from component1 converted to Number or null if cannot be converted
  - setComponent1
```
public Field37A setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field37A setComponent1(Number component1)
```
    Set the component1 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:
    component1 - the Number with the component1 content to set
  - setRate
```
public Field37A setRate(String component1)
```
    Set the Rate (component1).
    
    Parameters:
    component1 - the Rate to set
  - setRate
```
public Field37A setRate(Number component1)
```
    Set the Rate (component1) from a Number object.
    
    Parameters:
    component1 - Number with the Rate content to set
    See Also:
    setComponent1(java.lang.Number)
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsCalendar
```
public Calendar getComponent2AsCalendar()
```
    Get the component2 as Calendar
    
    Returns:
    the component2 converted to Calendar or null if cannot be converted
  - getDate
```
public String getDate()
```
    Get the Date (component2).
    
    Returns:
    the Date from component2
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component2) as Calendar
    
    Returns:
    the Date from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field37A setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field37A setComponent2(Calendar component2)
```
    Set the component2 from a Calendar 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:
    component2 - the Calendar with the component2 content to set
  - setDate
```
public Field37A setDate(String component2)
```
    Set the Date (component2).
    
    Parameters:
    component2 - the Date to set
  - setDate
```
public Field37A setDate(Calendar component2)
```
    Set the Date (component2) from a Calendar object.
    
    Parameters:
    component2 - Calendar with the Date content to set
    See Also:
    setComponent2(java.util.Calendar)
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent3AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(3)
  - getDMMark
```
public String getDMMark()
```
    Get the D/M Mark (component3).
    
    Returns:
    the D/M Mark from component3
  - setComponent3
```
public Field37A setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setDMMark
```
public Field37A setDMMark(String component3)
```
    Set the D/M Mark (component3).
    
    Parameters:
    component3 - the D/M Mark to set
  - 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
  - getNumberofDaysMonths
```
public String getNumberofDaysMonths()
```
    Get the Number of Days/Months (component4).
    
    Returns:
    the Number of Days/Months from component4
  - getNumberofDaysMonthsAsNumber
```
public Number getNumberofDaysMonthsAsNumber()
```
    Get the Number of Days/Months (component4) as Number
    
    Returns:
    the Number of Days/Months from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field37A setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field37A 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
  - setNumberofDaysMonths
```
public Field37A setNumberofDaysMonths(String component4)
```
    Set the Number of Days/Months (component4).
    
    Parameters:
    component4 - the Number of Days/Months to set
  - setNumberofDaysMonths
```
public Field37A setNumberofDaysMonths(Number component4)
```
    Set the Number of Days/Months (component4) from a Number object.
    
    Parameters:
    component4 - Number with the Number of Days/Months content to set
    See Also:
    setComponent4(java.lang.Number)
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getComponent5AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent5AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(5)
  - getInformation
```
public String getInformation()
```
    Get the Information (component5).
    
    Returns:
    the Information from component5
  - setComponent5
```
public Field37A setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - setInformation
```
public Field37A setInformation(String component5)
```
    Set the Information (component5).
    
    Parameters:
    component5 - the Information to set
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - 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
  - 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 Field37A.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 Field37A.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field37A 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 Field37A get(SwiftMessage msg)
```
    Get the first instance of Field37A 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<Field37A> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field37A 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<Field37A> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field37A 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 Field37A

SWIFT MT Field 37A

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_37A

PARSER_PATTERN

COMPONENTS_PATTERN

RATE

DATE

DM_MARK

NUMBER_OF_DAYSMONTHS

INFORMATION

Constructor Detail

Field37A

Field37A

Field37A

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsNumber

getRate

getRateAsNumber

setComponent1

setComponent1

setRate

setRate

getComponent2

getComponent2AsCalendar

getDate

getDateAsCalendar

setComponent2

setComponent2

setDate

setDate

getComponent3

getComponent3AsString

getDMMark

setComponent3

setDMMark

getComponent4

getComponent4AsNumber

getNumberofDaysMonths

getNumberofDaysMonthsAsNumber

setComponent4

setComponent4

setNumberofDaysMonths

setNumberofDaysMonths

getComponent5

getComponent5AsString

getInformation

setComponent5

setInformation

dates

amounts

amount

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay