@Generated public class Field258 extends Field implements java.io.Serializable, DateContainer
LogicalTerminalAddress
Number
Number
Calendar
Calendar
Calendar
<LT>4!n<MT><DATE2>[<HHMM><HHMM>]
<LT>4!N<MT><DATE2>[<HHMM><HHMM>]
ZNMEHH
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
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_258
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_TYPE
Component number for the Message Type subfield
|
static java.lang.String |
NAME
Constant with the field name 258
|
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 |
---|
Field258()
Default constructor.
|
Field258(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field258(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's 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 Field258 |
get(SwiftMessage msg)
Get the first instance of Field258 in the given message.
|
static Field258 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field258> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field258 in the given message
an empty list is returned if none found.
|
static java.util.List<Field258> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field258 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Get the component1
|
LogicalTerminalAddress |
getComponent1AsLogicalTerminalAddress()
Get the component1 as LogicalTerminalAddress
|
java.lang.String |
getComponent2()
Get the component2
|
java.lang.Number |
getComponent2AsNumber()
Get the component2 as Number
|
java.lang.String |
getComponent3()
Get the component3
|
java.lang.String |
getComponent4()
Get the component4
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
java.lang.String |
getComponent5()
Get the component5
|
java.util.Calendar |
getComponent5AsCalendar()
Get the component5 as Calendar
|
java.lang.String |
getComponent6()
Get the component6
|
java.util.Calendar |
getComponent6AsCalendar()
Get the component6 as Calendar
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
java.lang.String |
getDate()
Get the Date (component4).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component4) as Calendar
|
java.lang.String |
getEndTime()
Get the End Time (component6).
|
java.util.Calendar |
getEndTimeAsCalendar()
Get the End Time (component6) as Calendar
|
java.lang.String |
getLTAddress()
Get the LT Address (component1).
|
LogicalTerminalAddress |
getLTAddressAsLogicalTerminalAddress()
Get the LT Address (component1) as LogicalTerminalAddress
|
java.lang.String |
getMessageType()
Get the Message Type (component3).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getSessionNumber()
Get the Session Number (component2).
|
java.lang.Number |
getSessionNumberAsNumber()
Get the Session Number (component2) as Number
|
java.lang.String |
getStartTime()
Get the Start Time (component5).
|
java.util.Calendar |
getStartTimeAsCalendar()
Get the Start Time (component5) 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 Field258 |
newInstance(Field258 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() |
Field258 |
setComponent1(LogicalTerminalAddress component1)
Set the component1 from a LogicalTerminalAddress object.
|
Field258 |
setComponent1(java.lang.String component1)
Set the component1.
|
Field258 |
setComponent2(java.lang.Number component2)
Set the component2 from a Number object.
|
Field258 |
setComponent2(java.lang.String component2)
Set the component2.
|
Field258 |
setComponent3(java.lang.String component3)
Set the component3.
|
Field258 |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field258 |
setComponent4(java.lang.String component4)
Set the component4.
|
Field258 |
setComponent5(java.util.Calendar component5)
Set the component5 from a Calendar object.
|
Field258 |
setComponent5(java.lang.String component5)
Set the component5.
|
Field258 |
setComponent6(java.util.Calendar component6)
Set the component6 from a Calendar object.
|
Field258 |
setComponent6(java.lang.String component6)
Set the component6.
|
Field258 |
setDate(java.util.Calendar component4)
Set the Date (component4) from a Calendar object.
|
Field258 |
setDate(java.lang.String component4)
Set the Date (component4).
|
Field258 |
setEndTime(java.util.Calendar component6)
Set the End Time (component6) from a Calendar object.
|
Field258 |
setEndTime(java.lang.String component6)
Set the End Time (component6).
|
Field258 |
setLTAddress(LogicalTerminalAddress component1)
Set the LT Address (component1) from a LogicalTerminalAddress object.
|
Field258 |
setLTAddress(java.lang.String component1)
Set the LT Address (component1).
|
Field258 |
setMessageType(java.lang.String component3)
Set the Message Type (component3).
|
Field258 |
setSessionNumber(java.lang.Number component2)
Set the Session Number (component2) from a Number object.
|
Field258 |
setSessionNumber(java.lang.String component2)
Set the Session Number (component2).
|
Field258 |
setStartTime(java.util.Calendar component5)
Set the Start Time (component5) from a Calendar object.
|
Field258 |
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's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_258
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_TYPE
public static final java.lang.Integer DATE
public static final java.lang.Integer START_TIME
public static final java.lang.Integer END_TIME
public Field258()
public Field258(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field258(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field258 newInstance(Field258 source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
public LogicalTerminalAddress getComponent1AsLogicalTerminalAddress()
null
if cannot be convertedpublic java.lang.String getLTAddress()
public LogicalTerminalAddress getLTAddressAsLogicalTerminalAddress()
null
if cannot be convertedpublic Field258 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field258 setComponent1(LogicalTerminalAddress component1)
component1
- the LogicalTerminalAddress with the component1 content to setpublic Field258 setLTAddress(java.lang.String component1)
component1
- the LT Address to setpublic Field258 setLTAddress(LogicalTerminalAddress component1)
component1
- LogicalTerminalAddress with the LT Address content to setsetComponent1(com.prowidesoftware.swift.model.LogicalTerminalAddress)
public java.lang.String getComponent2()
public java.lang.Number getComponent2AsNumber()
null
if cannot be convertedpublic java.lang.String getSessionNumber()
public java.lang.Number getSessionNumberAsNumber()
null
if cannot be convertedpublic Field258 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field258 setComponent2(java.lang.Number component2)
component2
- the Number with the component2 content to setsetComponent2(String)
public Field258 setSessionNumber(java.lang.String component2)
component2
- the Session Number to setpublic Field258 setSessionNumber(java.lang.Number component2)
component2
- Number with the Session Number content to setsetComponent2(java.lang.Number)
public java.lang.String getComponent3()
public java.lang.String getMessageType()
public Field258 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field258 setMessageType(java.lang.String component3)
component3
- the Message Type to setpublic java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field258 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field258 setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field258 setDate(java.lang.String component4)
component4
- the Date to setpublic Field258 setDate(java.util.Calendar component4)
component4
- Calendar with the Date content to setsetComponent4(java.util.Calendar)
public java.lang.String getComponent5()
public java.util.Calendar getComponent5AsCalendar()
null
if cannot be convertedpublic java.lang.String getStartTime()
public java.util.Calendar getStartTimeAsCalendar()
null
if cannot be convertedpublic Field258 setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field258 setComponent5(java.util.Calendar component5)
component5
- the Calendar with the component5 content to setpublic Field258 setStartTime(java.lang.String component5)
component5
- the Start Time to setpublic Field258 setStartTime(java.util.Calendar component5)
component5
- Calendar with the Start Time content to setsetComponent5(java.util.Calendar)
public java.lang.String getComponent6()
public java.util.Calendar getComponent6AsCalendar()
null
if cannot be convertedpublic java.lang.String getEndTime()
public java.util.Calendar getEndTimeAsCalendar()
null
if cannot be convertedpublic Field258 setComponent6(java.lang.String component6)
component6
- the component6 to setpublic Field258 setComponent6(java.util.Calendar component6)
component6
- the Calendar with the component6 content to setpublic Field258 setEndTime(java.lang.String component6)
component6
- the End Time to setpublic Field258 setEndTime(java.util.Calendar component6)
component6
- Calendar with the End Time content to setsetComponent6(java.util.Calendar)
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field258 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field258 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field258> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field258> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)