Class Field109
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field109
-
- All Implemented Interfaces:
JsonSerializable
,DateContainer
,PatternContainer
,java.io.Serializable
@Generated public class Field109 extends Field implements java.io.Serializable, DateContainer
SWIFT MT Field 109.Model and parser for field 109 of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Date:
Calendar
- Component 2: Time:
Calendar
- Component 3: MIR:
String
Structure definition
- validation pattern:
<DATE2><TIME2><MIR>
- parser pattern:
<DATE2><TIME2>S
- components pattern:
DTS
This class complies with standard release SRU2022
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
DATE
Component number for the Date subfield.static java.lang.String
F_109
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.String
NAME
Constant with the field name 109.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.Integer
TIME
Component number for the Time subfield.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field109()
Default constructor.Field109(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field109(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
instead.int
componentsSize()
Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.java.util.Calendar
date()
Returns the first component that can be converted to a Calendarjava.util.List<java.util.Calendar>
dates()
Returns all components that can be converted to a Calendarstatic Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field109
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field109 object.static Field109
get(SwiftMessage msg)
Gets the first instance of Field109 in the given message.static Field109
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field109>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field109 in the given message an empty list is returned if none found.static java.util.List<Field109>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field109 from the given block an empty list is returned if none found.java.lang.String
getComponent1()
Gets the component 1 (Date).java.util.Calendar
getComponent1AsCalendar()
Get the component 1 as Calendarjava.lang.String
getComponent2()
Gets the component 2 (Time).java.util.Calendar
getComponent2AsCalendar()
Get the component 2 as Calendarjava.lang.String
getComponent3()
Gets the component 3 (MIR).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 1).java.util.Calendar
getDateAsCalendar()
Get the Date (component 1) as Calendarprotected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getMIR()
Gets the MIR (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
getTime()
Gets the Time (component 2).java.util.Calendar
getTimeAsCalendar()
Get the Time (component 2) as Calendarjava.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 Field109
newInstance(Field109 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.Field109
setComponent1(java.lang.String component1)
Set the component 1 (Date).Field109
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.Field109
setComponent2(java.lang.String component2)
Set the component 2 (Time).Field109
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.Field109
setComponent3(java.lang.String component3)
Set the component 3 (MIR).Field109
setDate(java.lang.String component1)
Set the Date (component 1).Field109
setDate(java.util.Calendar component1)
Set the Date (component 1) from a Calendar object.Field109
setMIR(java.lang.String component3)
Set the MIR (component 3).Field109
setTime(java.lang.String component2)
Set the Time (component 2).Field109
setTime(java.util.Calendar component2)
Set the Time (component 2) from a Calendar object.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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
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 109.- See Also:
- Constant Field Values
-
F_109
public static final java.lang.String F_109
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.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- 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.
-
MIR
public static final java.lang.Integer MIR
Component number for the MIR subfield.
-
-
Constructor Detail
-
Field109
public Field109()
Default constructor. Creates a new field setting all components to null.
-
Field109
public Field109(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
-
Field109
public Field109(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(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 Field109 newInstance(Field109 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 fornew 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 fornew 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.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
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 classField
- Parameters:
component
- number of the component to displaylocale
- 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.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
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 interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
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 classField
- 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.
-
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 classField
- 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 classField
- 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 classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Date).- 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
-
getDate
public java.lang.String getDate()
Gets the Date (component 1).- Returns:
- the Date from component 1
-
getDateAsCalendar
public java.util.Calendar getDateAsCalendar()
Get the Date (component 1) as Calendar- Returns:
- the Date from component 1 converted to Calendar or null if cannot be converted
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Time).- Returns:
- the component 2
-
getComponent2AsCalendar
public java.util.Calendar getComponent2AsCalendar()
Get the component 2 as Calendar- Returns:
- the component 2 converted to Calendar or null if cannot be converted
-
getTime
public java.lang.String getTime()
Gets the Time (component 2).- Returns:
- the Time from component 2
-
getTimeAsCalendar
public java.util.Calendar getTimeAsCalendar()
Get the Time (component 2) as Calendar- Returns:
- the Time from component 2 converted to Calendar or null if cannot be converted
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (MIR).- Returns:
- the component 3
-
getMIR
public java.lang.String getMIR()
Gets the MIR (component 3).- Returns:
- the MIR from component 3
-
setComponent1
public Field109 setComponent1(java.lang.String component1)
Set the component 1 (Date).- Parameters:
component1
- the Date to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field109 setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.- Parameters:
component1
- the Calendar with the Date content to set- Returns:
- the field object to enable build pattern
-
setDate
public Field109 setDate(java.lang.String component1)
Set the Date (component 1).- Parameters:
component1
- the Date to set- Returns:
- the field object to enable build pattern
-
setDate
public Field109 setDate(java.util.Calendar component1)
Set the Date (component 1) from a Calendar object.- Parameters:
component1
- Calendar with the Date content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent1(java.util.Calendar)
-
setComponent2
public Field109 setComponent2(java.lang.String component2)
Set the component 2 (Time).- Parameters:
component2
- the Time to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field109 setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.- Parameters:
component2
- the Calendar with the Time content to set- Returns:
- the field object to enable build pattern
-
setTime
public Field109 setTime(java.lang.String component2)
Set the Time (component 2).- Parameters:
component2
- the Time to set- Returns:
- the field object to enable build pattern
-
setTime
public Field109 setTime(java.util.Calendar component2)
Set the Time (component 2) from a Calendar object.- Parameters:
component2
- Calendar with the Time content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(java.util.Calendar)
-
setComponent3
public Field109 setComponent3(java.lang.String component3)
Set the component 3 (MIR).- Parameters:
component3
- the MIR to set- Returns:
- the field object to enable build pattern
-
setMIR
public Field109 setMIR(java.lang.String component3)
Set the MIR (component 3).- Parameters:
component3
- the MIR to set- Returns:
- the field object to enable build pattern
-
dates
public java.util.List<java.util.Calendar> dates()
Returns all components that can be converted to a Calendar- Specified by:
dates
in interfaceDateContainer
- Returns:
- the list of converted components (a Calendar object or null)
-
date
public java.util.Calendar date()
Returns the first component that can be converted to a Calendar- Returns:
- the converted components (a Calendar object or null)
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field109 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 Field109 get(SwiftMessage msg)
Gets the first instance of Field109 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<Field109> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field109 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<Field109> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field109 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 Field109 fromJson(java.lang.String json)
This method deserializes the JSON data into a Field109 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)
-
-