com.prowidesoftware.swift.model.field

Class Field22C

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field22C

All Implemented Interfaces:

PatternContainer, java.io.Serializable

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

SWIFT MT Field 22C

Model and parser for field 22C of a SWIFT MT message.

Subfields (components) Data types

1. String
2. String
3. Number
4. String
5. String

Structure definition

• validation pattern: CUSTOM
• parser pattern: 4!S2!S4!S4!S2!S
• components pattern: SSNSS

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_22C same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 22C
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	PARTY_PREFIX_1 Component number for the Party Prefix 1 subfield
static java.lang.Integer	PARTY_PREFIX_2 Component number for the Party Prefix 2 subfield
static java.lang.Integer	PARTY_SUFFIX_1 Component number for the Party Suffix 1 subfield
static java.lang.Integer	PARTY_SUFFIX_2 Component number for the Party Suffix 2 subfield
static java.lang.Integer	REFERENCE_CODE Component number for the Reference Code 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
Field22C() Default constructor.
Field22C(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field22C(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() 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 Field22C	get(SwiftMessage msg) Get the first instance of Field22C in the given message.
static Field22C	get(SwiftTagListBlock block) Get the first occurrence form the tag list or null if not found.
static java.util.List<Field22C>	getAll(SwiftMessage msg) Get a list of all occurrences of the field Field22C in the given message an empty list is returned if none found.
static java.util.List<Field22C>	getAll(SwiftTagListBlock block) Get a list of all occurrences of the field Field22C from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Get the component1
java.lang.String	getComponent1AsString() Deprecated. use Field.getComponent(int) instead
java.lang.String	getComponent2() Get the component2
java.lang.String	getComponent2AsString() Deprecated. use Field.getComponent(int) instead
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.String	getComponent4AsString() Deprecated. use Field.getComponent(int) instead
java.lang.String	getComponent5() Get the component5
java.lang.String	getComponent5AsString() Deprecated. use Field.getComponent(int) instead
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	getPartyPrefix1() Get the Party Prefix 1 (component1).
java.lang.String	getPartyPrefix2() Get the Party Prefix 2 (component4).
java.lang.String	getPartySuffix1() Get the Party Suffix 1 (component2).
java.lang.String	getPartySuffix2() Get the Party Suffix 2 (component5).
java.lang.String	getReferenceCode() Get the Reference Code (component3).
java.lang.Number	getReferenceCodeAsNumber() Get the Reference Code (component3) 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 Field22C	newInstance(Field22C 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()
Field22C	setComponent1(java.lang.String component1) Set the component1.
Field22C	setComponent2(java.lang.String component2) Set the component2.
Field22C	setComponent3(java.lang.Number component3) Set the component3 from a Number object.
Field22C	setComponent3(java.lang.String component3) Set the component3.
Field22C	setComponent4(java.lang.String component4) Set the component4.
Field22C	setComponent5(java.lang.String component5) Set the component5.
Field22C	setPartyPrefix1(java.lang.String component1) Set the Party Prefix 1 (component1).
Field22C	setPartyPrefix2(java.lang.String component4) Set the Party Prefix 2 (component4).
Field22C	setPartySuffix1(java.lang.String component2) Set the Party Suffix 1 (component2).
Field22C	setPartySuffix2(java.lang.String component5) Set the Party Suffix 2 (component5).
Field22C	setReferenceCode(java.lang.Number component3) Set the Reference Code (component3) from a Number object.
Field22C	setReferenceCode(java.lang.String component3) Set the Reference Code (component3).
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 22C

See Also:

Constant Field Values

F_22C

public static final java.lang.String F_22C

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

PARTY_PREFIX_1

public static final java.lang.Integer PARTY_PREFIX_1

Component number for the Party Prefix 1 subfield

PARTY_SUFFIX_1

public static final java.lang.Integer PARTY_SUFFIX_1

Component number for the Party Suffix 1 subfield

REFERENCE_CODE

public static final java.lang.Integer REFERENCE_CODE

Component number for the Reference Code subfield

PARTY_PREFIX_2

public static final java.lang.Integer PARTY_PREFIX_2

Component number for the Party Prefix 2 subfield

PARTY_SUFFIX_2

public static final java.lang.Integer PARTY_SUFFIX_2

Component number for the Party Suffix 2 subfield

Constructor Detail

Field22C

public Field22C()

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

Field22C

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

Field22C

public Field22C(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 Field22C newInstance(Field22C 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

getComponent1AsString

@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent1AsString()

Deprecated. use Field.getComponent(int) instead

Same as getComponent(1)

getPartyPrefix1

public java.lang.String getPartyPrefix1()

Get the Party Prefix 1 (component1).

Returns:

the Party Prefix 1 from component1

setComponent1

public Field22C setComponent1(java.lang.String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setPartyPrefix1

public Field22C setPartyPrefix1(java.lang.String component1)

Set the Party Prefix 1 (component1).

Parameters:

component1 - the Party Prefix 1 to set

getComponent2

public java.lang.String getComponent2()

Get the component2

Returns:

the component2

getComponent2AsString

@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent2AsString()

Deprecated. use Field.getComponent(int) instead

Same as getComponent(2)

getPartySuffix1

public java.lang.String getPartySuffix1()

Get the Party Suffix 1 (component2).

Returns:

the Party Suffix 1 from component2

setComponent2

public Field22C setComponent2(java.lang.String component2)

Set the component2.

Parameters:

component2 - the component2 to set

setPartySuffix1

public Field22C setPartySuffix1(java.lang.String component2)

Set the Party Suffix 1 (component2).

Parameters:

component2 - the Party Suffix 1 to set

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

getReferenceCode

public java.lang.String getReferenceCode()

Get the Reference Code (component3).

Returns:

the Reference Code from component3

getReferenceCodeAsNumber

public java.lang.Number getReferenceCodeAsNumber()

Get the Reference Code (component3) as Number

Returns:

the Reference Code from component3 converted to Number or null if cannot be converted

setComponent3

public Field22C setComponent3(java.lang.String component3)

Set the component3.

Parameters:

component3 - the component3 to set

setComponent3

public Field22C 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)

setReferenceCode

public Field22C setReferenceCode(java.lang.String component3)

Set the Reference Code (component3).

Parameters:

component3 - the Reference Code to set

setReferenceCode

public Field22C setReferenceCode(java.lang.Number component3)

Set the Reference Code (component3) from a Number object.

Parameters:

component3 - Number with the Reference Code content to set

See Also:

setComponent3(java.lang.Number)

getComponent4

public java.lang.String getComponent4()

Get the component4

Returns:

the component4

getComponent4AsString

@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent4AsString()

Deprecated. use Field.getComponent(int) instead

Same as getComponent(4)

getPartyPrefix2

public java.lang.String getPartyPrefix2()

Get the Party Prefix 2 (component4).

Returns:

the Party Prefix 2 from component4

setComponent4

public Field22C setComponent4(java.lang.String component4)

Set the component4.

Parameters:

component4 - the component4 to set

setPartyPrefix2

public Field22C setPartyPrefix2(java.lang.String component4)

Set the Party Prefix 2 (component4).

Parameters:

component4 - the Party Prefix 2 to set

getComponent5

public java.lang.String getComponent5()

Get the component5

Returns:

the component5

getComponent5AsString

@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent5AsString()

Deprecated. use Field.getComponent(int) instead

Same as getComponent(5)

getPartySuffix2

public java.lang.String getPartySuffix2()

Get the Party Suffix 2 (component5).

Returns:

the Party Suffix 2 from component5

setComponent5

public Field22C setComponent5(java.lang.String component5)

Set the component5.

Parameters:

component5 - the component5 to set

setPartySuffix2

public Field22C setPartySuffix2(java.lang.String component5)

Set the Party Suffix 2 (component5).

Parameters:

component5 - the Party Suffix 2 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 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 Field22C.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 Field22C.COMPONENTS_PATTERN

validatorPattern

public final java.lang.String validatorPattern()

Returns the field's validators pattern

Specified by:

validatorPattern in class Field

get

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

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

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

Get a list of all occurrences of the field Field22C 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)