@Generated public class Field259 extends Field implements java.io.Serializable, DateContainer
Model and parser for field 259 of a SWIFT MT message.
Subfields (components) Data types
LogicalTerminalAddress
Number
Number
Calendar
Calendar
Calendar
Structure definition
<LT>4!n1!n<DATE2><HHMM><HHMM>
<LT>4!Nc<DATE2><HHMM><HHMM>
ZNNEHH
This class complies with standard release SRU2020
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_259
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_CATEGORY
Component number for the Message Category subfield
|
static java.lang.String |
NAME
Constant with the field name 259
|
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
|
components
Constructor and Description |
---|
Field259()
Default constructor.
|
Field259(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field259(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()
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 Field259 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field259 object.
|
static Field259 |
get(SwiftMessage msg)
Gets the first instance of Field259 in the given message.
|
static Field259 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field259> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field259 in the given message
an empty list is returned if none found.
|
static java.util.List<Field259> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field259 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 Category).
|
java.lang.Number |
getComponent3AsNumber()
Get the component 3 as Number
|
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 |
getMessageCategory()
Gets the Message Category (component 3).
|
java.lang.Number |
getMessageCategoryAsNumber()
Get the Message Category (component 3) as Number
|
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 Field259 |
newInstance(Field259 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
|
Field259 |
setComponent1(LogicalTerminalAddress component1)
Set the component1 from a LogicalTerminalAddress object.
|
Field259 |
setComponent1(java.lang.String component1)
Set the component1 (LT Address).
|
Field259 |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field259 |
setComponent2(java.lang.String component2)
Set the component2 (Session Number).
|
Field259 |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field259 |
setComponent3(java.lang.String component3)
Set the component3 (Message Category).
|
Field259 |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field259 |
setComponent4(java.lang.String component4)
Set the component4 (Date).
|
Field259 |
setComponent5(java.util.Calendar component5)
Set the component5 from a Calendar object.
|
Field259 |
setComponent5(java.lang.String component5)
Set the component5 (Start Time).
|
Field259 |
setComponent6(java.util.Calendar component6)
Set the component6 from a Calendar object.
|
Field259 |
setComponent6(java.lang.String component6)
Set the component6 (End Time).
|
Field259 |
setDate(java.util.Calendar component4)
Set the Date (component4) from a Calendar object.
|
Field259 |
setDate(java.lang.String component4)
Set the Date (component4).
|
Field259 |
setEndTime(java.util.Calendar component6)
Set the End Time (component6) from a Calendar object.
|
Field259 |
setEndTime(java.lang.String component6)
Set the End Time (component6).
|
Field259 |
setLTAddress(LogicalTerminalAddress component1)
Set the LT Address (component1) from a LogicalTerminalAddress object.
|
Field259 |
setLTAddress(java.lang.String component1)
Set the LT Address (component1).
|
Field259 |
setMessageCategory(java.lang.Number component3)
Set the Message Category (component3) from a Number object.
|
Field259 |
setMessageCategory(java.lang.String component3)
Set the Message Category (component3).
|
Field259 |
setSessionNumber(java.lang.Number component2)
Set the Session Number (component2) from a Number object.
|
Field259 |
setSessionNumber(java.lang.String component2)
Set the Session Number (component2).
|
Field259 |
setStartTime(java.util.Calendar component5)
Set the Start Time (component5) from a Calendar object.
|
Field259 |
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
|
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
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_259
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer LT_ADDRESS
public static final java.lang.Integer SESSION_NUMBER
public static final java.lang.Integer MESSAGE_CATEGORY
public static final java.lang.Integer DATE
public static final java.lang.Integer START_TIME
public static final java.lang.Integer END_TIME
public Field259()
public Field259(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field259(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field259 newInstance(Field259 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 fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final 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
protected 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.lang.Number getComponent2AsNumber()
public java.lang.String getSessionNumber()
public java.lang.Number getSessionNumberAsNumber()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getMessageCategory()
public java.lang.Number getMessageCategoryAsNumber()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public java.lang.String getComponent5()
public java.util.Calendar getComponent5AsCalendar()
public java.lang.String getStartTime()
public java.util.Calendar getStartTimeAsCalendar()
public java.lang.String getComponent6()
public java.util.Calendar getComponent6AsCalendar()
public java.lang.String getEndTime()
public java.util.Calendar getEndTimeAsCalendar()
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public Field259 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field259 setComponent1(LogicalTerminalAddress component1)
component1
- the LogicalTerminalAddress with the component1 content to setpublic Field259 setLTAddress(java.lang.String component1)
component1
- the LT Address to setpublic Field259 setLTAddress(LogicalTerminalAddress component1)
component1
- LogicalTerminalAddress with the LT Address content to setsetComponent1(com.prowidesoftware.swift.model.LogicalTerminalAddress)
public Field259 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field259 setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field259 setSessionNumber(java.lang.String component2)
component2
- the Session Number to setpublic Field259 setSessionNumber(java.lang.Number component2)
component2
- Number with the Session Number content to setsetComponent2(java.lang.Number)
public Field259 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field259 setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field259 setMessageCategory(java.lang.String component3)
component3
- the Message Category to setpublic Field259 setMessageCategory(java.lang.Number component3)
component3
- Number with the Message Category content to setsetComponent3(java.lang.Number)
public Field259 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field259 setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field259 setDate(java.lang.String component4)
component4
- the Date to setpublic Field259 setDate(java.util.Calendar component4)
component4
- Calendar with the Date content to setsetComponent4(java.util.Calendar)
public Field259 setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field259 setComponent5(java.util.Calendar component5)
component5
- the Calendar with the component5 content to setpublic Field259 setStartTime(java.lang.String component5)
component5
- the Start Time to setpublic Field259 setStartTime(java.util.Calendar component5)
component5
- Calendar with the Start Time content to setsetComponent5(java.util.Calendar)
public Field259 setComponent6(java.lang.String component6)
component6
- the component6 to setpublic Field259 setComponent6(java.util.Calendar component6)
component6
- the Calendar with the component6 content to setpublic Field259 setEndTime(java.lang.String component6)
component6
- the End Time to setpublic Field259 setEndTime(java.util.Calendar component6)
component6
- Calendar with the End Time content to setsetComponent6(java.util.Calendar)
public java.lang.String getName()
public static Field259 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field259 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field259> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field259> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field259 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)