@Generated public class Field69F extends Field implements Serializable, DateContainer, GenericField
String
String
Calendar
Calendar
:4!c//4!c/<DATE4><TIME2>
:S//S/<DATE4><TIME2>
SSDT
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static Integer |
CODE
Component number for the Code subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static Integer |
DATE
Component number for the Date subfield
|
static String |
F_69F
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 69F
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
TIME
Component number for the Time subfield
|
components
Constructor and Description |
---|
Field69F()
Default constructor.
|
Field69F(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field69F(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 Field69F |
get(SwiftMessage msg)
Get the first instance of Field69F in the given message.
|
static Field69F |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field69F> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field69F in the given message
an empty list is returned if none found.
|
static List<Field69F> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field69F from the given block
an empty list is returned if none found.
|
String |
getCode()
Get the Code (component2).
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent3()
Get the component3
|
Calendar |
getComponent3AsCalendar()
Get the component3 as Calendar
|
String |
getComponent4()
Get the component4
|
Calendar |
getComponent4AsCalendar()
Get the component4 as Calendar
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
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. |
String |
getDate()
Get the Date (component3).
|
Calendar |
getDateAsCalendar()
Get the Date (component3) as Calendar
|
String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getQualifier()
Get the Qualifier (component1).
|
String |
getTime()
Get the Time (component4).
|
Calendar |
getTimeAsCalendar()
Get the Time (component4) 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 |
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 Field69F |
newInstance(Field69F 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() |
Field69F |
setCode(String component2)
Set the Code (component2).
|
Field69F |
setComponent1(String component1)
Set the component1.
|
Field69F |
setComponent2(String component2)
Set the component2.
|
Field69F |
setComponent3(Calendar component3)
Set the component3 from a Calendar object.
|
Field69F |
setComponent3(String component3)
Set the component3.
|
Field69F |
setComponent4(Calendar component4)
Set the component4 from a Calendar object.
|
Field69F |
setComponent4(String component4)
Set the component4.
|
Field69F |
setDate(Calendar component3)
Set the Date (component3) from a Calendar object.
|
Field69F |
setDate(String component3)
Set the Date (component3).
|
Field69F |
setQualifier(String component1)
Set the Qualifier (component1).
|
Field69F |
setTime(Calendar component4)
Set the Time (component4) from a Calendar object.
|
Field69F |
setTime(String component4)
Set the Time (component4).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
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, isAnyOf, 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_69F
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer CODE
public static final Integer DATE
public static final Integer TIME
public static final Integer CONDITIONAL_QUALIFIER
public Field69F()
public Field69F(String value)
value
- complete field value including separators and CRLFpublic Field69F(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 Field69F newInstance(Field69F 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()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent1AsString()
Field.getComponent(int)
insteadpublic String getQualifier()
public Field69F setComponent1(String component1)
component1
- the component1 to setpublic Field69F setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent2AsString()
Field.getComponent(int)
insteadpublic String getCode()
public Field69F setComponent2(String component2)
component2
- the component2 to setpublic Field69F setCode(String component2)
component2
- the Code to setpublic String getComponent3()
public Calendar getComponent3AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field69F setComponent3(String component3)
component3
- the component3 to setpublic Field69F setComponent3(Calendar component3)
component3
- the Calendar with the component3 content to setpublic Field69F setDate(String component3)
component3
- the Date to setpublic Field69F setDate(Calendar component3)
component3
- Calendar with the Date content to setsetComponent3(java.util.Calendar)
public String getComponent4()
public Calendar getComponent4AsCalendar()
null
if cannot be convertedpublic String getTime()
public Calendar getTimeAsCalendar()
null
if cannot be convertedpublic Field69F setComponent4(String component4)
component4
- the component4 to setpublic Field69F setComponent4(Calendar component4)
component4
- the Calendar with the component4 content to setpublic Field69F setTime(String component4)
component4
- the Time to setpublic Field69F setTime(Calendar component4)
component4
- Calendar with the Time content to setsetComponent4(java.util.Calendar)
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 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 String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.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 Field69F get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field69F get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field69F> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field69F> 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)