com.prowidesoftware.swift.model.field

Class Field258

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field258

All Implemented Interfaces:

JsonSerializable, DateContainer, PatternContainer, java.io.Serializable

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

SWIFT MT Field 258

Model and parser for field 258 of a SWIFT MT message.

Subfields (components) Data types

1. LogicalTerminalAddress
2. Number
3. Number
4. Calendar
5. Calendar
6. Calendar

Structure definition

• validation pattern: <LT>4!n<MT><DATE2>[<HHMM><HHMM>]
• parser pattern: <LT>4!N<MT><DATE2>[<HHMM><HHMM>]
• components pattern: ZNMEHH

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.Integer	END_TIME Component number for the End Time subfield
static java.lang.String	F_258 same as NAME, intended to be clear when using static imports
static java.lang.Integer	LT_ADDRESS Component number for the LT Address subfield
static java.lang.Integer	MESSAGE_TYPE Component number for the Message Type subfield
static java.lang.String	NAME Constant with the field name 258
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	SESSION_NUMBER Component number for the Session Number subfield
static int	SRU Constant identifying the SRU to which this class belongs to.
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
Field258() Default constructor.
Field258(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field258(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 Field258	fromJson(java.lang.String json) This method deserializes the JSON data into a Field258 object.
static Field258	get(SwiftMessage msg) Gets the first instance of Field258 in the given message.
static Field258	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field258>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field258 in the given message an empty list is returned if none found.
static java.util.List<Field258>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field258 from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (LT Address).
LogicalTerminalAddress	getComponent1AsLogicalTerminalAddress() Get the component 1 as LogicalTerminalAddress
java.lang.String	getComponent2() Gets the component 2 (Session Number).
java.lang.Number	getComponent2AsNumber() Get the component 2 as Number
java.lang.String	getComponent3() Gets the component 3 (Message Type).
java.lang.String	getComponent4() Gets the component 4 (Date).
java.util.Calendar	getComponent4AsCalendar() Get the component 4 as Calendar
java.lang.String	getComponent5() Gets the component 5 (Start Time).
java.util.Calendar	getComponent5AsCalendar() Get the component 5 as Calendar
java.lang.String	getComponent6() Gets the component 6 (End Time).
java.util.Calendar	getComponent6AsCalendar() Get the component 6 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 (component 4).
java.util.Calendar	getDateAsCalendar() Get the Date (component 4) as Calendar
java.lang.String	getEndTime() Gets the End Time (component 6).
java.util.Calendar	getEndTimeAsCalendar() Get the End Time (component 6) as Calendar
java.lang.String	getLTAddress() Gets the LT Address (component 1).
LogicalTerminalAddress	getLTAddressAsLogicalTerminalAddress() Get the LT Address (component 1) as LogicalTerminalAddress
java.lang.String	getMessageType() Gets the Message Type (component 3).
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any)
java.lang.String	getSessionNumber() Gets the Session Number (component 2).
java.lang.Number	getSessionNumberAsNumber() Get the Session Number (component 2) as Number
java.lang.String	getStartTime() Gets the Start Time (component 5).
java.util.Calendar	getStartTimeAsCalendar() Get the Start Time (component 5) 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	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 Field258	newInstance(Field258 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
Field258	setComponent1(LogicalTerminalAddress component1) Set the component1 from a LogicalTerminalAddress object.
Field258	setComponent1(java.lang.String component1) Set the component1 (LT Address).
Field258	setComponent2(java.lang.Number component2) Set the component2 from a Number object.
Field258	setComponent2(java.lang.String component2) Set the component2 (Session Number).
Field258	setComponent3(java.lang.String component3) Set the component3 (Message Type).
Field258	setComponent4(java.util.Calendar component4) Set the component4 from a Calendar object.
Field258	setComponent4(java.lang.String component4) Set the component4 (Date).
Field258	setComponent5(java.util.Calendar component5) Set the component5 from a Calendar object.
Field258	setComponent5(java.lang.String component5) Set the component5 (Start Time).
Field258	setComponent6(java.util.Calendar component6) Set the component6 from a Calendar object.
Field258	setComponent6(java.lang.String component6) Set the component6 (End Time).
Field258	setDate(java.util.Calendar component4) Set the Date (component4) from a Calendar object.
Field258	setDate(java.lang.String component4) Set the Date (component4).
Field258	setEndTime(java.util.Calendar component6) Set the End Time (component6) from a Calendar object.
Field258	setEndTime(java.lang.String component6) Set the End Time (component6).
Field258	setLTAddress(LogicalTerminalAddress component1) Set the LT Address (component1) from a LogicalTerminalAddress object.
Field258	setLTAddress(java.lang.String component1) Set the LT Address (component1).
Field258	setMessageType(java.lang.String component3) Set the Message Type (component3).
Field258	setSessionNumber(java.lang.Number component2) Set the Session Number (component2) from a Number object.
Field258	setSessionNumber(java.lang.String component2) Set the Session Number (component2).
Field258	setStartTime(java.util.Calendar component5) Set the Start Time (component5) from a Calendar object.
Field258	setStartTime(java.lang.String component5) Set the Start Time (component5).
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 258

See Also:

Constant Field Values

F_258

public static final java.lang.String F_258

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

LT_ADDRESS

public static final java.lang.Integer LT_ADDRESS

Component number for the LT Address subfield

SESSION_NUMBER

public static final java.lang.Integer SESSION_NUMBER

Component number for the Session Number subfield

MESSAGE_TYPE

public static final java.lang.Integer MESSAGE_TYPE

Component number for the Message Type subfield

DATE

public static final java.lang.Integer DATE

Component number for the Date subfield

START_TIME

public static final java.lang.Integer START_TIME

Component number for the Start Time subfield

END_TIME

public static final java.lang.Integer END_TIME

Component number for the End Time subfield

Constructor Detail

Field258

public Field258()

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

Field258

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

Field258

public Field258(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 Field258 newInstance(Field258 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 Field258.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 Field258.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 (LT Address).

Returns:

the component 1

getComponent1AsLogicalTerminalAddress

public LogicalTerminalAddress getComponent1AsLogicalTerminalAddress()

Get the component 1 as LogicalTerminalAddress

Returns:

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

getLTAddress

public java.lang.String getLTAddress()

Gets the LT Address (component 1).

Returns:

the LT Address from component 1

getLTAddressAsLogicalTerminalAddress

public LogicalTerminalAddress getLTAddressAsLogicalTerminalAddress()

Get the LT Address (component 1) as LogicalTerminalAddress

Returns:

the LT Address from component 1 converted to LogicalTerminalAddress or null if cannot be converted

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Session Number).

Returns:

the component 2

getComponent2AsNumber

public java.lang.Number getComponent2AsNumber()

Get the component 2 as Number

Returns:

the component 2 converted to Number or null if cannot be converted

getSessionNumber

public java.lang.String getSessionNumber()

Gets the Session Number (component 2).

Returns:

the Session Number from component 2

getSessionNumberAsNumber

public java.lang.Number getSessionNumberAsNumber()

Get the Session Number (component 2) as Number

Returns:

the Session Number from component 2 converted to Number or null if cannot be converted

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Message Type).

Returns:

the component 3

getMessageType

public java.lang.String getMessageType()

Gets the Message Type (component 3).

Returns:

the Message Type from component 3

getComponent4

public java.lang.String getComponent4()

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

getDate

public java.lang.String getDate()

Gets the Date (component 4).

Returns:

the Date from component 4

getDateAsCalendar

public java.util.Calendar getDateAsCalendar()

Get the Date (component 4) as Calendar

Returns:

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

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Start 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

getStartTime

public java.lang.String getStartTime()

Gets the Start Time (component 5).

Returns:

the Start Time from component 5

getStartTimeAsCalendar

public java.util.Calendar getStartTimeAsCalendar()

Get the Start Time (component 5) as Calendar

Returns:

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

getComponent6

public java.lang.String getComponent6()

Gets the component 6 (End Time).

Returns:

the component 6

getComponent6AsCalendar

public java.util.Calendar getComponent6AsCalendar()

Get the component 6 as Calendar

Returns:

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

getEndTime

public java.lang.String getEndTime()

Gets the End Time (component 6).

Returns:

the End Time from component 6

getEndTimeAsCalendar

public java.util.Calendar getEndTimeAsCalendar()

Get the End Time (component 6) as Calendar

Returns:

the End Time from component 6 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 Field258 setComponent1(java.lang.String component1)

Set the component1 (LT Address).

Parameters:

component1 - the component1 to set

setComponent1

public Field258 setComponent1(LogicalTerminalAddress component1)

Set the component1 from a LogicalTerminalAddress object.

Parameters:

component1 - the LogicalTerminalAddress with the component1 content to set

setLTAddress

public Field258 setLTAddress(java.lang.String component1)

Set the LT Address (component1).

Parameters:

component1 - the LT Address to set

setLTAddress

public Field258 setLTAddress(LogicalTerminalAddress component1)

Set the LT Address (component1) from a LogicalTerminalAddress object.

Parameters:

component1 - LogicalTerminalAddress with the LT Address content to set

See Also:

setComponent1(com.prowidesoftware.swift.model.LogicalTerminalAddress)

setComponent2

public Field258 setComponent2(java.lang.String component2)

Set the component2 (Session Number).

Parameters:

component2 - the component2 to set

setComponent2

public Field258 setComponent2(java.lang.Number component2)

Set the component2 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 setComponent2(String) method.

Parameters:

component2 - the Number with the component2 content to set

See Also:

setComponent2(String)

setSessionNumber

public Field258 setSessionNumber(java.lang.String component2)

Set the Session Number (component2).

Parameters:

component2 - the Session Number to set

setSessionNumber

public Field258 setSessionNumber(java.lang.Number component2)

Set the Session Number (component2) from a Number object.

Parameters:

component2 - Number with the Session Number content to set

See Also:

setComponent2(java.lang.Number)

setComponent3

public Field258 setComponent3(java.lang.String component3)

Set the component3 (Message Type).

Parameters:

component3 - the component3 to set

setMessageType

public Field258 setMessageType(java.lang.String component3)

Set the Message Type (component3).

Parameters:

component3 - the Message Type to set

setComponent4

public Field258 setComponent4(java.lang.String component4)

Set the component4 (Date).

Parameters:

component4 - the component4 to set

setComponent4

public Field258 setComponent4(java.util.Calendar component4)

Set the component4 from a Calendar object.

Parameters:

component4 - the Calendar with the component4 content to set

setDate

public Field258 setDate(java.lang.String component4)

Set the Date (component4).

Parameters:

component4 - the Date to set

setDate

public Field258 setDate(java.util.Calendar component4)

Set the Date (component4) from a Calendar object.

Parameters:

component4 - Calendar with the Date content to set

See Also:

setComponent4(java.util.Calendar)

setComponent5

public Field258 setComponent5(java.lang.String component5)

Set the component5 (Start Time).

Parameters:

component5 - the component5 to set

setComponent5

public Field258 setComponent5(java.util.Calendar component5)

Set the component5 from a Calendar object.

Parameters:

component5 - the Calendar with the component5 content to set

setStartTime

public Field258 setStartTime(java.lang.String component5)

Set the Start Time (component5).

Parameters:

component5 - the Start Time to set

setStartTime

public Field258 setStartTime(java.util.Calendar component5)

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

Parameters:

component5 - Calendar with the Start Time content to set

See Also:

setComponent5(java.util.Calendar)

setComponent6

public Field258 setComponent6(java.lang.String component6)

Set the component6 (End Time).

Parameters:

component6 - the component6 to set

setComponent6

public Field258 setComponent6(java.util.Calendar component6)

Set the component6 from a Calendar object.

Parameters:

component6 - the Calendar with the component6 content to set

setEndTime

public Field258 setEndTime(java.lang.String component6)

Set the End Time (component6).

Parameters:

component6 - the End Time to set

setEndTime

public Field258 setEndTime(java.util.Calendar component6)

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

Parameters:

component6 - Calendar with the End Time content to set

See Also:

setComponent6(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 Field258.NAME

get

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

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

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

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

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