com.prowidesoftware.swift.model.field

Class Field39A

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field39A

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

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

SWIFT MT Field 39A

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

Subfields (components) Data types

1. Long
2. Long

Structure definition

• validation pattern: 2n/2n
• parser pattern: S/S
• components pattern: NN

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_39A same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 39A
static java.lang.String	PARSER_PATTERN
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.Integer	TOLERANCE_1 Component number for the Tolerance 1 subfield
static java.lang.Integer	TOLERANCE_2 Component number for the Tolerance 2 subfield
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
Field39A() Default constructor.
Field39A(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field39A(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 Field39A	fromJson(java.lang.String json) This method deserializes the JSON data into a Field39A object.
static Field39A	get(SwiftMessage msg) Gets the first instance of Field39A in the given message.
static Field39A	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field39A>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field39A in the given message an empty list is returned if none found.
static java.util.List<Field39A>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field39A from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Tolerance 1).
java.lang.Long	getComponent1AsLong() Get the component 1 as Long
java.lang.Number	getComponent1AsNumber() Deprecated.
java.lang.String	getComponent2() Gets the component 2 (Tolerance 2).
java.lang.Long	getComponent2AsLong() Get the component 2 as Long
java.lang.Number	getComponent2AsNumber() Deprecated.
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	getName() Returns the field's name composed by the field number and the letter option (if any)
java.lang.String	getTolerance1() Gets the Tolerance 1 (component 1).
java.lang.Long	getTolerance1AsLong() Get the Tolerance 1 (component 1) as Long
java.lang.Number	getTolerance1AsNumber() Deprecated.
java.lang.String	getTolerance2() Gets the Tolerance 2 (component 2).
java.lang.Long	getTolerance2AsLong() Get the Tolerance 2 (component 2) as Long
java.lang.Number	getTolerance2AsNumber() Deprecated.
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 Field39A	newInstance(Field39A 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
Field39A	setComponent1(java.lang.Long component1) Set the component1 from a Long object.
Field39A	setComponent1(java.lang.Number component1) Alternative method setter for field's Tolerance 1 (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field39A	setComponent1(java.lang.String component1) Set the component 1 (Tolerance 1).
Field39A	setComponent2(java.lang.Long component2) Set the component2 from a Long object.
Field39A	setComponent2(java.lang.Number component2) Alternative method setter for field's Tolerance 2 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field39A	setComponent2(java.lang.String component2) Set the component 2 (Tolerance 2).
Field39A	setTolerance1(java.lang.Long component1) Set the Tolerance 1 (component 1) from a Long object.
Field39A	setTolerance1(java.lang.Number component1) Alternative method setter for field's Tolerance 1 (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field39A	setTolerance1(java.lang.String component1) Set the Tolerance 1 (component 1).
Field39A	setTolerance2(java.lang.Long component2) Set the Tolerance 2 (component 2) from a Long object.
Field39A	setTolerance2(java.lang.Number component2) Alternative method setter for field's Tolerance 2 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field39A	setTolerance2(java.lang.String component2) Set the Tolerance 2 (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 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 39A

See Also:

Constant Field Values

F_39A

public static final java.lang.String F_39A

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

TOLERANCE_1

public static final java.lang.Integer TOLERANCE_1

Component number for the Tolerance 1 subfield

TOLERANCE_2

public static final java.lang.Integer TOLERANCE_2

Component number for the Tolerance 2 subfield

Constructor Detail

Field39A

public Field39A()

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

Field39A

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

Field39A

public Field39A(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 Field39A newInstance(Field39A 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 Field39A.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 Field39A.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 Field39A.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 (Tolerance 1).

Returns:

the component 1

getComponent1AsLong

public java.lang.Long getComponent1AsLong()

Get the component 1 as Long

Returns:

the component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getComponent1AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent1AsNumber()

Deprecated.

Get the component 1 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent1AsLong()

getTolerance1

public java.lang.String getTolerance1()

Gets the Tolerance 1 (component 1).

Returns:

the Tolerance 1 from component 1

getTolerance1AsLong

public java.lang.Long getTolerance1AsLong()

Get the Tolerance 1 (component 1) as Long

Returns:

the Tolerance 1 from component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getTolerance1AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getTolerance1AsNumber()

Deprecated.

Get the Tolerance 1 (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getTolerance1AsLong()

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Tolerance 2).

Returns:

the component 2

getComponent2AsLong

public java.lang.Long getComponent2AsLong()

Get the component 2 as Long

Returns:

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

Since:

9.2.7

getComponent2AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent2AsNumber()

Deprecated.

Get the component 2 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent2AsLong() to get the proper value.

Returns:

the component 2 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent2AsLong()

getTolerance2

public java.lang.String getTolerance2()

Gets the Tolerance 2 (component 2).

Returns:

the Tolerance 2 from component 2

getTolerance2AsLong

public java.lang.Long getTolerance2AsLong()

Get the Tolerance 2 (component 2) as Long

Returns:

the Tolerance 2 from component 2 converted to Long or null if cannot be converted

Since:

9.2.7

getTolerance2AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getTolerance2AsNumber()

Deprecated.

Get the Tolerance 2 (component 2) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent2AsLong() to get the proper value.

Returns:

the component 2 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getTolerance2AsLong()

setComponent1

public Field39A setComponent1(java.lang.String component1)

Set the component 1 (Tolerance 1).

Parameters:

component1 - the Tolerance 1 to set

Returns:

the field object to enable build pattern

setComponent1

public Field39A setComponent1(java.lang.Long component1)

Set the component1 from a Long 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 setComponent1(String) method.

Parameters:

component1 - the Long with the Tolerance 1 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(String)

setComponent1

public Field39A setComponent1(java.lang.Number component1)

Alternative method setter for field's Tolerance 1 (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Tolerance 1 content to set

Returns:

the field object to enable build pattern

See Also:

setTolerance1(java.lang.Long)

setTolerance1

public Field39A setTolerance1(java.lang.String component1)

Set the Tolerance 1 (component 1).

Parameters:

component1 - the Tolerance 1 to set

Returns:

the field object to enable build pattern

setTolerance1

public Field39A setTolerance1(java.lang.Long component1)

Set the Tolerance 1 (component 1) from a Long object.

Parameters:

component1 - Long with the Tolerance 1 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(java.lang.Long)

setTolerance1

public Field39A setTolerance1(java.lang.Number component1)

Alternative method setter for field's Tolerance 1 (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Tolerance 1 content to set

Returns:

the field object to enable build pattern

See Also:

setTolerance1(java.lang.Long)

setComponent2

public Field39A setComponent2(java.lang.String component2)

Set the component 2 (Tolerance 2).

Parameters:

component2 - the Tolerance 2 to set

Returns:

the field object to enable build pattern

setComponent2

public Field39A setComponent2(java.lang.Long component2)

Set the component2 from a Long 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 setComponent2(String) method.

Parameters:

component2 - the Long with the Tolerance 2 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(String)

setComponent2

public Field39A setComponent2(java.lang.Number component2)

Alternative method setter for field's Tolerance 2 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component2 - the Number with the Tolerance 2 content to set

Returns:

the field object to enable build pattern

See Also:

setTolerance2(java.lang.Long)

setTolerance2

public Field39A setTolerance2(java.lang.String component2)

Set the Tolerance 2 (component 2).

Parameters:

component2 - the Tolerance 2 to set

Returns:

the field object to enable build pattern

setTolerance2

public Field39A setTolerance2(java.lang.Long component2)

Set the Tolerance 2 (component 2) from a Long object.

Parameters:

component2 - Long with the Tolerance 2 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(java.lang.Long)

setTolerance2

public Field39A setTolerance2(java.lang.Number component2)

Alternative method setter for field's Tolerance 2 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component2 - the Number with the Tolerance 2 content to set

Returns:

the field object to enable build pattern

See Also:

setTolerance2(java.lang.Long)

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

get

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

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

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

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

fromJson

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

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