Field38H (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
@Generated
public class Field38H
extends Field
implements 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 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 String`	`F_38H` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 38H
`static Integer`	`NUMBER_FROM` Component number for the Number From subfield
`static Integer`	`NUMBER_TO` Component number for the Number To subfield
`static String`	`PARSER_PATTERN`
`static Integer`	`PERIOD_FROM` Component number for the Period From subfield
`static 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(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

Methods
Modifier and Type	Method and Description
`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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field38H`	`get(SwiftMessage msg)` Get the first instance of Field38H in the given message.
`static Field38H`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field38H>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field38H in the given message an empty list is returned if none found.
`static List<Field38H>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field38H 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
`String`	`getComponent2AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent3()` Get the component3
`Number`	`getComponent3AsNumber()` Get the component3 as Number
`String`	`getComponent4()` Get the component4
`String`	`getComponent4AsString()` Deprecated. use `Field.getComponent(int)` instead
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getNumberFrom()` Get the Number From (component1).
`Number`	`getNumberFromAsNumber()` Get the Number From (component1) as Number
`String`	`getNumberTo()` Get the Number To (component3).
`Number`	`getNumberToAsNumber()` Get the Number To (component3) as Number
`String`	`getPeriodFrom()` Get the Period From (component2).
`String`	`getPeriodTo()` Get the Period To (component4).
`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 Field38H`	`newInstance(Field38H 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()`
`Field38H`	`setComponent1(Number component1)` Set the component1 from a Number object.
`Field38H`	`setComponent1(String component1)` Set the component1.
`Field38H`	`setComponent2(String component2)` Set the component2.
`Field38H`	`setComponent3(Number component3)` Set the component3 from a Number object.
`Field38H`	`setComponent3(String component3)` Set the component3.
`Field38H`	`setComponent4(String component4)` Set the component4.
`Field38H`	`setNumberFrom(Number component1)` Set the Number From (component1) from a Number object.
`Field38H`	`setNumberFrom(String component1)` Set the Number From (component1).
`Field38H`	`setNumberTo(Number component3)` Set the Number To (component3) from a Number object.
`Field38H`	`setNumberTo(String component3)` Set the Number To (component3).
`Field38H`	`setPeriodFrom(String component2)` Set the Period From (component2).
`Field38H`	`setPeriodTo(String component4)` Set the Period To (component4).
`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 38H
    
    See Also:
    Constant Field Values
  - F_38H
```
public static final String F_38H
```
    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
  - NUMBER_FROM
```
public static final Integer NUMBER_FROM
```
    Component number for the Number From subfield
  - PERIOD_FROM
```
public static final Integer PERIOD_FROM
```
    Component number for the Period From subfield
  - NUMBER_TO
```
public static final Integer NUMBER_TO
```
    Component number for the Number To subfield
  - PERIOD_TO
```
public static final 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(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:
    
    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 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
  - 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
  - getNumberFrom
```
public String getNumberFrom()
```
    Get the Number From (component1).
    
    Returns:
    the Number From from component1
  - getNumberFromAsNumber
```
public Number getNumberFromAsNumber()
```
    Get the Number From (component1) as Number
    
    Returns:
    the Number From from component1 converted to Number or null if cannot be converted
  - setComponent1
```
public Field38H setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field38H setComponent1(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(String component1)
```
    Set the Number From (component1).
    
    Parameters:
    component1 - the Number From to set
  - setNumberFrom
```
public Field38H setNumberFrom(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)
  - 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)
  - getPeriodFrom
```
public String getPeriodFrom()
```
    Get the Period From (component2).
    
    Returns:
    the Period From from component2
  - setComponent2
```
public Field38H setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setPeriodFrom
```
public Field38H setPeriodFrom(String component2)
```
    Set the Period From (component2).
    
    Parameters:
    component2 - the Period From to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsNumber
```
public Number getComponent3AsNumber()
```
    Get the component3 as Number
    
    Returns:
    the component3 converted to Number or null if cannot be converted
  - getNumberTo
```
public String getNumberTo()
```
    Get the Number To (component3).
    
    Returns:
    the Number To from component3
  - getNumberToAsNumber
```
public Number getNumberToAsNumber()
```
    Get the Number To (component3) as Number
    
    Returns:
    the Number To from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field38H setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field38H setComponent3(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(String component3)
```
    Set the Number To (component3).
    
    Parameters:
    component3 - the Number To to set
  - setNumberTo
```
public Field38H setNumberTo(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)
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent4AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(4)
  - getPeriodTo
```
public String getPeriodTo()
```
    Get the Period To (component4).
    
    Returns:
    the Period To from component4
  - setComponent4
```
public Field38H setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setPeriodTo
```
public Field38H setPeriodTo(String component4)
```
    Set the Period To (component4).
    
    Parameters:
    component4 - the Period To to set
  - 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 Field38H.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 Field38H.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field38H 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 Field38H get(SwiftMessage msg)
```
    Get 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 List<Field38H> getAll(SwiftMessage msg)
```
    Get 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 List<Field38H> getAll(SwiftTagListBlock block)
```
    Get 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
  - 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 Field38H

SWIFT MT Field 38H

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_38H

PARSER_PATTERN

COMPONENTS_PATTERN

NUMBER_FROM

PERIOD_FROM

NUMBER_TO

PERIOD_TO

Constructor Detail

Field38H

Field38H

Field38H

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsNumber

getNumberFrom

getNumberFromAsNumber

setComponent1

setComponent1

setNumberFrom

setNumberFrom

getComponent2

getComponent2AsString

getPeriodFrom

setComponent2

setPeriodFrom

getComponent3

getComponent3AsNumber

getNumberTo

getNumberToAsNumber

setComponent3

setComponent3

setNumberTo

setNumberTo

getComponent4

getComponent4AsString

getPeriodTo

setComponent4

setPeriodTo

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels