com.prowidesoftware.swift.model.field

Class Field98K

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field98K

All Implemented Interfaces:

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

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

SWIFT MT Field 98K.

Model and parser for field 98K of a SWIFT MT message.

Subfields (components) Data types

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

Structure definition

• validation pattern: :4!c/8c/<DATE4><TIME2>/34x(***)
• parser pattern: :S/S/<DATE4><TIME2>/S
• components pattern: SSDTS

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	CONDITIONAL_QUALIFIER Component number for the conditional qualifier subfield.
static java.lang.Integer	DATA_SOURCE_SCHEME Component number for the Data Source Scheme subfield.
static java.lang.Integer	DATE Component number for the Date subfield.
static java.lang.String	F_98K Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 98K.
static java.lang.String	PARSER_PATTERN Deprecated. use parserPattern() method instead.
static java.lang.Integer	PROPRIETARY_CODE Component number for the Proprietary Code subfield.
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	TIME Component number for the Time subfield.
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
Field98K() Default constructor.
Field98K(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field98K(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 Field98K	fromJson(java.lang.String json) This method deserializes the JSON data into a Field98K object.
static Field98K	get(SwiftMessage msg) Gets the first instance of Field98K in the given message.
static Field98K	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field98K>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field98K in the given message an empty list is returned if none found.
static java.util.List<Field98K>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field98K 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 (Data Source Scheme).
java.lang.String	getComponent3() Gets the component 3 (Date).
java.util.Calendar	getComponent3AsCalendar() Get the component 3 as Calendar
java.lang.String	getComponent4() Gets the component 4 (Time).
java.util.Calendar	getComponent4AsCalendar() Get the component 4 as Calendar
java.lang.String	getComponent5() Gets the component 5 (Proprietary Code).
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	getDataSourceScheme() Gets the Data Source Scheme (component 2).
java.lang.String	getDate() Gets the Date (component 3).
java.util.Calendar	getDateAsCalendar() Get the Date (component 3) as Calendar
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	getProprietaryCode() Gets the Proprietary Code (component 5).
java.lang.String	getQualifier() Gets the Qualifier (component 1).
java.lang.String	getTime() Gets the Time (component 4).
java.util.Calendar	getTimeAsCalendar() Get the Time (component 4) 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 Field98K	newInstance(Field98K 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.
Field98K	setComponent1(java.lang.String component1) Set the component 1 (Qualifier).
Field98K	setComponent2(java.lang.String component2) Set the component 2 (Data Source Scheme).
Field98K	setComponent3(java.util.Calendar component3) Set the component3 from a Calendar object.
Field98K	setComponent3(java.lang.String component3) Set the component 3 (Date).
Field98K	setComponent4(java.util.Calendar component4) Set the component4 from a Calendar object.
Field98K	setComponent4(java.lang.String component4) Set the component 4 (Time).
Field98K	setComponent5(java.lang.String component5) Set the component 5 (Proprietary Code).
Field98K	setDataSourceScheme(java.lang.String component2) Set the Data Source Scheme (component 2).
Field98K	setDate(java.util.Calendar component3) Set the Date (component 3) from a Calendar object.
Field98K	setDate(java.lang.String component3) Set the Date (component 3).
Field98K	setProprietaryCode(java.lang.String component5) Set the Proprietary Code (component 5).
Field98K	setQualifier(java.lang.String component1) Set the Qualifier (component 1).
Field98K	setTime(java.util.Calendar component4) Set the Time (component 4) from a Calendar object.
Field98K	setTime(java.lang.String component4) Set the Time (component 4).
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 98K.

See Also:

Constant Field Values

F_98K

public static final java.lang.String F_98K

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

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield.

DATA_SOURCE_SCHEME

public static final java.lang.Integer DATA_SOURCE_SCHEME

Component number for the Data Source Scheme subfield.

DATE

public static final java.lang.Integer DATE

Component number for the Date subfield.

TIME

public static final java.lang.Integer TIME

Component number for the Time subfield.

PROPRIETARY_CODE

public static final java.lang.Integer PROPRIETARY_CODE

Component number for the Proprietary Code subfield.

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield.

Constructor Detail

Field98K

public Field98K()

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

Field98K

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

Field98K

public Field98K(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 Field98K newInstance(Field98K 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 (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 (Data Source Scheme).

Returns:

the component 2

getDataSourceScheme

public java.lang.String getDataSourceScheme()

Gets the Data Source Scheme (component 2).

Returns:

the Data Source Scheme from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Date).

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

getDate

public java.lang.String getDate()

Gets the Date (component 3).

Returns:

the Date from component 3

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component 3) as Calendar

Returns:

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

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Time).

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

getTime

public java.lang.String getTime()

Gets the Time (component 4).

Returns:

the Time from component 4

getTimeAsCalendar

public java.util.Calendar getTimeAsCalendar()

Get the Time (component 4) as Calendar

Returns:

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

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Proprietary Code).

Returns:

the component 5

getProprietaryCode

public java.lang.String getProprietaryCode()

Gets the Proprietary Code (component 5).

Returns:

the Proprietary Code from component 5

setComponent1

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

Set the component 2 (Data Source Scheme).

Parameters:

component2 - the Data Source Scheme to set

Returns:

the field object to enable build pattern

setDataSourceScheme

public Field98K setDataSourceScheme(java.lang.String component2)

Set the Data Source Scheme (component 2).

Parameters:

component2 - the Data Source Scheme to set

Returns:

the field object to enable build pattern

setComponent3

public Field98K setComponent3(java.lang.String component3)

Set the component 3 (Date).

Parameters:

component3 - the Date to set

Returns:

the field object to enable build pattern

setComponent3

public Field98K setComponent3(java.util.Calendar component3)

Set the component3 from a Calendar object.

Parameters:

component3 - the Calendar with the Date content to set

Returns:

the field object to enable build pattern

setDate

public Field98K setDate(java.lang.String component3)

Set the Date (component 3).

Parameters:

component3 - the Date to set

Returns:

the field object to enable build pattern

setDate

public Field98K setDate(java.util.Calendar component3)

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

Parameters:

component3 - Calendar with the Date content to set

Returns:

the field object to enable build pattern

See Also:

setComponent3(java.util.Calendar)

setComponent4

public Field98K setComponent4(java.lang.String component4)

Set the component 4 (Time).

Parameters:

component4 - the Time to set

Returns:

the field object to enable build pattern

setComponent4

public Field98K setComponent4(java.util.Calendar component4)

Set the component4 from a Calendar object.

Parameters:

component4 - the Calendar with the Time content to set

Returns:

the field object to enable build pattern

setTime

public Field98K setTime(java.lang.String component4)

Set the Time (component 4).

Parameters:

component4 - the Time to set

Returns:

the field object to enable build pattern

setTime

public Field98K setTime(java.util.Calendar component4)

Set the Time (component 4) from a Calendar object.

Parameters:

component4 - Calendar with the Time content to set

Returns:

the field object to enable build pattern

See Also:

setComponent4(java.util.Calendar)

setComponent5

public Field98K setComponent5(java.lang.String component5)

Set the component 5 (Proprietary Code).

Parameters:

component5 - the Proprietary Code to set

Returns:

the field object to enable build pattern

setProprietaryCode

public Field98K setProprietaryCode(java.lang.String component5)

Set the Proprietary Code (component 5).

Parameters:

component5 - the Proprietary Code 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)

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

get

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

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

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

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

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