com.prowidesoftware.swift.model.field

Class Field32B

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field32B

All Implemented Interfaces:

JsonSerializable, AmountContainer, CurrencyContainer, MonetaryAmountContainer, PatternContainer, java.io.Serializable

@Generated
public class Field32B
extends Field
implements java.io.Serializable, MonetaryAmountContainer

SWIFT MT Field 32B.

Model and parser for field 32B of a SWIFT MT message.

Subfields (components) Data types

1. Component 1: Currency: Currency
2. Component 2: Amount: BigDecimal

Structure definition

• validation pattern: <CUR><AMOUNT>15
• parser pattern: SN
• components pattern: CN

This class complies with standard release SRU2023

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	AMOUNT Component number for the Amount subfield.
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.Integer	CURRENCY Component number for the Currency subfield.
static java.lang.String	F_32B Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 32B.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	PRICE Alternative constant name for field's Amount Component number.
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
Field32B() Default constructor.
Field32B(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field32B(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.
java.util.List<java.util.Currency>	currencies() Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()
java.util.Currency	currency() Analog to CurrencyContainer.currencyString()
java.lang.String	currencyString() Get the single currency contained in this field.
java.util.List<java.lang.String>	currencyStrings() Get a list of strings of currencies present in this field
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field32B	fromJson(java.lang.String json) This method deserializes the JSON data into a Field32B object.
static Field32B	get(SwiftMessage msg) Gets the first instance of Field32B in the given message.
static Field32B	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field32B>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field32B in the given message an empty list is returned if none found.
static java.util.List<Field32B>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field32B from the given block an empty list is returned if none found.
java.lang.String	getAmount() Gets the Amount (component 2).
java.math.BigDecimal	getAmountAsBigDecimal() Get the Amount (component 2) as BigDecimal
java.lang.Number	getAmountAsNumber() Deprecated. use #getAmountAsBigDecimal() instead
java.lang.String	getComponent1() Gets the component 1 (Currency).
java.util.Currency	getComponent1AsCurrency() Get the component 1 as Currency
java.lang.String	getComponent2() Gets the component 2 (Amount).
java.math.BigDecimal	getComponent2AsBigDecimal() Get the component 2 as BigDecimal
java.lang.Number	getComponent2AsNumber() Deprecated. use #getComponent2AsBigDecimal() instead
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	getCurrency() Gets the Currency (component 1).
java.util.Currency	getCurrencyAsCurrency() Get the Currency (component 1) as Currency
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	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getPrice() Deprecated. use #getAmount() instead
java.math.BigDecimal	getPriceAsBigDecimal() Deprecated. use #getAmountAsBigDecimal() instead
java.lang.Number	getPriceAsNumber() Deprecated. use #getAmountAsBigDecimal() instead
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.
void	initializeCurrencies(java.util.Currency cur)
void	initializeCurrencies(java.lang.String cur) Set the currency of this field.
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 Field32B	newInstance(Field32B 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.
Field32B	setAmount(java.math.BigDecimal component2) Set the Amount (component 2) from a BigDecimal object.
Field32B	setAmount(java.lang.Number component2) Alternative method setter for field's Amount (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field32B	setAmount(java.lang.String component2) Set the Amount (component 2).
Field32B	setComponent1(java.util.Currency component1) Set the component1 from a Currency object.
Field32B	setComponent1(java.lang.String component1) Set the component 1 (Currency).
Field32B	setComponent2(java.math.BigDecimal component2) Set the component2 from a BigDecimal object.
Field32B	setComponent2(java.lang.Number component2) Alternative method setter for field's Amount (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
Field32B	setComponent2(java.lang.String component2) Set the component 2 (Amount).
Field32B	setCurrency(java.util.Currency component1) Set the Currency (component 1) from a Currency object.
Field32B	setCurrency(java.lang.String component1) Set the Currency (component 1).
Field32B	setPrice(java.math.BigDecimal component2) Deprecated. use #setComponent2(java.math.BigDecimal) instead
Field32B	setPrice(java.lang.Number component2) Deprecated. use #setAmount(java.math.BigDecimal) instead
Field32B	setPrice(java.lang.String component2) Deprecated. use #setAmount(String) instead
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 32B.

See Also:

Constant Field Values

F_32B

public static final java.lang.String F_32B

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

CURRENCY

public static final java.lang.Integer CURRENCY

Component number for the Currency subfield.

AMOUNT

public static final java.lang.Integer AMOUNT

Component number for the Amount subfield.

PRICE

public static final java.lang.Integer PRICE

Alternative constant name for field's Amount Component number.

See Also:

AMOUNT

Constructor Detail

Field32B

public Field32B()

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

Field32B

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

Field32B

public Field32B(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 Field32B newInstance(Field32B 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 (Currency).

Returns:

the component 1

getComponent1AsCurrency

public java.util.Currency getComponent1AsCurrency()

Get the component 1 as Currency

Returns:

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

getCurrency

public java.lang.String getCurrency()

Gets the Currency (component 1).

Returns:

the Currency from component 1

getCurrencyAsCurrency

public java.util.Currency getCurrencyAsCurrency()

Get the Currency (component 1) as Currency

Returns:

the Currency from component 1 converted to Currency or null if cannot be converted

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Amount).

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(phase4=SRU2024)
public java.lang.Number getComponent2AsNumber()

Deprecated. use #getComponent2AsBigDecimal() instead

getAmount

public java.lang.String getAmount()

Gets the Amount (component 2).

Returns:

the Amount from component 2

getPrice

public java.lang.String getPrice()

Deprecated. use #getAmount() instead

Alternative method getter for field's Amount

Since:

9.2.7

getAmountAsBigDecimal

public java.math.BigDecimal getAmountAsBigDecimal()

Get the Amount (component 2) as BigDecimal

Returns:

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

Since:

9.2.7

getAmountAsNumber

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getAmountAsNumber()

Deprecated. use #getAmountAsBigDecimal() instead

getPriceAsBigDecimal

public java.math.BigDecimal getPriceAsBigDecimal()

Deprecated. use #getAmountAsBigDecimal() instead

Since:

9.2.7

getPriceAsNumber

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getPriceAsNumber()

Deprecated. use #getAmountAsBigDecimal() instead

setComponent1

public Field32B setComponent1(java.lang.String component1)

Set the component 1 (Currency).

Parameters:

component1 - the Currency to set

Returns:

the field object to enable build pattern

setComponent1

public Field32B setComponent1(java.util.Currency component1)

Set the component1 from a Currency object.

Parameters:

component1 - the Currency with the Currency content to set

Returns:

the field object to enable build pattern

setCurrency

public Field32B setCurrency(java.lang.String component1)

Set the Currency (component 1).

Parameters:

component1 - the Currency to set

Returns:

the field object to enable build pattern

setCurrency

public Field32B setCurrency(java.util.Currency component1)

Set the Currency (component 1) from a Currency object.

Parameters:

component1 - Currency with the Currency content to set

Returns:

the field object to enable build pattern

See Also:

setComponent1(java.util.Currency)

setComponent2

public Field32B setComponent2(java.lang.String component2)

Set the component 2 (Amount).

Parameters:

component2 - the Amount to set

Returns:

the field object to enable build pattern

setComponent2

public Field32B 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 Amount content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

setComponent2

public Field32B setComponent2(java.lang.Number component2)

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

Returns:

the field object to enable build pattern

See Also:

setAmount(java.math.BigDecimal)

setAmount

public Field32B setAmount(java.lang.String component2)

Set the Amount (component 2).

Parameters:

component2 - the Amount to set

Returns:

the field object to enable build pattern

setAmount

public Field32B setAmount(java.math.BigDecimal component2)

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

Parameters:

component2 - BigDecimal with the Amount content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(java.math.BigDecimal)

setAmount

public Field32B setAmount(java.lang.Number component2)

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

Returns:

the field object to enable build pattern

See Also:

setAmount(java.math.BigDecimal)

setPrice

public Field32B setPrice(java.lang.String component2)

Deprecated. use #setAmount(String) instead

setPrice

public Field32B setPrice(java.math.BigDecimal component2)

Deprecated. use #setComponent2(java.math.BigDecimal) instead

Since:

9.2.7

setPrice

public Field32B setPrice(java.lang.Number component2)

Deprecated. use #setAmount(java.math.BigDecimal) instead

currencyStrings

public java.util.List<java.lang.String> currencyStrings()

Description copied from interface: CurrencyContainer

Get a list of strings of currencies present in this field

Specified by:

currencyStrings in interface CurrencyContainer

Returns:

found currency codes or empty list

currencies

public java.util.List<java.util.Currency> currencies()

Description copied from interface: CurrencyContainer

Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()

Specified by:

currencies in interface CurrencyContainer

Returns:

found currencies or empty list

currency

public java.util.Currency currency()

Description copied from interface: CurrencyContainer

Analog to CurrencyContainer.currencyString()

Specified by:

currency in interface CurrencyContainer

See Also:

CurrencyContainer.currencyStrings(), CurrencyContainer.currencyString()

currencyString

public java.lang.String currencyString()

Description copied from interface: CurrencyContainer

Get the single currency contained in this field.

Specified by:

currencyString in interface CurrencyContainer

Returns:

null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.

initializeCurrencies

public void initializeCurrencies(java.lang.String cur)

Description copied from interface: CurrencyContainer

Set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.

Specified by:

initializeCurrencies in interface CurrencyContainer

initializeCurrencies

public void initializeCurrencies(java.util.Currency cur)

Specified by:

initializeCurrencies in interface CurrencyContainer

See Also:

CurrencyContainer.initializeCurrencies(String)

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:

MonetaryAmountResolver.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:

MonetaryAmountResolver.amount(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 Field32B.NAME

get

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

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

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

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

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