Field345 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
@Generated
public class Field345
extends Field
implements Serializable
```
Field 345

validation pattern: [3!c]*10
parser pattern: 3!S*10
components pattern: MMMMMMMMMM

Components Data types
- component1: Number
- component2: Number
- component3: Number
- component4: Number
- component5: Number
- component6: Number
- component7: Number
- component8: Number
- component9: Number
- component10: Number
NOTE: this source code has been generated from template This class complies with standard release SRU2016
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENTS_PATTERN`
`static String`	`F_345` same as NAME, intended to be clear when using static imports
`static Integer`	`MT1` Component number for the MT1 subfield
`static Integer`	`MT10` Component number for the MT10 subfield
`static Integer`	`MT2` Component number for the MT2 subfield
`static Integer`	`MT3` Component number for the MT3 subfield
`static Integer`	`MT4` Component number for the MT4 subfield
`static Integer`	`MT5` Component number for the MT5 subfield
`static Integer`	`MT6` Component number for the MT6 subfield
`static Integer`	`MT7` Component number for the MT7 subfield
`static Integer`	`MT8` Component number for the MT8 subfield
`static Integer`	`MT9` Component number for the MT9 subfield
`static String`	`NAME` Constant with the field name 345
`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
`Field345()` Default constructor.
`Field345(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field345(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 Field345`	`get(SwiftMessage msg)` Get the first instance of Field345 in the given message.
`static Field345`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field345>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field345 in the given message an empty list is returned if none found.
`static List<Field345>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field345 from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent10()` Get the component10
`String`	`getComponent2()` Get the component2
`String`	`getComponent3()` Get the component3
`String`	`getComponent4()` Get the component4
`String`	`getComponent5()` Get the component5
`String`	`getComponent6()` Get the component6
`String`	`getComponent7()` Get the component7
`String`	`getComponent8()` Get the component8
`String`	`getComponent9()` Get the component9
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getMT1()` Get the MT1 (component1).
`String`	`getMT10()` Get the MT10 (component10).
`String`	`getMT2()` Get the MT2 (component2).
`String`	`getMT3()` Get the MT3 (component3).
`String`	`getMT4()` Get the MT4 (component4).
`String`	`getMT5()` Get the MT5 (component5).
`String`	`getMT6()` Get the MT6 (component6).
`String`	`getMT7()` Get the MT7 (component7).
`String`	`getMT8()` Get the MT8 (component8).
`String`	`getMT9()` Get the MT9 (component9).
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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 Field345`	`newInstance(Field345 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()`
`Field345`	`setComponent1(String component1)` Set the component1.
`Field345`	`setComponent10(String component10)` Set the component10.
`Field345`	`setComponent2(String component2)` Set the component2.
`Field345`	`setComponent3(String component3)` Set the component3.
`Field345`	`setComponent4(String component4)` Set the component4.
`Field345`	`setComponent5(String component5)` Set the component5.
`Field345`	`setComponent6(String component6)` Set the component6.
`Field345`	`setComponent7(String component7)` Set the component7.
`Field345`	`setComponent8(String component8)` Set the component8.
`Field345`	`setComponent9(String component9)` Set the component9.
`Field345`	`setMT1(String component1)` Set the MT1 (component1).
`Field345`	`setMT10(String component10)` Set the MT10 (component10).
`Field345`	`setMT2(String component2)` Set the MT2 (component2).
`Field345`	`setMT3(String component3)` Set the MT3 (component3).
`Field345`	`setMT4(String component4)` Set the MT4 (component4).
`Field345`	`setMT5(String component5)` Set the MT5 (component5).
`Field345`	`setMT6(String component6)` Set the MT6 (component6).
`Field345`	`setMT7(String component7)` Set the MT7 (component7).
`Field345`	`setMT8(String component8)` Set the MT8 (component8).
`Field345`	`setMT9(String component9)` Set the MT9 (component9).
`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
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, 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 345
    
    See Also:
    Constant Field Values
  - F_345
```
public static final String F_345
```
    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
  - MT1
```
public static final Integer MT1
```
    Component number for the MT1 subfield
  - MT2
```
public static final Integer MT2
```
    Component number for the MT2 subfield
  - MT3
```
public static final Integer MT3
```
    Component number for the MT3 subfield
  - MT4
```
public static final Integer MT4
```
    Component number for the MT4 subfield
  - MT5
```
public static final Integer MT5
```
    Component number for the MT5 subfield
  - MT6
```
public static final Integer MT6
```
    Component number for the MT6 subfield
  - MT7
```
public static final Integer MT7
```
    Component number for the MT7 subfield
  - MT8
```
public static final Integer MT8
```
    Component number for the MT8 subfield
  - MT9
```
public static final Integer MT9
```
    Component number for the MT9 subfield
  - MT10
```
public static final Integer MT10
```
    Component number for the MT10 subfield
- Constructor Detail
  - Field345
```
public Field345()
```
    Default constructor. Creates a new field setting all components to null.
  - Field345
```
public Field345(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
  - Field345
```
public Field345(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 components value is overwritten.
    
    Overrides:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field345 newInstance(Field345 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)
    
    Overrides:
    
    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
  - getMT1
```
public String getMT1()
```
    Get the MT1 (component1).
    
    Returns:
    the MT1 from component1
  - setComponent1
```
public Field345 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setMT1
```
public Field345 setMT1(String component1)
```
    Set the MT1 (component1).
    
    Parameters:
    component1 - the MT1 to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getMT2
```
public String getMT2()
```
    Get the MT2 (component2).
    
    Returns:
    the MT2 from component2
  - setComponent2
```
public Field345 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setMT2
```
public Field345 setMT2(String component2)
```
    Set the MT2 (component2).
    
    Parameters:
    component2 - the MT2 to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getMT3
```
public String getMT3()
```
    Get the MT3 (component3).
    
    Returns:
    the MT3 from component3
  - setComponent3
```
public Field345 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setMT3
```
public Field345 setMT3(String component3)
```
    Set the MT3 (component3).
    
    Parameters:
    component3 - the MT3 to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getMT4
```
public String getMT4()
```
    Get the MT4 (component4).
    
    Returns:
    the MT4 from component4
  - setComponent4
```
public Field345 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setMT4
```
public Field345 setMT4(String component4)
```
    Set the MT4 (component4).
    
    Parameters:
    component4 - the MT4 to set
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getMT5
```
public String getMT5()
```
    Get the MT5 (component5).
    
    Returns:
    the MT5 from component5
  - setComponent5
```
public Field345 setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - setMT5
```
public Field345 setMT5(String component5)
```
    Set the MT5 (component5).
    
    Parameters:
    component5 - the MT5 to set
  - getComponent6
```
public String getComponent6()
```
    Get the component6
    
    Returns:
    the component6
  - getMT6
```
public String getMT6()
```
    Get the MT6 (component6).
    
    Returns:
    the MT6 from component6
  - setComponent6
```
public Field345 setComponent6(String component6)
```
    Set the component6.
    
    Parameters:
    component6 - the component6 to set
  - setMT6
```
public Field345 setMT6(String component6)
```
    Set the MT6 (component6).
    
    Parameters:
    component6 - the MT6 to set
  - getComponent7
```
public String getComponent7()
```
    Get the component7
    
    Returns:
    the component7
  - getMT7
```
public String getMT7()
```
    Get the MT7 (component7).
    
    Returns:
    the MT7 from component7
  - setComponent7
```
public Field345 setComponent7(String component7)
```
    Set the component7.
    
    Parameters:
    component7 - the component7 to set
  - setMT7
```
public Field345 setMT7(String component7)
```
    Set the MT7 (component7).
    
    Parameters:
    component7 - the MT7 to set
  - getComponent8
```
public String getComponent8()
```
    Get the component8
    
    Returns:
    the component8
  - getMT8
```
public String getMT8()
```
    Get the MT8 (component8).
    
    Returns:
    the MT8 from component8
  - setComponent8
```
public Field345 setComponent8(String component8)
```
    Set the component8.
    
    Parameters:
    component8 - the component8 to set
  - setMT8
```
public Field345 setMT8(String component8)
```
    Set the MT8 (component8).
    
    Parameters:
    component8 - the MT8 to set
  - getComponent9
```
public String getComponent9()
```
    Get the component9
    
    Returns:
    the component9
  - getMT9
```
public String getMT9()
```
    Get the MT9 (component9).
    
    Returns:
    the MT9 from component9
  - setComponent9
```
public Field345 setComponent9(String component9)
```
    Set the component9.
    
    Parameters:
    component9 - the component9 to set
  - setMT9
```
public Field345 setMT9(String component9)
```
    Set the MT9 (component9).
    
    Parameters:
    component9 - the MT9 to set
  - getComponent10
```
public String getComponent10()
```
    Get the component10
    
    Returns:
    the component10
  - getMT10
```
public String getMT10()
```
    Get the MT10 (component10).
    
    Returns:
    the MT10 from component10
  - setComponent10
```
public Field345 setComponent10(String component10)
```
    Set the component10.
    
    Parameters:
    component10 - the component10 to set
  - setMT10
```
public Field345 setMT10(String component10)
```
    Set the MT10 (component10).
    
    Parameters:
    component10 - the MT10 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 Field345.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 Field345.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field345 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 Field345 get(SwiftMessage msg)
```
    Get the first instance of Field345 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<Field345> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field345 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<Field345> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field345 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 Field345

Components Data types

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_345

PARSER_PATTERN

COMPONENTS_PATTERN

MT1

MT2

MT3

MT4

MT5

MT6

MT7

MT8

MT9

MT10

Constructor Detail

Field345

Field345

Field345

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getMT1

setComponent1

setMT1

getComponent2

getMT2

setComponent2

setMT2

getComponent3

getMT3

setComponent3

setMT3

getComponent4

getMT4

setComponent4

setMT4

getComponent5

getMT5

setComponent5

setMT5

getComponent6

getMT6

setComponent6

setMT6

getComponent7

getMT7

setComponent7

setMT7

getComponent8

getMT8

setComponent8

setMT8

getComponent9

getMT9

setComponent9

setMT9

getComponent10

getMT10

setComponent10

setMT10

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern