@Generated public class Field69B extends Field implements java.io.Serializable, DateContainer, GenericField
Model and parser for field 69B of a SWIFT MT message.
Subfields (components) Data types
String
Calendar
Calendar
Calendar
Calendar
Structure definition
:4!c//<DATE4><TIME2>/<DATE4><TIME2>
:S//<DATE4><TIME2>/<DATE4><TIME2>
SDTDT
This class complies with standard release SRU2023
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.
|
static java.lang.Integer |
DATE1
Component number for the Date1 subfield.
|
static java.lang.Integer |
DATE2
Component number for the Date2 subfield.
|
static java.lang.Integer |
END_DATE
Deprecated.
use #DATE2 instead
|
static java.lang.Integer |
END_TIME
Deprecated.
use #TIME2 instead
|
static java.lang.String |
F_69B
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 69B.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.Integer |
START_DATE
Deprecated.
use #DATE1 instead
|
static java.lang.Integer |
START_TIME
Deprecated.
use #TIME1 instead
|
static java.lang.Integer |
TIME1
Component number for the Time1 subfield.
|
static java.lang.Integer |
TIME2
Component number for the Time2 subfield.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components, labelMap
Constructor and Description |
---|
Field69B()
Default constructor.
|
Field69B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field69B(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 Field69B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field69B object.
|
static Field69B |
get(SwiftMessage msg)
Gets the first instance of Field69B in the given message.
|
static Field69B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field69B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field69B in the given message
an empty list is returned if none found.
|
static java.util.List<Field69B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field69B from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (Date1).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Time1).
|
java.util.Calendar |
getComponent3AsCalendar()
Get the component 3 as Calendar
|
java.lang.String |
getComponent4()
Gets the component 4 (Date2).
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component 4 as Calendar
|
java.lang.String |
getComponent5()
Gets the component 5 (Time2).
|
java.util.Calendar |
getComponent5AsCalendar()
Get the component 5 as Calendar
|
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 |
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.
|
java.lang.String |
getDate1()
Gets the Date1 (component 2).
|
java.util.Calendar |
getDate1AsCalendar()
Get the Date1 (component 2) as Calendar
|
java.lang.String |
getDate2()
Gets the Date2 (component 4).
|
java.util.Calendar |
getDate2AsCalendar()
Get the Date2 (component 4) as Calendar
|
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getEndDate()
Deprecated.
use #getDate2() instead
|
java.util.Calendar |
getEndDateAsCalendar()
Deprecated.
use #getDate2AsCalendar() instead
|
java.lang.String |
getEndTime()
Deprecated.
use #getTime2() instead
|
java.util.Calendar |
getEndTimeAsCalendar()
Deprecated.
use #getTime2AsCalendar() instead
|
protected 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 |
getQualifier()
Gets the Qualifier (component 1).
|
java.lang.String |
getStartDate()
Deprecated.
use #getDate1() instead
|
java.util.Calendar |
getStartDateAsCalendar()
Deprecated.
use #getDate1AsCalendar() instead
|
java.lang.String |
getStartTime()
Deprecated.
use #getTime1() instead
|
java.util.Calendar |
getStartTimeAsCalendar()
Deprecated.
use #getTime1AsCalendar() instead
|
java.lang.String |
getTime1()
Gets the Time1 (component 3).
|
java.util.Calendar |
getTime1AsCalendar()
Get the Time1 (component 3) as Calendar
|
java.lang.String |
getTime2()
Gets the Time2 (component 5).
|
java.util.Calendar |
getTime2AsCalendar()
Get the Time2 (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 |
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.
|
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 Field69B |
newInstance(Field69B 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.
|
Field69B |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field69B |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field69B |
setComponent2(java.lang.String component2)
Set the component 2 (Date1).
|
Field69B |
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.
|
Field69B |
setComponent3(java.lang.String component3)
Set the component 3 (Time1).
|
Field69B |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field69B |
setComponent4(java.lang.String component4)
Set the component 4 (Date2).
|
Field69B |
setComponent5(java.util.Calendar component5)
Set the component5 from a Calendar object.
|
Field69B |
setComponent5(java.lang.String component5)
Set the component 5 (Time2).
|
Field69B |
setDate1(java.util.Calendar component2)
Set the Date1 (component 2) from a Calendar object.
|
Field69B |
setDate1(java.lang.String component2)
Set the Date1 (component 2).
|
Field69B |
setDate2(java.util.Calendar component4)
Set the Date2 (component 4) from a Calendar object.
|
Field69B |
setDate2(java.lang.String component4)
Set the Date2 (component 4).
|
Field69B |
setEndDate(java.util.Calendar component4)
Deprecated.
use #setComponent4(java.util.Calendar) instead
|
Field69B |
setEndDate(java.lang.String component4)
Deprecated.
use #setDate2(String) instead
|
Field69B |
setEndTime(java.util.Calendar component5)
Deprecated.
use #setComponent5(java.util.Calendar) instead
|
Field69B |
setEndTime(java.lang.String component5)
Deprecated.
use #setTime2(String) instead
|
Field69B |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
Field69B |
setStartDate(java.util.Calendar component2)
Deprecated.
use #setComponent2(java.util.Calendar) instead
|
Field69B |
setStartDate(java.lang.String component2)
Deprecated.
use #setDate1(String) instead
|
Field69B |
setStartTime(java.util.Calendar component3)
Deprecated.
use #setComponent3(java.util.Calendar) instead
|
Field69B |
setStartTime(java.lang.String component3)
Deprecated.
use #setTime1(String) instead
|
Field69B |
setTime1(java.util.Calendar component3)
Set the Time1 (component 3) from a Calendar object.
|
Field69B |
setTime1(java.lang.String component3)
Set the Time1 (component 3).
|
Field69B |
setTime2(java.util.Calendar component5)
Set the Time2 (component 5) from a Calendar object.
|
Field69B |
setTime2(java.lang.String component5)
Set the Time2 (component 5).
|
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, 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
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_69B
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer DATE1
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer START_DATE
public static final java.lang.Integer TIME1
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer START_TIME
public static final java.lang.Integer DATE2
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer END_DATE
public static final java.lang.Integer TIME2
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer END_TIME
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field69B()
public Field69B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field69B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field69B newInstance(Field69B 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(phase4=SRU2024) 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getDate1()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getStartDate()
public java.util.Calendar getDate1AsCalendar()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getStartDateAsCalendar()
public java.lang.String getComponent3()
public java.util.Calendar getComponent3AsCalendar()
public java.lang.String getTime1()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getStartTime()
public java.util.Calendar getTime1AsCalendar()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getStartTimeAsCalendar()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getDate2()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getEndDate()
public java.util.Calendar getDate2AsCalendar()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getEndDateAsCalendar()
public java.lang.String getComponent5()
public java.util.Calendar getComponent5AsCalendar()
public java.lang.String getTime2()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getEndTime()
public java.util.Calendar getTime2AsCalendar()
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.util.Calendar getEndTimeAsCalendar()
public Field69B setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field69B setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field69B setComponent2(java.lang.String component2)
component2
- the Date1 to setpublic Field69B setComponent2(java.util.Calendar component2)
component2
- the Calendar with the Date1 content to setpublic Field69B setDate1(java.lang.String component2)
component2
- the Date1 to setpublic Field69B setDate1(java.util.Calendar component2)
component2
- Calendar with the Date1 content to setsetComponent2(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setStartDate(java.lang.String component2)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setStartDate(java.util.Calendar component2)
public Field69B setComponent3(java.lang.String component3)
component3
- the Time1 to setpublic Field69B setComponent3(java.util.Calendar component3)
component3
- the Calendar with the Time1 content to setpublic Field69B setTime1(java.lang.String component3)
component3
- the Time1 to setpublic Field69B setTime1(java.util.Calendar component3)
component3
- Calendar with the Time1 content to setsetComponent3(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setStartTime(java.lang.String component3)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setStartTime(java.util.Calendar component3)
public Field69B setComponent4(java.lang.String component4)
component4
- the Date2 to setpublic Field69B setComponent4(java.util.Calendar component4)
component4
- the Calendar with the Date2 content to setpublic Field69B setDate2(java.lang.String component4)
component4
- the Date2 to setpublic Field69B setDate2(java.util.Calendar component4)
component4
- Calendar with the Date2 content to setsetComponent4(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setEndDate(java.lang.String component4)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setEndDate(java.util.Calendar component4)
public Field69B setComponent5(java.lang.String component5)
component5
- the Time2 to setpublic Field69B setComponent5(java.util.Calendar component5)
component5
- the Calendar with the Time2 content to setpublic Field69B setTime2(java.lang.String component5)
component5
- the Time2 to setpublic Field69B setTime2(java.util.Calendar component5)
component5
- Calendar with the Time2 content to setsetComponent5(java.util.Calendar)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setEndTime(java.lang.String component5)
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field69B setEndTime(java.util.Calendar component5)
public java.util.List<java.util.Calendar> dates()
dates
in interface DateContainer
public java.util.Calendar date()
public java.lang.String getDSS()
getDSS
in interface GenericField
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
public java.lang.String getName()
public static Field69B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field69B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field69B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field69B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field69B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)