com.prowidesoftware.swift.model.field

Class Field98G

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field98G

All Implemented Interfaces:

JsonSerializable, DateContainer, PatternContainer, java.io.Serializable

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

SWIFT MT Field 98G

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

Subfields (components) Data types

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

Structure definition

• validation pattern: <DATE4><TIME2>[,3n][/[<N>]<TIME3>]
• parser pattern: <DATE4><TIME2>[,S][/[c]<TIME3>]
• components pattern: DTNCW

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.String	F_98G same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 98G
static java.lang.Integer	NUMBER Component number for the Number subfield
static java.lang.Integer	OFFSET Component number for the Offset subfield
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	SIGN Component number for the Sign 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.Integer	TIME_2 Deprecated. use OFFSET instead

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

components

Constructor Summary

Constructors

Constructor and Description
Field98G() Default constructor.
Field98G(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field98G(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 Field98G	fromJson(java.lang.String json) This method deserializes the JSON data into a Field98G object.
static Field98G	get(SwiftMessage msg) Gets the first instance of Field98G in the given message.
static Field98G	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field98G>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field98G in the given message an empty list is returned if none found.
static java.util.List<Field98G>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field98G from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component1 (Date).
java.util.Calendar	getComponent1AsCalendar() Get the component1 as Calendar
java.lang.String	getComponent2() Gets the component2 (Time).
java.util.Calendar	getComponent2AsCalendar() Get the component2 as Calendar
java.lang.String	getComponent3() Gets the component3 (Number).
java.lang.Number	getComponent3AsNumber() Get the component3 as Number
java.lang.String	getComponent4() Gets the component4 (Sign).
java.util.Currency	getComponent4AsCurrency() Get the component4 as Currency
java.lang.String	getComponent5() Gets the component5 (Offset).
java.util.Calendar	getComponent5AsCalendar() Get the component5 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	getDate() Gets the Date (component1).
java.util.Calendar	getDateAsCalendar() Get the Date (component1) 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	getNumber() Gets the Number (component3).
java.lang.Number	getNumberAsNumber() Get the Number (component3) as Number
java.lang.String	getOffset() Gets the Offset (component5).
java.util.Calendar	getOffsetAsCalendar() Get the Offset (component5) as Calendar
java.lang.String	getSign() Gets the Sign (component4).
java.util.Currency	getSignAsCurrency() Get the Sign (component4) as Currency
java.lang.String	getTime() Gets the Time (component2).
java.lang.String	getTime2() Deprecated. use getOffset() or getUtcIndicator() instead, the later returns both the sign and offset
java.util.Calendar	getTime2AsCalendar() Deprecated. use getOffsetAsCalendar() instead
java.util.Calendar	getTimeAsCalendar() Get the Time (component2) as Calendar
java.lang.String	getUtcIndicator() Get the ISO UTC Indicator combining the sign and offset, and changing the "N" negative sign indication by proper +/- signs
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 Field98G	newInstance(Field98G 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
Field98G	setComponent1(java.util.Calendar component1) Set the component1 from a Calendar object.
Field98G	setComponent1(java.lang.String component1) Set the component1 (Date).
Field98G	setComponent2(java.util.Calendar component2) Set the component2 from a Calendar object.
Field98G	setComponent2(java.lang.String component2) Set the component2 (Time).
Field98G	setComponent3(java.lang.Number component3) Set the component3 from a Number object.
Field98G	setComponent3(java.lang.String component3) Set the component3 (Number).
Field98G	setComponent4(java.util.Currency component4) Set the component4 from a Currency object.
Field98G	setComponent4(java.lang.String component4) Set the component4 (Sign).
Field98G	setComponent5(java.util.Calendar component5) Set the component5 from a Calendar object.
Field98G	setComponent5(java.lang.String component5) Set the component5 (Offset).
Field98G	setDate(java.util.Calendar component1) Set the Date (component1) from a Calendar object.
Field98G	setDate(java.lang.String component1) Set the Date (component1).
Field98G	setNumber(java.lang.Number component3) Set the Number (component3) from a Number object.
Field98G	setNumber(java.lang.String component3) Set the Number (component3).
Field98G	setOffset(java.util.Calendar component5) Set the Offset (component5) from a Calendar object.
Field98G	setOffset(java.lang.String component5) Set the Offset (component5).
Field98G	setSign(java.util.Currency component4) Set the Sign (component4) from a Currency object.
Field98G	setSign(java.lang.String component4) Set the Sign (component4).
Field98G	setTime(java.util.Calendar component2) Set the Time (component2) from a Calendar object.
Field98G	setTime(java.lang.String component2) Set the Time (component2).
Field98G	setTime2(java.util.Calendar cal) Deprecated. use setOffset(Calendar) instead
Field98G	setTime2(java.lang.String component) Deprecated. use setOffset(String) instead
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 98G

See Also:

Constant Field Values

F_98G

public static final java.lang.String F_98G

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

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

NUMBER

public static final java.lang.Integer NUMBER

Component number for the Number subfield

SIGN

public static final java.lang.Integer SIGN

Component number for the Sign subfield

OFFSET

public static final java.lang.Integer OFFSET

Component number for the Offset subfield

TIME_2

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public static final java.lang.Integer TIME_2

Deprecated. use OFFSET instead

Constructor Detail

Field98G

public Field98G()

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

Field98G

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

Field98G

public Field98G(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 Field98G newInstance(Field98G 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 Field98G.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 Field98G.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 component1 (Date).

Returns:

the component1

getComponent1AsCalendar

public java.util.Calendar getComponent1AsCalendar()

Get the component1 as Calendar

Returns:

the component1 converted to Calendar or null if cannot be converted

getDate

public java.lang.String getDate()

Gets the Date (component1).

Returns:

the Date from component1

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component1) as Calendar

Returns:

the Date from component1 converted to Calendar or null if cannot be converted

getComponent2

public java.lang.String getComponent2()

Gets the component2 (Time).

Returns:

the component2

getComponent2AsCalendar

public java.util.Calendar getComponent2AsCalendar()

Get the component2 as Calendar

Returns:

the component2 converted to Calendar or null if cannot be converted

getTime

public java.lang.String getTime()

Gets the Time (component2).

Returns:

the Time from component2

getTimeAsCalendar

public java.util.Calendar getTimeAsCalendar()

Get the Time (component2) as Calendar

Returns:

the Time from component2 converted to Calendar or null if cannot be converted

getComponent3

public java.lang.String getComponent3()

Gets the component3 (Number).

Returns:

the component3

getComponent3AsNumber

public java.lang.Number getComponent3AsNumber()

Get the component3 as Number

Returns:

the component3 converted to Number or null if cannot be converted

getNumber

public java.lang.String getNumber()

Gets the Number (component3).

Returns:

the Number from component3

getNumberAsNumber

public java.lang.Number getNumberAsNumber()

Get the Number (component3) as Number

Returns:

the Number from component3 converted to Number or null if cannot be converted

getComponent4

public java.lang.String getComponent4()

Gets the component4 (Sign).

Returns:

the component4

getComponent4AsCurrency

public java.util.Currency getComponent4AsCurrency()

Get the component4 as Currency

Returns:

the component4 converted to Currency or null if cannot be converted

getSign

public java.lang.String getSign()

Gets the Sign (component4).

Returns:

the Sign from component4

getSignAsCurrency

public java.util.Currency getSignAsCurrency()

Get the Sign (component4) as Currency

Returns:

the Sign from component4 converted to Currency or null if cannot be converted

getComponent5

public java.lang.String getComponent5()

Gets the component5 (Offset).

Returns:

the component5

getComponent5AsCalendar

public java.util.Calendar getComponent5AsCalendar()

Get the component5 as Calendar

Returns:

the component5 converted to Calendar or null if cannot be converted

getOffset

public java.lang.String getOffset()

Gets the Offset (component5).

Returns:

the Offset from component5

getOffsetAsCalendar

public java.util.Calendar getOffsetAsCalendar()

Get the Offset (component5) as Calendar

Returns:

the Offset from component5 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 Field98G setComponent1(java.lang.String component1)

Set the component1 (Date).

Parameters:

component1 - the component1 to set

setComponent1

public Field98G setComponent1(java.util.Calendar component1)

Set the component1 from a Calendar object.

Parameters:

component1 - the Calendar with the component1 content to set

setDate

public Field98G setDate(java.lang.String component1)

Set the Date (component1).

Parameters:

component1 - the Date to set

setDate

public Field98G setDate(java.util.Calendar component1)

Set the Date (component1) from a Calendar object.

Parameters:

component1 - Calendar with the Date content to set

See Also:

setComponent1(java.util.Calendar)

setComponent2

public Field98G setComponent2(java.lang.String component2)

Set the component2 (Time).

Parameters:

component2 - the component2 to set

setComponent2

public Field98G setComponent2(java.util.Calendar component2)

Set the component2 from a Calendar object.

Parameters:

component2 - the Calendar with the component2 content to set

setTime

public Field98G setTime(java.lang.String component2)

Set the Time (component2).

Parameters:

component2 - the Time to set

setTime

public Field98G setTime(java.util.Calendar component2)

Set the Time (component2) from a Calendar object.

Parameters:

component2 - Calendar with the Time content to set

See Also:

setComponent2(java.util.Calendar)

setComponent3

public Field98G setComponent3(java.lang.String component3)

Set the component3 (Number).

Parameters:

component3 - the component3 to set

setComponent3

public Field98G setComponent3(java.lang.Number component3)

Set the component3 from a Number object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.

Parameters:

component3 - the Number with the component3 content to set

See Also:

setComponent3(String)

setNumber

public Field98G setNumber(java.lang.String component3)

Set the Number (component3).

Parameters:

component3 - the Number to set

setNumber

public Field98G setNumber(java.lang.Number component3)

Set the Number (component3) from a Number object.

Parameters:

component3 - Number with the Number content to set

See Also:

setComponent3(java.lang.Number)

setComponent4

public Field98G setComponent4(java.lang.String component4)

Set the component4 (Sign).

Parameters:

component4 - the component4 to set

setComponent4

public Field98G setComponent4(java.util.Currency component4)

Set the component4 from a Currency object.

Parameters:

component4 - the Currency with the component4 content to set

setSign

public Field98G setSign(java.lang.String component4)

Set the Sign (component4).

Parameters:

component4 - the Sign to set

setSign

public Field98G setSign(java.util.Currency component4)

Set the Sign (component4) from a Currency object.

Parameters:

component4 - Currency with the Sign content to set

See Also:

setComponent4(java.util.Currency)

setComponent5

public Field98G setComponent5(java.lang.String component5)

Set the component5 (Offset).

Parameters:

component5 - the component5 to set

setComponent5

public Field98G setComponent5(java.util.Calendar component5)

Set the component5 from a Calendar object.

Parameters:

component5 - the Calendar with the component5 content to set

setOffset

public Field98G setOffset(java.lang.String component5)

Set the Offset (component5).

Parameters:

component5 - the Offset to set

setOffset

public Field98G setOffset(java.util.Calendar component5)

Set the Offset (component5) from a Calendar object.

Parameters:

component5 - Calendar with the Offset content to set

See Also:

setComponent5(java.util.Calendar)

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

get

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

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

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

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

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

getUtcIndicator

public java.lang.String getUtcIndicator()

Get the ISO UTC Indicator combining the sign and offset, and changing the "N" negative sign indication by proper +/- signs

Returns:

the the UTC indicator such as +0100 or -0300

getTime2

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public java.lang.String getTime2()

Deprecated. use getOffset() or getUtcIndicator() instead, the later returns both the sign and offset

getTime2AsCalendar

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public java.util.Calendar getTime2AsCalendar()

Deprecated. use getOffsetAsCalendar() instead

setTime2

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public Field98G setTime2(java.lang.String component)

Deprecated. use setOffset(String) instead

setTime2

@Deprecated
 @ProwideDeprecated(phase2=SRU2021)
public Field98G setTime2(java.util.Calendar cal)

Deprecated. use setOffset(Calendar) instead