Field343 (Prowide Core API Reference)

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

All Implemented Interfaces:

PatternContainer, java.io.Serializable
```
@Generated
public class Field343
extends Field
implements java.io.Serializable
```
SWIFT MT Field 343
Model and parser for field 343 of a SWIFT MT message.
Subfields (components) Data types
1. Number
2. Number
3. Number
4. Number
Structure definition
- validation pattern: 5!n 5!n 5!n 5!n
- parser pattern: N<SPACE>N<SPACE>N<SPACE>N
- components pattern: NNNN
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 java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.String`	`F_343` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 343
`static java.lang.String`	`PARSER_PATTERN`
`static java.lang.Integer`	`REGION_TIME_COUNT_1` Component number for the Region Time Count 1 subfield
`static java.lang.Integer`	`REGION_TIME_COUNT_2` Component number for the Region Time Count 2 subfield
`static java.lang.Integer`	`REGION_TIME_COUNT_3` Component number for the Region Time Count 3 subfield
`static java.lang.Integer`	`REGION_TIME_COUNT_4` Component number for the Region Time Count 4 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
`Field343()` Default constructor.
`Field343(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field343(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'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 Field343`	`get(SwiftMessage msg)` Get the first instance of Field343 in the given message.
`static Field343`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static java.util.List<Field343>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field343 in the given message an empty list is returned if none found.
`static java.util.List<Field343>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field343 from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Get the component1
`java.lang.Number`	`getComponent1AsNumber()` Get the component1 as Number
`java.lang.String`	`getComponent2()` Get the component2
`java.lang.Number`	`getComponent2AsNumber()` Get the component2 as Number
`java.lang.String`	`getComponent3()` Get the component3
`java.lang.Number`	`getComponent3AsNumber()` Get the component3 as Number
`java.lang.String`	`getComponent4()` Get the component4
`java.lang.Number`	`getComponent4AsNumber()` Get the component4 as Number
`protected java.util.List<java.lang.String>`	`getComponentLabels()` Returns english label for components.
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`java.lang.String`	`getRegionTimeCount1()` Get the Region Time Count 1 (component1).
`java.lang.Number`	`getRegionTimeCount1AsNumber()` Get the Region Time Count 1 (component1) as Number
`java.lang.String`	`getRegionTimeCount2()` Get the Region Time Count 2 (component2).
`java.lang.Number`	`getRegionTimeCount2AsNumber()` Get the Region Time Count 2 (component2) as Number
`java.lang.String`	`getRegionTimeCount3()` Get the Region Time Count 3 (component3).
`java.lang.Number`	`getRegionTimeCount3AsNumber()` Get the Region Time Count 3 (component3) as Number
`java.lang.String`	`getRegionTimeCount4()` Get the Region Time Count 4 (component4).
`java.lang.Number`	`getRegionTimeCount4AsNumber()` Get the Region Time Count 4 (component4) as Number
`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 Field343`	`newInstance(Field343 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()`
`Field343`	`setComponent1(java.lang.Number component1)` Set the component1 from a Number object.
`Field343`	`setComponent1(java.lang.String component1)` Set the component1.
`Field343`	`setComponent2(java.lang.Number component2)` Set the component2 from a Number object.
`Field343`	`setComponent2(java.lang.String component2)` Set the component2.
`Field343`	`setComponent3(java.lang.Number component3)` Set the component3 from a Number object.
`Field343`	`setComponent3(java.lang.String component3)` Set the component3.
`Field343`	`setComponent4(java.lang.Number component4)` Set the component4 from a Number object.
`Field343`	`setComponent4(java.lang.String component4)` Set the component4.
`Field343`	`setRegionTimeCount1(java.lang.Number component1)` Set the Region Time Count 1 (component1) from a Number object.
`Field343`	`setRegionTimeCount1(java.lang.String component1)` Set the Region Time Count 1 (component1).
`Field343`	`setRegionTimeCount2(java.lang.Number component2)` Set the Region Time Count 2 (component2) from a Number object.
`Field343`	`setRegionTimeCount2(java.lang.String component2)` Set the Region Time Count 2 (component2).
`Field343`	`setRegionTimeCount3(java.lang.Number component3)` Set the Region Time Count 3 (component3) from a Number object.
`Field343`	`setRegionTimeCount3(java.lang.String component3)` Set the Region Time Count 3 (component3).
`Field343`	`setRegionTimeCount4(java.lang.Number component4)` Set the Region Time Count 4 (component4) from a Number object.
`Field343`	`setRegionTimeCount4(java.lang.String component4)` Set the Region Time Count 4 (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'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, 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 java.lang.String NAME
```
    Constant with the field name 343
    
    See Also:
    
    Constant Field Values
  - F_343
```
public static final java.lang.String F_343
```
    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
  - REGION_TIME_COUNT_1
```
public static final java.lang.Integer REGION_TIME_COUNT_1
```
    Component number for the Region Time Count 1 subfield
  - REGION_TIME_COUNT_2
```
public static final java.lang.Integer REGION_TIME_COUNT_2
```
    Component number for the Region Time Count 2 subfield
  - REGION_TIME_COUNT_3
```
public static final java.lang.Integer REGION_TIME_COUNT_3
```
    Component number for the Region Time Count 3 subfield
  - REGION_TIME_COUNT_4
```
public static final java.lang.Integer REGION_TIME_COUNT_4
```
    Component number for the Region Time Count 4 subfield
- Constructor Detail
  - Field343
```
public Field343()
```
    Default constructor. Creates a new field setting all components to null.
  - Field343
```
public Field343(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
  - Field343
```
public Field343(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
  - 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
  - newInstance
```
public static Field343 newInstance(Field343 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 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
  - 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
  - getComponent1
```
public java.lang.String getComponent1()
```
    Get the component1
    
    Returns:
    
    the component1
  - getComponent1AsNumber
```
public java.lang.Number getComponent1AsNumber()
```
    Get the component1 as Number
    
    Returns:
    
    the component1 converted to Number or null if cannot be converted
  - getRegionTimeCount1
```
public java.lang.String getRegionTimeCount1()
```
    Get the Region Time Count 1 (component1).
    
    Returns:
    
    the Region Time Count 1 from component1
  - getRegionTimeCount1AsNumber
```
public java.lang.Number getRegionTimeCount1AsNumber()
```
    Get the Region Time Count 1 (component1) as Number
    
    Returns:
    
    the Region Time Count 1 from component1 converted to Number or null if cannot be converted
  - setComponent1
```
public Field343 setComponent1(java.lang.String component1)
```
    Set the component1.
    
    Parameters:
    
    component1 - the component1 to set
  - setComponent1
```
public Field343 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)
  - setRegionTimeCount1
```
public Field343 setRegionTimeCount1(java.lang.String component1)
```
    Set the Region Time Count 1 (component1).
    
    Parameters:
    
    component1 - the Region Time Count 1 to set
  - setRegionTimeCount1
```
public Field343 setRegionTimeCount1(java.lang.Number component1)
```
    Set the Region Time Count 1 (component1) from a Number object.
    
    Parameters:
    
    component1 - Number with the Region Time Count 1 content to set
    
    See Also:
    
    setComponent1(java.lang.Number)
  - getComponent2
```
public java.lang.String getComponent2()
```
    Get the component2
    
    Returns:
    
    the component2
  - getComponent2AsNumber
```
public java.lang.Number getComponent2AsNumber()
```
    Get the component2 as Number
    
    Returns:
    
    the component2 converted to Number or null if cannot be converted
  - getRegionTimeCount2
```
public java.lang.String getRegionTimeCount2()
```
    Get the Region Time Count 2 (component2).
    
    Returns:
    
    the Region Time Count 2 from component2
  - getRegionTimeCount2AsNumber
```
public java.lang.Number getRegionTimeCount2AsNumber()
```
    Get the Region Time Count 2 (component2) as Number
    
    Returns:
    
    the Region Time Count 2 from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field343 setComponent2(java.lang.String component2)
```
    Set the component2.
    
    Parameters:
    
    component2 - the component2 to set
  - setComponent2
```
public Field343 setComponent2(java.lang.Number component2)
```
    Set the component2 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 setComponent2(String) method.
    
    Parameters:
    
    component2 - the Number with the component2 content to set
    
    See Also:
    
    setComponent2(String)
  - setRegionTimeCount2
```
public Field343 setRegionTimeCount2(java.lang.String component2)
```
    Set the Region Time Count 2 (component2).
    
    Parameters:
    
    component2 - the Region Time Count 2 to set
  - setRegionTimeCount2
```
public Field343 setRegionTimeCount2(java.lang.Number component2)
```
    Set the Region Time Count 2 (component2) from a Number object.
    
    Parameters:
    
    component2 - Number with the Region Time Count 2 content to set
    
    See Also:
    
    setComponent2(java.lang.Number)
  - getComponent3
```
public java.lang.String getComponent3()
```
    Get the component3
    
    Returns:
    
    the component3
  - getComponent3AsNumber
```
public java.lang.Number getComponent3AsNumber()
```
    Get the component3 as Number
    
    Returns:
    
    the component3 converted to Number or null if cannot be converted
  - getRegionTimeCount3
```
public java.lang.String getRegionTimeCount3()
```
    Get the Region Time Count 3 (component3).
    
    Returns:
    
    the Region Time Count 3 from component3
  - getRegionTimeCount3AsNumber
```
public java.lang.Number getRegionTimeCount3AsNumber()
```
    Get the Region Time Count 3 (component3) as Number
    
    Returns:
    
    the Region Time Count 3 from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field343 setComponent3(java.lang.String component3)
```
    Set the component3.
    
    Parameters:
    
    component3 - the component3 to set
  - setComponent3
```
public Field343 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)
  - setRegionTimeCount3
```
public Field343 setRegionTimeCount3(java.lang.String component3)
```
    Set the Region Time Count 3 (component3).
    
    Parameters:
    
    component3 - the Region Time Count 3 to set
  - setRegionTimeCount3
```
public Field343 setRegionTimeCount3(java.lang.Number component3)
```
    Set the Region Time Count 3 (component3) from a Number object.
    
    Parameters:
    
    component3 - Number with the Region Time Count 3 content to set
    
    See Also:
    
    setComponent3(java.lang.Number)
  - getComponent4
```
public java.lang.String getComponent4()
```
    Get the component4
    
    Returns:
    
    the component4
  - getComponent4AsNumber
```
public java.lang.Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    
    the component4 converted to Number or null if cannot be converted
  - getRegionTimeCount4
```
public java.lang.String getRegionTimeCount4()
```
    Get the Region Time Count 4 (component4).
    
    Returns:
    
    the Region Time Count 4 from component4
  - getRegionTimeCount4AsNumber
```
public java.lang.Number getRegionTimeCount4AsNumber()
```
    Get the Region Time Count 4 (component4) as Number
    
    Returns:
    
    the Region Time Count 4 from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field343 setComponent4(java.lang.String component4)
```
    Set the component4.
    
    Parameters:
    
    component4 - the component4 to set
  - setComponent4
```
public Field343 setComponent4(java.lang.Number component4)
```
    Set the component4 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 setComponent4(String) method.
    
    Parameters:
    
    component4 - the Number with the component4 content to set
    
    See Also:
    
    setComponent4(String)
  - setRegionTimeCount4
```
public Field343 setRegionTimeCount4(java.lang.String component4)
```
    Set the Region Time Count 4 (component4).
    
    Parameters:
    
    component4 - the Region Time Count 4 to set
  - setRegionTimeCount4
```
public Field343 setRegionTimeCount4(java.lang.Number component4)
```
    Set the Region Time Count 4 (component4) from a Number object.
    
    Parameters:
    
    component4 - Number with the Region Time Count 4 content to set
    
    See Also:
    
    setComponent4(java.lang.Number)
  - 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 java.lang.String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - 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 Field343.NAME
  - componentsPattern
```
public final java.lang.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 Field343.COMPONENTS_PATTERN
  - validatorPattern
```
public final java.lang.String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field343 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 Field343 get(SwiftMessage msg)
```
    Get the first instance of Field343 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<Field343> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field343 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<Field343> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field343 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 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
  - 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)

Class Field343

SWIFT MT Field 343

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_343

PARSER_PATTERN

COMPONENTS_PATTERN

REGION_TIME_COUNT_1

REGION_TIME_COUNT_2

REGION_TIME_COUNT_3

REGION_TIME_COUNT_4

Constructor Detail

Field343

Field343

Field343

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsNumber

getRegionTimeCount1

getRegionTimeCount1AsNumber

setComponent1

setComponent1

setRegionTimeCount1

setRegionTimeCount1

getComponent2

getComponent2AsNumber

getRegionTimeCount2

getRegionTimeCount2AsNumber

setComponent2

setComponent2

setRegionTimeCount2

setRegionTimeCount2

getComponent3

getComponent3AsNumber

getRegionTimeCount3

getRegionTimeCount3AsNumber

setComponent3

setComponent3

setRegionTimeCount3

setRegionTimeCount3

getComponent4

getComponent4AsNumber

getRegionTimeCount4

getRegionTimeCount4AsNumber

setComponent4

setComponent4

setRegionTimeCount4

setRegionTimeCount4

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels