com.prowidesoftware.swift.model.field

Class Field50A

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field50A

All Implemented Interfaces:

JsonSerializable, BICContainer, MultiLineField, PatternContainer, java.io.Serializable

@Generated
public class Field50A
extends Field
implements java.io.Serializable, BICContainer, MultiLineField

SWIFT MT Field 50A.

Model and parser for field 50A of a SWIFT MT message.

Subfields (components) Data types

1. String
2. BIC

Structure definition

• validation pattern: [/34x$]<BIC>
• parser pattern: [/S$]S
• components pattern: SB

This class complies with standard release SRU2022

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	ACCOUNT Component number for the Account subfield.
static java.lang.Integer	BIC Deprecated.
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.String	F_50A Same as NAME, intended to be clear when using static imports.
static java.lang.Integer	IDENTIFIER_CODE Component number for the Identifier Code subfield.
static java.lang.String	NAME Constant with the field name 50A.
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
Field50A() Default constructor.
Field50A(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field50A(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.util.List<BIC>	bics() Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
java.util.List<java.lang.String>	bicStrings() Get a list of strings of BICs present in this field
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 Field50A	fromJson(java.lang.String json) This method deserializes the JSON data into a Field50A object.
static Field50A	get(SwiftMessage msg) Gets the first instance of Field50A in the given message.
static Field50A	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
java.lang.String	getAccount() Gets the Account (component 1) removing its starting slashes if any.
static java.util.List<Field50A>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field50A in the given message an empty list is returned if none found.
static java.util.List<Field50A>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field50A from the given block an empty list is returned if none found.
java.lang.String	getBIC() Deprecated.
BIC	getBICAsBIC() Deprecated.
java.lang.String	getComponent1() Gets the component 1 (Account).
java.lang.String	getComponent2() Gets the component 2 (Identifier Code).
BIC	getComponent2AsBIC() Get the component 2 as BIC
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	getIdentifierCode() Gets the Identifier Code (component 2).
BIC	getIdentifierCodeAsBIC() Get the Identifier Code (component 2) as BIC
java.lang.String	getLine(int line) Returns a specific line from the field's value.
java.lang.String	getLine(int line, int offset) Returns a specific line from the field's value.
java.util.List<java.lang.String>	getLines() Returns the field value split into lines.
java.util.List<java.lang.String>	getLines(int offset) Returns the field value starting at the offset component, split into lines.
java.util.List<java.lang.String>	getLinesBetween(int start, int end) Returns a specific subset of lines from the field's value, given a range.
java.util.List<java.lang.String>	getLinesBetween(int start, int end, int offset) Returns a specific subset of lines from the field's value, starting at the offset component.
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 Field50A	newInstance(Field50A 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.
Field50A	setAccount(java.lang.String component1) Set the Account (component 1).
Field50A	setBIC(BIC component2) Deprecated.
Field50A	setBIC(java.lang.String component2) Deprecated.
Field50A	setComponent1(java.lang.String component1) Set the component 1 (Account).
Field50A	setComponent2(BIC component2) Set the component2 from a BIC object.
Field50A	setComponent2(java.lang.String component2) Set the component 2 (Identifier Code).
Field50A	setIdentifierCode(BIC component2) Set the Identifier Code (component 2) from a BIC object.
Field50A	setIdentifierCode(java.lang.String component2) Set the Identifier Code (component 2).
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 50A.

See Also:

Constant Field Values

F_50A

public static final java.lang.String F_50A

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

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

ACCOUNT

public static final java.lang.Integer ACCOUNT

Component number for the Account subfield.

IDENTIFIER_CODE

public static final java.lang.Integer IDENTIFIER_CODE

Component number for the Identifier Code subfield.

BIC

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.Integer BIC

Deprecated.

Alternative (DEPRECATED) constant name for field's Identifier Code Component number.

See Also:

IDENTIFIER_CODE

Constructor Detail

Field50A

public Field50A()

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

Field50A

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

Field50A

public Field50A(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 Field50A newInstance(Field50A 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(phase3=SRU2023)
public java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead.

Specified by:

componentsPattern in class Field

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 (Account).

Returns:

the component 1

getAccount

public java.lang.String getAccount()

Gets the Account (component 1) removing its starting slashes if any.

Returns:

the Account from component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Identifier Code).

Returns:

the component 2

getComponent2AsBIC

public BIC getComponent2AsBIC()

Get the component 2 as BIC

Returns:

the component 2 converted to BIC or null if cannot be converted

getIdentifierCode

public java.lang.String getIdentifierCode()

Gets the Identifier Code (component 2).

Returns:

the Identifier Code from component 2

getBIC

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.String getBIC()

Deprecated.

Alternative DEPRECATED method getter for field's Identifier Code

Since:

9.2.7

See Also:

getIdentifierCode()

getIdentifierCodeAsBIC

public BIC getIdentifierCodeAsBIC()

Get the Identifier Code (component 2) as BIC

Returns:

the Identifier Code from component 2 converted to BIC or null if cannot be converted

getBICAsBIC

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public BIC getBICAsBIC()

Deprecated.

Alternative DEPRECATED method getter for field's Identifier Code as BIC

See Also:

getIdentifierCodeAsBIC()

setComponent1

public Field50A setComponent1(java.lang.String component1)

Set the component 1 (Account).

Parameters:

component1 - the Account to set

Returns:

the field object to enable build pattern

setAccount

public Field50A setAccount(java.lang.String component1)

Set the Account (component 1).

Parameters:

component1 - the Account to set

Returns:

the field object to enable build pattern

setComponent2

public Field50A setComponent2(java.lang.String component2)

Set the component 2 (Identifier Code).

Parameters:

component2 - the Identifier Code to set

Returns:

the field object to enable build pattern

setComponent2

public Field50A setComponent2(BIC component2)

Set the component2 from a BIC object.

Parameters:

component2 - the BIC with the Identifier Code content to set

Returns:

the field object to enable build pattern

setIdentifierCode

public Field50A setIdentifierCode(java.lang.String component2)

Set the Identifier Code (component 2).

Parameters:

component2 - the Identifier Code to set

Returns:

the field object to enable build pattern

setIdentifierCode

public Field50A setIdentifierCode(BIC component2)

Set the Identifier Code (component 2) from a BIC object.

Parameters:

component2 - BIC with the Identifier Code content to set

Returns:

the field object to enable build pattern

See Also:

setComponent2(com.prowidesoftware.swift.model.BIC)

setBIC

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public Field50A setBIC(java.lang.String component2)

Deprecated.

Alternative DEPRECATED method setter for field's Identifier Code

Parameters:

component2 - the Identifier Code to set

Returns:

the field object to enable build pattern

See Also:

setIdentifierCode(String)

setBIC

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public Field50A setBIC(BIC component2)

Deprecated.

Alternative DEPRECATED method setter for field's Identifier Code from a BIC object.

Parameters:

component2 - BIC with the Identifier Code content to set

Returns:

the field object to enable build pattern

See Also:

setComponent2(com.prowidesoftware.swift.model.BIC)

bics

public java.util.List<BIC> bics()

Description copied from interface: BICContainer

Utility method that creates a BIC for every string returned by BICContainer.bicStrings()

Specified by:

bics in interface BICContainer

Returns:

list of BIC objects

bicStrings

public java.util.List<java.lang.String> bicStrings()

Description copied from interface: BICContainer

Get a list of strings of BICs present in this field

Specified by:

bicStrings in interface BICContainer

Returns:

a list, with zero or more BICs in this field.

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

get

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

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

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

Gets a list of all occurrences of the field Field50A 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

getLine

public java.lang.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 java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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)

fromJson

public static Field50A fromJson(java.lang.String json)

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