public class Field98F extends Field implements java.io.Serializable, GenericField
String
String
String
Calendar
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_98F
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 98F
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field98F()
Default constructor
|
Field98F(java.lang.String value)
Creates the field parsing the parameter value into fields' components
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentsPattern() |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field98F |
get(SwiftMessage msg)
Get the first instance of Field98F in the given message.
|
static Field98F |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field98F> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field98F in the given message
an empty list is returned if none found.
|
static java.util.List<Field98F> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field98F from the given block
an empty list is returned if none found.
|
java.lang.String |
getCode()
Get the Code (component3).
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
|
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
|
java.lang.String |
getComponent3()
Get the component3
|
java.lang.String |
getComponent3AsString()
Deprecated.
|
java.lang.String |
getComponent4()
Get the component4
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
java.lang.String |
getConditionalQualifier()
Gets the conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition. |
java.lang.String |
getDataSourceScheme()
Get the Data Source Scheme (component2).
|
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getQualifier()
Get the Qualifier (component1).
|
java.lang.String |
getTime()
Get the Time (component4).
|
java.util.Calendar |
getTimeAsCalendar()
Get the Time (component4) as Calendar
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
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. |
java.lang.String |
parserPattern() |
Field98F |
setCode(java.lang.String component3)
Set the Code (component3).
|
Field98F |
setComponent1(java.lang.String component1)
Set the component1.
|
Field98F |
setComponent2(java.lang.String component2)
Set the component2.
|
Field98F |
setComponent3(java.lang.String component3)
Set the component3.
|
Field98F |
setComponent4(java.util.Calendar component4)
Set the component4.
|
Field98F |
setComponent4(java.lang.String component4)
Set the component4.
|
Field98F |
setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component2).
|
Field98F |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field98F |
setTime(java.util.Calendar component4)
Set the Time (component4) as Calendar
|
Field98F |
setTime(java.lang.String component4)
Set the Time (component4).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.String F_98F
public static final java.lang.String NAME
public static final java.lang.String PARSER_PATTERN
public Field98F()
public Field98F(java.lang.String value)
value
- public java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public static Field98F get(SwiftMessage msg)
msg
- may be empty or null
public static Field98F get(SwiftTagListBlock block)
block
- may be null or emptypublic static java.util.List<Field98F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returned
public static java.util.List<Field98F> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getCode()
public java.lang.String getComponent1()
@Deprecated public java.lang.String getComponent1AsString()
public java.lang.String getComponent2()
@Deprecated public java.lang.String getComponent2AsString()
public java.lang.String getComponent3()
@Deprecated public java.lang.String getComponent3AsString()
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.public java.lang.String getDataSourceScheme()
public java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public java.lang.String getQualifier()
public java.lang.String getTime()
public java.util.Calendar getTimeAsCalendar()
null
if cannot be convertedpublic java.lang.String getValue()
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public boolean isGeneric()
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public Field98F setCode(java.lang.String component3)
component3
- the Code to setpublic Field98F setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field98F setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field98F setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field98F setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field98F setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field98F setDataSourceScheme(java.lang.String component2)
component2
- the Data Source Scheme to setpublic Field98F setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field98F setTime(java.util.Calendar component4)
component4
- Calendar with the Time content to setpublic Field98F setTime(java.lang.String component4)
component4
- the Time to set