@Generated public class Field331 extends Field implements Serializable, DateContainer
Number
Calendar
Calendar
Calendar
Calendar
Number
Number
Number
Number
Number
Number
Number
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
DATE_SESSION_CLOSED
Component number for the Date Session Closed subfield
|
static Integer |
DATE_SESSION_OPENED
Component number for the Date Session Opened subfield
|
static String |
F_331
same as NAME, intended to be clear when using static imports
|
static Integer |
FIRST_INPUT_SEQUENCE_NUMBER
Component number for the First Input Sequence Number subfield
|
static Integer |
FIRST_OUTPUT_SEQUENCE_NUMBER
Component number for the First Output Sequence Number subfield
|
static Integer |
LAST_INPUT_SEQUENCE_NUMBER
Component number for the Last Input Sequence Number subfield
|
static Integer |
LAST_OUTPUT_SEQUENCE_NUMBER
Component number for the Last Output Sequence Number subfield
|
static String |
NAME
Constant with the field name 331
|
static String |
PARSER_PATTERN |
static Integer |
QUANTITY_OF_MESSAGES_RECEIVED
Component number for the Quantity Of Messages Received subfield
|
static Integer |
QUANTITY_OF_MESSAGES_SENT
Component number for the Quantity Of Messages Sent subfield
|
static Integer |
REASON_FOR_CLOSURE
Component number for the Reason For Closure subfield
|
static Integer |
SESSION_NUMBER
Component number for the Session Number subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
TIME_SESSION_CLOSED
Component number for the Time Session Closed subfield
|
static Integer |
TIME_SESSION_OPENED
Component number for the Time Session Opened subfield
|
components
Constructor and Description |
---|
Field331()
Default constructor.
|
Field331(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field331(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
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. |
List<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 Field331 |
get(SwiftMessage msg)
Get the first instance of Field331 in the given message.
|
static Field331 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field331> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field331 in the given message
an empty list is returned if none found.
|
static List<Field331> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field331 from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent10()
Get the component10
|
Number |
getComponent10AsNumber()
Get the component10 as Number
|
String |
getComponent11()
Get the component11
|
Number |
getComponent11AsNumber()
Get the component11 as Number
|
String |
getComponent12()
Get the component12
|
Number |
getComponent12AsNumber()
Get the component12 as Number
|
Number |
getComponent1AsNumber()
Get the component1 as Number
|
String |
getComponent2()
Get the component2
|
Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
String |
getComponent3()
Get the component3
|
Calendar |
getComponent3AsCalendar()
Get the component3 as Calendar
|
String |
getComponent4()
Get the component4
|
Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
String |
getComponent5()
Get the component5
|
Calendar |
getComponent5AsCalendar()
Get the component5 as Calendar
|
String |
getComponent6()
Get the component6
|
Number |
getComponent6AsNumber()
Get the component6 as Number
|
String |
getComponent7()
Get the component7
|
Number |
getComponent7AsNumber()
Get the component7 as Number
|
String |
getComponent8()
Get the component8
|
Number |
getComponent8AsNumber()
Get the component8 as Number
|
String |
getComponent9()
Get the component9
|
Number |
getComponent9AsNumber()
Get the component9 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getDateSessionClosed()
Get the Date Session Closed (component4).
|
Calendar |
getDateSessionClosedAsCalendar()
Get the Date Session Closed (component4) as Calendar
|
String |
getDateSessionOpened()
Get the Date Session Opened (component2).
|
Calendar |
getDateSessionOpenedAsCalendar()
Get the Date Session Opened (component2) as Calendar
|
String |
getFirstInputSequenceNumber()
Get the First Input Sequence Number (component9).
|
Number |
getFirstInputSequenceNumberAsNumber()
Get the First Input Sequence Number (component9) as Number
|
String |
getFirstOutputSequenceNumber()
Get the First Output Sequence Number (component11).
|
Number |
getFirstOutputSequenceNumberAsNumber()
Get the First Output Sequence Number (component11) as Number
|
String |
getLastInputSequenceNumber()
Get the Last Input Sequence Number (component10).
|
Number |
getLastInputSequenceNumberAsNumber()
Get the Last Input Sequence Number (component10) as Number
|
String |
getLastOutputSequenceNumber()
Get the Last Output Sequence Number (component12).
|
Number |
getLastOutputSequenceNumberAsNumber()
Get the Last Output Sequence Number (component12) as Number
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getQuantityOfMessagesReceived()
Get the Quantity Of Messages Received (component8).
|
Number |
getQuantityOfMessagesReceivedAsNumber()
Get the Quantity Of Messages Received (component8) as Number
|
String |
getQuantityOfMessagesSent()
Get the Quantity Of Messages Sent (component7).
|
Number |
getQuantityOfMessagesSentAsNumber()
Get the Quantity Of Messages Sent (component7) as Number
|
String |
getReasonForClosure()
Get the Reason For Closure (component6).
|
Number |
getReasonForClosureAsNumber()
Get the Reason For Closure (component6) as Number
|
String |
getSessionNumber()
Get the Session Number (component1).
|
Number |
getSessionNumberAsNumber()
Get the Session Number (component1) as Number
|
String |
getTimeSessionClosed()
Get the Time Session Closed (component5).
|
Calendar |
getTimeSessionClosedAsCalendar()
Get the Time Session Closed (component5) as Calendar
|
String |
getTimeSessionOpened()
Get the Time Session Opened (component3).
|
Calendar |
getTimeSessionOpenedAsCalendar()
Get the Time Session Opened (component3) as Calendar
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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 Field331 |
newInstance(Field331 source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field331 |
setComponent1(Number component1)
Set the component1 from a Number object.
|
Field331 |
setComponent1(String component1)
Set the component1.
|
Field331 |
setComponent10(Number component10)
Set the component10 from a Number object.
|
Field331 |
setComponent10(String component10)
Set the component10.
|
Field331 |
setComponent11(Number component11)
Set the component11 from a Number object.
|
Field331 |
setComponent11(String component11)
Set the component11.
|
Field331 |
setComponent12(Number component12)
Set the component12 from a Number object.
|
Field331 |
setComponent12(String component12)
Set the component12.
|
Field331 |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field331 |
setComponent2(String component2)
Set the component2.
|
Field331 |
setComponent3(Calendar component3)
Set the component3 from a Calendar object.
|
Field331 |
setComponent3(String component3)
Set the component3.
|
Field331 |
setComponent4(Calendar component4)
Set the component4 from a Calendar object.
|
Field331 |
setComponent4(String component4)
Set the component4.
|
Field331 |
setComponent5(Calendar component5)
Set the component5 from a Calendar object.
|
Field331 |
setComponent5(String component5)
Set the component5.
|
Field331 |
setComponent6(Number component6)
Set the component6 from a Number object.
|
Field331 |
setComponent6(String component6)
Set the component6.
|
Field331 |
setComponent7(Number component7)
Set the component7 from a Number object.
|
Field331 |
setComponent7(String component7)
Set the component7.
|
Field331 |
setComponent8(Number component8)
Set the component8 from a Number object.
|
Field331 |
setComponent8(String component8)
Set the component8.
|
Field331 |
setComponent9(Number component9)
Set the component9 from a Number object.
|
Field331 |
setComponent9(String component9)
Set the component9.
|
Field331 |
setDateSessionClosed(Calendar component4)
Set the Date Session Closed (component4) from a Calendar object.
|
Field331 |
setDateSessionClosed(String component4)
Set the Date Session Closed (component4).
|
Field331 |
setDateSessionOpened(Calendar component2)
Set the Date Session Opened (component2) from a Calendar object.
|
Field331 |
setDateSessionOpened(String component2)
Set the Date Session Opened (component2).
|
Field331 |
setFirstInputSequenceNumber(Number component9)
Set the First Input Sequence Number (component9) from a Number object.
|
Field331 |
setFirstInputSequenceNumber(String component9)
Set the First Input Sequence Number (component9).
|
Field331 |
setFirstOutputSequenceNumber(Number component11)
Set the First Output Sequence Number (component11) from a Number object.
|
Field331 |
setFirstOutputSequenceNumber(String component11)
Set the First Output Sequence Number (component11).
|
Field331 |
setLastInputSequenceNumber(Number component10)
Set the Last Input Sequence Number (component10) from a Number object.
|
Field331 |
setLastInputSequenceNumber(String component10)
Set the Last Input Sequence Number (component10).
|
Field331 |
setLastOutputSequenceNumber(Number component12)
Set the Last Output Sequence Number (component12) from a Number object.
|
Field331 |
setLastOutputSequenceNumber(String component12)
Set the Last Output Sequence Number (component12).
|
Field331 |
setQuantityOfMessagesReceived(Number component8)
Set the Quantity Of Messages Received (component8) from a Number object.
|
Field331 |
setQuantityOfMessagesReceived(String component8)
Set the Quantity Of Messages Received (component8).
|
Field331 |
setQuantityOfMessagesSent(Number component7)
Set the Quantity Of Messages Sent (component7) from a Number object.
|
Field331 |
setQuantityOfMessagesSent(String component7)
Set the Quantity Of Messages Sent (component7).
|
Field331 |
setReasonForClosure(Number component6)
Set the Reason For Closure (component6) from a Number object.
|
Field331 |
setReasonForClosure(String component6)
Set the Reason For Closure (component6).
|
Field331 |
setSessionNumber(Number component1)
Set the Session Number (component1) from a Number object.
|
Field331 |
setSessionNumber(String component1)
Set the Session Number (component1).
|
Field331 |
setTimeSessionClosed(Calendar component5)
Set the Time Session Closed (component5) from a Calendar object.
|
Field331 |
setTimeSessionClosed(String component5)
Set the Time Session Closed (component5).
|
Field331 |
setTimeSessionOpened(Calendar component3)
Set the Time Session Opened (component3) from a Calendar object.
|
Field331 |
setTimeSessionOpened(String component3)
Set the Time Session Opened (component3).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
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, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_331
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer SESSION_NUMBER
public static final Integer DATE_SESSION_OPENED
public static final Integer TIME_SESSION_OPENED
public static final Integer DATE_SESSION_CLOSED
public static final Integer TIME_SESSION_CLOSED
public static final Integer REASON_FOR_CLOSURE
public static final Integer QUANTITY_OF_MESSAGES_SENT
public static final Integer QUANTITY_OF_MESSAGES_RECEIVED
public static final Integer FIRST_INPUT_SEQUENCE_NUMBER
public static final Integer LAST_INPUT_SEQUENCE_NUMBER
public static final Integer FIRST_OUTPUT_SEQUENCE_NUMBER
public static final Integer LAST_OUTPUT_SEQUENCE_NUMBER
public Field331()
public Field331(String value)
value
- complete field value including separators and CRLFpublic Field331(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field331 newInstance(Field331 source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
public Number getComponent1AsNumber()
null
if cannot be convertedpublic String getSessionNumber()
public Number getSessionNumberAsNumber()
null
if cannot be convertedpublic Field331 setComponent1(String component1)
component1
- the component1 to setpublic Field331 setComponent1(Number component1)
component1
- the Number with the component1 content to setsetComponent1(String)
public Field331 setSessionNumber(String component1)
component1
- the Session Number to setpublic Field331 setSessionNumber(Number component1)
component1
- Number with the Session Number content to setsetComponent1(java.lang.Number)
public String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getDateSessionOpened()
public Calendar getDateSessionOpenedAsCalendar()
null
if cannot be convertedpublic Field331 setComponent2(String component2)
component2
- the component2 to setpublic Field331 setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field331 setDateSessionOpened(String component2)
component2
- the Date Session Opened to setpublic Field331 setDateSessionOpened(Calendar component2)
component2
- Calendar with the Date Session Opened content to setsetComponent2(java.util.Calendar)
public String getComponent3()
public Calendar getComponent3AsCalendar()
null
if cannot be convertedpublic String getTimeSessionOpened()
public Calendar getTimeSessionOpenedAsCalendar()
null
if cannot be convertedpublic Field331 setComponent3(String component3)
component3
- the component3 to setpublic Field331 setComponent3(Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field331 setTimeSessionOpened(String component3)
component3
- the Time Session Opened to setpublic Field331 setTimeSessionOpened(Calendar component3)
component3
- Calendar with the Time Session Opened content to setsetComponent3(java.util.Calendar)
public String getComponent4()
public Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic String getDateSessionClosed()
public Calendar getDateSessionClosedAsCalendar()
null
if cannot be convertedpublic Field331 setComponent4(String component4)
component4
- the component4 to setpublic Field331 setComponent4(Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field331 setDateSessionClosed(String component4)
component4
- the Date Session Closed to setpublic Field331 setDateSessionClosed(Calendar component4)
component4
- Calendar with the Date Session Closed content to setsetComponent4(java.util.Calendar)
public String getComponent5()
public Calendar getComponent5AsCalendar()
null
if cannot be convertedpublic String getTimeSessionClosed()
public Calendar getTimeSessionClosedAsCalendar()
null
if cannot be convertedpublic Field331 setComponent5(String component5)
component5
- the component5 to setpublic Field331 setComponent5(Calendar component5)
component5
- the Calendar with the component5 content to setpublic Field331 setTimeSessionClosed(String component5)
component5
- the Time Session Closed to setpublic Field331 setTimeSessionClosed(Calendar component5)
component5
- Calendar with the Time Session Closed content to setsetComponent5(java.util.Calendar)
public String getComponent6()
public Number getComponent6AsNumber()
null
if cannot be convertedpublic String getReasonForClosure()
public Number getReasonForClosureAsNumber()
null
if cannot be convertedpublic Field331 setComponent6(String component6)
component6
- the component6 to setpublic Field331 setComponent6(Number component6)
component6
- the Number with the component6 content to setsetComponent6(String)
public Field331 setReasonForClosure(String component6)
component6
- the Reason For Closure to setpublic Field331 setReasonForClosure(Number component6)
component6
- Number with the Reason For Closure content to setsetComponent6(java.lang.Number)
public String getComponent7()
public Number getComponent7AsNumber()
null
if cannot be convertedpublic String getQuantityOfMessagesSent()
public Number getQuantityOfMessagesSentAsNumber()
null
if cannot be convertedpublic Field331 setComponent7(String component7)
component7
- the component7 to setpublic Field331 setComponent7(Number component7)
component7
- the Number with the component7 content to setsetComponent7(String)
public Field331 setQuantityOfMessagesSent(String component7)
component7
- the Quantity Of Messages Sent to setpublic Field331 setQuantityOfMessagesSent(Number component7)
component7
- Number with the Quantity Of Messages Sent content to setsetComponent7(java.lang.Number)
public String getComponent8()
public Number getComponent8AsNumber()
null
if cannot be convertedpublic String getQuantityOfMessagesReceived()
public Number getQuantityOfMessagesReceivedAsNumber()
null
if cannot be convertedpublic Field331 setComponent8(String component8)
component8
- the component8 to setpublic Field331 setComponent8(Number component8)
component8
- the Number with the component8 content to setsetComponent8(String)
public Field331 setQuantityOfMessagesReceived(String component8)
component8
- the Quantity Of Messages Received to setpublic Field331 setQuantityOfMessagesReceived(Number component8)
component8
- Number with the Quantity Of Messages Received content to setsetComponent8(java.lang.Number)
public String getComponent9()
public Number getComponent9AsNumber()
null
if cannot be convertedpublic String getFirstInputSequenceNumber()
public Number getFirstInputSequenceNumberAsNumber()
null
if cannot be convertedpublic Field331 setComponent9(String component9)
component9
- the component9 to setpublic Field331 setComponent9(Number component9)
component9
- the Number with the component9 content to setsetComponent9(String)
public Field331 setFirstInputSequenceNumber(String component9)
component9
- the First Input Sequence Number to setpublic Field331 setFirstInputSequenceNumber(Number component9)
component9
- Number with the First Input Sequence Number content to setsetComponent9(java.lang.Number)
public String getComponent10()
public Number getComponent10AsNumber()
null
if cannot be convertedpublic String getLastInputSequenceNumber()
public Number getLastInputSequenceNumberAsNumber()
null
if cannot be convertedpublic Field331 setComponent10(String component10)
component10
- the component10 to setpublic Field331 setComponent10(Number component10)
component10
- the Number with the component10 content to setsetComponent10(String)
public Field331 setLastInputSequenceNumber(String component10)
component10
- the Last Input Sequence Number to setpublic Field331 setLastInputSequenceNumber(Number component10)
component10
- Number with the Last Input Sequence Number content to setsetComponent10(java.lang.Number)
public String getComponent11()
public Number getComponent11AsNumber()
null
if cannot be convertedpublic String getFirstOutputSequenceNumber()
public Number getFirstOutputSequenceNumberAsNumber()
null
if cannot be convertedpublic Field331 setComponent11(String component11)
component11
- the component11 to setpublic Field331 setComponent11(Number component11)
component11
- the Number with the component11 content to setsetComponent11(String)
public Field331 setFirstOutputSequenceNumber(String component11)
component11
- the First Output Sequence Number to setpublic Field331 setFirstOutputSequenceNumber(Number component11)
component11
- Number with the First Output Sequence Number content to setsetComponent11(java.lang.Number)
public String getComponent12()
public Number getComponent12AsNumber()
null
if cannot be convertedpublic String getLastOutputSequenceNumber()
public Number getLastOutputSequenceNumberAsNumber()
null
if cannot be convertedpublic Field331 setComponent12(String component12)
component12
- the component12 to setpublic Field331 setComponent12(Number component12)
component12
- the Number with the component12 content to setsetComponent12(String)
public Field331 setLastOutputSequenceNumber(String component12)
component12
- the Last Output Sequence Number to setpublic Field331 setLastOutputSequenceNumber(Number component12)
component12
- Number with the Last Output Sequence Number content to setsetComponent12(java.lang.Number)
public List<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 String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
public static Field331 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field331 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field331> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field331> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)