Field38H (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable
```
@Generated
public class Field38H
extends Field
implements java.io.Serializable
```
SWIFT MT Field 38H
Model and parser for field 38H of a SWIFT MT message.
Subfields (components) Data types
1. Number
2. String
3. Number
4. String
Structure definition
- validation pattern: 2n1a/2n1a
- parser pattern: NS/NS
- components pattern: NSNS
This class complies with standard release SRU2020
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.String`	`F_38H` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 38H
`static java.lang.Integer`	`NUMBER_FROM` Component number for the Number From subfield
`static java.lang.Integer`	`NUMBER_TO` Component number for the Number To subfield
`static java.lang.String`	`PARSER_PATTERN`
`static java.lang.Integer`	`PERIOD_FROM` Component number for the Period From subfield
`static java.lang.Integer`	`PERIOD_TO` Component number for the Period To 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
`Field38H()` Default constructor.
`Field38H(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field38H(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.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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field38H`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field38H object.
`static Field38H`	`get(SwiftMessage msg)` Gets the first instance of Field38H in the given message.
`static Field38H`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field38H>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field38H in the given message an empty list is returned if none found.
`static java.util.List<Field38H>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field38H from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component 1 (Number From).
`java.lang.Number`	`getComponent1AsNumber()` Get the component 1 as Number
`java.lang.String`	`getComponent2()` Gets the component 2 (Period From).
`java.lang.String`	`getComponent3()` Gets the component 3 (Number To).
`java.lang.Number`	`getComponent3AsNumber()` Get the component 3 as Number
`java.lang.String`	`getComponent4()` Gets the component 4 (Period To).
`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`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`java.lang.String`	`getNumberFrom()` Gets the Number From (component 1).
`java.lang.Number`	`getNumberFromAsNumber()` Get the Number From (component 1) as Number
`java.lang.String`	`getNumberTo()` Gets the Number To (component 3).
`java.lang.Number`	`getNumberToAsNumber()` Get the Number To (component 3) as Number
`java.lang.String`	`getPeriodFrom()` Gets the Period From (component 2).
`java.lang.String`	`getPeriodTo()` Gets the Period To (component 4).
`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 Field38H`	`newInstance(Field38H 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
`Field38H`	`setComponent1(java.lang.Number component1)` Set the component1 from a Number object.
`Field38H`	`setComponent1(java.lang.String component1)` Set the component1 (Number From).
`Field38H`	`setComponent2(java.lang.String component2)` Set the component2 (Period From).
`Field38H`	`setComponent3(java.lang.Number component3)` Set the component3 from a Number object.
`Field38H`	`setComponent3(java.lang.String component3)` Set the component3 (Number To).
`Field38H`	`setComponent4(java.lang.String component4)` Set the component4 (Period To).
`Field38H`	`setNumberFrom(java.lang.Number component1)` Set the Number From (component1) from a Number object.
`Field38H`	`setNumberFrom(java.lang.String component1)` Set the Number From (component1).
`Field38H`	`setNumberTo(java.lang.Number component3)` Set the Number To (component3) from a Number object.
`Field38H`	`setNumberTo(java.lang.String component3)` Set the Number To (component3).
`Field38H`	`setPeriodFrom(java.lang.String component2)` Set the Period From (component2).
`Field38H`	`setPeriodTo(java.lang.String component4)` Set the Period To (component4).
`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 38H
    
    See Also:
    
    Constant Field Values
  - F_38H
```
public static final java.lang.String F_38H
```
    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
  - NUMBER_FROM
```
public static final java.lang.Integer NUMBER_FROM
```
    Component number for the Number From subfield
  - PERIOD_FROM
```
public static final java.lang.Integer PERIOD_FROM
```
    Component number for the Period From subfield
  - NUMBER_TO
```
public static final java.lang.Integer NUMBER_TO
```
    Component number for the Number To subfield
  - PERIOD_TO
```
public static final java.lang.Integer PERIOD_TO
```
    Component number for the Period To subfield
- Constructor Detail
  - Field38H
```
public Field38H()
```
    Default constructor. Creates a new field setting all components to null.
  - Field38H
```
public Field38H(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
  - Field38H
```
public Field38H(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 Field38H newInstance(Field38H 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 Field38H.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 Field38H.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 (Number From).
    
    Returns:
    
    the component 1
  - getComponent1AsNumber
```
public java.lang.Number getComponent1AsNumber()
```
    Get the component 1 as Number
    
    Returns:
    
    the component 1 converted to Number or null if cannot be converted
  - getNumberFrom
```
public java.lang.String getNumberFrom()
```
    Gets the Number From (component 1).
    
    Returns:
    
    the Number From from component 1
  - getNumberFromAsNumber
```
public java.lang.Number getNumberFromAsNumber()
```
    Get the Number From (component 1) as Number
    
    Returns:
    
    the Number From from component 1 converted to Number or null if cannot be converted
  - getComponent2
```
public java.lang.String getComponent2()
```
    Gets the component 2 (Period From).
    
    Returns:
    
    the component 2
  - getPeriodFrom
```
public java.lang.String getPeriodFrom()
```
    Gets the Period From (component 2).
    
    Returns:
    
    the Period From from component 2
  - getComponent3
```
public java.lang.String getComponent3()
```
    Gets the component 3 (Number To).
    
    Returns:
    
    the component 3
  - getComponent3AsNumber
```
public java.lang.Number getComponent3AsNumber()
```
    Get the component 3 as Number
    
    Returns:
    
    the component 3 converted to Number or null if cannot be converted
  - getNumberTo
```
public java.lang.String getNumberTo()
```
    Gets the Number To (component 3).
    
    Returns:
    
    the Number To from component 3
  - getNumberToAsNumber
```
public java.lang.Number getNumberToAsNumber()
```
    Get the Number To (component 3) as Number
    
    Returns:
    
    the Number To from component 3 converted to Number or null if cannot be converted
  - getComponent4
```
public java.lang.String getComponent4()
```
    Gets the component 4 (Period To).
    
    Returns:
    
    the component 4
  - getPeriodTo
```
public java.lang.String getPeriodTo()
```
    Gets the Period To (component 4).
    
    Returns:
    
    the Period To from component 4
  - setComponent1
```
public Field38H setComponent1(java.lang.String component1)
```
    Set the component1 (Number From).
    
    Parameters:
    
    component1 - the component1 to set
  - setComponent1
```
public Field38H setComponent1(java.lang.Number component1)
```
    Set the component1 from a Number object.
    If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent1(String) method.
    
    Parameters:
    
    component1 - the Number with the component1 content to set
    
    See Also:
    
    setComponent1(String)
  - setNumberFrom
```
public Field38H setNumberFrom(java.lang.String component1)
```
    Set the Number From (component1).
    
    Parameters:
    
    component1 - the Number From to set
  - setNumberFrom
```
public Field38H setNumberFrom(java.lang.Number component1)
```
    Set the Number From (component1) from a Number object.
    
    Parameters:
    
    component1 - Number with the Number From content to set
    
    See Also:
    
    setComponent1(java.lang.Number)
  - setComponent2
```
public Field38H setComponent2(java.lang.String component2)
```
    Set the component2 (Period From).
    
    Parameters:
    
    component2 - the component2 to set
  - setPeriodFrom
```
public Field38H setPeriodFrom(java.lang.String component2)
```
    Set the Period From (component2).
    
    Parameters:
    
    component2 - the Period From to set
  - setComponent3
```
public Field38H setComponent3(java.lang.String component3)
```
    Set the component3 (Number To).
    
    Parameters:
    
    component3 - the component3 to set
  - setComponent3
```
public Field38H setComponent3(java.lang.Number component3)
```
    Set the component3 from a Number object.
    If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.
    
    Parameters:
    
    component3 - the Number with the component3 content to set
    
    See Also:
    
    setComponent3(String)
  - setNumberTo
```
public Field38H setNumberTo(java.lang.String component3)
```
    Set the Number To (component3).
    
    Parameters:
    
    component3 - the Number To to set
  - setNumberTo
```
public Field38H setNumberTo(java.lang.Number component3)
```
    Set the Number To (component3) from a Number object.
    
    Parameters:
    
    component3 - Number with the Number To content to set
    
    See Also:
    
    setComponent3(java.lang.Number)
  - setComponent4
```
public Field38H setComponent4(java.lang.String component4)
```
    Set the component4 (Period To).
    
    Parameters:
    
    component4 - the component4 to set
  - setPeriodTo
```
public Field38H setPeriodTo(java.lang.String component4)
```
    Set the Period To (component4).
    
    Parameters:
    
    component4 - the Period To to set
  - 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 Field38H.NAME
  - get
```
public static Field38H 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 Field38H get(SwiftMessage msg)
```
    Gets the first instance of Field38H 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<Field38H> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field38H 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<Field38H> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field38H 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 Field38H fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field38H 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 Field38H

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_38H

PARSER_PATTERN

COMPONENTS_PATTERN

NUMBER_FROM

PERIOD_FROM

NUMBER_TO

PERIOD_TO

Constructor Detail

Field38H

Field38H

Field38H

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getComponent1

getComponent1AsNumber

getNumberFrom

getNumberFromAsNumber

getComponent2

getPeriodFrom

getComponent3

getComponent3AsNumber

getNumberTo

getNumberToAsNumber

getComponent4

getPeriodTo

setComponent1

setComponent1

setNumberFrom

setNumberFrom

setComponent2

setPeriodFrom

setComponent3

setComponent3

setNumberTo

setNumberTo

setComponent4

setPeriodTo

getName

get

get

getAll

getAll

fromJson