@Generated public class Field333 extends Field implements java.io.Serializable, DateContainer
Model and parser for field 333 of a SWIFT MT message.
Subfields (components) Data types
Calendar
Calendar
Number
Calendar
Calendar
Number
Number
Number
Structure definition
<DATE2><HHMM>4!n<DATE2><HHMM>3!n6!n6!n
<DATE2><HHMM>4!N<DATE2><HHMM>3!N6!N6!N
EHNEHNNN
This class complies with standard release SRU2020
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DATE_LAST_SESSION_CLOSED
Component number for the Date Last Session Closed subfield
|
static java.lang.Integer |
DATE_LAST_SESSION_OPENED
Component number for the Date Last Session Opened subfield
|
static java.lang.String |
F_333
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
LAST_INPUT_SEQUENCE_NUMBER_RECEIVED
Component number for the Last Input Sequence Number Received subfield
|
static java.lang.Integer |
LAST_OUTPUT_SEQUENCE_NUMBER_SENT
Component number for the Last Output Sequence Number Sent subfield
|
static java.lang.String |
NAME
Constant with the field name 333
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
REASON_FOR_CLOSURE
Component number for the Reason For Closure subfield
|
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 |
TIME_LAST_SESSION_CLOSED
Component number for the Time Last Session Closed subfield
|
static java.lang.Integer |
TIME_LAST_SESSION_OPENED
Component number for the Time Last Session Opened subfield
|
components
Constructor and Description |
---|
Field333()
Default constructor.
|
Field333(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field333(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 Field333 |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field333 object.
|
static Field333 |
get(SwiftMessage msg)
Gets the first instance of Field333 in the given message.
|
static Field333 |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field333> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field333 in the given message
an empty list is returned if none found.
|
static java.util.List<Field333> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field333 from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Date Last Session Opened).
|
java.util.Calendar |
getComponent1AsCalendar()
Get the component 1 as Calendar
|
java.lang.String |
getComponent2()
Gets the component 2 (Time Last Session Opened).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Session Number).
|
java.lang.Number |
getComponent3AsNumber()
Get the component 3 as Number
|
java.lang.String |
getComponent4()
Gets the component 4 (Date Last Session Closed).
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component 4 as Calendar
|
java.lang.String |
getComponent5()
Gets the component 5 (Time Last Session Closed).
|
java.util.Calendar |
getComponent5AsCalendar()
Get the component 5 as Calendar
|
java.lang.String |
getComponent6()
Gets the component 6 (Reason For Closure).
|
java.lang.Number |
getComponent6AsNumber()
Get the component 6 as Number
|
java.lang.String |
getComponent7()
Gets the component 7 (Last Input Sequence Number Received).
|
java.lang.Number |
getComponent7AsNumber()
Get the component 7 as Number
|
java.lang.String |
getComponent8()
Gets the component 8 (Last Output Sequence Number Sent).
|
java.lang.Number |
getComponent8AsNumber()
Get the component 8 as Number
|
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 |
getDateLastSessionClosed()
Gets the Date Last Session Closed (component 4).
|
java.util.Calendar |
getDateLastSessionClosedAsCalendar()
Get the Date Last Session Closed (component 4) as Calendar
|
java.lang.String |
getDateLastSessionOpened()
Gets the Date Last Session Opened (component 1).
|
java.util.Calendar |
getDateLastSessionOpenedAsCalendar()
Get the Date Last Session Opened (component 1) as Calendar
|
java.lang.String |
getLastInputSequenceNumberReceived()
Gets the Last Input Sequence Number Received (component 7).
|
java.lang.Number |
getLastInputSequenceNumberReceivedAsNumber()
Get the Last Input Sequence Number Received (component 7) as Number
|
java.lang.String |
getLastOutputSequenceNumberSent()
Gets the Last Output Sequence Number Sent (component 8).
|
java.lang.Number |
getLastOutputSequenceNumberSentAsNumber()
Get the Last Output Sequence Number Sent (component 8) 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 |
getReasonForClosure()
Gets the Reason For Closure (component 6).
|
java.lang.Number |
getReasonForClosureAsNumber()
Get the Reason For Closure (component 6) as Number
|
java.lang.String |
getSessionNumber()
Gets the Session Number (component 3).
|
java.lang.Number |
getSessionNumberAsNumber()
Get the Session Number (component 3) as Number
|
java.lang.String |
getTimeLastSessionClosed()
Gets the Time Last Session Closed (component 5).
|
java.util.Calendar |
getTimeLastSessionClosedAsCalendar()
Get the Time Last Session Closed (component 5) as Calendar
|
java.lang.String |
getTimeLastSessionOpened()
Gets the Time Last Session Opened (component 2).
|
java.util.Calendar |
getTimeLastSessionOpenedAsCalendar()
Get the Time Last Session Opened (component 2) 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 Field333 |
newInstance(Field333 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
|
Field333 |
setComponent1(java.util.Calendar component1)
Set the component1 from a Calendar object.
|
Field333 |
setComponent1(java.lang.String component1)
Set the component1 (Date Last Session Opened).
|
Field333 |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field333 |
setComponent2(java.lang.String component2)
Set the component2 (Time Last Session Opened).
|
Field333 |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field333 |
setComponent3(java.lang.String component3)
Set the component3 (Session Number).
|
Field333 |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field333 |
setComponent4(java.lang.String component4)
Set the component4 (Date Last Session Closed).
|
Field333 |
setComponent5(java.util.Calendar component5)
Set the component5 from a Calendar object.
|
Field333 |
setComponent5(java.lang.String component5)
Set the component5 (Time Last Session Closed).
|
Field333 |
setComponent6(java.lang.Number component6)
Set the component6 from a Number object.
|
Field333 |
setComponent6(java.lang.String component6)
Set the component6 (Reason For Closure).
|
Field333 |
setComponent7(java.lang.Number component7)
Set the component7 from a Number object.
|
Field333 |
setComponent7(java.lang.String component7)
Set the component7 (Last Input Sequence Number Received).
|
Field333 |
setComponent8(java.lang.Number component8)
Set the component8 from a Number object.
|
Field333 |
setComponent8(java.lang.String component8)
Set the component8 (Last Output Sequence Number Sent).
|
Field333 |
setDateLastSessionClosed(java.util.Calendar component4)
Set the Date Last Session Closed (component4) from a Calendar object.
|
Field333 |
setDateLastSessionClosed(java.lang.String component4)
Set the Date Last Session Closed (component4).
|
Field333 |
setDateLastSessionOpened(java.util.Calendar component1)
Set the Date Last Session Opened (component1) from a Calendar object.
|
Field333 |
setDateLastSessionOpened(java.lang.String component1)
Set the Date Last Session Opened (component1).
|
Field333 |
setLastInputSequenceNumberReceived(java.lang.Number component7)
Set the Last Input Sequence Number Received (component7) from a Number object.
|
Field333 |
setLastInputSequenceNumberReceived(java.lang.String component7)
Set the Last Input Sequence Number Received (component7).
|
Field333 |
setLastOutputSequenceNumberSent(java.lang.Number component8)
Set the Last Output Sequence Number Sent (component8) from a Number object.
|
Field333 |
setLastOutputSequenceNumberSent(java.lang.String component8)
Set the Last Output Sequence Number Sent (component8).
|
Field333 |
setReasonForClosure(java.lang.Number component6)
Set the Reason For Closure (component6) from a Number object.
|
Field333 |
setReasonForClosure(java.lang.String component6)
Set the Reason For Closure (component6).
|
Field333 |
setSessionNumber(java.lang.Number component3)
Set the Session Number (component3) from a Number object.
|
Field333 |
setSessionNumber(java.lang.String component3)
Set the Session Number (component3).
|
Field333 |
setTimeLastSessionClosed(java.util.Calendar component5)
Set the Time Last Session Closed (component5) from a Calendar object.
|
Field333 |
setTimeLastSessionClosed(java.lang.String component5)
Set the Time Last Session Closed (component5).
|
Field333 |
setTimeLastSessionOpened(java.util.Calendar component2)
Set the Time Last Session Opened (component2) from a Calendar object.
|
Field333 |
setTimeLastSessionOpened(java.lang.String component2)
Set the Time Last Session Opened (component2).
|
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_333
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DATE_LAST_SESSION_OPENED
public static final java.lang.Integer TIME_LAST_SESSION_OPENED
public static final java.lang.Integer SESSION_NUMBER
public static final java.lang.Integer DATE_LAST_SESSION_CLOSED
public static final java.lang.Integer TIME_LAST_SESSION_CLOSED
public static final java.lang.Integer REASON_FOR_CLOSURE
public static final java.lang.Integer LAST_INPUT_SEQUENCE_NUMBER_RECEIVED
public static final java.lang.Integer LAST_OUTPUT_SEQUENCE_NUMBER_SENT
public Field333()
public Field333(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field333(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field333 newInstance(Field333 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 java.util.Calendar getComponent1AsCalendar()
public java.lang.String getDateLastSessionOpened()
public java.util.Calendar getDateLastSessionOpenedAsCalendar()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getTimeLastSessionOpened()
public java.util.Calendar getTimeLastSessionOpenedAsCalendar()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
public java.lang.String getSessionNumber()
public java.lang.Number getSessionNumberAsNumber()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
public java.lang.String getDateLastSessionClosed()
public java.util.Calendar getDateLastSessionClosedAsCalendar()
public java.lang.String getComponent5()
public java.util.Calendar getComponent5AsCalendar()
public java.lang.String getTimeLastSessionClosed()
public java.util.Calendar getTimeLastSessionClosedAsCalendar()
public java.lang.String getComponent6()
public java.lang.Number getComponent6AsNumber()
public java.lang.String getReasonForClosure()
public java.lang.Number getReasonForClosureAsNumber()
public java.lang.String getComponent7()
public java.lang.Number getComponent7AsNumber()
public java.lang.String getLastInputSequenceNumberReceived()
public java.lang.Number getLastInputSequenceNumberReceivedAsNumber()
public java.lang.String getComponent8()
public java.lang.Number getComponent8AsNumber()
public java.lang.String getLastOutputSequenceNumberSent()
public java.lang.Number getLastOutputSequenceNumberSentAsNumber()
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public Field333 setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field333 setComponent1(java.util.Calendar component1)
component1
- the Calendar with the component1 content to setpublic Field333 setDateLastSessionOpened(java.lang.String component1)
component1
- the Date Last Session Opened to setpublic Field333 setDateLastSessionOpened(java.util.Calendar component1)
component1
- Calendar with the Date Last Session Opened content to setsetComponent1(java.util.Calendar)
public Field333 setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field333 setComponent2(java.util.Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field333 setTimeLastSessionOpened(java.lang.String component2)
component2
- the Time Last Session Opened to setpublic Field333 setTimeLastSessionOpened(java.util.Calendar component2)
component2
- Calendar with the Time Last Session Opened content to setsetComponent2(java.util.Calendar)
public Field333 setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field333 setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field333 setSessionNumber(java.lang.String component3)
component3
- the Session Number to setpublic Field333 setSessionNumber(java.lang.Number component3)
component3
- Number with the Session Number content to setsetComponent3(java.lang.Number)
public Field333 setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field333 setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field333 setDateLastSessionClosed(java.lang.String component4)
component4
- the Date Last Session Closed to setpublic Field333 setDateLastSessionClosed(java.util.Calendar component4)
component4
- Calendar with the Date Last Session Closed content to setsetComponent4(java.util.Calendar)
public Field333 setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field333 setComponent5(java.util.Calendar component5)
component5
- the Calendar with the component5 content to setpublic Field333 setTimeLastSessionClosed(java.lang.String component5)
component5
- the Time Last Session Closed to setpublic Field333 setTimeLastSessionClosed(java.util.Calendar component5)
component5
- Calendar with the Time Last Session Closed content to setsetComponent5(java.util.Calendar)
public Field333 setComponent6(java.lang.String component6)
component6
- the component6 to setpublic Field333 setComponent6(java.lang.Number component6)
component6
- the Number with the component6 content to setsetComponent6(String)
public Field333 setReasonForClosure(java.lang.String component6)
component6
- the Reason For Closure to setpublic Field333 setReasonForClosure(java.lang.Number component6)
component6
- Number with the Reason For Closure content to setsetComponent6(java.lang.Number)
public Field333 setComponent7(java.lang.String component7)
component7
- the component7 to setpublic Field333 setComponent7(java.lang.Number component7)
component7
- the Number with the component7 content to setsetComponent7(String)
public Field333 setLastInputSequenceNumberReceived(java.lang.String component7)
component7
- the Last Input Sequence Number Received to setpublic Field333 setLastInputSequenceNumberReceived(java.lang.Number component7)
component7
- Number with the Last Input Sequence Number Received content to setsetComponent7(java.lang.Number)
public Field333 setComponent8(java.lang.String component8)
component8
- the component8 to setpublic Field333 setComponent8(java.lang.Number component8)
component8
- the Number with the component8 content to setsetComponent8(String)
public Field333 setLastOutputSequenceNumberSent(java.lang.String component8)
component8
- the Last Output Sequence Number Sent to setpublic Field333 setLastOutputSequenceNumberSent(java.lang.Number component8)
component8
- Number with the Last Output Sequence Number Sent content to setsetComponent8(java.lang.Number)
public java.lang.String getName()
public static Field333 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field333 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field333> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field333> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field333 fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)