com.prowidesoftware.swift.model.field

Class Field31F

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field31F

All Implemented Interfaces:

JsonSerializable, DateContainer, PatternContainer, java.io.Serializable

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

SWIFT MT Field 31F.

Model and parser for field 31F of a SWIFT MT message.

Subfields (components) Data types

1. Calendar
2. Calendar
3. String

Structure definition

• validation pattern: <DATE2>[/<DATE2>][//35x]
• parser pattern: <DATE2>[/<DATE2>][//S]
• components pattern: EES

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. use typesPattern() method instead.
static java.lang.Integer	DATE Component number for the Date subfield.
static java.lang.String	F_31F Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 31F.
static java.lang.String	PARSER_PATTERN Deprecated. use parserPattern() method instead.
static java.lang.Integer	PERIOD_DATE Component number for the Period Date subfield.
static java.lang.Integer	PERIOD_DETAILS Component number for the Period Details 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
Field31F() Default constructor.
Field31F(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field31F(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. 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.Calendar	date() Returns the first component that can be converted to a Calendar
java.util.List<java.util.Calendar>	dates() Returns all components that can be converted to a Calendar
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field31F	fromJson(java.lang.String json) This method deserializes the JSON data into a Field31F object.
static Field31F	get(SwiftMessage msg) Gets the first instance of Field31F in the given message.
static Field31F	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field31F>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field31F in the given message an empty list is returned if none found.
static java.util.List<Field31F>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field31F from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Date).
java.util.Calendar	getComponent1AsCalendar() Get the component 1 as Calendar
java.lang.String	getComponent2() Gets the component 2 (Period Date).
java.util.Calendar	getComponent2AsCalendar() Get the component 2 as Calendar
java.lang.String	getComponent3() Gets the component 3 (Period Details).
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 1).
java.util.Calendar	getDateAsCalendar() Get the Date (component 1) as Calendar
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getPeriodDate() Gets the Period Date (component 2).
java.util.Calendar	getPeriodDateAsCalendar() Get the Period Date (component 2) as Calendar
java.lang.String	getPeriodDetails() Gets the Period Details (component 3).
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 Field31F	newInstance(Field31F 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.
Field31F	setComponent1(java.util.Calendar component1) Set the component1 from a Calendar object.
Field31F	setComponent1(java.lang.String component1) Set the component 1 (Date).
Field31F	setComponent2(java.util.Calendar component2) Set the component2 from a Calendar object.
Field31F	setComponent2(java.lang.String component2) Set the component 2 (Period Date).
Field31F	setComponent3(java.lang.String component3) Set the component 3 (Period Details).
Field31F	setDate(java.util.Calendar component1) Set the Date (component 1) from a Calendar object.
Field31F	setDate(java.lang.String component1) Set the Date (component 1).
Field31F	setPeriodDate(java.util.Calendar component2) Set the Period Date (component 2) from a Calendar object.
Field31F	setPeriodDate(java.lang.String component2) Set the Period Date (component 2).
Field31F	setPeriodDetails(java.lang.String component3) Set the Period Details (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 31F.

See Also:

Constant Field Values

F_31F

public static final java.lang.String F_31F

Same as NAME, intended to be clear when using static imports.

See Also:

Constant Field Values

PARSER_PATTERN

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

Deprecated. use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

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

Deprecated. use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

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

Deprecated. use typesPattern() method instead.

See Also:

Constant Field Values

DATE

public static final java.lang.Integer DATE

Component number for the Date subfield.

PERIOD_DATE

public static final java.lang.Integer PERIOD_DATE

Component number for the Period Date subfield.

PERIOD_DETAILS

public static final java.lang.Integer PERIOD_DETAILS

Component number for the Period Details subfield.

Constructor Detail

Field31F

public Field31F()

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

Field31F

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

Field31F

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

Deprecated. use typesPattern() instead.

Description copied from class: Field

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

Specified by:

componentsPattern in class Field

Returns:

the static value of Field${dto.getField()}.COMPONENTS_PATTERN

See Also:

Field.typesPattern()

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

Returns:

the component 1

getComponent1AsCalendar

public java.util.Calendar getComponent1AsCalendar()

Get the component 1 as Calendar

Returns:

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

getDate

public java.lang.String getDate()

Gets the Date (component 1).

Returns:

the Date from component 1

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component 1) as Calendar

Returns:

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

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Period 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

getPeriodDate

public java.lang.String getPeriodDate()

Gets the Period Date (component 2).

Returns:

the Period Date from component 2

getPeriodDateAsCalendar

public java.util.Calendar getPeriodDateAsCalendar()

Get the Period Date (component 2) as Calendar

Returns:

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

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Period Details).

Returns:

the component 3

getPeriodDetails

public java.lang.String getPeriodDetails()

Gets the Period Details (component 3).

Returns:

the Period Details from component 3

setComponent1

public Field31F setComponent1(java.lang.String component1)

Set the component 1 (Date).

Parameters:

component1 - the Date to set

Returns:

the field object to enable build pattern

setComponent1

public Field31F setComponent1(java.util.Calendar component1)

Set the component1 from a Calendar object.

Parameters:

component1 - the Calendar with the Date content to set

Returns:

the field object to enable build pattern

setDate

public Field31F setDate(java.lang.String component1)

Set the Date (component 1).

Parameters:

component1 - the Date to set

Returns:

the field object to enable build pattern

setDate

public Field31F setDate(java.util.Calendar component1)

Set the Date (component 1) from a Calendar object.

Parameters:

component1 - Calendar with the Date content to set

Returns:

the field object to enable build pattern

See Also:

setComponent1(java.util.Calendar)

setComponent2

public Field31F setComponent2(java.lang.String component2)

Set the component 2 (Period Date).

Parameters:

component2 - the Period Date to set

Returns:

the field object to enable build pattern

setComponent2

public Field31F setComponent2(java.util.Calendar component2)

Set the component2 from a Calendar object.

Parameters:

component2 - the Calendar with the Period Date content to set

Returns:

the field object to enable build pattern

setPeriodDate

public Field31F setPeriodDate(java.lang.String component2)

Set the Period Date (component 2).

Parameters:

component2 - the Period Date to set

Returns:

the field object to enable build pattern

setPeriodDate

public Field31F setPeriodDate(java.util.Calendar component2)

Set the Period Date (component 2) from a Calendar object.

Parameters:

component2 - Calendar with the Period Date content to set

Returns:

the field object to enable build pattern

See Also:

setComponent2(java.util.Calendar)

setComponent3

public Field31F setComponent3(java.lang.String component3)

Set the component 3 (Period Details).

Parameters:

component3 - the Period Details to set

Returns:

the field object to enable build pattern

setPeriodDetails

public Field31F setPeriodDetails(java.lang.String component3)

Set the Period Details (component 3).

Parameters:

component3 - the Period Details to set

Returns:

the field object to enable build pattern

dates

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

Returns all components that can be converted to a Calendar

Specified by:

dates in interface DateContainer

Returns:

the list of converted components (a Calendar object or null)

date

public java.util.Calendar date()

Returns the first component that can be converted to a Calendar

Returns:

the converted components (a Calendar object or null)

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

get

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

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

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

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

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