Field39C (Prowide Integrator API Reference)

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

All Implemented Interfaces:

MultiLineField, PatternContainer, Serializable
```
@Generated
public class Field39C
extends Field
implements Serializable, MultiLineField
```
SWIFT MT Field 39C
Model and parser for field 39C of a SWIFT MT message.
Subfields (components) Data types
1. String
2. String
3. String
4. String
Structure definition
- validation pattern: 35x[$35x]0-3
- parser pattern: S[$S]0-3
- components pattern: SSSS
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_39C` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 39C
`static Integer`	`NARRATIVE` Component number for the Narrative subfield
`static 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
`Field39C()` Default constructor.
`Field39C(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field39C(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 Field39C`	`get(SwiftMessage msg)` Get the first instance of Field39C in the given message.
`static Field39C`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field39C>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field39C in the given message an empty list is returned if none found.
`static List<Field39C>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field39C from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent3()` Get the component3
`String`	`getComponent3AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent4()` Get the component4
`String`	`getComponent4AsString()` Deprecated. use `Field.getComponent(int)` instead
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getLine(int line)` Returns a specific line from the field's value.
`String`	`getLine(int line, int offset)` Returns a specific line from the field's value.
`List<String>`	`getLines()` Returns the field value split into lines.
`List<String>`	`getLines(int offset)` Returns the field value starting at the offset component, split into lines.
`List<String>`	`getLinesBetween(int start, int end)` Returns a specific subset of lines from the field's value, given a range.
`List<String>`	`getLinesBetween(int start, int end, int offset)` Returns a specific subset of lines from the field's value, starting at the offset component.
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getNarrative()` Get the Narrative as a concatenation of component1 to component4.
`String`	`getNarrativeLine1()` Get the Narrative (component1).
`String`	`getNarrativeLine2()` Get the Narrative (component2).
`String`	`getNarrativeLine3()` Get the Narrative (component3).
`String`	`getNarrativeLine4()` Get the Narrative (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 Field39C`	`newInstance(Field39C 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()`
`Field39C`	`setComponent1(String component1)` Set the component1.
`Field39C`	`setComponent2(String component2)` Set the component2.
`Field39C`	`setComponent3(String component3)` Set the component3.
`Field39C`	`setComponent4(String component4)` Set the component4.
`Field39C`	`setNarrative(String value)` Set the Narrative splitting the parameter lines into components 1 to 4.
`Field39C`	`setNarrativeLine1(String component1)` Set the Narrative (component1).
`Field39C`	`setNarrativeLine2(String component2)` Set the Narrative (component2).
`Field39C`	`setNarrativeLine3(String component3)` Set the Narrative (component3).
`Field39C`	`setNarrativeLine4(String component4)` Set the Narrative (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 39C
    
    See Also:
    Constant Field Values
  - F_39C
```
public static final String F_39C
```
    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
  - NARRATIVE
```
public static final Integer NARRATIVE
```
    Component number for the Narrative subfield
- Constructor Detail
  - Field39C
```
public Field39C()
```
    Default constructor. Creates a new field setting all components to null.
  - Field39C
```
public Field39C(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
  - Field39C
```
public Field39C(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 Field39C newInstance(Field39C 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
  - getComponent1AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent1AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(1)
  - getNarrativeLine1
```
public String getNarrativeLine1()
```
    Get the Narrative (component1).
    
    Returns:
    the Narrative from component1
  - getNarrativeLine2
```
public String getNarrativeLine2()
```
    Get the Narrative (component2).
    
    Returns:
    the Narrative from component2
  - getNarrativeLine3
```
public String getNarrativeLine3()
```
    Get the Narrative (component3).
    
    Returns:
    the Narrative from component3
  - getNarrativeLine4
```
public String getNarrativeLine4()
```
    Get the Narrative (component4).
    
    Returns:
    the Narrative from component4
  - getNarrative
```
public String getNarrative()
```
    Get the Narrative as a concatenation of component1 to component4.
    
    Returns:
    the Narrative from components
  - setComponent1
```
public Field39C setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setNarrativeLine1
```
public Field39C setNarrativeLine1(String component1)
```
    Set the Narrative (component1).
    
    Parameters:
    component1 - the Narrative to set
  - setNarrativeLine2
```
public Field39C setNarrativeLine2(String component2)
```
    Set the Narrative (component2).
    
    Parameters:
    component2 - the Narrative to set
  - setNarrativeLine3
```
public Field39C setNarrativeLine3(String component3)
```
    Set the Narrative (component3).
    
    Parameters:
    component3 - the Narrative to set
  - setNarrativeLine4
```
public Field39C setNarrativeLine4(String component4)
```
    Set the Narrative (component4).
    
    Parameters:
    component4 - the Narrative to set
  - setNarrative
```
public Field39C setNarrative(String value)
```
    Set the Narrative splitting the parameter lines into components 1 to 4.
    
    Parameters:
    value - the Narrative to set, may contain line ends and each line will be set to its correspondent component attribute
  - 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)
  - setComponent2
```
public Field39C setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
@ProwideDeprecated(phase2=_2018)
public String getComponent3AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(3)
  - setComponent3
```
public Field39C setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - 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)
  - setComponent4
```
public Field39C setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 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 Field39C.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 Field39C.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field39C 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 Field39C get(SwiftMessage msg)
```
    Get the first instance of Field39C 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<Field39C> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field39C 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<Field39C> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field39C 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
  - getLine
```
public String getLine(int line)
```
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLine(int)
  - getLine
```
public String getLine(int line,
             int offset)
```
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    offset - an optional component number used as offset when counting lines
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLine(int, int)
  - getLines
```
public List<String> getLines()
```
    Returns the field value split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Returns:
    lines content or empty list if field's value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLines()
  - getLines
```
public List<String> getLines(int offset)
```
    Returns the field value starting at the offset component, split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Parameters:
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLines(int)
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end)
```
    Returns a specific subset of lines from the field's value, given a range.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    
    Returns:
    found lines or empty list if value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLinesBetween(int, int )
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end,
                           int offset)
```
    Returns a specific subset of lines from the field's value, starting at the offset component.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLinesBetween(int start, int end, int offset)
  - 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 Field39C

SWIFT MT Field 39C

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_39C

PARSER_PATTERN

COMPONENTS_PATTERN

NARRATIVE

Constructor Detail

Field39C

Field39C

Field39C

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getNarrativeLine1

getNarrativeLine2

getNarrativeLine3

getNarrativeLine4

getNarrative

setComponent1

setNarrativeLine1

setNarrativeLine2

setNarrativeLine3

setNarrativeLine4

setNarrative

getComponent2

getComponent2AsString

setComponent2

getComponent3

getComponent3AsString

setComponent3

getComponent4

getComponent4AsString

setComponent4

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween

getValueDisplay

getComponentLabels