com.prowidesoftware.swift.model.field

Class Field98J

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field98J

All Implemented Interfaces:

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

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

SWIFT MT Field 98J

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

Subfields (components) Data types

1. String
2. Calendar
3. Calendar
4. BIC

Structure definition

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

This class complies with standard release SRU2017

NOTE: this source code has been generated from template

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	BIC Component number for the BIC subfield
static java.lang.String	COMPONENTS_PATTERN
static java.lang.Integer	CONDITIONAL_QUALIFIER Component number for the conditional qualifier subfield
static java.lang.Integer	DATE Component number for the Date subfield
static java.lang.String	F_98J same as NAME, intended to be clear when using static imports
static java.lang.String	NAME Constant with the field name 98J
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	TIME Component number for the Time subfield

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

components

Constructor Summary

Constructors

Constructor and Description
Field98J() Default constructor.
Field98J(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field98J(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.util.List<BIC>	bics() Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
java.util.List<java.lang.String>	bicStrings() Get a list of strings of BICs present in this field
java.lang.String	componentsPattern() Returns the field's 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 Field98J	get(SwiftMessage msg) Get the first instance of Field98J in the given message.
static Field98J	get(SwiftTagListBlock block) Get the first occurrence form the tag list or null if not found.
static java.util.List<Field98J>	getAll(SwiftMessage msg) Get a list of all occurrences of the field Field98J in the given message an empty list is returned if none found.
static java.util.List<Field98J>	getAll(SwiftTagListBlock block) Get a list of all occurrences of the field Field98J from the given block an empty list is returned if none found.
java.lang.String	getBIC() Get the BIC (component4).
BIC	getBICAsBIC() Get the BIC (component4) as BIC
java.lang.String	getComponent1() Get the component1
java.lang.String	getComponent1AsString() Deprecated. use Field.getComponent(int) instead
java.lang.String	getComponent2() Get the component2
java.util.Calendar	getComponent2AsCalendar() Get the component2 as Calendar
java.lang.String	getComponent3() Get the component3
java.util.Calendar	getComponent3AsCalendar() Get the component3 as Calendar
java.lang.String	getComponent4() Get the component4
BIC	getComponent4AsBIC() Get the component4 as BIC
protected java.util.List<java.lang.String>	getComponentLabels() Returns english label for components.
java.lang.String	getConditionalQualifier() Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
java.lang.String	getDate() Get the Date (component2).
java.util.Calendar	getDateAsCalendar() Get the Date (component2) 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	getQualifier() Get the Qualifier (component1).
java.lang.String	getTime() Get the Time (component3).
java.util.Calendar	getTimeAsCalendar() Get the Time (component3) 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 Field98J	newInstance(Field98J 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()
Field98J	setBIC(BIC component4) Set the BIC (component4) from a BIC object.
Field98J	setBIC(java.lang.String component4) Set the BIC (component4).
Field98J	setComponent1(java.lang.String component1) Set the component1.
Field98J	setComponent2(java.util.Calendar component2) Set the component2 from a Calendar object.
Field98J	setComponent2(java.lang.String component2) Set the component2.
Field98J	setComponent3(java.util.Calendar component3) Set the component3 from a Calendar object.
Field98J	setComponent3(java.lang.String component3) Set the component3.
Field98J	setComponent4(BIC component4) Set the component4 from a BIC object.
Field98J	setComponent4(java.lang.String component4) Set the component4.
Field98J	setDate(java.util.Calendar component2) Set the Date (component2) from a Calendar object.
Field98J	setDate(java.lang.String component2) Set the Date (component2).
Field98J	setQualifier(java.lang.String component1) Set the Qualifier (component1).
Field98J	setTime(java.util.Calendar component3) Set the Time (component3) from a Calendar object.
Field98J	setTime(java.lang.String component3) Set the 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's validators 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, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, 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 98J

See Also:

Constant Field Values

F_98J

public static final java.lang.String F_98J

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

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

BIC

public static final java.lang.Integer BIC

Component number for the BIC subfield

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield

Constructor Detail

Field98J

public Field98J()

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

Field98J

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

Field98J

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

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

newInstance

public static Field98J newInstance(Field98J 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

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

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

getComponent1

public java.lang.String getComponent1()

Get the component1

Returns:

the component1

getComponent1AsString

@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent1AsString()

Deprecated. use Field.getComponent(int) instead

Same as getComponent(1)

getQualifier

public java.lang.String getQualifier()

Get the Qualifier (component1).

Returns:

the Qualifier from component1

setComponent1

public Field98J setComponent1(java.lang.String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setQualifier

public Field98J setQualifier(java.lang.String component1)

Set the Qualifier (component1).

Parameters:

component1 - the Qualifier to set

getComponent2

public java.lang.String getComponent2()

Get the component2

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

getDate

public java.lang.String getDate()

Get the Date (component2).

Returns:

the Date from component2

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component2) as Calendar

Returns:

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

setComponent2

public Field98J setComponent2(java.lang.String component2)

Set the component2.

Parameters:

component2 - the component2 to set

setComponent2

public Field98J setComponent2(java.util.Calendar component2)

Set the component2 from a Calendar object.

Parameters:

component2 - the Calendar with the component2 content to set

setDate

public Field98J setDate(java.lang.String component2)

Set the Date (component2).

Parameters:

component2 - the Date to set

setDate

public Field98J 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)

getComponent3

public java.lang.String getComponent3()

Get the component3

Returns:

the component3

getComponent3AsCalendar

public java.util.Calendar getComponent3AsCalendar()

Get the component3 as Calendar

Returns:

the component3 converted to Calendar or null if cannot be converted

getTime

public java.lang.String getTime()

Get the Time (component3).

Returns:

the Time from component3

getTimeAsCalendar

public java.util.Calendar getTimeAsCalendar()

Get the Time (component3) as Calendar

Returns:

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

setComponent3

public Field98J setComponent3(java.lang.String component3)

Set the component3.

Parameters:

component3 - the component3 to set

setComponent3

public Field98J setComponent3(java.util.Calendar component3)

Set the component3 from a Calendar object.

Parameters:

component3 - the Calendar with the component3 content to set

setTime

public Field98J setTime(java.lang.String component3)

Set the Time (component3).

Parameters:

component3 - the Time to set

setTime

public Field98J setTime(java.util.Calendar component3)

Set the Time (component3) from a Calendar object.

Parameters:

component3 - Calendar with the Time content to set

See Also:

setComponent3(java.util.Calendar)

getComponent4

public java.lang.String getComponent4()

Get the component4

Returns:

the component4

getComponent4AsBIC

public BIC getComponent4AsBIC()

Get the component4 as BIC

Returns:

the component4 converted to BIC or null if cannot be converted

getBIC

public java.lang.String getBIC()

Get the BIC (component4).

Returns:

the BIC from component4

getBICAsBIC

public BIC getBICAsBIC()

Get the BIC (component4) as BIC

Returns:

the BIC from component4 converted to BIC or null if cannot be converted

setComponent4

public Field98J setComponent4(java.lang.String component4)

Set the component4.

Parameters:

component4 - the component4 to set

setComponent4

public Field98J setComponent4(BIC component4)

Set the component4 from a BIC object.

Parameters:

component4 - the BIC with the component4 content to set

setBIC

public Field98J setBIC(java.lang.String component4)

Set the BIC (component4).

Parameters:

component4 - the BIC to set

setBIC

public Field98J setBIC(BIC component4)

Set the BIC (component4) from a BIC object.

Parameters:

component4 - BIC with the BIC content to set

See Also:

setComponent4(com.prowidesoftware.swift.model.BIC)

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

bics

public java.util.List<BIC> bics()

Description copied from interface: BICContainer

Utility method that creates a BIC for every string returned by BICContainer.bicStrings()

Specified by:

bics in interface BICContainer

bicStrings

public java.util.List<java.lang.String> bicStrings()

Description copied from interface: BICContainer

Get a list of strings of BICs present in this field

Specified by:

bicStrings in interface BICContainer

Returns:

a list, with zero or more BICs in this 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

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 conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.

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 kind of field.

parserPattern

public java.lang.String parserPattern()

Specified by:

parserPattern in interface PatternContainer

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

componentsPattern

public final java.lang.String componentsPattern()

Returns the field's components pattern

Specified by:

componentsPattern in interface PatternContainer

Specified by:

componentsPattern in class Field

Returns:

the static value of Field98J.COMPONENTS_PATTERN

validatorPattern

public final java.lang.String validatorPattern()

Returns the field's validators pattern

Specified by:

validatorPattern in class Field

get

public static Field98J get(SwiftTagListBlock block)

Get 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 Field98J get(SwiftMessage msg)

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

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

Get a list of all occurrences of the field Field98J 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

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

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

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)