Field38A (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable
```
@Generated
public class Field38A
extends Field
implements java.io.Serializable
```
SWIFT MT Field 38A
Model and parser for field 38A of a SWIFT MT message.
Subfields (components) Data types
1. Long
Structure definition
- validation pattern: 3n
- parser pattern: S
- components pattern: N
This class complies with standard release SRU2021
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENTS_PATTERN` Deprecated.
`static java.lang.String`	`F_38A` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 38A
`static java.lang.Integer`	`NUMBER` Deprecated.
`static java.lang.String`	`PARSER_PATTERN`
`static java.lang.Integer`	`PERIOD` Component number for the Period subfield
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.
`static java.lang.String`	`TYPES_PATTERN` Types pattern Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
Constructor and Description
`Field38A()` Default constructor.
`Field38A(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field38A(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.lang.String`	`componentsPattern()` Deprecated.
`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 Field38A`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field38A object.
`static Field38A`	`get(SwiftMessage msg)` Gets the first instance of Field38A in the given message.
`static Field38A`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field38A>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field38A in the given message an empty list is returned if none found.
`static java.util.List<Field38A>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field38A from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component 1 (Period).
`java.lang.Long`	`getComponent1AsLong()` Get the component 1 as Long
`java.lang.Number`	`getComponent1AsNumber()` Deprecated.
`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`	`getNumber()` Deprecated.
`java.lang.Long`	`getNumberAsLong()` Deprecated.
`java.lang.Number`	`getNumberAsNumber()` Deprecated.
`java.lang.String`	`getPeriod()` Gets the Period (component 1).
`java.lang.Long`	`getPeriodAsLong()` Get the Period (component 1) as Long
`java.lang.Number`	`getPeriodAsNumber()` Deprecated.
`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 Field38A`	`newInstance(Field38A 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
`Field38A`	`setComponent1(java.lang.Long component1)` Set the component1 from a Long object.
`Field38A`	`setComponent1(java.lang.Number component1)` Alternative method setter for field's Period (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
`Field38A`	`setComponent1(java.lang.String component1)` Set the component 1 (Period).
`Field38A`	`setNumber(java.lang.Long component1)` Deprecated.
`Field38A`	`setNumber(java.lang.Number component1)` Deprecated.
`Field38A`	`setNumber(java.lang.String component1)` Deprecated.
`Field38A`	`setPeriod(java.lang.Long component1)` Set the Period (component 1) from a Long object.
`Field38A`	`setPeriod(java.lang.Number component1)` Alternative method setter for field's Period (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
`Field38A`	`setPeriod(java.lang.String component1)` Set the Period (component 1).
`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 This method returns a letter representing the type for each component in the Field.
`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, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, 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 38A
    
    See Also:
    
    Constant Field Values
  - F_38A
```
public static final java.lang.String F_38A
```
    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
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String COMPONENTS_PATTERN
```
    Deprecated.
    
    Components pattern Contains a description of the type for every component. This is DEPRECATED, use TYPES_PATTERN instead, because it distinguishes between N (number) and I (BigDecimal)
    
    See Also:
    
    TYPES_PATTERN, Constant Field Values
  - TYPES_PATTERN
```
public static final java.lang.String TYPES_PATTERN
```
    Types pattern Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.
    
    Since:
    
    9.2.7
    
    See Also:
    
    Constant Field Values
  - PERIOD
```
public static final java.lang.Integer PERIOD
```
    Component number for the Period subfield
  - NUMBER
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.Integer NUMBER
```
    Deprecated.
    
    Alternative (DEPRECATED) constant name for field's Period Component number
    
    See Also:
    
    PERIOD
- Constructor Detail
  - Field38A
```
public Field38A()
```
    Default constructor. Creates a new field setting all components to null.
  - Field38A
```
public Field38A(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
  - Field38A
```
public Field38A(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 Field38A newInstance(Field38A 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
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public final java.lang.String componentsPattern()
```
    Deprecated.
    
    Returns the field components pattern This method is DEPRECATED, use typesPattern() instead.
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field38A.COMPONENTS_PATTERN
    
    See Also:
    
    typesPattern()
  - typesPattern
```
public final 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
    
    Returns:
    
    the static value of Field38A.TYPES_PATTERN
    
    Since:
    
    9.2.7
    
    See Also:
    
    TYPES_PATTERN
  - parserPattern
```
public final java.lang.String parserPattern()
```
    Returns the field parser pattern
    
    Specified by:
    
    parserPattern in interface PatternContainer
    
    Returns:
    
    the static value of Field38A.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 (Period).
    
    Returns:
    
    the component 1
  - getComponent1AsLong
```
public java.lang.Long getComponent1AsLong()
```
    Get the component 1 as Long
    
    Returns:
    
    the component 1 converted to Long or null if cannot be converted
    
    Since:
    
    9.2.7
  - getComponent1AsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent1AsNumber()
```
    Deprecated.
    
    Get the component 1 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.
    
    Returns:
    
    the component 1 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getComponent1AsLong()
  - getPeriod
```
public java.lang.String getPeriod()
```
    Gets the Period (component 1).
    
    Returns:
    
    the Period from component 1
  - getNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.String getNumber()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Period
    
    Since:
    
    9.2.7
    
    See Also:
    
    getPeriod()
  - getPeriodAsLong
```
public java.lang.Long getPeriodAsLong()
```
    Get the Period (component 1) as Long
    
    Returns:
    
    the Period from component 1 converted to Long or null if cannot be converted
    
    Since:
    
    9.2.7
  - getPeriodAsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getPeriodAsNumber()
```
    Deprecated.
    
    Get the Period (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.
    
    Returns:
    
    the component 1 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getPeriodAsLong()
  - getNumberAsLong
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Long getNumberAsLong()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Period as Long
    
    See Also:
    
    getPeriodAsLong()
  - getNumberAsNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getNumberAsNumber()
```
    Deprecated.
    
    Alternative DEPRECATED method getter for field's Period (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.
    
    Returns:
    
    the component 1 converted to Number (BigDecimal) or null if cannot be converted
    
    See Also:
    
    getPeriodAsLong()
  - setComponent1
```
public Field38A setComponent1(java.lang.String component1)
```
    Set the component 1 (Period).
    
    Parameters:
    
    component1 - the Period to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent1
```
public Field38A setComponent1(java.lang.Long component1)
```
    Set the component1 from a Long 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 Long with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
    
    See Also:
    
    setComponent1(String)
  - setComponent1
```
public Field38A setComponent1(java.lang.Number component1)
```
    Alternative method setter for field's Period (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component1 - the Number with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setPeriod(java.lang.Long)
  - setPeriod
```
public Field38A setPeriod(java.lang.String component1)
```
    Set the Period (component 1).
    
    Parameters:
    
    component1 - the Period to set
    
    Returns:
    
    the field object to enable build pattern
  - setPeriod
```
public Field38A setPeriod(java.lang.Long component1)
```
    Set the Period (component 1) from a Long object.
    
    Parameters:
    
    component1 - Long with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
    
    See Also:
    
    setComponent1(java.lang.Long)
  - setPeriod
```
public Field38A setPeriod(java.lang.Number component1)
```
    Alternative method setter for field's Period (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component1 - the Number with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setPeriod(java.lang.Long)
  - setNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field38A setNumber(java.lang.String component1)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Period
    
    Parameters:
    
    component1 - the Period to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setPeriod(String)
  - setNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field38A setNumber(java.lang.Long component1)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Period from a Long object.
    
    Parameters:
    
    component1 - Long with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    Since:
    
    9.2.7
    
    See Also:
    
    setComponent1(java.lang.Long)
  - setNumber
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public Field38A setNumber(java.lang.Number component1)
```
    Deprecated.
    
    Alternative DEPRECATED method setter for field's Period (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component1 - the Number with the Period content to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setPeriod(java.lang.Long)
  - 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 Field38A.NAME
  - get
```
public static Field38A 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 Field38A get(SwiftMessage msg)
```
    Gets the first instance of Field38A 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<Field38A> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field38A 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<Field38A> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field38A 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 Field38A fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field38A 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 Field38A

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_38A

PARSER_PATTERN

COMPONENTS_PATTERN

TYPES_PATTERN

PERIOD

NUMBER

Constructor Detail

Field38A

Field38A

Field38A

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getComponent1

getComponent1AsLong

getComponent1AsNumber

getPeriod

getNumber

getPeriodAsLong

getPeriodAsNumber

getNumberAsLong

getNumberAsNumber

setComponent1

setComponent1

setComponent1

setPeriod

setPeriod

setPeriod

setNumber

setNumber

setNumber

getName

get

get

getAll

getAll

fromJson