com.prowidesoftware.swift.model.field

Class Field422

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field422

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

@Generated
public class Field422
extends Field
implements java.io.Serializable

SWIFT MT Field 422.

Model and parser for field 422 of a SWIFT MT message.

Subfields (components) Data types

1. Character
2. String
3. Character
4. String
5. Character
6. String
7. Character
8. String
9. Character
10. String
11. Character
12. String
13. Character
14. String
15. Character
16. String
17. Character
18. String
19. Character
20. String
21. Character
22. String
23. Character
24. String

Structure definition

• validation pattern: 12*(1!c/38x)
• parser pattern: 12*(S/S)
• components pattern: cScScScScScScScScScScScS

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. Use typesPattern() method instead.
static java.lang.String	F_422 Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 422.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.String	TYPES_PATTERN Deprecated. Use typesPattern() method instead.

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

components

Constructor Summary

Constructors

Constructor and Description
Field422() Default constructor.
Field422(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field422(Tag tag) Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Modifier and Type	Method and Description
java.lang.String	componentsPattern() Deprecated. Use typesPattern() instead.
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.
static Field422	fromJson(java.lang.String json) This method deserializes the JSON data into a Field422 object.
static Field422	get(SwiftMessage msg) Gets the first instance of Field422 in the given message.
static Field422	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field422>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field422 in the given message an empty list is returned if none found.
static java.util.List<Field422>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field422 from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 ($label).
java.lang.String	getComponent10() Gets the component 10 ($label).
java.lang.String	getComponent11() Gets the component 11 ($label).
java.lang.String	getComponent12() Gets the component 12 ($label).
java.lang.String	getComponent13() Gets the component 13 ($label).
java.lang.String	getComponent14() Gets the component 14 ($label).
java.lang.String	getComponent15() Gets the component 15 ($label).
java.lang.String	getComponent16() Gets the component 16 ($label).
java.lang.String	getComponent17() Gets the component 17 ($label).
java.lang.String	getComponent18() Gets the component 18 ($label).
java.lang.String	getComponent19() Gets the component 19 ($label).
java.lang.String	getComponent2() Gets the component 2 ($label).
java.lang.String	getComponent20() Gets the component 20 ($label).
java.lang.String	getComponent21() Gets the component 21 ($label).
java.lang.String	getComponent22() Gets the component 22 ($label).
java.lang.String	getComponent23() Gets the component 23 ($label).
java.lang.String	getComponent24() Gets the component 24 ($label).
java.lang.String	getComponent3() Gets the component 3 ($label).
java.lang.String	getComponent4() Gets the component 4 ($label).
java.lang.String	getComponent5() Gets the component 5 ($label).
java.lang.String	getComponent6() Gets the component 6 ($label).
java.lang.String	getComponent7() Gets the component 7 ($label).
java.lang.String	getComponent8() Gets the component 8 ($label).
java.lang.String	getComponent9() Gets the component 9 ($label).
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	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 Field422	newInstance(Field422 source) Copy constructor.
void	parse(java.lang.String value) Parses the parameter value into the internal components structure.
java.lang.String	parserPattern() Returns the field parser pattern.
Field422	setComponent1(java.lang.String component1) Set the component 1 ($label).
Field422	setComponent10(java.lang.String component10) Set the component 10 ($label).
Field422	setComponent11(java.lang.String component11) Set the component 11 ($label).
Field422	setComponent12(java.lang.String component12) Set the component 12 ($label).
Field422	setComponent13(java.lang.String component13) Set the component 13 ($label).
Field422	setComponent14(java.lang.String component14) Set the component 14 ($label).
Field422	setComponent15(java.lang.String component15) Set the component 15 ($label).
Field422	setComponent16(java.lang.String component16) Set the component 16 ($label).
Field422	setComponent17(java.lang.String component17) Set the component 17 ($label).
Field422	setComponent18(java.lang.String component18) Set the component 18 ($label).
Field422	setComponent19(java.lang.String component19) Set the component 19 ($label).
Field422	setComponent2(java.lang.String component2) Set the component 2 ($label).
Field422	setComponent20(java.lang.String component20) Set the component 20 ($label).
Field422	setComponent21(java.lang.String component21) Set the component 21 ($label).
Field422	setComponent22(java.lang.String component22) Set the component 22 ($label).
Field422	setComponent23(java.lang.String component23) Set the component 23 ($label).
Field422	setComponent24(java.lang.String component24) Set the component 24 ($label).
Field422	setComponent3(java.lang.String component3) Set the component 3 ($label).
Field422	setComponent4(java.lang.String component4) Set the component 4 ($label).
Field422	setComponent5(java.lang.String component5) Set the component 5 ($label).
Field422	setComponent6(java.lang.String component6) Set the component 6 ($label).
Field422	setComponent7(java.lang.String component7) Set the component 7 ($label).
Field422	setComponent8(java.lang.String component8) Set the component 8 ($label).
Field422	setComponent9(java.lang.String component9) Set the component 9 ($label).
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.
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 422.

See Also:

Constant Field Values

F_422

public static final java.lang.String F_422

Same as NAME, intended to be clear when using static imports.

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

Constructor Detail

Field422

public Field422()

Default constructor. Creates a new field setting all components to null.

Field422

public Field422(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

Field422

public Field422(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 Field422 newInstance(Field422 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 java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead.

Description copied from class: Field

Returns the field components pattern This method is DEPRECATED, use typesPattern() instead.

Specified by:

componentsPattern in class Field

Returns:

the static value of Field${dto.getField()}.COMPONENTS_PATTERN

See Also:

Field.typesPattern()

typesPattern

public 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

Since:

9.2.7

parserPattern

public java.lang.String parserPattern()

Returns the field parser pattern.

Specified by:

parserPattern in interface PatternContainer

validatorPattern

public 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

public 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 ($label).

Returns:

the component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 ($label).

Returns:

the component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 ($label).

Returns:

the component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 ($label).

Returns:

the component 4

getComponent5

public java.lang.String getComponent5()

Gets the component 5 ($label).

Returns:

the component 5

getComponent6

public java.lang.String getComponent6()

Gets the component 6 ($label).

Returns:

the component 6

getComponent7

public java.lang.String getComponent7()

Gets the component 7 ($label).

Returns:

the component 7

getComponent8

public java.lang.String getComponent8()

Gets the component 8 ($label).

Returns:

the component 8

getComponent9

public java.lang.String getComponent9()

Gets the component 9 ($label).

Returns:

the component 9

getComponent10

public java.lang.String getComponent10()

Gets the component 10 ($label).

Returns:

the component 10

getComponent11

public java.lang.String getComponent11()

Gets the component 11 ($label).

Returns:

the component 11

getComponent12

public java.lang.String getComponent12()

Gets the component 12 ($label).

Returns:

the component 12

getComponent13

public java.lang.String getComponent13()

Gets the component 13 ($label).

Returns:

the component 13

getComponent14

public java.lang.String getComponent14()

Gets the component 14 ($label).

Returns:

the component 14

getComponent15

public java.lang.String getComponent15()

Gets the component 15 ($label).

Returns:

the component 15

getComponent16

public java.lang.String getComponent16()

Gets the component 16 ($label).

Returns:

the component 16

getComponent17

public java.lang.String getComponent17()

Gets the component 17 ($label).

Returns:

the component 17

getComponent18

public java.lang.String getComponent18()

Gets the component 18 ($label).

Returns:

the component 18

getComponent19

public java.lang.String getComponent19()

Gets the component 19 ($label).

Returns:

the component 19

getComponent20

public java.lang.String getComponent20()

Gets the component 20 ($label).

Returns:

the component 20

getComponent21

public java.lang.String getComponent21()

Gets the component 21 ($label).

Returns:

the component 21

getComponent22

public java.lang.String getComponent22()

Gets the component 22 ($label).

Returns:

the component 22

getComponent23

public java.lang.String getComponent23()

Gets the component 23 ($label).

Returns:

the component 23

getComponent24

public java.lang.String getComponent24()

Gets the component 24 ($label).

Returns:

the component 24

setComponent1

public Field422 setComponent1(java.lang.String component1)

Set the component 1 ($label).

Parameters:

component1 - the $label to set

Returns:

the field object to enable build pattern

setComponent2

public Field422 setComponent2(java.lang.String component2)

Set the component 2 ($label).

Parameters:

component2 - the $label to set

Returns:

the field object to enable build pattern

setComponent3

public Field422 setComponent3(java.lang.String component3)

Set the component 3 ($label).

Parameters:

component3 - the $label to set

Returns:

the field object to enable build pattern

setComponent4

public Field422 setComponent4(java.lang.String component4)

Set the component 4 ($label).

Parameters:

component4 - the $label to set

Returns:

the field object to enable build pattern

setComponent5

public Field422 setComponent5(java.lang.String component5)

Set the component 5 ($label).

Parameters:

component5 - the $label to set

Returns:

the field object to enable build pattern

setComponent6

public Field422 setComponent6(java.lang.String component6)

Set the component 6 ($label).

Parameters:

component6 - the $label to set

Returns:

the field object to enable build pattern

setComponent7

public Field422 setComponent7(java.lang.String component7)

Set the component 7 ($label).

Parameters:

component7 - the $label to set

Returns:

the field object to enable build pattern

setComponent8

public Field422 setComponent8(java.lang.String component8)

Set the component 8 ($label).

Parameters:

component8 - the $label to set

Returns:

the field object to enable build pattern

setComponent9

public Field422 setComponent9(java.lang.String component9)

Set the component 9 ($label).

Parameters:

component9 - the $label to set

Returns:

the field object to enable build pattern

setComponent10

public Field422 setComponent10(java.lang.String component10)

Set the component 10 ($label).

Parameters:

component10 - the $label to set

Returns:

the field object to enable build pattern

setComponent11

public Field422 setComponent11(java.lang.String component11)

Set the component 11 ($label).

Parameters:

component11 - the $label to set

Returns:

the field object to enable build pattern

setComponent12

public Field422 setComponent12(java.lang.String component12)

Set the component 12 ($label).

Parameters:

component12 - the $label to set

Returns:

the field object to enable build pattern

setComponent13

public Field422 setComponent13(java.lang.String component13)

Set the component 13 ($label).

Parameters:

component13 - the $label to set

Returns:

the field object to enable build pattern

setComponent14

public Field422 setComponent14(java.lang.String component14)

Set the component 14 ($label).

Parameters:

component14 - the $label to set

Returns:

the field object to enable build pattern

setComponent15

public Field422 setComponent15(java.lang.String component15)

Set the component 15 ($label).

Parameters:

component15 - the $label to set

Returns:

the field object to enable build pattern

setComponent16

public Field422 setComponent16(java.lang.String component16)

Set the component 16 ($label).

Parameters:

component16 - the $label to set

Returns:

the field object to enable build pattern

setComponent17

public Field422 setComponent17(java.lang.String component17)

Set the component 17 ($label).

Parameters:

component17 - the $label to set

Returns:

the field object to enable build pattern

setComponent18

public Field422 setComponent18(java.lang.String component18)

Set the component 18 ($label).

Parameters:

component18 - the $label to set

Returns:

the field object to enable build pattern

setComponent19

public Field422 setComponent19(java.lang.String component19)

Set the component 19 ($label).

Parameters:

component19 - the $label to set

Returns:

the field object to enable build pattern

setComponent20

public Field422 setComponent20(java.lang.String component20)

Set the component 20 ($label).

Parameters:

component20 - the $label to set

Returns:

the field object to enable build pattern

setComponent21

public Field422 setComponent21(java.lang.String component21)

Set the component 21 ($label).

Parameters:

component21 - the $label to set

Returns:

the field object to enable build pattern

setComponent22

public Field422 setComponent22(java.lang.String component22)

Set the component 22 ($label).

Parameters:

component22 - the $label to set

Returns:

the field object to enable build pattern

setComponent23

public Field422 setComponent23(java.lang.String component23)

Set the component 23 ($label).

Parameters:

component23 - the $label to set

Returns:

the field object to enable build pattern

setComponent24

public Field422 setComponent24(java.lang.String component24)

Set the component 24 ($label).

Parameters:

component24 - the $label to set

Returns:

the field object to enable build pattern

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 Field422.NAME

get

public static Field422 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 Field422 get(SwiftMessage msg)

Gets the first instance of Field422 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<Field422> getAll(SwiftMessage msg)

Gets a list of all occurrences of the field Field422 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<Field422> getAll(SwiftTagListBlock block)

Gets a list of all occurrences of the field Field422 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 Field422 fromJson(java.lang.String json)

This method deserializes the JSON data into a Field422 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)