com.prowidesoftware.swift.model.field

Class Field56A

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field56A

All Implemented Interfaces:

BICContainer, MultiLineField, PatternContainer, java.io.Serializable

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

SWIFT MT Field 56A

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

Subfields (components) Data types

1. String
2. String
3. BIC

Structure definition

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

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.Integer	ACCOUNT Component number for the Account subfield
static java.lang.Integer	BIC Component number for the BIC subfield
static java.lang.String	COMPONENTS_PATTERN
static java.lang.Integer	DC_MARK Component number for the D/C Mark subfield
static java.lang.String	F_56A same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 56A
static java.lang.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
Field56A() Default constructor.
Field56A(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field56A(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() 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 Field56A	get(SwiftMessage msg) Get the first instance of Field56A in the given message.
static Field56A	get(SwiftTagListBlock block) Get the first occurrence form the tag list or null if not found.
java.lang.String	getAccount() Get the Account (component2) removing its starting slashes if any.
static java.util.List<Field56A>	getAll(SwiftMessage msg) Get a list of all occurrences of the field Field56A in the given message an empty list is returned if none found.
static java.util.List<Field56A>	getAll(SwiftTagListBlock block) Get a list of all occurrences of the field Field56A from the given block an empty list is returned if none found.
java.lang.String	getBIC() Get the BIC (component3).
BIC	getBICAsBIC() Get the BIC (component3) as BIC
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
BIC	getComponent3AsBIC() Get the component3 as BIC
protected java.util.List<java.lang.String>	getComponentLabels() Returns english label for components.
java.lang.String	getDCMark() Get the D/C Mark (component1).
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 Field56A	newInstance(Field56A 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()
Field56A	setAccount(java.lang.String component2) Set the Account (component2).
Field56A	setBIC(BIC component3) Set the BIC (component3) from a BIC object.
Field56A	setBIC(java.lang.String component3) Set the BIC (component3).
Field56A	setComponent1(java.lang.String component1) Set the component1.
Field56A	setComponent2(java.lang.String component2) Set the component2.
Field56A	setComponent3(BIC component3) Set the component3 from a BIC object.
Field56A	setComponent3(java.lang.String component3) Set the component3.
Field56A	setDCMark(java.lang.String component1) Set the D/C Mark (component1).
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 56A

See Also:

Constant Field Values

F_56A

public static final java.lang.String F_56A

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

DC_MARK

public static final java.lang.Integer DC_MARK

Component number for the D/C Mark subfield

ACCOUNT

public static final java.lang.Integer ACCOUNT

Component number for the Account subfield

BIC

public static final java.lang.Integer BIC

Component number for the BIC subfield

Constructor Detail

Field56A

public Field56A()

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

Field56A

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

Field56A

public Field56A(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 Field56A newInstance(Field56A 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)

getDCMark

public java.lang.String getDCMark()

Get the D/C Mark (component1).

Returns:

the D/C Mark from component1

setComponent1

public Field56A setComponent1(java.lang.String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setDCMark

public Field56A setDCMark(java.lang.String component1)

Set the D/C Mark (component1).

Parameters:

component1 - the D/C Mark 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)

getAccount

public java.lang.String getAccount()

Get the Account (component2) removing its starting slashes if any.

Returns:

the Account from component2

setComponent2

public Field56A setComponent2(java.lang.String component2)

Set the component2.

Parameters:

component2 - the component2 to set

setAccount

public Field56A setAccount(java.lang.String component2)

Set the Account (component2).

Parameters:

component2 - the Account to set

getComponent3

public java.lang.String getComponent3()

Get the component3

Returns:

the component3

getComponent3AsBIC

public BIC getComponent3AsBIC()

Get the component3 as BIC

Returns:

the component3 converted to BIC or null if cannot be converted

getBIC

public java.lang.String getBIC()

Get the BIC (component3).

Returns:

the BIC from component3

getBICAsBIC

public BIC getBICAsBIC()

Get the BIC (component3) as BIC

Returns:

the BIC from component3 converted to BIC or null if cannot be converted

setComponent3

public Field56A setComponent3(java.lang.String component3)

Set the component3.

Parameters:

component3 - the component3 to set

setComponent3

public Field56A setComponent3(BIC component3)

Set the component3 from a BIC object.

Parameters:

component3 - the BIC with the component3 content to set

setBIC

public Field56A setBIC(java.lang.String component3)

Set the BIC (component3).

Parameters:

component3 - the BIC to set

setBIC

public Field56A setBIC(BIC component3)

Set the BIC (component3) from a BIC object.

Parameters:

component3 - BIC with the BIC content to set

See Also:

setComponent3(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

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.

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 Field56A.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 Field56A.COMPONENTS_PATTERN

validatorPattern

public final java.lang.String validatorPattern()

Returns the field's validators pattern

Specified by:

validatorPattern in class Field

get

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

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

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

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

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)

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)