com.prowidesoftware.swift.model.field

Class Field42M

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field42M

All Implemented Interfaces:

JsonSerializable, MultiLineField, PatternContainer, java.io.Serializable

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

SWIFT MT Field 42M

Model and parser for field 42M of a SWIFT MT message.

Subfields (components) Data types

1. String
2. String
3. String
4. String

Structure definition

• validation pattern: 35x[$35x]0-3
• parser pattern: S[$S]0-3
• components pattern: SSSS

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.
static java.lang.String	F_42M same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 42M
static java.lang.Integer	NARRATIVE Component number for the Narrative subfield
static java.lang.String	PARSER_PATTERN
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.String	TYPES_PATTERN Types pattern Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.

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

components

Constructor Summary

Constructors

Constructor and Description
Field42M() Default constructor.
Field42M(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field42M(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.
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 Field42M	fromJson(java.lang.String json) This method deserializes the JSON data into a Field42M object.
static Field42M	get(SwiftMessage msg) Gets the first instance of Field42M in the given message.
static Field42M	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field42M>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field42M in the given message an empty list is returned if none found.
static java.util.List<Field42M>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field42M from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Narrative).
java.lang.String	getComponent2() Gets the component 2 (Narrative 2).
java.lang.String	getComponent3() Gets the component 3 (Narrative 3).
java.lang.String	getComponent4() Gets the component 4 (Narrative 4).
protected 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	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	getNarrative() Gets the Narrative as a concatenation of component 1 to component 4.
java.lang.String	getNarrative(java.lang.CharSequence deli) Gets the Narrative as a concatenation of component 1 to component 4 joined together with a copy of the specified delimiter.
java.lang.String	getNarrativeLine1() Gets the Narrative (component 1).
java.lang.String	getNarrativeLine2() Gets the Narrative 2 (component 2).
java.lang.String	getNarrativeLine3() Gets the Narrative 3 (component 3).
java.lang.String	getNarrativeLine4() Gets the Narrative 4 (component 4).
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 Field42M	newInstance(Field42M 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() Returns the field parser pattern
Field42M	setComponent1(java.lang.String component1) Set the component 1 (Narrative).
Field42M	setComponent2(java.lang.String component2) Set the component 2 (Narrative 2).
Field42M	setComponent3(java.lang.String component3) Set the component 3 (Narrative 3).
Field42M	setComponent4(java.lang.String component4) Set the component 4 (Narrative 4).
Field42M	setNarrative(java.lang.String value) Set the Narrative splitting the parameter lines into components 1 to 4.
Field42M	setNarrativeLine1(java.lang.String component1) Set the Narrative (component 1).
Field42M	setNarrativeLine2(java.lang.String component2) Set the Narrative 2 (component 2).
Field42M	setNarrativeLine3(java.lang.String component3) Set the Narrative 3 (component 3).
Field42M	setNarrativeLine4(java.lang.String component4) Set the Narrative 4 (component 4).
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 This method returns a letter representing the type for each component in the Field.
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 42M

See Also:

Constant Field Values

F_42M

public static final java.lang.String F_42M

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

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

Deprecated.

Components pattern Contains a description of the type for every component. This is DEPRECATED, use TYPES_PATTERN instead, because it distinguishes between N (number) and I (BigDecimal)

See Also:

TYPES_PATTERN, Constant Field Values

TYPES_PATTERN

public static final java.lang.String TYPES_PATTERN

Types pattern Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.

Since:

9.2.7

See Also:

Constant Field Values

NARRATIVE

public static final java.lang.Integer NARRATIVE

Component number for the Narrative subfield

Constructor Detail

Field42M

public Field42M()

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

Field42M

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

Field42M

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

Deprecated.

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

Specified by:

componentsPattern in class Field

Returns:

the static value of Field42M.COMPONENTS_PATTERN

See Also:

typesPattern()

typesPattern

public final 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

Returns:

the static value of Field42M.TYPES_PATTERN

Since:

9.2.7

See Also:

TYPES_PATTERN

parserPattern

public final java.lang.String parserPattern()

Returns the field parser pattern

Specified by:

parserPattern in interface PatternContainer

Returns:

the static value of Field42M.PARSER_PATTERN

validatorPattern

public final 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

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)

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

Returns:

the component 1

getNarrativeLine1

public java.lang.String getNarrativeLine1()

Gets the Narrative (component 1).

Returns:

the Narrative from component 1

getNarrative

public java.lang.String getNarrative()

Gets the Narrative as a concatenation of component 1 to component 4.

Returns:

the Narrative from components

getNarrative

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

Gets the Narrative as a concatenation of component 1 to component 4 joined together with a copy of the specified delimiter.

Parameters:

deli - the delimiter that separates each component

Returns:

the Narrative from components

Since:

9.1.4

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Narrative 2).

Returns:

the component 2

getNarrativeLine2

public java.lang.String getNarrativeLine2()

Gets the Narrative 2 (component 2).

Returns:

the Narrative 2 from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Narrative 3).

Returns:

the component 3

getNarrativeLine3

public java.lang.String getNarrativeLine3()

Gets the Narrative 3 (component 3).

Returns:

the Narrative 3 from component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Narrative 4).

Returns:

the component 4

getNarrativeLine4

public java.lang.String getNarrativeLine4()

Gets the Narrative 4 (component 4).

Returns:

the Narrative 4 from component 4

setComponent1

public Field42M setComponent1(java.lang.String component1)

Set the component 1 (Narrative).

Parameters:

component1 - the Narrative to set

Returns:

the field object to enable build pattern

setNarrativeLine1

public Field42M setNarrativeLine1(java.lang.String component1)

Set the Narrative (component 1).

Parameters:

component1 - the Narrative to set

Returns:

the field object to enable build pattern

setNarrative

public Field42M setNarrative(java.lang.String value)

Set the Narrative splitting the parameter lines into components 1 to 4.

Parameters:

value - the Narrative 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

setComponent2

public Field42M setComponent2(java.lang.String component2)

Set the component 2 (Narrative 2).

Parameters:

component2 - the Narrative 2 to set

Returns:

the field object to enable build pattern

setNarrativeLine2

public Field42M setNarrativeLine2(java.lang.String component2)

Set the Narrative 2 (component 2).

Parameters:

component2 - the Narrative 2 to set

Returns:

the field object to enable build pattern

setComponent3

public Field42M setComponent3(java.lang.String component3)

Set the component 3 (Narrative 3).

Parameters:

component3 - the Narrative 3 to set

Returns:

the field object to enable build pattern

setNarrativeLine3

public Field42M setNarrativeLine3(java.lang.String component3)

Set the Narrative 3 (component 3).

Parameters:

component3 - the Narrative 3 to set

Returns:

the field object to enable build pattern

setComponent4

public Field42M setComponent4(java.lang.String component4)

Set the component 4 (Narrative 4).

Parameters:

component4 - the Narrative 4 to set

Returns:

the field object to enable build pattern

setNarrativeLine4

public Field42M setNarrativeLine4(java.lang.String component4)

Set the Narrative 4 (component 4).

Parameters:

component4 - the Narrative 4 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 Field42M.NAME

get

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

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

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

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

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