com.prowidesoftware.swift.model.field

Class Field92D

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field92D

All Implemented Interfaces:

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

@Generated
public class Field92D
extends Field
implements java.io.Serializable, AmountContainer, GenericField

SWIFT MT Field 92D.

Model and parser for field 92D of a SWIFT MT message.

Subfields (components) Data types

1. String
2. BigDecimal
3. BigDecimal

Structure definition

• validation pattern: :4!c//<AMOUNT>15/<AMOUNT>15
• parser pattern: :S//N/N
• components pattern: SNN

This class complies with standard release SRU2022

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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_92D Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 92D.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	QUALIFIER Component number for the Qualifier subfield.
static java.lang.Integer	QUANTITY1 Component number for the Quantity1 subfield.
static java.lang.Integer	QUANTITY2 Component number for the Quantity2 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

Constructor Summary

Constructors

Constructor and Description
Field92D() Default constructor.
Field92D(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field92D(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.math.BigDecimal	amount() Returns the first amounts as BigDecimal
java.util.List<java.math.BigDecimal>	amounts() Returns the list of all NON-NULL amounts as BigDecimal
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 Field92D	fromJson(java.lang.String json) This method deserializes the JSON data into a Field92D object.
static Field92D	get(SwiftMessage msg) Gets the first instance of Field92D in the given message.
static Field92D	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field92D>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field92D in the given message an empty list is returned if none found.
static java.util.List<Field92D>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field92D 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 (Quantity1).
java.math.BigDecimal	getComponent2AsBigDecimal() Get the component 2 as BigDecimal
java.lang.Number	getComponent2AsNumber() Deprecated.
java.lang.String	getComponent3() Gets the component 3 (Quantity2).
java.math.BigDecimal	getComponent3AsBigDecimal() Get the component 3 as BigDecimal
java.lang.Number	getComponent3AsNumber() Deprecated.
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).
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	getQuantity1() Gets the Quantity1 (component 2).
java.math.BigDecimal	getQuantity1AsBigDecimal() Get the Quantity1 (component 2) as BigDecimal
java.lang.Number	getQuantity1AsNumber() Deprecated.
java.lang.String	getQuantity2() Gets the Quantity2 (component 3).
java.math.BigDecimal	getQuantity2AsBigDecimal() Get the Quantity2 (component 3) as BigDecimal
java.lang.Number	getQuantity2AsNumber() 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	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 Field92D	newInstance(Field92D 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.
Field92D	setComponent1(java.lang.String component1) Set the component 1 (Qualifier).
Field92D	setComponent2(java.math.BigDecimal component2) Set the component2 from a BigDecimal object.
Field92D	setComponent2(java.lang.Number component2) Alternative method setter for field's Quantity1 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
Field92D	setComponent2(java.lang.String component2) Set the component 2 (Quantity1).
Field92D	setComponent3(java.math.BigDecimal component3) Set the component3 from a BigDecimal object.
Field92D	setComponent3(java.lang.Number component3) Alternative method setter for field's Quantity2 (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
Field92D	setComponent3(java.lang.String component3) Set the component 3 (Quantity2).
Field92D	setQualifier(java.lang.String component1) Set the Qualifier (component 1).
Field92D	setQuantity1(java.math.BigDecimal component2) Set the Quantity1 (component 2) from a BigDecimal object.
Field92D	setQuantity1(java.lang.Number component2) Alternative method setter for field's Quantity1 (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field92D	setQuantity1(java.lang.String component2) Set the Quantity1 (component 2).
Field92D	setQuantity2(java.math.BigDecimal component3) Set the Quantity2 (component 3) from a BigDecimal object.
Field92D	setQuantity2(java.lang.Number component3) Alternative method setter for field's Quantity2 (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field92D	setQuantity2(java.lang.String component3) Set the Quantity2 (component 3).
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 92D.

See Also:

Constant Field Values

F_92D

public static final java.lang.String F_92D

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

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield.

QUANTITY1

public static final java.lang.Integer QUANTITY1

Component number for the Quantity1 subfield.

QUANTITY2

public static final java.lang.Integer QUANTITY2

Component number for the Quantity2 subfield.

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield.

Constructor Detail

Field92D

public Field92D()

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

Field92D

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

Field92D

public Field92D(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 Field92D newInstance(Field92D 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 (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 (Quantity1).

Returns:

the component 2

getComponent2AsBigDecimal

public java.math.BigDecimal getComponent2AsBigDecimal()

Get the component 2 as BigDecimal

Returns:

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

Since:

9.2.7

getComponent2AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
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 getComponent2AsBigDecimal() to get the proper value.

Returns:

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

See Also:

getComponent2AsBigDecimal()

getQuantity1

public java.lang.String getQuantity1()

Gets the Quantity1 (component 2).

Returns:

the Quantity1 from component 2

getQuantity1AsBigDecimal

public java.math.BigDecimal getQuantity1AsBigDecimal()

Get the Quantity1 (component 2) as BigDecimal

Returns:

the Quantity1 from component 2 converted to BigDecimal or null if cannot be converted

Since:

9.2.7

getQuantity1AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getQuantity1AsNumber()

Deprecated.

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

Returns:

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

See Also:

getQuantity1AsBigDecimal()

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Quantity2).

Returns:

the component 3

getComponent3AsBigDecimal

public java.math.BigDecimal getComponent3AsBigDecimal()

Get the component 3 as BigDecimal

Returns:

the component 3 converted to BigDecimal or null if cannot be converted

Since:

9.2.7

getComponent3AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent3AsNumber()

Deprecated.

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

Returns:

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

See Also:

getComponent3AsBigDecimal()

getQuantity2

public java.lang.String getQuantity2()

Gets the Quantity2 (component 3).

Returns:

the Quantity2 from component 3

getQuantity2AsBigDecimal

public java.math.BigDecimal getQuantity2AsBigDecimal()

Get the Quantity2 (component 3) as BigDecimal

Returns:

the Quantity2 from component 3 converted to BigDecimal or null if cannot be converted

Since:

9.2.7

getQuantity2AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getQuantity2AsNumber()

Deprecated.

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

Returns:

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

See Also:

getQuantity2AsBigDecimal()

setComponent1

public Field92D 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 Field92D 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 Field92D setComponent2(java.lang.String component2)

Set the component 2 (Quantity1).

Parameters:

component2 - the Quantity1 to set

Returns:

the field object to enable build pattern

setComponent2

public Field92D setComponent2(java.math.BigDecimal component2)

Set the component2 from a BigDecimal object.
Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.

• Example: 1234.00 -> 1234,
• Example: 1234 -> 1234,
• Example: 1234.56 -> 1234,56

Parameters:

component2 - the BigDecimal with the Quantity1 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

setComponent2

public Field92D setComponent2(java.lang.Number component2)

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

Parameters:

component2 - the Number with the Quantity1 content to set

Returns:

the field object to enable build pattern

See Also:

setQuantity1(java.math.BigDecimal)

setQuantity1

public Field92D setQuantity1(java.lang.String component2)

Set the Quantity1 (component 2).

Parameters:

component2 - the Quantity1 to set

Returns:

the field object to enable build pattern

setQuantity1

public Field92D setQuantity1(java.math.BigDecimal component2)

Set the Quantity1 (component 2) from a BigDecimal object.

Parameters:

component2 - BigDecimal with the Quantity1 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(java.math.BigDecimal)

setQuantity1

public Field92D setQuantity1(java.lang.Number component2)

Alternative method setter for field's Quantity1 (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 Quantity1 content to set

Returns:

the field object to enable build pattern

See Also:

setQuantity1(java.math.BigDecimal)

setComponent3

public Field92D setComponent3(java.lang.String component3)

Set the component 3 (Quantity2).

Parameters:

component3 - the Quantity2 to set

Returns:

the field object to enable build pattern

setComponent3

public Field92D setComponent3(java.math.BigDecimal component3)

Set the component3 from a BigDecimal object.
Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.

• Example: 1234.00 -> 1234,
• Example: 1234 -> 1234,
• Example: 1234.56 -> 1234,56

Parameters:

component3 - the BigDecimal with the Quantity2 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

setComponent3

public Field92D setComponent3(java.lang.Number component3)

Alternative method setter for field's Quantity2 (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)

Parameters:

component3 - the Number with the Quantity2 content to set

Returns:

the field object to enable build pattern

See Also:

setQuantity2(java.math.BigDecimal)

setQuantity2

public Field92D setQuantity2(java.lang.String component3)

Set the Quantity2 (component 3).

Parameters:

component3 - the Quantity2 to set

Returns:

the field object to enable build pattern

setQuantity2

public Field92D setQuantity2(java.math.BigDecimal component3)

Set the Quantity2 (component 3) from a BigDecimal object.

Parameters:

component3 - BigDecimal with the Quantity2 content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent3(java.math.BigDecimal)

setQuantity2

public Field92D setQuantity2(java.lang.Number component3)

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

Parameters:

component3 - the Number with the Quantity2 content to set

Returns:

the field object to enable build pattern

See Also:

setQuantity2(java.math.BigDecimal)

amounts

public java.util.List<java.math.BigDecimal> amounts()

Returns the list of all NON-NULL amounts as BigDecimal

Returns:

the list of NON-NULL amounts as BigDecimal values

See Also:

AmountResolver.amounts(Field)

amount

public java.math.BigDecimal amount()

Returns the first amounts as BigDecimal

Specified by:

amount in interface AmountContainer

Returns:

the first amount as BigDecimal value. Can be null

See Also:

AmountResolver.amount(Field)

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

get

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

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

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

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

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