Class Field254
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field254
-
- All Implemented Interfaces:
JsonSerializable
,PatternContainer
,java.io.Serializable
@Generated public class Field254 extends Field implements java.io.Serializable
SWIFT MT Field 254.Model and parser for field 254 of a SWIFT MT message.
Subfields (components) Data types
- Component 1: StartMOR:
MOR
- Component 2: EndMOR:
MOR
- Component 3: StartTime:
Calendar
- Component 4: EndTime:
Calendar
Structure definition
- validation pattern:
<MOR><MOR>[<HHMM><HHMM>]
- parser pattern:
<MOR><MOR>[<HHMM><HHMM>]
- components pattern:
VVHH
This class complies with standard release SRU2023
- 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
END_MOR
Component number for the End MOR subfield.static java.lang.Integer
END_TIME
Component number for the End Time subfield.static java.lang.String
F_254
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 254.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
START_MOR
Component number for the Start MOR subfield.static java.lang.Integer
START_TIME
Component number for the Start 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 Field254()
Default constructor.Field254(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field254(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.static Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field254
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field254 object.static Field254
get(SwiftMessage msg)
Gets the first instance of Field254 in the given message.static Field254
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field254>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field254 in the given message an empty list is returned if none found.static java.util.List<Field254>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field254 from the given block an empty list is returned if none found.java.lang.String
getComponent1()
Gets the component 1 (Start MOR).MOR
getComponent1AsMOR()
Get the component 1 as MORjava.lang.String
getComponent2()
Gets the component 2 (End MOR).MOR
getComponent2AsMOR()
Get the component 2 as MORjava.lang.String
getComponent3()
Gets the component 3 (Start Time).java.util.Calendar
getComponent3AsCalendar()
Get the component 3 as Calendarjava.lang.String
getComponent4()
Gets the component 4 (End Time).java.util.Calendar
getComponent4AsCalendar()
Get the component 4 as Calendarjava.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
getEndMOR()
Gets the End MOR (component 2).MOR
getEndMORAsMOR()
Get the End MOR (component 2) as MORjava.lang.String
getEndTime()
Gets the End Time (component 4).java.util.Calendar
getEndTimeAsCalendar()
Get the End Time (component 4) 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
getName()
Returns the field's name composed by the field number and the letter option (if any).java.lang.String
getStartMOR()
Gets the Start MOR (component 1).MOR
getStartMORAsMOR()
Get the Start MOR (component 1) as MORjava.lang.String
getStartTime()
Gets the Start Time (component 3).java.util.Calendar
getStartTimeAsCalendar()
Get the Start Time (component 3) 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 Field254
newInstance(Field254 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.Field254
setComponent1(MOR component1)
Set the component1 from a MOR object.Field254
setComponent1(java.lang.String component1)
Set the component 1 (Start MOR).Field254
setComponent2(MOR component2)
Set the component2 from a MOR object.Field254
setComponent2(java.lang.String component2)
Set the component 2 (End MOR).Field254
setComponent3(java.lang.String component3)
Set the component 3 (Start Time).Field254
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.Field254
setComponent4(java.lang.String component4)
Set the component 4 (End Time).Field254
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.Field254
setEndMOR(MOR component2)
Set the End MOR (component 2) from a MOR object.Field254
setEndMOR(java.lang.String component2)
Set the End MOR (component 2).Field254
setEndTime(java.lang.String component4)
Set the End Time (component 4).Field254
setEndTime(java.util.Calendar component4)
Set the End Time (component 4) from a Calendar object.Field254
setStartMOR(MOR component1)
Set the Start MOR (component 1) from a MOR object.Field254
setStartMOR(java.lang.String component1)
Set the Start MOR (component 1).Field254
setStartTime(java.lang.String component3)
Set the Start Time (component 3).Field254
setStartTime(java.util.Calendar component3)
Set the Start Time (component 3) 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 254.- See Also:
- Constant Field Values
-
F_254
public static final java.lang.String F_254
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
START_MOR
public static final java.lang.Integer START_MOR
Component number for the Start MOR subfield.
-
END_MOR
public static final java.lang.Integer END_MOR
Component number for the End MOR 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
-
Field254
public Field254()
Default constructor. Creates a new field setting all components to null.
-
Field254
public Field254(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
-
Field254
public Field254(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 Field254 newInstance(Field254 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(phase4=SRU2024) 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 (Start MOR).- Returns:
- the component 1
-
getComponent1AsMOR
public MOR getComponent1AsMOR()
Get the component 1 as MOR- Returns:
- the component 1 converted to MOR or null if cannot be converted
-
getStartMOR
public java.lang.String getStartMOR()
Gets the Start MOR (component 1).- Returns:
- the Start MOR from component 1
-
getStartMORAsMOR
public MOR getStartMORAsMOR()
Get the Start MOR (component 1) as MOR- Returns:
- the Start MOR from component 1 converted to MOR or null if cannot be converted
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (End MOR).- Returns:
- the component 2
-
getComponent2AsMOR
public MOR getComponent2AsMOR()
Get the component 2 as MOR- Returns:
- the component 2 converted to MOR or null if cannot be converted
-
getEndMOR
public java.lang.String getEndMOR()
Gets the End MOR (component 2).- Returns:
- the End MOR from component 2
-
getEndMORAsMOR
public MOR getEndMORAsMOR()
Get the End MOR (component 2) as MOR- Returns:
- the End MOR from component 2 converted to MOR or null if cannot be converted
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Start Time).- Returns:
- the component 3
-
getComponent3AsCalendar
public java.util.Calendar getComponent3AsCalendar()
Get the component 3 as Calendar- Returns:
- the component 3 converted to Calendar or null if cannot be converted
-
getStartTime
public java.lang.String getStartTime()
Gets the Start Time (component 3).- Returns:
- the Start Time from component 3
-
getStartTimeAsCalendar
public java.util.Calendar getStartTimeAsCalendar()
Get the Start Time (component 3) as Calendar- Returns:
- the Start Time from component 3 converted to Calendar or null if cannot be converted
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (End Time).- 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
-
getEndTime
public java.lang.String getEndTime()
Gets the End Time (component 4).- Returns:
- the End Time from component 4
-
getEndTimeAsCalendar
public java.util.Calendar getEndTimeAsCalendar()
Get the End Time (component 4) as Calendar- Returns:
- the End Time from component 4 converted to Calendar or null if cannot be converted
-
setComponent1
public Field254 setComponent1(java.lang.String component1)
Set the component 1 (Start MOR).- Parameters:
component1
- the Start MOR to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field254 setComponent1(MOR component1)
Set the component1 from a MOR object.- Parameters:
component1
- the MOR with the Start MOR content to set- Returns:
- the field object to enable build pattern
-
setStartMOR
public Field254 setStartMOR(java.lang.String component1)
Set the Start MOR (component 1).- Parameters:
component1
- the Start MOR to set- Returns:
- the field object to enable build pattern
-
setStartMOR
public Field254 setStartMOR(MOR component1)
Set the Start MOR (component 1) from a MOR object.- Parameters:
component1
- MOR with the Start MOR content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent1(com.prowidesoftware.swift.model.MOR)
-
setComponent2
public Field254 setComponent2(java.lang.String component2)
Set the component 2 (End MOR).- Parameters:
component2
- the End MOR to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field254 setComponent2(MOR component2)
Set the component2 from a MOR object.- Parameters:
component2
- the MOR with the End MOR content to set- Returns:
- the field object to enable build pattern
-
setEndMOR
public Field254 setEndMOR(java.lang.String component2)
Set the End MOR (component 2).- Parameters:
component2
- the End MOR to set- Returns:
- the field object to enable build pattern
-
setEndMOR
public Field254 setEndMOR(MOR component2)
Set the End MOR (component 2) from a MOR object.- Parameters:
component2
- MOR with the End MOR content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(com.prowidesoftware.swift.model.MOR)
-
setComponent3
public Field254 setComponent3(java.lang.String component3)
Set the component 3 (Start Time).- Parameters:
component3
- the Start Time to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field254 setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.- Parameters:
component3
- the Calendar with the Start Time content to set- Returns:
- the field object to enable build pattern
-
setStartTime
public Field254 setStartTime(java.lang.String component3)
Set the Start Time (component 3).- Parameters:
component3
- the Start Time to set- Returns:
- the field object to enable build pattern
-
setStartTime
public Field254 setStartTime(java.util.Calendar component3)
Set the Start Time (component 3) from a Calendar object.- Parameters:
component3
- Calendar with the Start Time content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent3(java.util.Calendar)
-
setComponent4
public Field254 setComponent4(java.lang.String component4)
Set the component 4 (End Time).- Parameters:
component4
- the End Time to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field254 setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.- Parameters:
component4
- the Calendar with the End Time content to set- Returns:
- the field object to enable build pattern
-
setEndTime
public Field254 setEndTime(java.lang.String component4)
Set the End Time (component 4).- Parameters:
component4
- the End Time to set- Returns:
- the field object to enable build pattern
-
setEndTime
public Field254 setEndTime(java.util.Calendar component4)
Set the End Time (component 4) from a Calendar object.- Parameters:
component4
- Calendar with the End Time content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent4(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).
-
get
public static Field254 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 Field254 get(SwiftMessage msg)
Gets the first instance of Field254 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<Field254> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field254 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<Field254> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field254 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 Field254 fromJson(java.lang.String json)
This method deserializes the JSON data into a Field254 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)
-
-