com.prowidesoftware.swift.model.field

Class Field69B

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field69B

All Implemented Interfaces:

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

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

SWIFT MT Field 69B

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

Subfields (components) Data types

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

Structure definition

• validation pattern: :4!c//<DATE4><TIME2>/<DATE4><TIME2>
• parser pattern: :S//<DATE4><TIME2>/<DATE4><TIME2>
• components pattern: SDTDT

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	CONDITIONAL_QUALIFIER Component number for the conditional qualifier subfield
static java.lang.Integer	END_DATE Component number for the End Date subfield
static java.lang.Integer	END_TIME Component number for the End Time subfield
static java.lang.String	F_69B same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 69B
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	QUALIFIER Component number for the Qualifier subfield
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.Integer	START_DATE Component number for the Start Date subfield
static java.lang.Integer	START_TIME Component number for the Start Time subfield

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

components

Constructor Summary

Constructors

Constructor and Description
Field69B() Default constructor.
Field69B(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field69B(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() 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 Field69B	fromJson(java.lang.String json) This method deserializes the JSON data into a Field69B object.
static Field69B	get(SwiftMessage msg) Gets the first instance of Field69B in the given message.
static Field69B	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field69B>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field69B in the given message an empty list is returned if none found.
static java.util.List<Field69B>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field69B 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 (Start Date).
java.util.Calendar	getComponent2AsCalendar() Get the component 2 as Calendar
java.lang.String	getComponent3() Gets the component 3 (Start Time).
java.util.Calendar	getComponent3AsCalendar() Get the component 3 as Calendar
java.lang.String	getComponent4() Gets the component 4 (End Date).
java.util.Calendar	getComponent4AsCalendar() Get the component 4 as Calendar
java.lang.String	getComponent5() Gets the component 5 (End Time).
java.util.Calendar	getComponent5AsCalendar() Get the component 5 as Calendar
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	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	getEndDate() Gets the End Date (component 4).
java.util.Calendar	getEndDateAsCalendar() Get the End Date (component 4) as Calendar
java.lang.String	getEndTime() Gets the End Time (component 5).
java.util.Calendar	getEndTimeAsCalendar() Get the End Time (component 5) 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	getQualifier() Gets the Qualifier (component 1).
java.lang.String	getStartDate() Gets the Start Date (component 2).
java.util.Calendar	getStartDateAsCalendar() Get the Start Date (component 2) as Calendar
java.lang.String	getStartTime() Gets the Start Time (component 3).
java.util.Calendar	getStartTimeAsCalendar() Get the Start Time (component 3) as Calendar
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 Field69B	newInstance(Field69B 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
Field69B	setComponent1(java.lang.String component1) Set the component1 (Qualifier).
Field69B	setComponent2(java.util.Calendar component2) Set the component2 from a Calendar object.
Field69B	setComponent2(java.lang.String component2) Set the component2 (Start Date).
Field69B	setComponent3(java.util.Calendar component3) Set the component3 from a Calendar object.
Field69B	setComponent3(java.lang.String component3) Set the component3 (Start Time).
Field69B	setComponent4(java.util.Calendar component4) Set the component4 from a Calendar object.
Field69B	setComponent4(java.lang.String component4) Set the component4 (End Date).
Field69B	setComponent5(java.util.Calendar component5) Set the component5 from a Calendar object.
Field69B	setComponent5(java.lang.String component5) Set the component5 (End Time).
Field69B	setEndDate(java.util.Calendar component4) Set the End Date (component4) from a Calendar object.
Field69B	setEndDate(java.lang.String component4) Set the End Date (component4).
Field69B	setEndTime(java.util.Calendar component5) Set the End Time (component5) from a Calendar object.
Field69B	setEndTime(java.lang.String component5) Set the End Time (component5).
Field69B	setQualifier(java.lang.String component1) Set the Qualifier (component1).
Field69B	setStartDate(java.util.Calendar component2) Set the Start Date (component2) from a Calendar object.
Field69B	setStartDate(java.lang.String component2) Set the Start Date (component2).
Field69B	setStartTime(java.util.Calendar component3) Set the Start Time (component3) from a Calendar object.
Field69B	setStartTime(java.lang.String component3) Set the Start Time (component3).
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, 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 69B

See Also:

Constant Field Values

F_69B

public static final java.lang.String F_69B

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

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield

START_DATE

public static final java.lang.Integer START_DATE

Component number for the Start Date subfield

START_TIME

public static final java.lang.Integer START_TIME

Component number for the Start Time subfield

END_DATE

public static final java.lang.Integer END_DATE

Component number for the End Date subfield

END_TIME

public static final java.lang.Integer END_TIME

Component number for the End Time subfield

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield

Constructor Detail

Field69B

public Field69B()

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

Field69B

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

Field69B

public Field69B(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 Field69B newInstance(Field69B 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 Field69B.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 Field69B.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 (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 (Start 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

getStartDate

public java.lang.String getStartDate()

Gets the Start Date (component 2).

Returns:

the Start Date from component 2

getStartDateAsCalendar

public java.util.Calendar getStartDateAsCalendar()

Get the Start Date (component 2) as Calendar

Returns:

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

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Start Time).

Returns:

the component 3

getComponent3AsCalendar

public java.util.Calendar getComponent3AsCalendar()

Get the component 3 as Calendar

Returns:

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

getStartTime

public java.lang.String getStartTime()

Gets the Start Time (component 3).

Returns:

the Start Time from component 3

getStartTimeAsCalendar

public java.util.Calendar getStartTimeAsCalendar()

Get the Start Time (component 3) as Calendar

Returns:

the Start Time from component 3 converted to Calendar or null if cannot be converted

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (End Date).

Returns:

the component 4

getComponent4AsCalendar

public java.util.Calendar getComponent4AsCalendar()

Get the component 4 as Calendar

Returns:

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

getEndDate

public java.lang.String getEndDate()

Gets the End Date (component 4).

Returns:

the End Date from component 4

getEndDateAsCalendar

public java.util.Calendar getEndDateAsCalendar()

Get the End Date (component 4) as Calendar

Returns:

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

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (End Time).

Returns:

the component 5

getComponent5AsCalendar

public java.util.Calendar getComponent5AsCalendar()

Get the component 5 as Calendar

Returns:

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

getEndTime

public java.lang.String getEndTime()

Gets the End Time (component 5).

Returns:

the End Time from component 5

getEndTimeAsCalendar

public java.util.Calendar getEndTimeAsCalendar()

Get the End Time (component 5) as Calendar

Returns:

the End Time from component 5 converted to Calendar or null if cannot be converted

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

setComponent1

public Field69B setComponent1(java.lang.String component1)

Set the component1 (Qualifier).

Parameters:

component1 - the component1 to set

setQualifier

public Field69B setQualifier(java.lang.String component1)

Set the Qualifier (component1).

Parameters:

component1 - the Qualifier to set

setComponent2

public Field69B setComponent2(java.lang.String component2)

Set the component2 (Start Date).

Parameters:

component2 - the component2 to set

setComponent2

public Field69B setComponent2(java.util.Calendar component2)

Set the component2 from a Calendar object.

Parameters:

component2 - the Calendar with the component2 content to set

setStartDate

public Field69B setStartDate(java.lang.String component2)

Set the Start Date (component2).

Parameters:

component2 - the Start Date to set

setStartDate

public Field69B setStartDate(java.util.Calendar component2)

Set the Start Date (component2) from a Calendar object.

Parameters:

component2 - Calendar with the Start Date content to set

See Also:

setComponent2(java.util.Calendar)

setComponent3

public Field69B setComponent3(java.lang.String component3)

Set the component3 (Start Time).

Parameters:

component3 - the component3 to set

setComponent3

public Field69B setComponent3(java.util.Calendar component3)

Set the component3 from a Calendar object.

Parameters:

component3 - the Calendar with the component3 content to set

setStartTime

public Field69B setStartTime(java.lang.String component3)

Set the Start Time (component3).

Parameters:

component3 - the Start Time to set

setStartTime

public Field69B setStartTime(java.util.Calendar component3)

Set the Start Time (component3) from a Calendar object.

Parameters:

component3 - Calendar with the Start Time content to set

See Also:

setComponent3(java.util.Calendar)

setComponent4

public Field69B setComponent4(java.lang.String component4)

Set the component4 (End Date).

Parameters:

component4 - the component4 to set

setComponent4

public Field69B setComponent4(java.util.Calendar component4)

Set the component4 from a Calendar object.

Parameters:

component4 - the Calendar with the component4 content to set

setEndDate

public Field69B setEndDate(java.lang.String component4)

Set the End Date (component4).

Parameters:

component4 - the End Date to set

setEndDate

public Field69B setEndDate(java.util.Calendar component4)

Set the End Date (component4) from a Calendar object.

Parameters:

component4 - Calendar with the End Date content to set

See Also:

setComponent4(java.util.Calendar)

setComponent5

public Field69B setComponent5(java.lang.String component5)

Set the component5 (End Time).

Parameters:

component5 - the component5 to set

setComponent5

public Field69B setComponent5(java.util.Calendar component5)

Set the component5 from a Calendar object.

Parameters:

component5 - the Calendar with the component5 content to set

setEndTime

public Field69B setEndTime(java.lang.String component5)

Set the End Time (component5).

Parameters:

component5 - the End Time to set

setEndTime

public Field69B setEndTime(java.util.Calendar component5)

Set the End Time (component5) from a Calendar object.

Parameters:

component5 - Calendar with the End Time content to set

See Also:

setComponent5(java.util.Calendar)

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

Overrides:

getDSS in class Field

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

Overrides:

isDSSPresent in class Field

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

Overrides:

getConditionalQualifier in class Field

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

get

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

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

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

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

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