@Generated public class Field98K extends Field implements java.io.Serializable, DateContainer, GenericField
String
String
Calendar
Calendar
String
:4!c/8c/<DATE4><TIME2>/34!x(***)
:S/S/<DATE4><TIME2>/S
SSDTS
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 |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.Integer |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield
|
static java.lang.Integer |
DATE
Component number for the Date subfield
|
static java.lang.String |
F_98K
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 98K
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PROPRIETARY_CODE
Component number for the Proprietary Code subfield
|
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 |
TIME
Component number for the Time subfield
|
components
Constructor and Description |
---|
Field98K()
Default constructor.
|
Field98K(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field98K(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 Field98K |
get(SwiftMessage msg)
Get the first instance of Field98K in the given message.
|
static Field98K |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field98K> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field98K in the given message
an empty list is returned if none found.
|
static java.util.List<Field98K> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field98K from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Get the component3
|
java.util.Calendar |
getComponent3AsCalendar()
Get the component3 as Calendar
|
java.lang.String |
getComponent4()
Get the component4
|
java.util.Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
java.lang.String |
getComponent5()
Get the component5
|
java.lang.String |
getComponent5AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
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 |
getDate()
Get the Date (component3).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component3) as Calendar
|
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getProprietaryCode()
Get the Proprietary Code (component5).
|
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)
|
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 Field98K |
newInstance(Field98K 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() |
Field98K |
setComponent1(java.lang.String component1)
Set the component1.
|
Field98K |
setComponent2(java.lang.String component2)
Set the component2.
|
Field98K |
setComponent3(java.util.Calendar component3)
Set the component3 from a Calendar object.
|
Field98K |
setComponent3(java.lang.String component3)
Set the component3.
|
Field98K |
setComponent4(java.util.Calendar component4)
Set the component4 from a Calendar object.
|
Field98K |
setComponent4(java.lang.String component4)
Set the component4.
|
Field98K |
setComponent5(java.lang.String component5)
Set the component5.
|
Field98K |
setDataSourceScheme(java.lang.String component2)
Set the Data Source Scheme (component2).
|
Field98K |
setDate(java.util.Calendar component3)
Set the Date (component3) from a Calendar object.
|
Field98K |
setDate(java.lang.String component3)
Set the Date (component3).
|
Field98K |
setProprietaryCode(java.lang.String component5)
Set the Proprietary Code (component5).
|
Field98K |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field98K |
setTime(java.util.Calendar component4)
Set the Time (component4) from a Calendar object.
|
Field98K |
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.
|
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, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, 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_98K
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer DATA_SOURCE_SCHEME
public static final java.lang.Integer DATE
public static final java.lang.Integer TIME
public static final java.lang.Integer PROPRIETARY_CODE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field98K()
public Field98K(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field98K(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 Field98K newInstance(Field98K 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()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getQualifier()
public Field98K setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field98K setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getDataSourceScheme()
public Field98K setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field98K setDataSourceScheme(java.lang.String component2)
component2
- the Data Source Scheme to setpublic java.lang.String getComponent3()
public java.util.Calendar getComponent3AsCalendar()
null
if cannot be convertedpublic java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field98K setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field98K setComponent3(java.util.Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field98K setDate(java.lang.String component3)
component3
- the Date to setpublic Field98K setDate(java.util.Calendar component3)
component3
- Calendar with the Date content to setsetComponent3(java.util.Calendar)
public java.lang.String getComponent4()
public java.util.Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic java.lang.String getTime()
public java.util.Calendar getTimeAsCalendar()
null
if cannot be convertedpublic Field98K setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field98K setComponent4(java.util.Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field98K setTime(java.lang.String component4)
component4
- the Time to setpublic Field98K setTime(java.util.Calendar component4)
component4
- Calendar with the Time content to setsetComponent4(java.util.Calendar)
public java.lang.String getComponent5()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent5AsString()
Field.getComponent(int)
insteadpublic java.lang.String getProprietaryCode()
public Field98K setComponent5(java.lang.String component5)
component5
- the component5 to setpublic Field98K setProprietaryCode(java.lang.String component5)
component5
- the Proprietary Code to setpublic 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 getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public 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 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 Field98K get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field98K get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field98K> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field98K> 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)