Field37H (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, AmountContainer, PatternContainer, java.io.Serializable
```
@Generated
public class Field37H
extends Field
implements java.io.Serializable, AmountContainer
```
SWIFT MT Field 37H.
Model and parser for field 37H of a SWIFT MT message.
Subfields (components) Data types
1. Component 1: Indicator: String
2. Component 2: Sign: String
3. Component 3: Rate: BigDecimal
Structure definition
- validation pattern: <DC>[<N>]<AMOUNT>12
- parser pattern: c[c]N
- components pattern: SSN
This class complies with standard release SRU2024
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`F_37H` Same as NAME, intended to be clear when using static imports.
`static java.lang.Integer`	`INDICATOR` Component number for the Indicator subfield.
`static java.lang.String`	`NAME` Constant with the field name 37H.
`static java.lang.Integer`	`RATE` Component number for the Rate subfield.
`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, labelMap

Constructor Summary

Constructors
Constructor and Description
`Field37H()` Default constructor.
`Field37H(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field37H(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()` Returns the first amounts as BigDecimal
`java.util.List<java.math.BigDecimal>`	`amounts()` Returns the list of all NON-NULL amounts as BigDecimal
`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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value.
`static Field37H`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field37H object.
`static Field37H`	`get(SwiftMessage msg)` Gets the first instance of Field37H in the given message.
`static Field37H`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field37H>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field37H in the given message an empty list is returned if none found.
`static java.util.List<Field37H>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field37H from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component 1 (Indicator).
`java.lang.String`	`getComponent2()` Gets the component 2 (Sign).
`java.lang.String`	`getComponent3()` Gets the component 3 (Rate).
`java.math.BigDecimal`	`getComponent3AsBigDecimal()` Get the component 3 as BigDecimal
`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`	`getIndicator()` Gets the Indicator (component 1).
`protected java.util.Map<java.lang.String,java.lang.Integer>`	`getLabelMap()` Returns a mapping between component labels and the internal component number.
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any).
`java.lang.String`	`getRate()` Gets the Rate (component 3).
`java.math.BigDecimal`	`getRateAsBigDecimal()` Get the Rate (component 3) as BigDecimal
`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.
`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 Field37H`	`newInstance(Field37H source)` Copy constructor.
`void`	`parse(java.lang.String value)` Parses the parameter value into the internal components structure.
`java.lang.String`	`parserPattern()` Returns the field parser pattern.
`Field37H`	`setComponent1(java.lang.String component1)` Set the component 1 (Indicator).
`Field37H`	`setComponent2(java.lang.String component2)` Set the component 2 (Sign).
`Field37H`	`setComponent3(java.lang.Number component3)` Alternative method setter for field's Rate (component 3) as Number
`Field37H`	`setComponent3(java.lang.String component3)` Set the component 3 (Rate).
`Field37H`	`setIndicator(java.lang.String component1)` Set the Indicator (component 1).
`Field37H`	`setRate(java.lang.Number component3)` Alternative method setter for field's Rate (component 3) as Number
`Field37H`	`setRate(java.lang.String component3)` Set the Rate (component 3).
`Field37H`	`setSign(java.lang.String component2)` Set the Sign (component 2).
`static Tag`	`tag(java.lang.String value)` Create a Tag with this field name and the given value.
`java.lang.String`	`typesPattern()` Returns the field component types pattern.
`java.lang.String`	`validatorPattern()` Returns the field validator pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, 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 37H.
    
    See Also:
    
    Constant Field Values
  - F_37H
```
public static final java.lang.String F_37H
```
    Same as NAME, intended to be clear when using static imports.
    
    See Also:
    
    Constant Field Values
  - INDICATOR
```
public static final java.lang.Integer INDICATOR
```
    Component number for the Indicator subfield.
  - SIGN
```
public static final java.lang.Integer SIGN
```
    Component number for the Sign subfield.
  - RATE
```
public static final java.lang.Integer RATE
```
    Component number for the Rate subfield.
- Constructor Detail
  - Field37H
```
public Field37H()
```
    Default constructor. Creates a new field setting all components to null.
  - Field37H
```
public Field37H(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
  - Field37H
```
public Field37H(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 Field37H newInstance(Field37H 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
  - typesPattern
```
public java.lang.String typesPattern()
```
    Returns the field component types pattern.
    This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).
    
    Specified by:
    
    typesPattern in interface PatternContainer
    
    Specified by:
    
    typesPattern in class Field
    
    Since:
    
    9.2.7
  - parserPattern
```
public java.lang.String parserPattern()
```
    Returns the field parser pattern.
    
    Specified by:
    
    parserPattern in interface PatternContainer
  - validatorPattern
```
public java.lang.String validatorPattern()
```
    Returns the field validator pattern
    
    Specified by:
    
    validatorPattern in class Field
  - isOptional
```
public boolean isOptional(int component)
```
    Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message.
    Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
    
    Specified by:
    
    isOptional in class Field
    
    Parameters:
    
    component - component number, first component of a field is referenced as 1
    
    Returns:
    
    true if the component is optional for this field, false otherwise
  - isGeneric
```
public boolean isGeneric()
```
    Returns true if the field is a GENERIC FIELD as specified by the standard.
    
    Specified by:
    
    isGeneric in class Field
    
    Returns:
    
    true if the field is generic, false otherwise
  - componentsSize
```
public int componentsSize()
```
    Returns the defined amount of components.
    This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
    
    Specified by:
    
    componentsSize in class Field
    
    Since:
    
    7.7
  - getComponentLabels
```
public java.util.List<java.lang.String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Specified by:
    
    getComponentLabels in class Field
    
    Since:
    
    7.8.4
    
    See Also:
    
    Field.getComponentLabel(int)
  - getComponentMap
```
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
```
    Returns a mapping between component numbers and their label in camel case format.
    
    Specified by:
    
    getComponentMap in class Field
    
    Since:
    
    7.10.3
  - getLabelMap
```
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
```
    Description copied from class: Field
    
    Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.
    
    Specified by:
    
    getLabelMap in class Field
    
    Since:
    
    9.3.12
    
    See Also:
    
    Field.getLabelMap()
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component 1 (Indicator).
    
    Returns:
    
    the component 1
  - getIndicator
```
public java.lang.String getIndicator()
```
    Gets the Indicator (component 1).
    
    Returns:
    
    the Indicator 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 (Rate).
    
    Returns:
    
    the component 3
  - getComponent3AsBigDecimal
```
public java.math.BigDecimal getComponent3AsBigDecimal()
```
    Get the component 3 as BigDecimal
    
    Returns:
    
    the component 3 converted to BigDecimal or null if cannot be converted
    
    Since:
    
    9.2.7
  - getRate
```
public java.lang.String getRate()
```
    Gets the Rate (component 3).
    
    Returns:
    
    the Rate from component 3
  - getRateAsBigDecimal
```
public java.math.BigDecimal getRateAsBigDecimal()
```
    Get the Rate (component 3) as BigDecimal
    
    Returns:
    
    the Rate from component 3 converted to BigDecimal or null if cannot be converted
    
    Since:
    
    9.2.7
  - setComponent1
```
public Field37H setComponent1(java.lang.String component1)
```
    Set the component 1 (Indicator).
    
    Parameters:
    
    component1 - the Indicator to set
    
    Returns:
    
    the field object to enable build pattern
  - setIndicator
```
public Field37H setIndicator(java.lang.String component1)
```
    Set the Indicator (component 1).
    
    Parameters:
    
    component1 - the Indicator to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent2
```
public Field37H setComponent2(java.lang.String component2)
```
    Set the component 2 (Sign).
    
    Parameters:
    
    component2 - the Sign to set
    
    Returns:
    
    the field object to enable build pattern
  - setSign
```
public Field37H setSign(java.lang.String component2)
```
    Set the Sign (component 2).
    
    Parameters:
    
    component2 - the Sign to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field37H setComponent3(java.lang.String component3)
```
    Set the component 3 (Rate).
    
    Parameters:
    
    component3 - the Rate to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field37H setComponent3(java.lang.Number component3)
```
    Alternative method setter for field's Rate (component 3) as Number
    This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
    
    Parameters:
    
    component3 - the Number with the Rate content to set
    
    Returns:
    
    the field object to enable build pattern
  - setRate
```
public Field37H setRate(java.lang.String component3)
```
    Set the Rate (component 3).
    
    Parameters:
    
    component3 - the Rate to set
    
    Returns:
    
    the field object to enable build pattern
  - setRate
```
public Field37H setRate(java.lang.Number component3)
```
    Alternative method setter for field's Rate (component 3) as Number
    This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component3 - the Number with the Rate content to set
    
    Returns:
    
    the field object to enable build pattern
  - amounts
```
public java.util.List<java.math.BigDecimal> amounts()
```
    Returns the list of all NON-NULL amounts as BigDecimal
    
    Returns:
    
    the list of NON-NULL amounts as BigDecimal values
    
    See Also:
    
    AmountResolver.amounts(Field)
  - amount
```
public java.math.BigDecimal amount()
```
    Returns the first amounts as BigDecimal
    
    Specified by:
    
    amount in interface AmountContainer
    
    Returns:
    
    the first amount as BigDecimal value. Can be null
    
    See Also:
    
    AmountResolver.amount(Field)
  - getName
```
public java.lang.String getName()
```
    Returns the field's name composed by the field number and the letter option (if any).
    
    Specified by:
    
    getName in class Field
    
    Returns:
    
    the static value of Field37H.NAME
  - get
```
public static Field37H 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 Field37H get(SwiftMessage msg)
```
    Gets the first instance of Field37H 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<Field37H> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field37H 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<Field37H> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field37H 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 Field37H fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field37H 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 Field37H

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_37H

INDICATOR

SIGN

RATE

Constructor Detail

Field37H

Field37H

Field37H

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getLabelMap

getComponent1

getIndicator

getComponent2

getSign

getComponent3

getComponent3AsBigDecimal

getRate

getRateAsBigDecimal

setComponent1

setIndicator

setComponent2

setSign

setComponent3

setComponent3

setRate

setRate

amounts

amount

getName

get

get

getAll

getAll

fromJson