com.prowidesoftware.swift.model.field

Class Field94G

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field94G

All Implemented Interfaces:

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

@Generated
public class Field94G
extends Field
implements java.io.Serializable, GenericField, MultiLineField

SWIFT MT Field 94G.

Model and parser for field 94G of a SWIFT MT message.

Subfields (components) Data types

1. Component 1: Qualifier: String
2. Component 2: Address: String
3. Component 3: Address2: String

Structure definition

• validation pattern: :4!c//35x[$35x]
• parser pattern: :S//S[$S]
• components pattern: SSS

This class complies with standard release SRU2023

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	ADDRESS Component number for the Address subfield.
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.Integer	CONDITIONAL_QUALIFIER Component number for the conditional qualifier subfield.
static java.lang.String	F_94G Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 94G.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	QUALIFIER Component number for the Qualifier subfield.
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, labelMap

Constructor Summary

Constructors

Constructor and Description
Field94G() Default constructor.
Field94G(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field94G(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 Field94G	fromJson(java.lang.String json) This method deserializes the JSON data into a Field94G object.
static Field94G	get(SwiftMessage msg) Gets the first instance of Field94G in the given message.
static Field94G	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
java.lang.String	getAddress() Gets the Address as a concatenation of component 2 to component 3.
java.lang.String	getAddress(java.lang.CharSequence deli) Gets the Address as a concatenation of component 2 to component 3 joined together with a copy of the specified delimiter.
java.lang.String	getAddressLine1() Gets the Address (component 2).
java.lang.String	getAddressLine2() Gets the Address 2 (component 3).
static java.util.List<Field94G>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field94G in the given message an empty list is returned if none found.
static java.util.List<Field94G>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field94G from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Qualifier).
java.lang.String	getComponent2() Gets the component 2 (Address).
java.lang.String	getComponent3() Gets the component 3 (Address 2).
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	getConditionalQualifier() Gets the component with the conditional (secondary) qualifier.
java.lang.String	getDSS() Returns the issuer code (or Data Source Scheme or DSS).
protected java.util.Map<java.lang.String,java.lang.Integer>	getLabelMap() Returns a mapping between component labels and the internal component number.
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	getQualifier() Gets the Qualifier (component 1).
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	isDSSPresent() Checks if the issuer code (or Data Source Scheme or DSS) is present.
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 Field94G	newInstance(Field94G 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.
Field94G	setAddress(java.lang.String value) Set the Address splitting the parameter lines into components 2 to 3.
Field94G	setAddressLine1(java.lang.String component2) Set the Address (component 2).
Field94G	setAddressLine2(java.lang.String component3) Set the Address 2 (component 3).
Field94G	setComponent1(java.lang.String component1) Set the component 1 (Qualifier).
Field94G	setComponent2(java.lang.String component2) Set the component 2 (Address).
Field94G	setComponent3(java.lang.String component3) Set the component 3 (Address 2).
Field94G	setQualifier(java.lang.String component1) Set the Qualifier (component 1).
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, 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 94G.

See Also:

Constant Field Values

F_94G

public static final java.lang.String F_94G

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

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield.

ADDRESS

public static final java.lang.Integer ADDRESS

Component number for the Address subfield.

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield.

Constructor Detail

Field94G

public Field94G()

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

Field94G

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

Field94G

public Field94G(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 Field94G newInstance(Field94G 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(phase4=SRU2024)
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

getLabelMap

protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()

Description copied from class: Field

Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.

Specified by:

getLabelMap in class Field

Since:

9.3.12

See Also:

Field.getLabelMap()

getComponent1

public java.lang.String getComponent1()

Gets the component 1 (Qualifier).

Returns:

the component 1

getQualifier

public java.lang.String getQualifier()

Gets the Qualifier (component 1).

Returns:

the Qualifier from component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Address).

Returns:

the component 2

getAddressLine1

public java.lang.String getAddressLine1()

Gets the Address (component 2).

Returns:

the Address from component 2

getAddress

public java.lang.String getAddress()

Gets the Address as a concatenation of component 2 to component 3.

Returns:

the Address from components

getAddress

public java.lang.String getAddress(java.lang.CharSequence deli)

Gets the Address as a concatenation of component 2 to component 3 joined together with a copy of the specified delimiter.

Parameters:

deli - the delimiter that separates each component

Returns:

the Address from components

Since:

9.1.4

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Address 2).

Returns:

the component 3

getAddressLine2

public java.lang.String getAddressLine2()

Gets the Address 2 (component 3).

Returns:

the Address 2 from component 3

setComponent1

public Field94G setComponent1(java.lang.String component1)

Set the component 1 (Qualifier).

Parameters:

component1 - the Qualifier to set

Returns:

the field object to enable build pattern

setQualifier

public Field94G setQualifier(java.lang.String component1)

Set the Qualifier (component 1).

Parameters:

component1 - the Qualifier to set

Returns:

the field object to enable build pattern

setComponent2

public Field94G setComponent2(java.lang.String component2)

Set the component 2 (Address).

Parameters:

component2 - the Address to set

Returns:

the field object to enable build pattern

setAddressLine1

public Field94G setAddressLine1(java.lang.String component2)

Set the Address (component 2).

Parameters:

component2 - the Address to set

Returns:

the field object to enable build pattern

setAddress

public Field94G setAddress(java.lang.String value)

Set the Address splitting the parameter lines into components 2 to 3.

Parameters:

value - the Address to set, may contain line ends and each line will be set to its correspondent component attribute

Returns:

the field object to enable build pattern

setComponent3

public Field94G setComponent3(java.lang.String component3)

Set the component 3 (Address 2).

Parameters:

component3 - the Address 2 to set

Returns:

the field object to enable build pattern

setAddressLine2

public Field94G setAddressLine2(java.lang.String component3)

Set the Address 2 (component 3).

Parameters:

component3 - the Address 2 to set

Returns:

the field object to enable build pattern

getDSS

public java.lang.String getDSS()

Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.

Specified by:

getDSS in interface GenericField

Returns:

DSS component value or null if the DSS is not set or not available for this field.

isDSSPresent

public boolean isDSSPresent()

Checks if the issuer code (or Data Source Scheme or DSS) is present.

Specified by:

isDSSPresent in interface GenericField

Returns:

true if DSS is present, false otherwise.

See Also:

getDSS()

getConditionalQualifier

public java.lang.String getConditionalQualifier()

Gets the component with the conditional (secondary) qualifier.

Specified by:

getConditionalQualifier in interface GenericField

Returns:

for generic fields returns the value of the conditional qualifier or null if not set or not applicable for 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 Field94G.NAME

get

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

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

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

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

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