com.prowidesoftware.swift.model.field

Class Field335

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field335

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

@Generated
public class Field335
extends Field
implements java.io.Serializable

SWIFT MT Field 335.

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

Subfields (components) Data types

1. Calendar
2. MIR
3. Long
4. LogicalTerminalAddress
5. Calendar

Structure definition

• validation pattern: <HHMM><MIR><MT><LT>[<HHMM>]
• parser pattern: <HHMM><MIR>NS[N]
• components pattern: HRMZH

This class complies with standard release SRU2022

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.String	F_335 Same as NAME, intended to be clear when using static imports.
static java.lang.Integer	MIR Component number for the MIR subfield.
static java.lang.Integer	MT Component number for the MT subfield.
static java.lang.String	NAME Constant with the field name 335.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	RECEIVER Component number for the Receiver subfield.
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.Integer	TIME_LAST_DELIVERY_ATTEMPT Component number for the Time Last Delivery Attempt subfield.
static java.lang.Integer	TIME_MESSAGE_ENTERED Component number for the Time Message Entered 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
Field335() Default constructor.
Field335(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field335(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.
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field335	fromJson(java.lang.String json) This method deserializes the JSON data into a Field335 object.
static Field335	get(SwiftMessage msg) Gets the first instance of Field335 in the given message.
static Field335	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field335>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field335 in the given message an empty list is returned if none found.
static java.util.List<Field335>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field335 from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Time Message Entered).
java.util.Calendar	getComponent1AsCalendar() Get the component 1 as Calendar
java.lang.String	getComponent2() Gets the component 2 (MIR).
MIR	getComponent2AsMIR() Get the component 2 as MIR
java.lang.String	getComponent3() Gets the component 3 (MT).
java.lang.String	getComponent4() Gets the component 4 (Receiver).
LogicalTerminalAddress	getComponent4AsLogicalTerminalAddress() Get the component 4 as LogicalTerminalAddress
java.lang.String	getComponent5() Gets the component 5 (Time Last Delivery Attempt).
java.util.Calendar	getComponent5AsCalendar() Get the component 5 as Calendar
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	getMIR() Gets the MIR (component 2).
MIR	getMIRAsMIR() Get the MIR (component 2) as MIR
java.lang.String	getMT() Gets the MT (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	getReceiver() Gets the Receiver (component 4).
LogicalTerminalAddress	getReceiverAsLogicalTerminalAddress() Get the Receiver (component 4) as LogicalTerminalAddress
java.lang.String	getTimeLastDeliveryAttempt() Gets the Time Last Delivery Attempt (component 5).
java.util.Calendar	getTimeLastDeliveryAttemptAsCalendar() Get the Time Last Delivery Attempt (component 5) as Calendar
java.lang.String	getTimeMessageEntered() Gets the Time Message Entered (component 1).
java.util.Calendar	getTimeMessageEnteredAsCalendar() Get the Time Message Entered (component 1) 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 Field335	newInstance(Field335 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.
Field335	setComponent1(java.util.Calendar component1) Set the component1 from a Calendar object.
Field335	setComponent1(java.lang.String component1) Set the component 1 (Time Message Entered).
Field335	setComponent2(MIR component2) Set the component2 from a MIR object.
Field335	setComponent2(java.lang.String component2) Set the component 2 (MIR).
Field335	setComponent3(java.lang.String component3) Set the component 3 (MT).
Field335	setComponent4(LogicalTerminalAddress component4) Set the component4 from a LogicalTerminalAddress object.
Field335	setComponent4(java.lang.String component4) Set the component 4 (Receiver).
Field335	setComponent5(java.util.Calendar component5) Set the component5 from a Calendar object.
Field335	setComponent5(java.lang.String component5) Set the component 5 (Time Last Delivery Attempt).
Field335	setMIR(MIR component2) Set the MIR (component 2) from a MIR object.
Field335	setMIR(java.lang.String component2) Set the MIR (component 2).
Field335	setMT(java.lang.String component3) Set the MT (component 3).
Field335	setReceiver(LogicalTerminalAddress component4) Set the Receiver (component 4) from a LogicalTerminalAddress object.
Field335	setReceiver(java.lang.String component4) Set the Receiver (component 4).
Field335	setTimeLastDeliveryAttempt(java.util.Calendar component5) Set the Time Last Delivery Attempt (component 5) from a Calendar object.
Field335	setTimeLastDeliveryAttempt(java.lang.String component5) Set the Time Last Delivery Attempt (component 5).
Field335	setTimeMessageEntered(java.util.Calendar component1) Set the Time Message Entered (component 1) from a Calendar object.
Field335	setTimeMessageEntered(java.lang.String component1) Set the Time Message Entered (component 1).
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 335.

See Also:

Constant Field Values

F_335

public static final java.lang.String F_335

Same as NAME, intended to be clear when using static imports.

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TIME_MESSAGE_ENTERED

public static final java.lang.Integer TIME_MESSAGE_ENTERED

Component number for the Time Message Entered subfield.

MIR

public static final java.lang.Integer MIR

Component number for the MIR subfield.

MT

public static final java.lang.Integer MT

Component number for the MT subfield.

RECEIVER

public static final java.lang.Integer RECEIVER

Component number for the Receiver subfield.

TIME_LAST_DELIVERY_ATTEMPT

public static final java.lang.Integer TIME_LAST_DELIVERY_ATTEMPT

Component number for the Time Last Delivery Attempt subfield.

Constructor Detail

Field335

public Field335()

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

Field335

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

Field335

public Field335(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 Field335 newInstance(Field335 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(phase3=SRU2023)
public java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead.

Specified by:

componentsPattern in class Field

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 (Time Message Entered).

Returns:

the component 1

getComponent1AsCalendar

public java.util.Calendar getComponent1AsCalendar()

Get the component 1 as Calendar

Returns:

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

getTimeMessageEntered

public java.lang.String getTimeMessageEntered()

Gets the Time Message Entered (component 1).

Returns:

the Time Message Entered from component 1

getTimeMessageEnteredAsCalendar

public java.util.Calendar getTimeMessageEnteredAsCalendar()

Get the Time Message Entered (component 1) as Calendar

Returns:

the Time Message Entered from component 1 converted to Calendar or null if cannot be converted

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (MIR).

Returns:

the component 2

getComponent2AsMIR

public MIR getComponent2AsMIR()

Get the component 2 as MIR

Returns:

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

getMIR

public java.lang.String getMIR()

Gets the MIR (component 2).

Returns:

the MIR from component 2

getMIRAsMIR

public MIR getMIRAsMIR()

Get the MIR (component 2) as MIR

Returns:

the MIR from component 2 converted to MIR or null if cannot be converted

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (MT).

Returns:

the component 3

getMT

public java.lang.String getMT()

Gets the MT (component 3).

Returns:

the MT from component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Receiver).

Returns:

the component 4

getComponent4AsLogicalTerminalAddress

public LogicalTerminalAddress getComponent4AsLogicalTerminalAddress()

Get the component 4 as LogicalTerminalAddress

Returns:

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

getReceiver

public java.lang.String getReceiver()

Gets the Receiver (component 4).

Returns:

the Receiver from component 4

getReceiverAsLogicalTerminalAddress

public LogicalTerminalAddress getReceiverAsLogicalTerminalAddress()

Get the Receiver (component 4) as LogicalTerminalAddress

Returns:

the Receiver from component 4 converted to LogicalTerminalAddress or null if cannot be converted

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Time Last Delivery Attempt).

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

getTimeLastDeliveryAttempt

public java.lang.String getTimeLastDeliveryAttempt()

Gets the Time Last Delivery Attempt (component 5).

Returns:

the Time Last Delivery Attempt from component 5

getTimeLastDeliveryAttemptAsCalendar

public java.util.Calendar getTimeLastDeliveryAttemptAsCalendar()

Get the Time Last Delivery Attempt (component 5) as Calendar

Returns:

the Time Last Delivery Attempt from component 5 converted to Calendar or null if cannot be converted

setComponent1

public Field335 setComponent1(java.lang.String component1)

Set the component 1 (Time Message Entered).

Parameters:

component1 - the Time Message Entered to set

Returns:

the field object to enable build pattern

setComponent1

public Field335 setComponent1(java.util.Calendar component1)

Set the component1 from a Calendar object.

Parameters:

component1 - the Calendar with the Time Message Entered content to set

Returns:

the field object to enable build pattern

setTimeMessageEntered

public Field335 setTimeMessageEntered(java.lang.String component1)

Set the Time Message Entered (component 1).

Parameters:

component1 - the Time Message Entered to set

Returns:

the field object to enable build pattern

setTimeMessageEntered

public Field335 setTimeMessageEntered(java.util.Calendar component1)

Set the Time Message Entered (component 1) from a Calendar object.

Parameters:

component1 - Calendar with the Time Message Entered content to set

Returns:

the field object to enable build pattern

See Also:

setComponent1(java.util.Calendar)

setComponent2

public Field335 setComponent2(java.lang.String component2)

Set the component 2 (MIR).

Parameters:

component2 - the MIR to set

Returns:

the field object to enable build pattern

setComponent2

public Field335 setComponent2(MIR component2)

Set the component2 from a MIR object.

Parameters:

component2 - the MIR with the MIR content to set

Returns:

the field object to enable build pattern

setMIR

public Field335 setMIR(java.lang.String component2)

Set the MIR (component 2).

Parameters:

component2 - the MIR to set

Returns:

the field object to enable build pattern

setMIR

public Field335 setMIR(MIR component2)

Set the MIR (component 2) from a MIR object.

Parameters:

component2 - MIR with the MIR content to set

Returns:

the field object to enable build pattern

See Also:

setComponent2(com.prowidesoftware.swift.model.MIR)

setComponent3

public Field335 setComponent3(java.lang.String component3)

Set the component 3 (MT).

Parameters:

component3 - the MT to set

Returns:

the field object to enable build pattern

setMT

public Field335 setMT(java.lang.String component3)

Set the MT (component 3).

Parameters:

component3 - the MT to set

Returns:

the field object to enable build pattern

setComponent4

public Field335 setComponent4(java.lang.String component4)

Set the component 4 (Receiver).

Parameters:

component4 - the Receiver to set

Returns:

the field object to enable build pattern

setComponent4

public Field335 setComponent4(LogicalTerminalAddress component4)

Set the component4 from a LogicalTerminalAddress object.

Parameters:

component4 - the LogicalTerminalAddress with the Receiver content to set

Returns:

the field object to enable build pattern

setReceiver

public Field335 setReceiver(java.lang.String component4)

Set the Receiver (component 4).

Parameters:

component4 - the Receiver to set

Returns:

the field object to enable build pattern

setReceiver

public Field335 setReceiver(LogicalTerminalAddress component4)

Set the Receiver (component 4) from a LogicalTerminalAddress object.

Parameters:

component4 - LogicalTerminalAddress with the Receiver content to set

Returns:

the field object to enable build pattern

See Also:

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

setComponent5

public Field335 setComponent5(java.lang.String component5)

Set the component 5 (Time Last Delivery Attempt).

Parameters:

component5 - the Time Last Delivery Attempt to set

Returns:

the field object to enable build pattern

setComponent5

public Field335 setComponent5(java.util.Calendar component5)

Set the component5 from a Calendar object.

Parameters:

component5 - the Calendar with the Time Last Delivery Attempt content to set

Returns:

the field object to enable build pattern

setTimeLastDeliveryAttempt

public Field335 setTimeLastDeliveryAttempt(java.lang.String component5)

Set the Time Last Delivery Attempt (component 5).

Parameters:

component5 - the Time Last Delivery Attempt to set

Returns:

the field object to enable build pattern

setTimeLastDeliveryAttempt

public Field335 setTimeLastDeliveryAttempt(java.util.Calendar component5)

Set the Time Last Delivery Attempt (component 5) from a Calendar object.

Parameters:

component5 - Calendar with the Time Last Delivery Attempt content to set

Returns:

the field object to enable build pattern

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

get

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

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

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

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

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