com.prowidesoftware.swift.model.field

Class Field37E

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field37E

All Implemented Interfaces:

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

@Generated
public class Field37E
extends Field
implements java.io.Serializable, DateContainer, AmountContainer

SWIFT MT Field 37E

Model and parser for field 37E of a SWIFT MT message.

Subfields (components) Data types

1. Number
2. Calendar
3. String
4. Number
5. String

Structure definition

• validation pattern: <AMOUNT>12[//<DATE2><DM>3n][/16x]
• parser pattern: N[//<DATE2>cS][/S]
• components pattern: NESNS

This class complies with standard release SRU2020

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENTS_PATTERN
static java.lang.Integer	DATE Component number for the Date subfield
static java.lang.Integer	DM_MARK Component number for the D/M Mark subfield
static java.lang.String	F_37E same as NAME, intended to be clear when using static imports
static java.lang.Integer	INFORMATION Component number for the Information subfield
static java.lang.String	NAME Constant with the field name 37E
static java.lang.Integer	NUMBER_OF_DAYSMONTHS Component number for the Number of Days/Months subfield
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	RATE Component number for the Rate subfield
static int	SRU Constant identifying the SRU to which this class belongs to.

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

components

Constructor Summary

Constructors

Constructor and Description
Field37E() Default constructor.
Field37E(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field37E(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() Get the first amount in this field.
java.util.List<java.math.BigDecimal>	amounts()
java.lang.String	componentsPattern() Returns the field components pattern
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.Calendar>	dates() Get a calendar for every date found
static Tag	emptyTag() Create a Tag with this field name and an empty string as value Shorthand for new Tag(NAME, "")
static Field37E	fromJson(java.lang.String json) This method deserializes the JSON data into a Field37E object.
static Field37E	get(SwiftMessage msg) Gets the first instance of Field37E in the given message.
static Field37E	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field37E>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field37E in the given message an empty list is returned if none found.
static java.util.List<Field37E>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field37E from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Rate).
java.lang.Number	getComponent1AsNumber() Get the component 1 as Number
java.lang.String	getComponent2() Gets the component 2 (Date).
java.util.Calendar	getComponent2AsCalendar() Get the component 2 as Calendar
java.lang.String	getComponent3() Gets the component 3 (D/M Mark).
java.lang.String	getComponent4() Gets the component 4 (Number of Days/Months).
java.lang.Number	getComponent4AsNumber() Get the component 4 as Number
java.lang.String	getComponent5() Gets the component 5 (Information).
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	getDate() Gets the Date (component 2).
java.util.Calendar	getDateAsCalendar() Get the Date (component 2) as Calendar
java.lang.String	getDMMark() Gets the D/M Mark (component 3).
java.lang.String	getInformation() Gets the Information (component 5).
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any)
java.lang.String	getNumberofDaysMonths() Gets the Number of Days/Months (component 4).
java.lang.Number	getNumberofDaysMonthsAsNumber() Get the Number of Days/Months (component 4) as Number
java.lang.String	getRate() Gets the Rate (component 1).
java.lang.Number	getRateAsNumber() Get the Rate (component 1) as Number
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 Field37E	newInstance(Field37E 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
Field37E	setComponent1(java.lang.Number component1) Set the component1 from a Number object.
Field37E	setComponent1(java.lang.String component1) Set the component1 (Rate).
Field37E	setComponent2(java.util.Calendar component2) Set the component2 from a Calendar object.
Field37E	setComponent2(java.lang.String component2) Set the component2 (Date).
Field37E	setComponent3(java.lang.String component3) Set the component3 (D/M Mark).
Field37E	setComponent4(java.lang.Number component4) Set the component4 from a Number object.
Field37E	setComponent4(java.lang.String component4) Set the component4 (Number of Days/Months).
Field37E	setComponent5(java.lang.String component5) Set the component5 (Information).
Field37E	setDate(java.util.Calendar component2) Set the Date (component2) from a Calendar object.
Field37E	setDate(java.lang.String component2) Set the Date (component2).
Field37E	setDMMark(java.lang.String component3) Set the D/M Mark (component3).
Field37E	setInformation(java.lang.String component5) Set the Information (component5).
Field37E	setNumberofDaysMonths(java.lang.Number component4) Set the Number of Days/Months (component4) from a Number object.
Field37E	setNumberofDaysMonths(java.lang.String component4) Set the Number of Days/Months (component4).
Field37E	setRate(java.lang.Number component1) Set the Rate (component1) from a Number object.
Field37E	setRate(java.lang.String component1) Set the Rate (component1).
static Tag	tag(java.lang.String value) Create a Tag with this field name and the given value.
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, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isDSSPresent, 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 37E

See Also:

Constant Field Values

F_37E

public static final java.lang.String F_37E

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

public static final java.lang.String COMPONENTS_PATTERN

See Also:

Constant Field Values

RATE

public static final java.lang.Integer RATE

Component number for the Rate subfield

DATE

public static final java.lang.Integer DATE

Component number for the Date subfield

DM_MARK

public static final java.lang.Integer DM_MARK

Component number for the D/M Mark subfield

NUMBER_OF_DAYSMONTHS

public static final java.lang.Integer NUMBER_OF_DAYSMONTHS

Component number for the Number of Days/Months subfield

INFORMATION

public static final java.lang.Integer INFORMATION

Component number for the Information subfield

Constructor Detail

Field37E

public Field37E()

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

Field37E

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

Field37E

public Field37E(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 Field37E newInstance(Field37E 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

public final java.lang.String componentsPattern()

Returns the field components pattern

Specified by:

componentsPattern in interface PatternContainer

Specified by:

componentsPattern in class Field

Returns:

the static value of Field37E.COMPONENTS_PATTERN

parserPattern

public final java.lang.String parserPattern()

Returns the field parser pattern

Specified by:

parserPattern in interface PatternContainer

Returns:

the static value of Field37E.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 (Rate).

Returns:

the component 1

getComponent1AsNumber

public java.lang.Number getComponent1AsNumber()

Get the component 1 as Number

Returns:

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

getRate

public java.lang.String getRate()

Gets the Rate (component 1).

Returns:

the Rate from component 1

getRateAsNumber

public java.lang.Number getRateAsNumber()

Get the Rate (component 1) as Number

Returns:

the Rate from component 1 converted to Number or null if cannot be converted

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Date).

Returns:

the component 2

getComponent2AsCalendar

public java.util.Calendar getComponent2AsCalendar()

Get the component 2 as Calendar

Returns:

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

getDate

public java.lang.String getDate()

Gets the Date (component 2).

Returns:

the Date from component 2

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component 2) as Calendar

Returns:

the Date from component 2 converted to Calendar or null if cannot be converted

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (D/M Mark).

Returns:

the component 3

getDMMark

public java.lang.String getDMMark()

Gets the D/M Mark (component 3).

Returns:

the D/M Mark from component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Number of Days/Months).

Returns:

the component 4

getComponent4AsNumber

public java.lang.Number getComponent4AsNumber()

Get the component 4 as Number

Returns:

the component 4 converted to Number or null if cannot be converted

getNumberofDaysMonths

public java.lang.String getNumberofDaysMonths()

Gets the Number of Days/Months (component 4).

Returns:

the Number of Days/Months from component 4

getNumberofDaysMonthsAsNumber

public java.lang.Number getNumberofDaysMonthsAsNumber()

Get the Number of Days/Months (component 4) as Number

Returns:

the Number of Days/Months from component 4 converted to Number or null if cannot be converted

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Information).

Returns:

the component 5

getInformation

public java.lang.String getInformation()

Gets the Information (component 5).

Returns:

the Information from component 5

dates

public java.util.List<java.util.Calendar> dates()

Description copied from interface: DateContainer

Get a calendar for every date found

Specified by:

dates in interface DateContainer

Returns:

found dates or empty list

amounts

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

See Also:

AmountResolver.amounts(Field)

amount

public java.math.BigDecimal amount()

Description copied from interface: AmountContainer

Get the first amount in this field.

Specified by:

amount in interface AmountContainer

See Also:

AmountResolver.amount(Field)

setComponent1

public Field37E setComponent1(java.lang.String component1)

Set the component1 (Rate).

Parameters:

component1 - the component1 to set

setComponent1

public Field37E setComponent1(java.lang.Number component1)

Set the component1 from a Number object.
Parses the Number 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:

component1 - the Number with the component1 content to set

setRate

public Field37E setRate(java.lang.String component1)

Set the Rate (component1).

Parameters:

component1 - the Rate to set

setRate

public Field37E setRate(java.lang.Number component1)

Set the Rate (component1) from a Number object.

Parameters:

component1 - Number with the Rate content to set

See Also:

setComponent1(java.lang.Number)

setComponent2

public Field37E setComponent2(java.lang.String component2)

Set the component2 (Date).

Parameters:

component2 - the component2 to set

setComponent2

public Field37E setComponent2(java.util.Calendar component2)

Set the component2 from a Calendar object.
Parses the Number 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 Calendar with the component2 content to set

setDate

public Field37E setDate(java.lang.String component2)

Set the Date (component2).

Parameters:

component2 - the Date to set

setDate

public Field37E setDate(java.util.Calendar component2)

Set the Date (component2) from a Calendar object.

Parameters:

component2 - Calendar with the Date content to set

See Also:

setComponent2(java.util.Calendar)

setComponent3

public Field37E setComponent3(java.lang.String component3)

Set the component3 (D/M Mark).

Parameters:

component3 - the component3 to set

setDMMark

public Field37E setDMMark(java.lang.String component3)

Set the D/M Mark (component3).

Parameters:

component3 - the D/M Mark to set

setComponent4

public Field37E setComponent4(java.lang.String component4)

Set the component4 (Number of Days/Months).

Parameters:

component4 - the component4 to set

setComponent4

public Field37E setComponent4(java.lang.Number component4)

Set the component4 from a Number object.
Parses the Number 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:

component4 - the Number with the component4 content to set

setNumberofDaysMonths

public Field37E setNumberofDaysMonths(java.lang.String component4)

Set the Number of Days/Months (component4).

Parameters:

component4 - the Number of Days/Months to set

setNumberofDaysMonths

public Field37E setNumberofDaysMonths(java.lang.Number component4)

Set the Number of Days/Months (component4) from a Number object.

Parameters:

component4 - Number with the Number of Days/Months content to set

See Also:

setComponent4(java.lang.Number)

setComponent5

public Field37E setComponent5(java.lang.String component5)

Set the component5 (Information).

Parameters:

component5 - the component5 to set

setInformation

public Field37E setInformation(java.lang.String component5)

Set the Information (component5).

Parameters:

component5 - the Information to set

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

get

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

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

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

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

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