Field62M (Prowide Core API Reference)

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

All Implemented Interfaces:

AmountContainer, DateContainer, PatternContainer, java.io.Serializable
```
@Generated
public class Field62M
extends Field
implements java.io.Serializable, DateContainer, AmountContainer
```
SWIFT MT Field 62M
Model and parser for field 62M of a SWIFT MT message.
Subfields (components) Data types
1. String
2. Calendar
3. String
4. Number
Structure definition
- validation pattern: <DC><DATE2><3!a><AMOUNT>15
- parser pattern: [c]<DATE2>SN
- components pattern: SESN
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 java.lang.Integer`	`AMOUNT` Component number for the Amount subfield
`static java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.Integer`	`CURRENCY` Component number for the Currency subfield
`static java.lang.Integer`	`DATE` Component number for the Date subfield
`static java.lang.Integer`	`DC_MARK` Component number for the D/C Mark subfield
`static java.lang.String`	`F_62M` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 62M
`static java.lang.String`	`PARSER_PATTERN`
`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
`Field62M()` Default constructor.
`Field62M(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field62M(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()` Get the first amount in this field.
`java.util.List<java.math.BigDecimal>`	`amounts()`
`java.lang.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.
`java.util.List<java.util.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 Field62M`	`get(SwiftMessage msg)` Get the first instance of Field62M in the given message.
`static Field62M`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static java.util.List<Field62M>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field62M in the given message an empty list is returned if none found.
`static java.util.List<Field62M>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field62M from the given block an empty list is returned if none found.
`java.lang.String`	`getAmount()` Get the Amount (component4).
`java.lang.Number`	`getAmountAsNumber()` Get the Amount (component4) as Number
`java.lang.String`	`getComponent1()` Get the component1
`java.lang.String`	`getComponent1AsString()` Deprecated. use `Field.getComponent(int)` instead
`java.lang.String`	`getComponent2()` Get the component2
`java.util.Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`java.lang.String`	`getComponent3()` Get the component3
`java.lang.String`	`getComponent3AsString()` Deprecated. use `Field.getComponent(int)` instead
`java.lang.String`	`getComponent4()` Get the component4
`java.lang.Number`	`getComponent4AsNumber()` Get the component4 as Number
`protected java.util.List<java.lang.String>`	`getComponentLabels()` Returns english label for components.
`java.lang.String`	`getCurrency()` Get the Currency (component3).
`java.lang.String`	`getDate()` Get the Date (component2).
`java.util.Calendar`	`getDateAsCalendar()` Get the Date (component2) as Calendar
`java.lang.String`	`getDCMark()` Get the D/C Mark (component1).
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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.
`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 Field62M`	`newInstance(Field62M 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()`
`Field62M`	`setAmount(java.lang.Number component4)` Set the Amount (component4) from a Number object.
`Field62M`	`setAmount(java.lang.String component4)` Set the Amount (component4).
`Field62M`	`setComponent1(java.lang.String component1)` Set the component1.
`Field62M`	`setComponent2(java.util.Calendar component2)` Set the component2 from a Calendar object.
`Field62M`	`setComponent2(java.lang.String component2)` Set the component2.
`Field62M`	`setComponent3(java.lang.String component3)` Set the component3.
`Field62M`	`setComponent4(java.lang.Number component4)` Set the component4 from a Number object.
`Field62M`	`setComponent4(java.lang.String component4)` Set the component4.
`Field62M`	`setCurrency(java.lang.String component3)` Set the Currency (component3).
`Field62M`	`setDate(java.util.Calendar component2)` Set the Date (component2) from a Calendar object.
`Field62M`	`setDate(java.lang.String component2)` Set the Date (component2).
`Field62M`	`setDCMark(java.lang.String component1)` Set the D/C Mark (component1).
`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'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, 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 java.lang.String NAME
```
    Constant with the field name 62M
    
    See Also:
    
    Constant Field Values
  - F_62M
```
public static final java.lang.String F_62M
```
    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
  - DC_MARK
```
public static final java.lang.Integer DC_MARK
```
    Component number for the D/C Mark subfield
  - DATE
```
public static final java.lang.Integer DATE
```
    Component number for the Date 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
  - Field62M
```
public Field62M()
```
    Default constructor. Creates a new field setting all components to null.
  - Field62M
```
public Field62M(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
  - Field62M
```
public Field62M(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
  - 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
  - newInstance
```
public static Field62M newInstance(Field62M 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 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
  - 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
  - getComponent1
```
public java.lang.String getComponent1()
```
    Get the component1
    
    Returns:
    
    the component1
  - getComponent1AsString
```
@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent1AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(1)
  - getDCMark
```
public java.lang.String getDCMark()
```
    Get the D/C Mark (component1).
    
    Returns:
    
    the D/C Mark from component1
  - setComponent1
```
public Field62M setComponent1(java.lang.String component1)
```
    Set the component1.
    
    Parameters:
    
    component1 - the component1 to set
  - setDCMark
```
public Field62M setDCMark(java.lang.String component1)
```
    Set the D/C Mark (component1).
    
    Parameters:
    
    component1 - the D/C Mark to set
  - getComponent2
```
public java.lang.String getComponent2()
```
    Get the component2
    
    Returns:
    
    the component2
  - getComponent2AsCalendar
```
public java.util.Calendar getComponent2AsCalendar()
```
    Get the component2 as Calendar
    
    Returns:
    
    the component2 converted to Calendar or null if cannot be converted
  - getDate
```
public java.lang.String getDate()
```
    Get the Date (component2).
    
    Returns:
    
    the Date from component2
  - getDateAsCalendar
```
public java.util.Calendar getDateAsCalendar()
```
    Get the Date (component2) as Calendar
    
    Returns:
    
    the Date from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field62M setComponent2(java.lang.String component2)
```
    Set the component2.
    
    Parameters:
    
    component2 - the component2 to set
  - setComponent2
```
public Field62M setComponent2(java.util.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 Field62M setDate(java.lang.String component2)
```
    Set the Date (component2).
    
    Parameters:
    
    component2 - the Date to set
  - setDate
```
public Field62M setDate(java.util.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 java.lang.String getComponent3()
```
    Get the component3
    
    Returns:
    
    the component3
  - getComponent3AsString
```
@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent3AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(3)
  - getCurrency
```
public java.lang.String getCurrency()
```
    Get the Currency (component3).
    
    Returns:
    
    the Currency from component3
  - setComponent3
```
public Field62M setComponent3(java.lang.String component3)
```
    Set the component3.
    
    Parameters:
    
    component3 - the component3 to set
  - setCurrency
```
public Field62M setCurrency(java.lang.String component3)
```
    Set the Currency (component3).
    
    Parameters:
    
    component3 - the Currency to set
  - getComponent4
```
public java.lang.String getComponent4()
```
    Get the component4
    
    Returns:
    
    the component4
  - getComponent4AsNumber
```
public java.lang.Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    
    the component4 converted to Number or null if cannot be converted
  - getAmount
```
public java.lang.String getAmount()
```
    Get the Amount (component4).
    
    Returns:
    
    the Amount from component4
  - getAmountAsNumber
```
public java.lang.Number getAmountAsNumber()
```
    Get the Amount (component4) as Number
    
    Returns:
    
    the Amount from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field62M setComponent4(java.lang.String component4)
```
    Set the component4.
    
    Parameters:
    
    component4 - the component4 to set
  - setComponent4
```
public Field62M 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 Field62M setAmount(java.lang.String component4)
```
    Set the Amount (component4).
    
    Parameters:
    
    component4 - the Amount to set
  - setAmount
```
public Field62M 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)
  - dates
```
public java.util.List<java.util.Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - 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)
  - 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 java.lang.String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - 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 Field62M.NAME
  - componentsPattern
```
public final java.lang.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 Field62M.COMPONENTS_PATTERN
  - validatorPattern
```
public final java.lang.String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field62M 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 Field62M get(SwiftMessage msg)
```
    Get the first instance of Field62M 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<Field62M> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field62M 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<Field62M> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field62M 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 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
  - 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)

Class Field62M

SWIFT MT Field 62M

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_62M

PARSER_PATTERN

COMPONENTS_PATTERN

DC_MARK

DATE

CURRENCY

AMOUNT

Constructor Detail

Field62M

Field62M

Field62M

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getDCMark

setComponent1

setDCMark

getComponent2

getComponent2AsCalendar

getDate

getDateAsCalendar

setComponent2

setComponent2

setDate

setDate

getComponent3

getComponent3AsString

getCurrency

setComponent3

setCurrency

getComponent4

getComponent4AsNumber

getAmount

getAmountAsNumber

setComponent4

setComponent4

setAmount

setAmount

dates

amounts

amount

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels