@Generated public class Field257 extends Field implements java.io.Serializable, DateContainer
Model and parser for field 257 of a SWIFT MT message.
Subfields (components) Data types
LogicalTerminalAddress
Calendar
Calendar
Calendar
Long
Structure definition
<LT><DATE2><HHMM><HHMM>[4!n]
<LT><DATE2><HHMM><HHMM>[N]
ZEHHN
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
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_257
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.String |
NAME
Constant with the field name 257.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
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.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components
Constructor and Description |
---|
Field257()
Default constructor.
|
Field257(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field257(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
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. |
java.util.Calendar |
date()
Returns the first component that can be converted to a Calendar
|
java.util.List<java.util.Calendar> |
dates()
Returns all components that can be converted to a Calendar
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value.
|
static Field257 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field257 object.
|
static Field257 |
get(SwiftMessage msg)
Gets the first instance of Field257 in the given message.
|
static Field257 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field257> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field257 in the given message
an empty list is returned if none found.
|
static java.util.List<Field257> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field257 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 (Date).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Start Time).
|
java.util.Calendar |
getComponent3AsCalendar()
Get the component 3 as Calendar
|
java.lang.String |
getComponent4()
Gets the component 4 (End Time).
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component 4 as Calendar
|
java.lang.String |
getComponent5()
Gets the component 5 (Session Number).
|
java.lang.Long |
getComponent5AsLong()
Get the component 5 as Long
|
java.lang.Number |
getComponent5AsNumber()
Deprecated.
|
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 2).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component 2) as Calendar
|
java.lang.String |
getEndTime()
Gets the End Time (component 4).
|
java.util.Calendar |
getEndTimeAsCalendar()
Get the End Time (component 4) 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 |
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 5).
|
java.lang.Long |
getSessionNumberAsLong()
Get the Session Number (component 5) as Long
|
java.lang.Number |
getSessionNumberAsNumber()
Deprecated.
|
java.lang.String |
getStartTime()
Gets the Start Time (component 3).
|
java.util.Calendar |
getStartTimeAsCalendar()
Get the Start Time (component 3) 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 Field257 |
newInstance(Field257 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.
|
Field257 |
setComponent1(LogicalTerminalAddress component1)
Set the component1 from a LogicalTerminalAddress object.
|
Field257 |
setComponent1(java.lang.String component1)
Set the component 1 (LT Address).
|
Field257 |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field257 |
setComponent2(java.lang.String component2)
Set the component 2 (Date).
|
Field257 |
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.
|
Field257 |
setComponent3(java.lang.String component3)
Set the component 3 (Start Time).
|
Field257 |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field257 |
setComponent4(java.lang.String component4)
Set the component 4 (End Time).
|
Field257 |
setComponent5(java.lang.Long component5)
Set the component5 from a Long object.
|
Field257 |
setComponent5(java.lang.Number component5)
Alternative method setter for field's Session Number (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field257 |
setComponent5(java.lang.String component5)
Set the component 5 (Session Number).
|
Field257 |
setDate(java.util.Calendar component2)
Set the Date (component 2) from a Calendar object.
|
Field257 |
setDate(java.lang.String component2)
Set the Date (component 2).
|
Field257 |
setEndTime(java.util.Calendar component4)
Set the End Time (component 4) from a Calendar object.
|
Field257 |
setEndTime(java.lang.String component4)
Set the End Time (component 4).
|
Field257 |
setLTAddress(LogicalTerminalAddress component1)
Set the LT Address (component 1) from a LogicalTerminalAddress object.
|
Field257 |
setLTAddress(java.lang.String component1)
Set the LT Address (component 1).
|
Field257 |
setSessionNumber(java.lang.Long component5)
Set the Session Number (component 5) from a Long object.
|
Field257 |
setSessionNumber(java.lang.Number component5)
Alternative method setter for field's Session Number (component 5) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field257 |
setSessionNumber(java.lang.String component5)
Set the Session Number (component 5).
|
Field257 |
setStartTime(java.util.Calendar component3)
Set the Start Time (component 3) from a Calendar object.
|
Field257 |
setStartTime(java.lang.String component3)
Set the Start Time (component 3).
|
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
|
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
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_257
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer LT_ADDRESS
public static final java.lang.Integer DATE
public static final java.lang.Integer START_TIME
public static final java.lang.Integer END_TIME
public static final java.lang.Integer SESSION_NUMBER
public Field257()
public Field257(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field257(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field257 newInstance(Field257 source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
getValueDisplay
in class Field
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is usedjava.lang.IllegalArgumentException
- if component number is invalid for the field@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
public java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public java.lang.String getComponent1()
public LogicalTerminalAddress getComponent1AsLogicalTerminalAddress()
public java.lang.String getLTAddress()
public LogicalTerminalAddress getLTAddressAsLogicalTerminalAddress()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public java.lang.String getComponent3()
public java.util.Calendar getComponent3AsCalendar()
public java.lang.String getStartTime()
public java.util.Calendar getStartTimeAsCalendar()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getEndTime()
public java.util.Calendar getEndTimeAsCalendar()
public java.lang.String getComponent5()
public java.lang.Long getComponent5AsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent5AsNumber()
getComponent5AsLong()
to get the proper value.getComponent5AsLong()
public java.lang.String getSessionNumber()
public java.lang.Long getSessionNumberAsLong()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getSessionNumberAsNumber()
getComponent5AsLong()
to get the proper value.getSessionNumberAsLong()
public Field257 setComponent1(java.lang.String component1)
component1
- the LT Address to setpublic Field257 setComponent1(LogicalTerminalAddress component1)
component1
- the LogicalTerminalAddress with the LT Address content to setpublic Field257 setLTAddress(java.lang.String component1)
component1
- the LT Address to setpublic Field257 setLTAddress(LogicalTerminalAddress component1)
component1
- LogicalTerminalAddress with the LT Address content to setsetComponent1(com.prowidesoftware.swift.model.LogicalTerminalAddress)
public Field257 setComponent2(java.lang.String component2)
component2
- the Date to setpublic Field257 setComponent2(java.util.Calendar component2)
component2
- the Calendar with the Date content to setpublic Field257 setDate(java.lang.String component2)
component2
- the Date to setpublic Field257 setDate(java.util.Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public Field257 setComponent3(java.lang.String component3)
component3
- the Start Time to setpublic Field257 setComponent3(java.util.Calendar component3)
component3
- the Calendar with the Start Time content to setpublic Field257 setStartTime(java.lang.String component3)
component3
- the Start Time to setpublic Field257 setStartTime(java.util.Calendar component3)
component3
- Calendar with the Start Time content to setsetComponent3(java.util.Calendar)
public Field257 setComponent4(java.lang.String component4)
component4
- the End Time to setpublic Field257 setComponent4(java.util.Calendar component4)
component4
- the Calendar with the End Time content to setpublic Field257 setEndTime(java.lang.String component4)
component4
- the End Time to setpublic Field257 setEndTime(java.util.Calendar component4)
component4
- Calendar with the End Time content to setsetComponent4(java.util.Calendar)
public Field257 setComponent5(java.lang.String component5)
component5
- the Session Number to setpublic Field257 setComponent5(java.lang.Long component5)
component5
- the Long with the Session Number content to setsetComponent5(String)
public Field257 setComponent5(java.lang.Number component5)
component5
- the Number with the Session Number content to setsetSessionNumber(java.lang.Long)
public Field257 setSessionNumber(java.lang.String component5)
component5
- the Session Number to setpublic Field257 setSessionNumber(java.lang.Long component5)
component5
- Long with the Session Number content to setsetComponent5(java.lang.Long)
public Field257 setSessionNumber(java.lang.Number component5)
component5
- the Number with the Session Number content to setsetSessionNumber(java.lang.Long)
public java.util.List<java.util.Calendar> dates()
dates
in interface DateContainer
public java.util.Calendar date()
public java.lang.String getName()
public static Field257 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field257 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field257> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field257> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field257 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)